Account holders7

Authorized card users4

Balance accounts5

Balances5

Bank account validation1

Card orders2

Custom payout schedules (sweeps)5

Direct debit mandates4

Grant accounts1

Grant offers2

Manage card PIN3

Manage SCA devices6

Managed payout schedules8

Network tokens2

Payment instrument groups3

Payment instruments9

Platform3

Recurring top ups4

SCA association management3

SCA device management4

Transaction rules4

Transfer limits - balance account level6

Transfer limits - balance platform level4

Transfer routes1

Balance accounts

Update a balance account

Updates a balance account.

patch/balanceAccounts/{id}

Path parameters

idstring required

The unique identifier of the balance account.

Request body

accountHolderIdstring

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

descriptionstring

A human-readable description of the balance account. You can use this parameter to distinguish between multiple balance accounts under an account holder.

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.

referencestring

Your reference to the balance account.

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

The status of the balance account. Payment instruments linked to the balance account can only be used if the balance account status is active.

Possible values: active, closed, suspended.

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.

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 6 of the 51 revisions of this API.123

Jun 2, 2026v2d97824b012f71See 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
Dec 10, 2025v2725b9c7457be1See the full diff
- ●
  removed the optional property balances/items/pendingAvailable from the response with the 200 status
  response-optional-property-removed
Dec 2, 2025v210b9f2e232481See the full diff
- ○
  added the optional property balances/items/pendingAvailable to the response with the 200 status
  response-optional-property-added
Jan 16, 2024v224691235e7211See 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
Nov 14, 2023v212a0c6036e6b10See 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
Oct 19, 2023v278e297a2eb6f1See the full diff
- ●
  removed the request property defaultCurrencyCode
  request-property-removed

Full history