Manage card lifecycle

After you create and issue cards to your users, you will need to manage the whole lifecycle of your cards, including:

• Suspending a card to temporarily stop payment processing.
• Permanently closing a card.
• Replacing a lost or stolen card.

Suspend a card

You can suspend a payment instrument to temporarily prevent payment processing. You can activate the card again at any time. If you want to permanently close a card, you need to close the card.

To suspend a card, make a PATCH /paymentInstruments/{id} request and set the status to Suspended.

curl https://balanceplatform-api-test.adyen.com/bcl/v1/paymentInstruments/PI3227C223222B5BPCMFXD2XG \
-u "ws@BalancePlatform.YOUR_BALANCE_PLATFORM":"YOUR_WS_PASSWORD" \
-H "content-type: application/json" \
-X PATCH \
-d '{
    "status":"Suspended"
}'

The card can no longer be used for payments. To re-enable payments, you need to update the status back to Active.

{
    "balanceAccountId": "BA32272223222Y7R9Z3T52DKZ",
    "description": "Main card",
    "issuingCountryCode": "GB",
    "status": "Suspended",
    "type": "card",
    "card": {
        "brand": "mc",
        "brandVariant": "mcdebit",
        "cardholderName": "Sam Hopper",
        "formFactor": "virtual",
        "bin": "555544",
        "expiration": {
            "month": "08",
            "year": "2023"
        },
        "lastFour": "2407",
        "number": "************2407"
    },
    "id": "PI3227C223222B5BPCMFXD2XG"
}

Close a card

Closing a card is a permanent action and cannot be reversed. If you want to temporarily prevent processing, you can suspend the card instead.

To close a card, make a PATCH /paymentInstruments/{id} request and set the status to Closed.

Here is an example of how you close a card with payment instrument id PI3227C223222B5BPCMFXD2XG:

curl https://balanceplatform-api-test.adyen.com/bcl/v1/paymentInstruments/PI3227C223222B5BPCMFXD2XG \
-u "ws@BalancePlatform.YOUR_BALANCE_PLATFORM":"YOUR_WS_PASSWORD" \
-H "content-type: application/json" \
-X PATCH \
-d '{
    "status":"Closed"
}'

Replace a card

Replacing a card requires creating a new payment instrument and specifying why the previous card is being replaced. The details of the new card will be generated based on the replacement reason:

• Lost: Card is reported as lost. New card number, CVV, and expiration date is used. The original card is canceled.
• Stolen: Card has been stolen. New card number, CVV, and expiration date is used. The original card is canceled.
• Damaged: The physical card is damaged. The card number is copied from original payment instrument to the new payment instrument, and a new CVV and expiration date will be used. The original card is left active.
• Expiration: The card is nearing expiration or is expired. The card number is copied from original payment instrument to the new payment instrument, and a new CVV and expiration date will be used. The original card is left active.