View executions of a managed payout schedule

get/balanceAccounts/{balanceAccountId}/payoutSchedules/{id}/executions

View information about the executions of a managed payout schedule on the specified balance account. An execution is an attempt to make a payout according to the payout schedule.

Endpoint destination URL

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

Query Parameters

Required

Optional

Minimum: 1Maximum: 100

The page number to be returned.

Default: 1

Minimum: 10

The number of items returned per page.

Default: 10

Contains a list of payout statuses. If included, the response returns only executed payouts that currently have one of the specified statuses.

Possible statuses:

succeeded: The payout was sent successfully.
failed: The payout was not sent due to an error.
skipped: The payout was not triggered as expected.

Path Parameters

Required

Optional

The unique identifier of the payout schedule on the balance account.

The unique identifier of the balance account.

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.
payoutScheduleExecutionsarray[object]
Contains a list of executions of the payout schedule.
idstring
The unique identifier of the payout execution.
resultstring
The status of the payout execution.

Possible values:

succeeded: The payout was sent successfully.

failed: The payout could not be sent because an error occurred.

skipped: The payout was not triggered as expected.

resultDetailsobject
Contains information about the result of the payout execution.
reasonstring
Human readable reason for why execution was not successful if applicable.
reasonCodestring
Reason Code for why execution was not successful if applicable.
transferIdstring
The id of the transfer from executing the payout.
triggeredAtstring
The date and time when the payout execution was initiated.
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.

View executions of a managed payout schedule

HTTP Responses

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

422 - Unprocessable Entity

500 - Internal Server Error