After you create account holders and balance accounts, you can use our APIs to:
- 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.
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 balance account resource
Use GET /balanceAccounts/{id}, where id is the unique identifier returned when you created the balance account. This retrieves the specific balanceAccount resource, including the balances, and the 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. By default, we limit the number of items returned per page to 10.
- To change the number of balance accounts returned per page, use
limit. - To skip a specified number of balance accounts, use
offset.
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"
}