Issuin icon

Manage cards

Learn how to change the status of a card.

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

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 is in inactive status.

To update the balance account ID, make a PATCH /paymentInstruments/{id} request and send the new balanceAccountId.

Update the balance account ID
Expand view
Copy link to code block
Copy code
Copy code
curl https://balanceplatform-api-test.adyen.com/bcl/v2/paymentInstruments/PI3227C223222B5BPCMFXD2XG \
-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \
-H 'content-type: application/json' \
-X PATCH \
-d '{
    "balanceAccountId":"BA32272223222B5CM82WL892M"
}'

The response contains the paymentInstrument resource, with the updated balanceAccountId.

Activate a card

To secure physical cards, we recommended that you keep them inactive until the user receives the card.

You can activate cards using the Customer Area or the Balance Platform API.

To activate a card:

  1. Log in to the Balance Platform Customer Area.
  2. Go to Payment instruments.
  3. Select the appropriate payment instrument from the list.
  4. Select Change card status in the upper right corner.
  5. In the pop-up window, set the New Status to Active.
  6. Select Change status.

After the card is activated, it can start processing payments.

Suspend a card

You can suspend a payment instrument to temporarily prevent payment processing. You can activate the card again at any time. To permanently deactivate a card, see Close a card.

You can suspend cards using the Customer Area or the Balance Platform API.

To suspend a card:

  1. Log in to the Balance Platform Customer Area.
  2. Go to Payment instruments.
  3. Select the appropriate payment instrument from the list.
  4. Select Change card status in the upper right corner.
  5. In the pop-up window, set the New Status to Suspended.
  6. In the Reason dropdown list, select the appropriate reason for the status change.
  7. If you have selected Other as a reason, you are also required to add a note.
  8. Select Change status.

The card can no longer be used for payments. To re-enable payments, you need to set 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.

You can close cards using the Balance Platform API or Customer Area.

To close a card:

  1. Log in to the Balance Platform Customer Area.
  2. Go to Payment instruments.
  3. Select the appropriate payment instrument from the list.
  4. Select Change card status in the upper right corner.
  5. In the pop-up window, set the New Status to Closed.
  6. In the Reason dropdown list, select the appropriate reason for the status change.
  7. Select Change status.

The card can no longer be used for payments.

View card payments

You can view all payments made with a card in the Balance Platform Customer Area.

  1. Log in to the Balance Platform Customer Area.
  2. Go to Payment instruments.
  3. Select the appropriate payment instrument from the list.
  4. Select View payments in the upper right corner.

A list is shown, displaying all payments made with the card. By default, the results are filtered to the last 6 months.

Next steps

required
Process payments

Learn how to handle payments made with Adyen-issued cards.
Create cards

Create cards for your users.