By default, Adyen defines a sales day from midnight (00:00) to midnight of the next day (23:59) in the balance account's local timezone. You can configure your sales day to end later if your user's business closes after midnight. For example, a restaurant owner that operates from noon to 3:00 AM can set the sales day closing to 3:00 AM. This means that the sales day of that business starts at 3:01 AM and ends at 3:00 AM on the next day.
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 delay closing times until 7:00 AM. The funds from certain payment methods or variants are settled according to the payment method's schedule, instead of the sales day closing time:
|
Configure sales day closing time
You can configure sales day settlements 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 |
---|---|---|
salesDayClosingTime | Specifies at what time a sales day ends. Possible values: Time in "HH:MM" format, where:
|
|
settlementDelayDays | Required if different from the default settlement delay applied to the merchant account. 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). |
The following code sample shows how you can configure the closing time where the sales day ends at 1 AM and the funds are made available after two business days.
If the request was successful, the response includes the platformPaymentConfiguration
object, which contains the data you provided.
Webhooks
After the new closing time 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.