Skip to main content
Payouts represent money sent from an account or user balance to an external destination, such as a bank account, wallet, or other saved payout method. Use the Payouts API to create payouts from stablecoin accounts, list payout history for accounts or users, monitor payout statuses, and show expected arrival details for funds leaving Whop.

​
Endpoints

​
Attributes

​
id
string
required
Payout ID.
​
amount
number
required
The payout amount in whole currency units.
​
created_at
string
required
When the payout was created.
​
currency
string
required
Payout currency.
​
estimated_arrival
string | null
required
Estimated time the funds become available in the destination account.
​
fee_amount
number
required
The fee charged for the payout, in the payout currency.
​
object
string
required
​
payer_name
string | null
required
Name of the entity processing the payout.
​
payout_request_id
string | null
required
The ID returned by POST /payouts when this payout was requested. Match it to the settled payout in GET /payouts. Null for payouts not created by POST /payouts.
​
payout_token
object | null
required
The saved payout method used. Requires payout:destination:read; null without it.

Properties

​
nickname
string | null
required
Saved payout method nickname.
​
payout_destination
object | null
required
Payout destination display details.

Properties

​
icon_url
string | null
required
Payout destination icon URL.
​
payer_name
string | null
required
Payout destination display name.
​
speed
string
required
Payout delivery speed.Available options: standard, instant
​
status
string
required
Current payout status.Available options: requested, awaiting_payment, in_transit, completed, failed, canceled, denied
Payout