Get a balance account
Returns a balance account and its balances for the default currency and other currencies with a non-zero balance.
Path Parameters
The unique identifier of the balance account.
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.
Show moreShow lessaccountHolderIdstringThe unique identifier of the account holder associated with the balance account.
balancesarray[object]List of balances with the amount and currency.
availableintegerThe current balance minus any reserved balance.
balanceintegerThe current balance of funds in the balance account. These are the funds from all transactions with a value date in the past that have not yet been paid out.
currencystringThe three-character ISO currency code of the balance.
pendingintegerThe amount of funds that Adyen has processed for this account, but will be settled in a future date.
For more information, see how to settle funds for users in your platform and marketplace.
reservedintegerThe amount reserved for payments that have been authorised, but not yet captured by the merchant.
Applies only to Adyen-issued cards.
defaultCurrencyCodestringThe 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.
descriptionstringMax length: 300A 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.
idstringThe unique identifier of the balance account.
metadataobjectA 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.
migratedAccountCodestringThe unique identifier of the account of the migrated account holder in the classic integration.
platformPaymentConfigurationobjectContains key-value pairs to the configure the settlement model in a balance account.
salesDayClosingTimestringSpecifies 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".
settlementDelayDaysintegerSpecifies after how many business days the funds in a settlement batch are made available in this balance account.
Possible values: 0 to 10, 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.
referencestringMax length: 150Your reference for the balance account, maximum 150 characters.
statusstringThe status of the balance account, set to active by default.
timeZonestringThe 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.
400 - Bad Request
A problem reading or understanding the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA 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.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.