Stop a payout that has not moved yet

post

https://api.avvio.xyz/business/api/v1/payments/organizations/{orgId}/payouts/{payoutId}/cancel

Only a payout still waiting on YOUR funds can be cancelled — one created
by mistake, or for the wrong amount, before anyone sent anything.

Anything else is refused with PAYOUT_NOT_CANCELABLE. Where acceptance
IS execution the money left when the payout was created, and cancelling
on our side while the network still holds an order would let us report
canceled for something that could still settle.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orgId

string

required

length ≥ 1

The opaque organization id issued to you, normally CUID-shaped (for
example cmsx…). It is not an org_-prefixed alias. Pass it unchanged
in every organization-scoped path.

payoutId

string

required

length ≥ 1

Opaque payoutId returned by create or accept. Pass it unchanged.

Headers

Idempotency-Key

string

required

length between 1 and 255

^[A-Za-z0-9_.:-]+$

A unique value per logical operation, 1-255 chars of A-Z a-z 0-9 _ . : -.

Reuse it to retry. Same key with the same body replays the stored
response; same key with a different body is a 409, because
answering with the first call's result would hand you a receipt for a
payout you did not request. A 4xx releases the key, so you can fix the
body and reuse it.

Reuse it — do not generate one per attempt. A key minted per attempt
defeats replay entirely: every retry looks like a new request, so every
retry pays. We also watch for an identical body arriving under a
different key within 15 minutes and refuse it with
DUPLICATE_REQUEST_DETECTED.

Records are kept for 7 days. That is a retention window, not a
correctness one — there is no path where an expired key is re-executed.

Responses

200The payout, now canceled.

400This payout cannot be cancelled.

401Missing, invalid, or revoked key — or a key on a route that does not accept one.

403Valid key, wrong organization.