PATCH /balanceAccounts/{id}
Updates a balance account.
Servers
- https://balanceplatform-api-test.adyen.com/bcl/v2
Path parameters
Name | Type | Required | Description |
---|---|---|---|
id |
String | Yes |
The unique identifier of the balance account. |
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 |
---|---|---|---|
description |
String | No |
A human-readable description of the balance account. 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.
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.
|
status |
String | No |
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. Possible values:
|
reference |
String | No |
Your reference to the balance account. |
accountHolderId |
String | No |
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. |
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.