After you create account holders and balance accounts, you can use the Balance Platform API to:
- Update an existing account holder.
- Get information about an existing account holder, such as their email or phone number.
- Get information about a balance account, including fund balances and the cards associated with it.
- Get a list of an account holder's balance accounts.
You can also log in to your Balance Platform app to view information about account holders, their balance accounts, and the cards issued to them.
Update an existing account holder
After creating an account holder resource, you might need to update the resource at a later time to change its status. You can update an account holder resource with a PATCH /accountHolders/{id} request.
Retrieve account holders
To get the account holder details, make a GET /accountHolders/{id} request, where id is the unique identifier returned when you created the account holder.
{
"balancePlatform": "YOUR_BALANCE_PLATFORM",
"contactDetails": {
"address": {
"city": "Amsterdam",
"country": "NL",
"houseNumberOrName": "274",
"postalCode": "1020CD",
"street": "Brannan Street"
},
"email": "s.hopper@example.com",
"phone": {
"number": "+315551231234",
"type": "Mobile"
}
},
"description": "S.Hopper - Staff 123",
"id": "AH32272223222B5BRQZLD2M7S",
"status": "Active"
}Retrieve balance accounts
After you have created balance accounts, you might want to see the status of each, or to see the balance accounts associated with an account holder.
Get the details of a balance account
Get the details of a balance account with a GET /balanceAccounts/{id} request, specifying the unique id returned when you created the balance account. This endpoint returns the specific balanceAccount resource, including a list of balances and paymentInstruments (cards) associated with the balance account.
{
"accountHolderId": "AHA1B2C3D4E5F6G7H8I9J0",
"defaultCurrencyCode": "EUR",
"description": "Main balance account",
"balances": [
{
"available": 12500,
"balance": 12500,
"currency": "EUR",
"reserved": 0
}
],
"id": "BA3227C223222H8NLP6JQC3FD",
"paymentInstruments": [
{
"id": "PI3227C223222B5BPCMFXD2XG"
}
],
"status": "Active"
}Get the account holder's balance accounts
Use GET /accountHolders/{id}/balanceAccounts to get a collection of balanceAccount resources associated with the specific accountHolder.
Because an account holder can have multiple balance accounts, we paginate the results to make the response more manageable. Use the query parameters offset and limit to page through the items. By default, we limit the number of items returned per page to 10.
Here is an example of how you would limit the page items to 2 and to skip the first 4 items:
The response returns the list, along with a hasNext and hasPrevious boolean parameters which indicate if there are more items in the previous or next page.
{
"balanceAccounts": [
{
"accountHolderId": "AHA1B2C3D4E5F6G7H8I9J0",
"defaultCurrencyCode": "EUR",
"id": "BA3227C223222H8NLP6JQC3FD",
"status": "Active"
},
{
"accountHolderId": "AHA1B2C3D4E5F6G7H8I9J0",
"defaultCurrencyCode": "EUR",
"id": "BA32272223222B5BRR27D2M7B",
"status": "Active"
}
],
"hasNext": "true",
"hasPrevious": "true"
}