v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-3196247792.5 KB
Managed payout schedules

View executions of a managed payout schedule

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

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

resultsExecutionResult[]

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