View executions of a custom payout schedule

get/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}/executions

Returns a paginated list of executions of a custom payout schedule on a balance account. You can use query parameters to filter the executions that are returned in the list.

Endpoint destination URL

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

Query Parameters

Required

Optional

The cursor from the next or previous pagination link in the previous response.

Minimum: 10

The number of items returned per page. By default, the response returns 10 items per page.

Contains a comma-separated list of sweep execution results. If included, the response returns only sweep executions with the specified results.

Possible results:

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

Path Parameters

Required

Optional

The unique identifier of the sweep configuration.

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.
linkobject
Contains links to the next and previous page whenever applicable.
firstobject
The link to the first page of the list.
hrefstring
lastobject
The link to the last page of the list.
hrefstring
nextobject
The link to the next page of the list.
hrefstring
previousobject
The link to the previous page of the list.
hrefstring
selfobject
The link to the list page you are currently viewing.
hrefstring
sweepExecutionsarray[object]
Contains a list of executions of the sweep configuration.
idstring
The unique identifier of the sweep execution.
resultstring
The outcome of the sweep execution.

Possible results:

succeeded: The sweep payout was completed successfully.

failed: The sweep payout was not completed due to an error.

skipped: The sweep payout was not triggered as expected.

resultDetailsobject
Details about the outcome of the sweep execution.
reasonstring
The human-readable reason for why the sweep execution was not successful, if applicable.
reasonCodestring
The reason code for why the sweep execution was not successful, if applicable.
sweepConfigurationDisabledboolean
Indicates whether the sweep configuration was disabled.
transferIdstring
The unique identifier of the transfer created by the sweep execution, if applicable.
triggeredAtstring
The timestamp of when the execution was triggered.
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.
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 custom payout schedule

HTTP Responses

200 - OK

401 - Unauthorized

404 - Not Found

422 - Unprocessable Entity

500 - Internal Server Error