POST /balanceAccounts

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

Servers

https://balanceplatform-api-test.adyen.com/bcl/v2

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`defaultCurrencyCode`	String	No	The default three-character ISO currency code of the balance account. The default value is EUR. After a balance account is created, you cannot change its default currency.
`description`	String	No	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.
`platformPaymentConfiguration`	Object	No	Contains key-value pairs to the configure the settlement model in a balance account.
`platformPaymentConfiguration.salesDayClosingTime`	String	No	Specifies at what time a sales day ends for this account. Possible values: Time in "HH:MM" format. HH ranges from 00 to 07. MM must be 00. Default value: "00:00".
`platformPaymentConfiguration.settlementDelayDays`	Integer	No	Specifies after how many business days the funds in a settlement batch are made available in this balance account. Possible values: 1 to 10, or null. Setting this value to an integer enables Sales day settlement in this balance account. See how Sales day settlement works in your marketplace or platform. Setting this value to null enables Pass-through settlement in this balance account. See how Pass-through settlement works in your marketplace or platform. Default value: null.
`metadata`	Object	No	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.
`reference`	String	No	Your reference for the balance account, maximum 150 characters.
`accountHolderId`	String	Yes	The unique identifier of the account holder associated with the balance account.
`timeZone`	String	No	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.
`migratedAccountCode`	String	No	The unique identifier of the account of the migrated account holder in the classic integration.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.