latestOpenAPI 3.1.02026-08-213914255.9 MB
715c4defcbbf
Payouts
List Payouts
Lists an account's or user's payouts, newest first.
get/payouts
Query parameters
account_idstring
The owning account ID (a biz_ identifier). Provide this or user_id.
user_idstring
The owning user ID (a user_ identifier). Provide this or account_id.
currencystring
Optional currency code filter, for example usd.
firstinteger
Number of payouts to return from the start of the window.
afterstring
Cursor to fetch the page after (from page_info.end_cursor).
lastinteger
Number of payouts to return from the end of the window.
beforestring
Cursor to fetch the page before (from page_info.start_cursor).
Response
payout method nulled without the destination-read scope
Example response
{
"data": [
{
"amount": "500.0",
"created_at": "2026-07-29T18:22:00.000Z",
"currency": "usd",
"destination_amount": "461.7",
"destination_currency": "eur",
"estimated_arrival": "2026-08-03T00:00:00.000Z",
"exchange_rate": 0.9234,
"failure": {
"code": "beneficiary_name_mismatch"
},
"fee_amount": "0.25",
"fee_paid_by": "self",
"id": "wdrl_xxxxxxxxxxxxx",
"markup_fee": "0.0",
"metadata": {
"batch_id": "2026-08-18"
},
"net_amount": "49.75",
"notes": "Detailing supplies restock",
"object": "payout",
"payer_name": "ACH Bank Deposit",
"payout_method": {
"nickname": "Business checking",
"supported_payout_method": {
"delivery_type": "bank_deposit",
"icon_url": "https://cdn.whop.com/payouts/ach.png",
"payer_name": "ACH Bank Deposit"
}
},
"payout_request_id": "cofr_xxxxxxxxxxxxx",
"source": "api",
"speed": "standard",
"status": "in_review",
"status_detail": "awaiting_provider_acceptance",
"trace_code": "021000021234567"
}
],
"page_info": {
"end_cursor": "WyJjdXJzb3IiLDFd",
"has_next_page": true,
"start_cursor": "WyJjdXJzb3IiLDFd"
}
}