Skip to main content
GET
TypeScript

Autorisationer

Authorization
string
header
påkrævet

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:withdrawal:read

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Sti-parametre

id
string
påkrævet

Payout ID, prefixed wdrl_ for a payout returned by GET /payouts or cofr_ for the payout request returned by POST /payouts.

Forespørgselsparametre

account_id
string

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.

user_id
string

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.

Svar

payout found

created_at
string<date-time>
påkrævet

When the payout was created.

Eksempel:

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

currency
string
påkrævet

Payout currency.

Eksempel:

"usd"

destination_amount
string<decimal> | null
påkrævet

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.

Eksempel:

"461.7"

destination_currency
string | null
påkrævet

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.

Eksempel:

"eur"

estimated_arrival
string<date-time> | null
påkrævet

Estimated time the funds become available in the destination account.

Eksempel:

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

exchange_rate
number<float> | null
påkrævet

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.

Eksempel:

0.9234

failure
object | null
påkrævet

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

id
string
påkrævet

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.

Eksempel:

"wdrl_xxxxxxxxxxxxx"

net_amount
string<decimal>
påkrævet

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.

Eksempel:

"49.75"

notes
string | null
påkrævet

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

Maximum string length: 255
Eksempel:

"Detailing supplies restock"

object
enum<string>
påkrævet
Tilgængelige muligheder:
payout
Eksempel:

"payout"

payer_name
string | null
påkrævet

Name of the entity processing the payout.

Eksempel:

"ACH Bank Deposit"

payout_method
object | null
påkrævet

Payout method display details. The nickname requires payout:destination:read on the owning ledger; otherwise it is null.

payout_request_id
string | null
påkrævet

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.

Eksempel:

"cofr_xxxxxxxxxxxxx"

speed
enum<string>
påkrævet

Payout delivery speed.

Tilgængelige muligheder:
standard,
instant
Eksempel:

"standard"

status
enum<string>
påkrævet

Current payout status.

Tilgængelige muligheder:
requested,
in_review,
processing,
completed,
reversed,
canceled,
failed,
denied
Eksempel:

"in_review"

status_detail
string
påkrævet

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.

Eksempel:

"awaiting_provider_acceptance"

trace_code
string | null
påkrævet

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.

Eksempel:

"021000021234567"

amount
string<decimal>

The payout amount in whole currency units, as a decimal string. Only returned to callers with payout:withdrawal:read on the owning ledger.

Eksempel:

"500.0"

cancelable
boolean

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. Only returned to callers with payout:withdrawal:read on the owning ledger.

Eksempel:

true

conversion
object | null

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. Only returned to callers with payout:withdrawal:read on the owning ledger.

delayed
boolean

Whether an in-transit withdrawal is past its settlement window.

Eksempel:

false

estimated_arrival_end
string<date-time> | null

End of the expected bank settlement window.

Eksempel:

null

fee_amount
string<decimal>

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.

Eksempel:

"0.25"

fee_paid_by
enum<string>

Who bore the payout fee: the account itself, or its parent platform. Only returned to callers with payout:withdrawal:read on the owning ledger.

Tilgængelige muligheder:
self,
platform
Eksempel:

"self"

markup_fee
string<decimal>

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.

Eksempel:

"0.0"

metadata
object

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.

Eksempel:
recipient_name
string | null

The recipient's first name and last initial, or null when no recipient name is available.

Eksempel:

"Rishabh J."

sender_name
string | null

The sending business's display name, or a personal sender's first name and last initial.

Eksempel:

"Whop Blueprints"

source
enum<string> | null

How the payout was created. automatic means a scheduled auto-payout. null when the payout has no recorded source. Only returned to callers with payout:withdrawal:read on the owning ledger.

Tilgængelige muligheder:
api,
dashboard,
automatic,
null
Eksempel:

"api"

statement_descriptor
string | null

The payment description sent with the payout, or null if no descriptor was set. When set, 5-80 printable ASCII characters. Only returned to callers with payout:withdrawal:read on the owning ledger.

Required string length: 5 - 80
Eksempel:

"MYCOMPANY"

timeline
object[]

Completed lifecycle events in chronological order. Present once the payout has a withdrawal record.