Suspend a cardholder's card

Suspends the cardholder's card at the processor, blocking it from transacting until it is unsuspended. The account and its balance are unchanged.

On success the response is 200 with a message. Call Get a cardholder by ID to read the new status.

StatustypeWhen
404cardholder_not_foundNo cardholder with this id in your company
409cardholder_already_suspendedThe card is already suspended
409cardholder_already_closedThe card is closed
409cardholder_status_transition_not_allowedThe processor refused the change for the card's current status
422cardholder_not_assignedThe card is still in inventory
422cardholder_no_cardsThe account has no card
422cardholder_card_lost_or_stolen, cardholder_fraud_blocked, cardholder_expiredThe card's status does not allow suspension
422cardholder_not_activatedThe card was never activated, or is cancelled or still in transit
502cardholder_status_change_failedThe processor failed; the status may not have changed, so check it before retrying
500internal_server_errorReading the card's status or changing it failed unexpectedly; check the status before retrying
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Cardholder identifier

Body Params
string
length ≤ 100

Reason for the status change

Headers
string
length ≤ 255

Optional idempotency key. Replaying within 24h returns the cached response; reusing a key with different parameters returns 400 idempotency_params_error.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json