ADadyen
Balance accounts

Update a balance account

Changed on

Updates a balance account.

patch/balanceAccounts/{id}

Request

  • Base URL
    https://balanceplatform-api-test.adyen.com/bcl/v2
  • URL
    https://balanceplatform-api-test.adyen.com/bcl/v2/balanceAccounts/{id}
  • Auth
    • API key in query parameter clientKey
    • or HTTP basic
    • or API key in header X-API-Key

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

  • v2d97824b012f7Revision changes
    • info

      added the optional property // to the response with the status

  • v2725b9c7457beRevision changes
    • warning

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