Get all managed payout schedules on your balance platform

get/balancePlatforms/{balancePlatformId}/payoutSchedules

Returns a list of all the payout schedules that are configured for your balance platform. You can use query parameters to filter the elements that are returned in the list.

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/bcl/v2/balancePlatforms/{balancePlatformId}/payoutSchedules

Query Parameters

Required

Optional

The three-character ISO currency code of the currency used in the payout configuration.

The two-letter ISO 3166-1 alpha-2 country code of the country to which the payout configuration applies.

Path Parameters

Required

Optional

The unique identifier of the balance platform.

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.
balancePlatformPayoutSchedulesarray[object]
Contains a list of the payout schedules configured in your balance platform.
automaticApplicationboolean
Specifies whether this payout schedule is automatically applied to new balance accounts.
balancePlatformIdstring
The balance platform to which the payout schedule applies.
countryCodestring
The two-letter ISO 3166-1 alpha-2 code of the country to which the payout schedule applies.
createdAtstring
The date when the payout schedule was created.
currencystring
The three-character ISO code of the currency used for the payout schedule.
defaultDescriptionstring
The default description for payouts initiated by this payout schedule.
defaultFrequencystring
The default frequency of payouts initiated by this payout schedule.
defaultFrequencyValueinteger
The default value for date of the month or day of the week when payouts are initiated. Allowed only if defaultFrequency is monthly or weekly.

Possible values if defaultFrequency 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 defaultFrequency is weekly: [1 - 5].
defaultReferencestring
Your internal default reference for the payout schedule.When the payout schedule is applied to a balance account, this reference is also used for that payout schedule.
defaultReferenceForBeneficiarystring
The default reference for beneficiary for payouts initiated by this payout schedule.
enabledboolean
Specifies whether the payout schedule is enabled immediately after it is created.
idstring
The unique identifier of the payout schedule for your balance platform.
maxPayoutAmountinteger
The maximum amount that can be paid out from balance accounts that use this payout schedule.

Default value: 0, which means that there is no maximum limit.
minPayoutAmountinteger
The minimum amount that can be paid out from balance accounts that use this payout schedule.

Default value: 0.
payoutScheduleDescriptionstring
The type of payout schedule. This type indicates how fast funds are paid out to your user.

Possible values:

Standard: The funds arrive in your user's transfer instrument two days after the funds are settled.

Accelerated: The funds arrive to your user's transfer instrument the day after the funds are settled.

retainedAmountinteger
The amount of funds that must remain available in a 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
updatedAtstring
The date when the payout schedule was updated.
userSettlementDelayinteger
The default settlement delay for this payout schedule.
userSettlementTimeobject
The time when the payout funds are settled in your user's transfer instrument.
hourinteger
minuteinteger
nanointeger
secondinteger
userSettlementTimeZonestring
The timezone of the userSettlementTime.
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.

Get all managed payout schedules on your balance platform

HTTP Responses

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

422 - Unprocessable Entity

500 - Internal Server Error