Sign in
Balance accounts

Get a balance account

Returns a balance account and its balances for the default currency and other currencies with a non-zero balance.

get/balanceAccounts/{id}

Path parameters

idstring required

The unique identifier of the balance account.

Response

OK - the request has succeeded.

accountHolderIdstring required

The unique identifier of the account holder associated with the balance account.

defaultCurrencyCodestring

The default three-character ISO currency code of the balance account. This is the currency displayed on the Balance Account overview page in your Customer Area. The default value is EUR.

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

descriptionstring

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 required

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.

referencestring

Your reference for the balance account, maximum 150 characters.

status'active' | 'closed' | 'inactive' | 'suspended'

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.

Changes

Changed in 5 of the 51 revisions of this API.113

  • v2d97824b012f71See the full diff
    • ○

      added the optional property balances/items/pendingAvailable to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v2725b9c7457be1See the full diff
    • ●

      removed the optional property balances/items/pendingAvailable from the response with the 200 status

      response-optional-property-removed

  • v210b9f2e232481See the full diff
    • ○

      added the optional property balances/items/pendingAvailable to the response with the 200 status

      response-optional-property-added

  • v224691235e7211See the full diff
    • ○

      the endpoint scheme security clientKey was added to the API

      api-security-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v212a0c6036e6b10See the full diff
    • ●

      removed the optional property response/paths from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property response/paths from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property response/paths from the response with the 403 status

      response-optional-property-removed

    • ●

      removed the optional property response/paths from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property response/paths from the response with the 500 status

      response-optional-property-removed

    • ●

      removed the optional property response/rootPath from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property response/rootPath from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property response/rootPath from the response with the 403 status

      response-optional-property-removed

    • ●

      removed the optional property response/rootPath from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property response/rootPath from the response with the 500 status

      response-optional-property-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog