Skip to main content

Cancel the nominated card

POST 
/v1/cards/:cardId/cancel

Required States: ACTIVE

This endpoint will execute when the following conditions are satisfied:

  • Party is in a relevant state ACTIVE
  • Party has a valid account that is ACTIVE
  • Party has a relationship to the nominated card instance.
  • The card is in the PROVISIONED, ACTIVE or LOCKED state

This operation cancels, or requests a replacement, for the nominated card instance based on the reason provided for cancellation.

Each of the following reasons will result in a different outcome:

  • CANCEL: The card will be cancelled and the status will be updated to CANCELED
  • LOST: The card will be cancelled and a replacement card will be requested. The current card instance will transition to CANCELED
  • STOLEN: The card will be cancelled and a replacement card will be requested. The current card instance will transition to CANCELED
  • DAMAGED: The card will remain ACTIVE and a replacement card will be requested. Depending on the type of card, it may be ACTIVE (VIRTUAL or PHYSICAL_AND_VIRTUAL cards) or NEW (PHYSICAL cards)

The response will return status information about the cancelled card instance.

Request​

Responses​

OK

Last updated on