POST /balanceAccounts/{balanceAccountId}/payoutSchedules

Apply a managed payout schedule to a balance account. This payout schedule is based on an existing payout schedule in your balance platform.

Servers

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

Path parameters

Name	Type	Required	Description
`balanceAccountId`	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
`frequency`	String	Yes	The frequency of payouts initiated by this payout schedule. Possible values: daily weekdays weekly monthly Default value: The `defaultFrequency` from the balance platform schedule that you are applying. Valid values: `"monthly"` `"weekly"` `"weekdays"` `"daily"`
`description`	String	No	The description used for all payouts initiated by this payout schedule. Maximum length: 140 characters. If your description is longer, it may be truncated. Default value: The `defaultDescription` from the balance platform schedule that you are applying.
`referenceForBeneficiary`	String	No	The reference for beneficiary used for all payouts initiated by this payout schedule. This reference is sent to the recipient of the transfer and is included in all webhooks related to the payout. Supported characters: a-z, A-Z, 0-9, - and space. Spaces might be replaced with - if the recipient bank or payment infrastructure does not allow spaces. Default value: The `defaultReferenceForBeneficiary` from the balance platform schedule that you are applying.
`balancePlatformPayoutScheduleId`	String	Yes	The unique identifier of the payout schedule that is applied to the balance account.
`currency`	String	No	The three-character ISO code of the currency used for this schedule.
`frequencyValue`	Integer	No	The date of the month or day of the week when payouts are initiated. Allowed only if `frequency` is monthly or weekly. Possible values if `frequency` is monthly: [1 - 31]. If your specified date happens on a weekend, the payout is initiated on the next business day. If your specified date (29, 30, or 31) does not exist in a month, the payout is initiated on the last day of that month. Possible values if `frequency` is weekly: [1 - 5]. Default value: The `defaultFrequencyValue` from the balance platform schedule that you are applying.
`transferInstrumentId`	String	Yes	The unique identifier of the transfer instrument to which the funds are paid out.
`enabled`	Boolean	No	Specifies whether the payout schedule is enabled immediately after it is created.
`retainedAmount`	Integer	No	The amount of funds that must remain available in the balance account after an execution of the payout schedule. If the funds in the balance account are less than the retained amount, the execution is not initiated. Default value: 0
`salesDayClosingTime`	String	No	The time of day when the sales day is closed in balance account time zone. The sales day closing time can be between 00:00 to 07:00. Format: HH:mm:ss
`reference`	String	No	The merchant reference that will be shown only in the schedule.
`maxPayoutAmount`	Integer	No	The maximum amount that can be paid out from balance accounts that use this payout schedule. Default value: 0
`minPayoutAmount`	Integer	No	The minimum amount that can be paid out from balance accounts that use this payout schedule. Default value: 0

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.