General

Get the balances of an account holder

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.

post/accountHolderBalance

Request body

accountHolderCodestring required

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

Response

OK - the request has succeeded.

pspReferencestring

The reference of a request. Can be used to uniquely identify the request.

resultCodestring

The result code.

submittedAsyncboolean

Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:

true: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
false: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.

Changes

Changed in 9 of the 23 revisions of this API.47733

Apr 12, 2023v3f2434cc6c1001446See the full diff
- ▲
  the balancePerAccount/items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the balancePerAccount/items/ response's property type/format changed from object/ to / for status 202
  response-property-type-changed
- ▲
  the totalBalance/balance/items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the totalBalance/balance/items/ response's property type/format changed from object/ to / for status 202
  response-property-type-changed
- ▲
  the totalBalance/pendingBalance/items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the totalBalance/pendingBalance/items/ response's property type/format changed from object/ to / for status 202
  response-property-type-changed
- ▲
  removed the required property totalBalance/balance/items/currency from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property totalBalance/balance/items/currency from the response with the 202 status
  response-required-property-removed
- ▲
  removed the required property totalBalance/balance/items/value from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property totalBalance/balance/items/value from the response with the 202 status
  response-required-property-removed
- ▲
  removed the required property totalBalance/pendingBalance/items/currency from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property totalBalance/pendingBalance/items/currency from the response with the 202 status
  response-required-property-removed
- ▲
  removed the required property totalBalance/pendingBalance/items/value from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property totalBalance/pendingBalance/items/value from the response with the 202 status
  response-required-property-removed
- ●
  removed the optional property balancePerAccount/items/accountCode from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property balancePerAccount/items/accountCode from the response with the 202 status
  response-optional-property-removed
- ●
  removed the optional property balancePerAccount/items/detailBalance from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property balancePerAccount/items/detailBalance from the response with the 202 status
  response-optional-property-removed
- ○
  added the optional property balancePerAccount/items/AccountDetailBalance to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property balancePerAccount/items/AccountDetailBalance to the response with the 202 status
  response-optional-property-added
- ○
  added the optional property totalBalance/balance/items/Amount to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property totalBalance/balance/items/Amount to the response with the 202 status
  response-optional-property-added
- ○
  added the optional property totalBalance/pendingBalance/items/Amount to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property totalBalance/pendingBalance/items/Amount to the response with the 202 status
  response-optional-property-added
Mar 22, 2023v340f3741a648322See the full diff
- ▲
  the request's body type/format changed from / to object/
  request-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 200
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 202
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 400
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 403
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 422
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 500
  response-body-type-changed
- ▲
  the balancePerAccount/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the balancePerAccount/items/ response's property type/format changed from / to object/ for status 202
  response-property-type-changed
- ▲
  the balancePerAccount/items/detailBalance response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the balancePerAccount/items/detailBalance response's property type/format changed from / to object/ for status 202
  response-property-type-changed
- ▲
  the balancePerAccount/items/detailBalance/balance/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the balancePerAccount/items/detailBalance/balance/items/ response's property type/format changed from / to object/ for status 202
  response-property-type-changed
- ▲
  the balancePerAccount/items/detailBalance/pendingBalance/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the balancePerAccount/items/detailBalance/pendingBalance/items/ response's property type/format changed from / to object/ for status 202
  response-property-type-changed
- ▲
  the totalBalance response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the totalBalance response's property type/format changed from / to object/ for status 202
  response-property-type-changed
- ▲
  the totalBalance/balance/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the totalBalance/balance/items/ response's property type/format changed from / to object/ for status 202
  response-property-type-changed
- ▲
  the totalBalance/pendingBalance/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the totalBalance/pendingBalance/items/ response's property type/format changed from / to object/ for status 202
  response-property-type-changed
Oct 6, 2022v34ab7688046381See the full diff
- ○
  added the success response with the status 202
  response-success-status-added
Aug 7, 2021v3f451762264261See the full diff
- ○
  api tag General added
  api-tag-added
Jul 9, 2021v3e38d0becc3862See the full diff
- ○
  the endpoint scheme security ApiKeyAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security BasicAuth was added to the API
  api-security-added
Apr 10, 2021v3a5193c3dc8525See the full diff
- ○
  added the optional property status to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 500 status
  response-optional-property-added
Mar 5, 2021v3ce23a0d8c0485See the full diff
- ○
  added the media type application/json for the response with the status 400
  response-media-type-added
- ○
  added the media type application/json for the response with the status 401
  response-media-type-added
- ○
  added the media type application/json for the response with the status 403
  response-media-type-added
- ○
  added the media type application/json for the response with the status 422
  response-media-type-added
- ○
  added the media type application/json for the response with the status 500
  response-media-type-added
Aug 5, 2020v352572967b37d21See the full diff
- ▲
  the response property pspReference became optional for the status 200
  response-property-became-optional
- ▲
  the response property submittedAsync became optional for the status 200
  response-property-became-optional
- ○
  api operation id post-accountHolderBalance was added
  api-operation-id-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 4, 2020v3711c8869c6599312See the full diff
- ▲
  the request's body type/format changed from object/ to /
  request-body-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 200
  response-body-type-changed
- ▲
  removed the media type application/json for the response with the status 400
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status 401
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status 403
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status 422
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status 500
  response-media-type-removed
- ▲
  the totalBalance response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  removed the success response with the status 202
  response-success-status-removed
- ●
  removed the optional property balancePerAccount/items/AccountDetailBalance from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property totalBalance/balance/items/Amount from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property totalBalance/pendingBalance/items/Amount from the response with the 200 status
  response-optional-property-removed
- ○
  api operation id post-accountHolderBalance removed and replaced with
  api-operation-id-removed
- ○
  the endpoint scheme security ApiKeyAuth was removed from the API
  api-security-removed
- ○
  the endpoint scheme security BasicAuth was removed from the API
  api-security-removed
- ○
  api tag General removed
  api-tag-removed
- ○
  added the optional property balancePerAccount/items/accountCode to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property balancePerAccount/items/detailBalance to the response with the 200 status
  response-optional-property-added
- ○
  the response property pspReference became required for the status 200
  response-property-became-required
- ○
  the response property submittedAsync became required for the status 200
  response-property-became-required
- ○
  added the required property totalBalance/balance/items/currency to the response with the 200 status
  response-required-property-added
- ○
  added the required property totalBalance/balance/items/value to the response with the 200 status
  response-required-property-added
- ○
  added the required property totalBalance/pendingBalance/items/currency to the response with the 200 status
  response-required-property-added
- ○
  added the required property totalBalance/pendingBalance/items/value to the response with the 200 status
  response-required-property-added
This revision also has 12 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history