Sign in

v9

OpenAPI 3.1.02026-08-043703845.2 MB
Payouts

List Saved Payout Methods

Lists the bank accounts, wallets, and crypto addresses an account or user can withdraw to, newest first.

get/payouts/methods

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.

status'created' | 'active' | 'broken'

Optional status filter. created means saved but unused, active means a payout through it succeeded, broken means the last payout failed and the method needs fixing.

amountnumber

Optional withdrawal amount in whole currency units, for example 250.00. When provided, each method includes a quote with the estimated fee, amount received, and delivery date for that amount.

currencystring

Currency code of the amount, for example usd. Only meaningful with amount or include_limits.

include_limitsboolean

When true, the response also carries limits — the live per-speed payout caps the account's payout requests are validated against, in the requested currency. Requires the payout:withdrawal:read scope.

firstinteger

Number of payout methods to return from the start of the window.

afterstring

Cursor to fetch the page after (from page_info.end_cursor).

lastinteger

Number of payout methods to return from the end of the window.

beforestring

Cursor to fetch the page before (from page_info.start_cursor).

Response

internal stablecoin destinations omitted

Example response

{
  "data": [
    {
      "account_reference": "••••6789",
      "created_at": "2026-06-15T09:00:00.000Z",
      "destination_currency": "usd",
      "estimated_arrival": {
        "instant": "2026-07-30T12:30:00.000Z",
        "standard": "2026-08-03T00:00:00.000Z"
      },
      "fee_structure": {
        "currency": "usd",
        "fixed_amount": 0.25
      },
      "id": "pyot_xxxxxxxxxxxxx",
      "institution_name": "Chase",
      "is_default": true,
      "nickname": "Business checking",
      "payer_name": "ACH Bank Deposit",
      "quote": {
        "amount": 500,
        "currency": "usd",
        "exchange_rate": 1,
        "instant": {
          "fee": 5.25,
          "total_received": 494.75
        },
        "max_limit": 25000,
        "min_limit": 1,
        "standard": {
          "fee": 0.25,
          "total_received": 499.75
        }
      },
      "supported_payout_method": {
        "delivery_type": "bank_deposit",
        "icon_url": "https://cdn.whop.com/payouts/ach.png",
        "name": "ACH Bank Deposit",
        "supports_standard_delivery": true
      }
    }
  ]
}