Retrieve Payout
Fetches one payout by its wdrl_ ID, or by the cofr_ conversion request ID a stablecoin payout carries as payout_request_id — both ids answer with the same payout object. Authentication is optional. Anyone with the ID can view payout tracking details, including notes, trace code, exchange rate, and payout request ID. Accounting fields require payout:withdrawal:read on the owning ledger. A supplied invalid credential returns 401.
Authorizations
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.
Headers
Pins the request to a dated API version.
"2026-10-09-2"
Path Parameters
Payout ID, prefixed wdrl_ for a payout returned by GET /payouts or cofr_ for the payout request returned by POST /payouts.
Query Parameters
Optional owning account ID, prefixed biz_. The payout ID identifies its ledger. If supplied, this must match the owner and cannot be combined with user_id.
Optional owning user ID, prefixed user_. The payout ID identifies its ledger. If supplied, this must match the owner and cannot be combined with account_id.
Response
payout found
When the payout was created.
"2026-07-29T18:22:00.000Z"
Payout currency.
"usd"
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.
"461.7"
Currency the funds are delivered in, taken from the payout method when the payout is created. On a stablecoin payout 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.
"eur"
Estimated time the funds become available in the destination account.
"2026-08-03T00:00:00.000Z"
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.
0.9234
Why the payout ended without paying, or why it reversed after settlement. Present on failed, canceled, denied, and reversed payouts; null otherwise.
Payout ID, prefixed wdrl_ for a payout returned by GET /payouts or cofr_ for a payout request returned by POST /payouts.
"wdrl_xxxxxxxxxxxxx"
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 stablecoin payout 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.
"49.75"
Free-form notes attached by the payout creator, or null when none were provided. Maximum 255 characters.
255"Detailing supplies restock"
payout "payout"
Name of the entity processing the payout.
"ACH Bank Deposit"
Payout method display details. The nickname requires payout:destination:read on the owning ledger; otherwise it is null.
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.
"cofr_xxxxxxxxxxxxx"
Payout delivery speed.
standard, instant "standard"
Current payout status.
requested, in_review, processing, completed, reversed, canceled, failed, denied "in_review"
The finest machine phase under status — for example awaiting_provider_acceptance vs in_transit under processing, or the stablecoin conversion phase under requested. Informational vocabulary: values can be added without a version bump; status is the versioned contract.
"awaiting_provider_acceptance"
ACH trace number the recipient's bank can use to locate this payout. Assigned when the payout is submitted to the bank, so it is null before then and on payouts not sent over ACH.
"021000021234567"
The payout amount in whole currency units, as a decimal string. Only returned to callers with payout:withdrawal:read on the owning ledger.
"500.0"
Whether an in-transit withdrawal is past its settlement window.
false
End of the expected bank settlement window.
null
The fee charged for the payout, in the payout currency, as a decimal string. Only returned to callers with payout:withdrawal:read on the owning ledger.
"0.25"
Who bore the payout fee: the account itself, or its parent platform. Only returned to callers with payout:withdrawal:read on the owning ledger.
self, platform "self"
Whop's markup on the provider fee, in the payout currency, as a decimal string. "0.0" when none applies. Only returned to callers with payout:withdrawal:read on the owning ledger.
"0.0"
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. Only returned to callers with payout:withdrawal:read on the owning ledger.
The recipient's first name and last initial, or null when no recipient name is available.
"Rishabh J."
The sending business's display name, or a personal sender's first name and last initial.
"Whop Blueprints"
How the payout was created. automatic means a scheduled auto-payout; null on payouts created before source tracking or through internal tooling. Only returned to callers with payout:withdrawal:read on the owning ledger.
api, dashboard, automatic, null "api"
Text that appears on the recipient's bank statement, or null if no descriptor was set. When set, 5-22 alphanumeric characters (A-Z, a-z, 0-9). Only returned to callers with payout:withdrawal:read on the owning ledger.
5 - 22"MYCOMPANY"
Completed lifecycle events in chronological order. Present once the payout has a withdrawal record.

