API Docs
API referencePayouts

Delete a payout

DELETE/api/v2/payouts/{id}

Allowed while status is created, approved, failed, or expired. A deleted payout is gone from the API: every endpoint answers 404 PAYOUT_NOT_FOUND for it, and lists do not include it. Its customId stays taken. Needs payouts:write.

Path Parameters

id*string

The payout id (payout_…) or your customId.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v2/payouts/payout_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e"
{  "object": "payout",  "id": "payout_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e",  "deleted": true}

Update a payout PATCH

Allowed while `status` is `created`. An omitted field is unchanged; `recipient` is replaced as a whole. Needs `payouts:write`.

Approve a payout POST

Moves `created` to `approved` and reserves the amount against the team balance. The body is optional. Needs `payouts:approve`, plus `payouts:write` with `andThen: "pay"`.