ADadyen
Custom payout schedules (sweeps)

View executions of a custom payout schedule

Changed on

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.

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

Request

  • Base URL
    https://balanceplatform-api-test.adyen.com/bcl/v2
  • URL
    https://balanceplatform-api-test.adyen.com/bcl/v2/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}/executions
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

balanceAccountIdstring required

The unique identifier of the balance account.

sweepIdstring required

The unique identifier of the sweep configuration.

Query parameters

resultsstring

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.
limitinteger

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

cursorstring

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

Response

OK - The request has succeeded.

Changes