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

SET API (Platforms) · Payout controls

Approve a payout

POST/v1/payouts/{id}/approve

Key scope: read

Approves a payout waiting for approval (pending_approval). Needs a key with the approve scope, other than the key that asked. A payout due now is checked against the wallet's balance and sent; one with a later scheduleAt waits for its time.

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.

Notes

  • approve is a third key scope beside read and write. SET issues approver keys; POST /v1/api_keys passes the scope on only from a key that has it. An approver key with read approve cannot make payouts.
  • Event payout.approved, then the payout's own events. SET's operator cannot approve.

Errors

  • 403 scope_missing
  • 403 operator_cannot_approve
  • 404 payout_unknown
  • 409 payout_not_pending_approval
  • 409 approver_is_requester
  • 409 balance_too_low
  • 409 payout_moved
  • 502 payout_refused
  • 401 api_key_required
  • 401 api_key_invalid
  • 401 api_key_wrong_mode
  • 403 scope_missing
  • 429 rate_limited

All codes: Errors.