By default, the settlement delay for transactions is configured for your entire merchant account. You can configure a different settlement delay for specific balance accounts when you create or update them using the Configuration API.
Requirements
Before you begin, take into account the following requirements, limitations, and preparations.
Requirement | Description |
---|---|
API credential roles | Make sure that you have the following role for the Configuration API:
|
Webhooks | Subscribe to the Configuration webhooks to receive the following webhooks: |
Limitations | You can only specify a settlement delay of 1 day with previous approval from Adyen. |
Configure settlement delay
You can configure the settlement delay on new and existing balance accounts by using the Configuration API and including the platformPaymentConfiguration
object in your request:
- Use POST /balanceAccounts when you create a balance account.
- Use PATCH /balanceAccounts/{id} when you update a balance account.
In the platformPaymentConfiguration object, include the following parameters:
Parameter | Required | Description |
---|---|---|
settlementDelayDays | Specifies after how many business days the funds in a settlement batch are made available. Possible values: integers from 1 to 20, and null (default). |
|
salesDayClosingTime | Specifies at what time a sales day ends. Possible values: Time in "HH:MM" format, where:
If you have previously configured a specific closing time, you must include this parameter whenever you update the balance account. Otherwise, the parameter is set back to the default value. |
The following code sample shows how you can change the sales day's settlement delay to 3 days.
If the request was successful, the response contains the platformPaymentConfiguration
object with the data you provided.
Webhooks
After the new settlement delay is applied to the balance account, we send one of the following webhooks to your server:
- For a new balance account, we send the balancePlatform.balanceAccount.created webhook.
- For existing balance accounts, we send the balancePlatform.balanceAccount.updated webhook.