To manage the balance accounts on your platform, you can use the Configuration API to:
- View the balance accounts for an account holder or the details of a specific balance account, including fund balances.
- Update balance accounts.
You can also log in to your Balance Platform Customer Area to view account holders and their balance accounts.
View balance accounts
To view the balance accounts and the available balances of your account holder, you can either use your Balance Platform Customer Area or make an API request.
To get balance accounts, use the following endpoints:
- GET /accountHolders/{id}/balanceAccounts: Get a list of the balance accounts of an account holder. This endpoint returns a paginated list of balance accounts.
- GET /balanceAccounts/{id}: Get the details of a balance account, including a list of balances and paymentInstruments (cards) associated with the balance account.
Update a balance account
To update a balance account, make a PATCH /balanceAccounts/{id} request. The following example shows how to update the description of a balance account.
Close a balance account
In some scenarios, you might want to close an account holder's balance account. For example, an account holder that has separate balance accounts for their businesses might want to close one of their businesses.
To permanently close a balance account:
- Check if the balance account has zero balance. You can only close an empty balance account, so if there are funds left, you must pay out or transfer any remaining balance to another balance account.
- Close a balance account by updating the balance account and setting the
statusto Closed.
If an account holder discontinues their contractual relationship with your platform, you can also permanently deactivate the account holder.