Skip to main content
POST
Cancel Payout

Autorisations

Authorization
string
header
requis

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

payout:withdraw_funds

En-têtes

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Exemple:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

Payout ID, prefixed wdrl_, or the cofr_ payout request ID returned by POST /payouts — both cancel the same payout.

Paramètres de requête

account_id
string

Owning account ID, prefixed biz_. Provide exactly one of account_id or user_id.

user_id
string

Owning user ID, prefixed user_. Provide exactly one of account_id or user_id.

Réponse

payout canceled and funds returned

amount
string<decimal>
requis

The payout amount in whole currency units, as a decimal string.

Exemple:

"500.0"

cancelable
boolean
requis

Whether POST /payouts/{id}/cancel would act on this payout right now: true while it is in_review, while it is processing with nothing yet submitted to the payout provider, or while a submitted payout can still be asked to cancel at the provider. false once the money has arrived or the payout has already ended.

Exemple:

false

conversion
object | null
requis

How the balance was converted into the payout currency before the payout was sent. null when the payout was sent from a balance in its own currency.

created_at
string<date-time>
requis

When the payout was created.

Exemple:

"2026-07-29T18:22:00.000Z"

currency
string
requis

Payout currency.

Exemple:

"usd"

destination_amount
string<decimal> | null
requis

The amount delivered in the destination currency, as a decimal string. Assigned when the payout is processed, so it is null before then and on payouts without a recorded conversion.

Exemple:

"461.7"

destination_currency
string | null
requis

Currency the funds are delivered in, taken from the payout method when the payout is created. On a payout funded by a conversion request it follows the settlement payout minted alongside it — the GET /payouts row carrying this payout's id as payout_request_id — and is null only when no settlement payout exists.

Exemple:

"eur"

estimated_arrival
string<date-time> | null
requis

Estimated time the funds become available in the destination account.

Exemple:

"2026-08-03T00:00:00.000Z"

exchange_rate
number<float> | null
requis

Exchange rate from the payout currency to the destination currency. Assigned when the payout is processed, so it is null before then and on payouts without a recorded rate.

Exemple:

0.9234

failure
object | null
requis

Why the payout ended without paying, or why it reversed after settlement. Present on failed, canceled, denied, and reversed payouts; null otherwise.

fee_amount
string<decimal>
requis

The fee charged for the payout, in the payout currency, as a decimal string.

Exemple:

"0.25"

fee_paid_by
enum<string>
requis

Who bore the payout fee: the account itself, or its parent platform.

Options disponibles:
self,
platform
Exemple:

"self"

id
string
requis

Payout ID, prefixed wdrl_ for a payout returned by GET /payouts, cofr_ for a payout request returned by POST /payouts, or pay_ for a payout funded by a card payment that has not been submitted yet.

Exemple:

"wdrl_xxxxxxxxxxxxx"

markup_fee
string<decimal>
requis

Whop's markup on the provider fee, in the payout currency, as a decimal string. "0.0" when none applies.

Exemple:

"0.0"

metadata
object
requis

Key-value data attached at creation and echoed on every read. At most 50 keys, key names up to 40 characters, string values up to 500 characters.

Exemple:
net_amount
string<decimal>
requis

The planned net for the destination, in the payout currency: amount minus fee_amount minus markup_fee when fee_paid_by is self; equal to amount when the platform covers the fees. A payout that ends denied, canceled, or failed delivered nothing — most keep the planned figure and failure says where the funds are, but a canceled payout funded by a conversion request can report the settled outcome instead: amount carries what stayed in the balance, fees are zero because none were charged, and net_amount is 0 because nothing was delivered.

Exemple:

"49.75"

notes
string | null
requis

Free-form notes attached by the payout creator, or null when none were provided. Maximum 255 characters.

Maximum string length: 255
Exemple:

"Detailing supplies restock"

object
enum<string>
requis
Options disponibles:
payout
Exemple:

"payout"

payer_name
string | null
requis

Name of the entity processing the payout.

Exemple:

"ACH Bank Deposit"

payout_method
object | null
requis

The saved payout method used. Requires payout:destination:read; null without it.

payout_request_id
string | null
requis

Payout request ID, prefixed cofr_, returned by POST /payouts. For a request retrieved by its own cofr_ ID, this equals id. Returns null for payouts not created by POST /payouts.

Exemple:

"cofr_xxxxxxxxxxxxx"

source
enum<string> | null
requis

How the payout was created. automatic means a scheduled auto-payout. null when the payout has no recorded source.

Options disponibles:
api,
dashboard,
automatic,
null
Exemple:

"api"

speed
enum<string>
requis

Payout delivery speed.

Options disponibles:
standard,
instant
Exemple:

"standard"

statement_descriptor
string | null
requis

The payment description sent with the payout, or null if no descriptor was set. When set, 5-80 printable ASCII characters.

Required string length: 5 - 80
Exemple:

"MYCOMPANY"

status
enum<string>
requis

Current payout status.

Options disponibles:
requested,
in_review,
processing,
completed,
reversed,
canceled,
failed,
denied
Exemple:

"canceled"

status_detail
string
requis

The finest machine phase under status — for example awaiting_provider_acceptance vs in_transit under processing, or the conversion phase under requested. Informational vocabulary: values can be added without a version bump; status is the versioned contract.

Exemple:

"awaiting_provider_acceptance"

trace_code
string | null
requis

Payment network reference for this payout, such as an ACH trace number, an RTP or FedNow end-to-end ID, a wire IMAD, or a SWIFT UETR. null until the reference is available, and on payouts that have none.

Exemple:

"021000021234567"