Sign in
Payouts

List Supported Payout Methods

Lists the payout methods an account or user is eligible to add.

get/payouts/supported_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.

countrystring

ISO 3166-1 alpha-2 country code for the bank account or wallet, such as US. Defaults to the country of supported_payout_method_id when one is given, otherwise the payout account's country.

amountnumber

Optional payout amount in whole currency units, for example 250.00. When provided, each destination includes per-currency fee and delivery quotes.

currencystring

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

supported_payout_method_idstring

Narrows the list to one supported payout method (a podst_ identifier) and includes the required_fields needed to save it as a payout method.

destination_currencystring

Currency the supported payout method would deliver payouts in. Only meaningful with supported_payout_method_id; required fields vary by destination currency.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

supported payout methods listed

Example response

{
  "data": [
    {
      "delivery_type": "bank_deposit",
      "icon_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/ach-bank-deposit",
      "id": "podst_xxxxxxxxxxxxxx",
      "name": "SEPA Bank Transfer",
      "object": "supported_payout_method",
      "quotes": [
        {
          "amount": 2500,
          "currency": "usd",
          "destination_currency": "usd",
          "exchange_rate": 1,
          "instant": {
            "estimated_arrival": "2026-01-01T12:00:00.000Z",
            "fee": 12.5,
            "total_received": 2487.5
          },
          "max_limit": 50000,
          "min_limit": 10,
          "standard": {
            "estimated_arrival": "2026-01-01T12:00:00.000Z",
            "fee": 2.5,
            "total_received": 2497.5
          }
        }
      ],
      "required_fields": [
        {
          "id": "fld_bank_account_number",
          "input_type": "text",
          "label": "Account Number",
          "object": "required_field",
          "options": [
            "savings"
          ],
          "placeholder": "8825310472",
          "required": true,
          "sensitive": true,
          "type": "bank_account_number",
          "validation": "^[0-9]{4,17}$"
        }
      ],
      "supports_standard_delivery": true
    }
  ],
  "page_info": {
    "end_cursor": "MQ",
    "has_next_page": true,
    "start_cursor": "MQ"
  }
}

Changes

Changed in 3 of the 74 revisions of this API.28

  • 621705ee8f4a23See the full diff
    • ●

      added the new card enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new check enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      removed the masspay_card enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the paper_check enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the unknown enum value from the // response property for the response status

      response-property-enum-value-removed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f1020c3ecda44See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 099fdc3be4221See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.