Replace Card

post

https://partner-api.getpliant.com/api/cards/{cardId}/replace

Replace or renew an existing card. This endpoints terminates the card being replaced and creates a new card with the same settings and card type, but different sensitive card information under the same cardholder. This can be useful to replace for instance a stolen credit card. The following callbacks will be triggered by this action:

For the terminated card: CARD_TERMINATED, CARD_STATUS_CHANGED to terminated and CARD_BALANCE_UPDATED to set the card balance to zero.
For the newly created card: CARD_ISSUED, CARD_ACTIVATED, CARD_STATUS_CHANGED and CARD_BALANCE_UPDATED with the corresponding balance.

Path Params

cardId

uuid

required

The unique identifier of the card.

Body Params

terminateCardReason

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:

expiryPeriodMonths

integer

required

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

Responses

200Ok

400Bad Request. The API consumer sent a malformed request which could not be processed.

401Unauthorized. The API consumer is not authorized to access the requested resource.

403Forbidden. The API consumer is not allowed to access the requested resource.

404Not Found. The requested resource could not be found.

429Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our API guidelines.

500Internal Server Error. The request was not completed due to an internal error.