Update a balance account

patch /balanceAccounts/{id}

Updates a balance account.

Endpoint destination URL

Click to copy

Path parameters

id string Required

The unique identifier of the balance account.

Request parameters

accountHolderId string

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

defaultCurrencyCode string

The default currency code of this balance account, in three-character ISO currency code format. The default value is EUR.

description string
Max length: 300

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.

metadata object

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.

platformPaymentConfiguration object

Contains key-value pairs to the configure the settlement model in a balance account.

reference string
Max length: 150

Your reference to the balance account, maximum 150 characters.

status string

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, inactive, closed, suspended.

timeZone string

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 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.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy