Replace Card

šŸ”’

Required scope: cards:write

The API credential calling this endpoint must be granted the cards category with read & write access.
Scopes are assigned to the credential when it is created or edited in Pliant, not requested when obtaining the access token.
A credential without this scope receives 403 Forbidden with the error code INSUFFICIENT_PERMISSION.

Replace or renew an existing card. This endpoint creates a new card with the same settings and card type, with new sensitive card data, for the same cardholder. This can be useful to replace for instance a stolen credit card.

When the old card is terminated depends on the card type and terminateCardReason:

  • Virtual cards: at once.
  • Physical cards, LOST or STOLEN: at once.
  • Physical cards, OTHER, DAMAGED or EXPIRING_SOON: when the new card is activated. Until then, the old card stays active.

The following callbacks are sent:

  • New card: CARD_CREATED, then CARD_BALANCE_UPDATED and CARD_LIMIT_CHANGED. A replacement card is created in its final state, so you receive no CARD_ISSUED or CARD_STATUS_CHANGED for it at creation. A physical replacement card starts in PENDING_ACTIVATION. When the cardholder activates it, you receive CARD_ACTIVATED and CARD_STATUS_CHANGED for it. This can be days or weeks after the replace request.
  • Old card: CARD_TERMINATED and CARD_STATUS_CHANGED, at the termination time above.

The order of these callbacks is not guaranteed, also between the two cards. Use replacedCardId from the response to link the new card to the old one.

Path Params
uuid
required

The unique identifier of the card.

Body Params
string
enum
required

The reason why the card is being replaced. Depending on the card type there are different valid reasons.

DAMAGED can be used for physical cards.
EXPIRING_SOON can be used for physical and virtual cards, plus the cards has to expiry within the next three months.
LOST can be used for physical cards.
STOLEN can be used for all types of cards.
OTHER can be used for all types of cards.

A replacement of a card is only possible if the card is not in one of the following statuses: PENDING_ISSUANCE, PENDING_REGISTRATION, REQUESTED.
Also, single-use cards cannot be replaced at all.

Allowed:
integer
required

The number of months the new card should be valid for. This needs to follow the guidelines from normal card issuing.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json