Manage balance accounts

A balance account is an API resource that contains information about the funds held by your user. To manage the balance accounts use the Configuration API.

This page contains instructions for common balance account operations. These operations are part of a larger process which includes verification and onboarding steps.

View balance accounts

To view the balance accounts and the available balances of your account holder, you can either use your Customer Area or make an API request.

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:

1. 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.
2. Close a balance account by updating the balance account and setting the status to Closed.

If an account holder discontinues their contractual relationship with your platform, you can also permanently deactivate the account holder.