Get all balance accounts of an account holder

get/accountHolders/{id}/balanceAccounts

API Version

Returns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters.

For example, to limit the page to 5 balance accounts and skip the first 10, use /accountHolders/{id}/balanceAccounts?limit=5&offset=10.

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/bcl/v2/accountHolders/{id}/balanceAccounts

Query Parameters

Required

Optional

The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.

The number of items that you want to skip.

Path Parameters

Required

Optional

The unique identifier of the account holder.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
balanceAccountsarray[object]
List of balance accounts.
accountHolderIdstring
The unique identifier of the account holder associated with the balance account.
defaultCurrencyCodestring
The default three-character ISO currency code of the balance account. The default value is EUR.

After a balance account is created, you cannot change its default currency.

descriptionstring
Max length: 300
A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder.
idstring
The unique identifier of the balance account.
metadataobject
A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired.

Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.

migratedAccountCodestring
The unique identifier of the account of the migrated account holder in the classic integration.
platformPaymentConfigurationobject
Contains key-value pairs to the configure the settlement model in a balance account.
salesDayClosingTimestring
Specifies at what time a sales day ends for this account.

Possible values: Time in "HH:MM" format. HH ranges from 00 to 07. MM must be 00.

Default value: "00:00".
settlementDelayDaysinteger
Specifies after how many business days the funds in a settlement batch are made available in this balance account.

Possible values: 1 to 20, or null.

Setting this value to an integer enables Sales day settlement in this balance account. See how Sales day settlement works in your marketplace or platform.

Setting this value to null enables Pass-through settlement in this balance account. See how Pass-through settlement works in your marketplace or platform.

Default value: null.
referencestring
Max length: 150
Your reference for the balance account, maximum 150 characters.
statusstring
The status of the balance account, set to active by default.

timeZonestring
The time zone of the balance account. For example, Europe/Amsterdam. Defaults to the time zone of the account holder if no time zone is set. For possible values, see the list of time zone codes.
hasNextboolean
Indicates whether there are more items on the next page.
hasPreviousboolean
Indicates whether there are more items on the previous page.
400 - Bad Request
A problem reading or understanding the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error
The server could not process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Get all balance accounts of an account holder

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error