After you create and issue cards to your users, you will need to manage the whole lifecycle of your cards, including:
- Updating the balance account linked to a card.
- Suspending a card to temporarily stop payment processing.
- Permanently closing a card.
Update the balance account linked to a card
Some use cases might require that you update the balance account linked to a card after the card has been created. You can do this only if the card has a Requested or Inactive status.
To update the balance account ID, make a PATCH /paymentInstruments/{id} request and send the new balanceAccountId
.
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 '{
"balanceAccountId":"BA32272223222B5CM82WL892M"
}'
The response contains the paymentInstrument resource, with the updated balanceAccountId
.
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.
The card can no longer be used for payments. To re-enable payments, you need to update the status
back to Active.
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: