Create a balance account

post /balanceAccounts

Creates a balance account that holds the funds of the associated account holder.

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/bcl/v2/balanceAccounts
Click to copy

Request parameters

accountHolderId string Required

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

defaultCurrencyCode string

The default three-character ISO currency code of the balance account. 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.

reference string
Max length: 150

Your reference for the balance account, maximum 150 characters.

timeZone string

The time zone of the balance account. For example, Europe/Amsterdam. If not set, the time zone of the account holder will be used. 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