v9

OpenAPI 3.1.02026-08-043703845.2 MB
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,
      "created_at": "2026-07-29T18:22:00.000Z",
      "currency": "usd",
      "estimated_arrival": "2026-08-03T00:00:00.000Z",
      "fee_amount": 0.25,
      "id": "wdrl_xxxxxxxxxxxxx",
      "payer_name": "ACH Bank Deposit",
      "payout_method": {
        "nickname": "Business checking",
        "supported_payout_method": {
          "icon_url": "https://cdn.whop.com/payouts/ach.png",
          "payer_name": "ACH Bank Deposit"
        }
      },
      "payout_request_id": "pyrq_xxxxxxxxxxxxx"
    }
  ]
}