Payout Runs
Cancel a payout run
Skip every row that has not started. A row whose payment has already started still settles, and its transaction is still reported on the run.
POST
Cancel a payout run
Authorizations
API token authentication using format <api token id>:<api client secret>
Path Parameters
System-generated unique payout run identifier
Response
The cancelled run
System-generated unique payout run identifier
Example:
"PayoutRun:019542f5-b3e7-1d02-0000-000000000001"
Status of a payout run.
Available options:
VALIDATING, SCHEDULED, PROCESSING, COMPLETED, PARTIALLY_FAILED, FAILED, CANCELLED Example:
false
Example:
"2026-11-04T22:00:00Z"
Example:
"2026-11-05T02:14:00Z"
When the run starts paying rows, if it was scheduled.
Example:
"2026-11-05T02:00:00Z"
When the run reached COMPLETED, PARTIALLY_FAILED, FAILED or CANCELLED.
Example:
"2026-11-05T02:14:00Z"