SETSimple Easy Transactions
SET DocsAPI reference and complianceUpdated 2026-11-09
Browse: SET API (Platforms)

SET API (Platforms) · Payout controls

Cancel a waiting payout

POST/v1/payouts/{id}/cancel

Key scope: write

Stops a payout still waiting for approval or for its scheduleAt. Event payout.canceled.

Path parameters

id stringrequired
The payout's id.

Headers

Idempotency-Key string
Optional. The same key and body run once; a replay answers with Idempotent-Replayed: true. Kept 24 hours.

Errors

  • 404 payout_unknown
  • 409 payout_not_waiting
  • 409 payout_moved
  • 401 api_key_required
  • 401 api_key_invalid
  • 401 api_key_wrong_mode
  • 403 scope_missing
  • 429 rate_limited

All codes: Errors.