Apply a managed payout schedule to a balance account

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.

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/bcl/v2/balanceAccounts/{balanceAccountId}/payoutSchedules

Path Parameters

Required

Optional

The unique identifier of the balance account.

Request Parameters

Required

Optional

The unique identifier of the payout schedule that is applied to the balance account.

The three-character ISO code of the currency used for this schedule.

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.

Specifies whether the payout schedule is enabled immediately after it is created.

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.

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.

The maximum amount that can be paid out from balance accounts that use this payout schedule.

Default value: 0

The minimum amount that can be paid out from balance accounts that use this payout schedule.

Default value: 0

The merchant reference that will be shown only in the schedule.

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.

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

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

The unique identifier of the transfer instrument to which the funds are paid out.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
balanceAccountIdstring
The unique identifier of the balance account to which you apply the payout schedule.
balancePlatformPayoutScheduleIdstring
The unique identifier of the balance platform payout schedule that is applied to the balance account.
createdAtstring
The date and time when the payout schedule was created.
currencystring
The three-character ISO code of the currency used for this schedule.
descriptionstring
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.
enabledboolean
Specifies whether the payout schedule is active.
frequencystring
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.
frequencyValueinteger
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.
idstring
The unique identifier of the payout schedule for the balance account.
maxPayoutAmountinteger
The maximum amount that can be paid out from balance accounts that use this payout schedule.

Default value: 0
minPayoutAmountinteger
The minimum amount that can be paid out from balance accounts that use this payout schedule.

Default value: 0
referencestring
Your reference for the payout schedule. This reference does not appear on statements of payouts initiated by the payout schedule.
referenceForBeneficiarystring
The reference for beneficiary used for all payouts initiated by this payout schedule. This reference is sent to the recipient of the payout and is included in all webhooks related to the payout.

Supported characters: a-z, A-Z, 0-9.

Default value: The defaultReferenceForBeneficiary from the balance platform schedule that you are applying.
retainedAmountinteger
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
salesDayClosingTimestringDeprecated
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
transferInstrumentIdstring
The unique identifier of the transfer instrument to which the funds are paid out.
updatedAtstring
The date and time when the payout schedule was updated.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
404 - Not Found
The resource was not found
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
500 - Internal Server Error
The server could not process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Apply a managed payout schedule to a balance account

HTTP Responses

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

422 - Unprocessable Entity

500 - Internal Server Error