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 through the API.
- Activating a card to enable payment processing.
- Suspending a card to temporarily stop payment processing.
- Permanently closing a card.
- Viewing card payments in the Balance Platform Customer Area.
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.
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.
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.
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.
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.
- Log in to the Balance Platform Customer Area.
- Go to Payment instruments.
- Select the appropriate payment instrument from the list.
- 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.