Get the balances of an account holder

post/accountHolderBalance

API Version

Returns the account balances of an account holder. An account's balances are organized according by currencies. This mean that an account may have multiple balances: one for each currency.

Endpoint destination URL

https://cal-test.adyen.com/cal/services/Fund/v6/accountHolderBalance

Request Parameters

Required

Optional

The code of the Account Holder of which to retrieve the balance.

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.
balancePerAccountarray[object]
A list of each account and their balances.
accountCodestring
The code of the account that holds the balance.
detailBalanceobject
Details of the balance held by the account.
balancearray[object]
The list of balances held by the account.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
onHoldBalancearray[object]
The list of on hold balances held by the account.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
pendingBalancearray[object]
The list of pending balances held by the account.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
invalidFieldsarray[object]
Contains field validation errors that would prevent requests from being processed.
errorCodeinteger
The validation error code.
errorDescriptionstring
A description of the validation error.
fieldTypeobject
The type of error field.
fieldstring
The full name of the property.
fieldNamestring
The type of the field.
shareholderCodestring
The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
pspReferencestring
The reference of a request. Can be used to uniquely identify the request.
resultCodestring
The result code.
totalBalanceobject
The total balance of the account holder.
balancearray[object]
The list of balances held by the account.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
onHoldBalancearray[object]
The list of on hold balances held by the account.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
pendingBalancearray[object]
The list of pending balances held by the account.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
202 - Accepted
The request has been accepted for processing, but the processing has not been completed.
balancePerAccountarray[object]
A list of each account and their balances.
accountCodestring
The code of the account that holds the balance.
detailBalanceobject
Details of the balance held by the account.
balancearray[object]
The list of balances held by the account.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
onHoldBalancearray[object]
The list of on hold balances held by the account.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
pendingBalancearray[object]
The list of pending balances held by the account.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
invalidFieldsarray[object]
Contains field validation errors that would prevent requests from being processed.
errorCodeinteger
The validation error code.
errorDescriptionstring
A description of the validation error.
fieldTypeobject
The type of error field.
fieldstring
The full name of the property.
fieldNamestring
The type of the field.
shareholderCodestring
The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
pspReferencestring
The reference of a request. Can be used to uniquely identify the request.
resultCodestring
The result code.
totalBalanceobject
The total balance of the account holder.
balancearray[object]
The list of balances held by the account.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
onHoldBalancearray[object]
The list of on hold balances held by the account.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
pendingBalancearray[object]
The list of pending balances held by the account.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
400 - Bad Request
A problem reading or understanding the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
401 - Unauthorized
Authentication required.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
403 - Forbidden
Insufficient permissions to process the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
422 - Unprocessable Entity
A request validation error.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
500 - Internal Server Error
The server could not process the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.

Get the balances of an account holder

HTTP Responses

200 - OK

202 - Accepted

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error