Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Card Lifecycle

Update Card Status

Change a card's status, applicable to SINGLE and SHARE mode cards.

The final status change of the card shall be subject to webhooks notification.

post/v1/issuing/cards/{id}/status

Path parameters

idstring uuid required
Example:b3d9d2d5-4c12-4946-a09d-953e82sed2b0

Universally unique identifier (UUID v4) of a resource.

Headers

x-on-behalf-ofstring

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-keystring uuid

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

Request body

card_status'ACTIVE' | 'FROZEN' | 'CANCELLED' required

Card status enum. See the Card lifecycle and statuses guide for more information.

  • ACTIVE - The request to create the card was successful and the card is ready to use.
  • FROZEN - All incoming authorization requests will be declined. the card can be reactivated to accept new authorizations.
  • CANCELLED - The card cannot be reactivated from this state, all incoming authorization requests will be permanently declined.
update_reasonstring

The reason for updating card status.

Example request

{
  "card_status": "FROZEN"
}

Response

Card update successfully.

card_idstring required

Unique identifier for the card.

card_order_idstring required

ID of the card order.

order_status'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILED' required

This field will contain the status of the request after processing.

  • PENDING -The initial status of the order request.
  • PROCESSING - If this status shall be subject to webhooks notification.
  • SUCCESS - The final status of the order request is successful.
  • FAILED - The final status of the order request is failed.
update_reasonstring

The reason for updating card status.

Example response

{
  "card_id": "c0cef051-29c5-4796-b86a-cd5b684bfad7",
  "card_order_id": "c0cef051-29c5-4796-b86a-cd5ee34bfad7"
}