ADadyen
Managed payout schedules

View executions of a managed payout schedule

Changed on

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.

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

Request

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

Path parameters

balanceAccountIdstring required

The unique identifier of the balance account.

idstring required

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

Query parameters

resultsstring

Contains a comma-separated 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.

Examples: results=succeeded, results=failed,skipped

limitinteger

The number of items returned per page.

Default: 10

offsetinteger required

The page number to be returned.

Default: 1

Response

OK - The request has succeeded.

Changes

  • v289a469ab11aaRevision changes
    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security BasicAuth was added to the API

    • info

      for the query request parameter results, the type was generalized from array to string

    • info

      removed the non-success response with the status

  • v287544766dc8eRevision changes
    • info

      endpoint added