Skip to main content
GET
/
payouts
/
methods
List Payout Methods
curl --request GET \
  --url https://{defaultHost}/payouts/methods \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "object": "payout_method",
      "id": "<string>",
      "is_default": true,
      "nickname": "<string>",
      "account_reference": "<string>",
      "institution_name": "<string>",
      "payer_name": "<string>",
      "destination_currency": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "payout_destination": {
        "name": "<string>",
        "icon_url": "<string>",
        "delivery_type": "<string>",
        "supports_standard_delivery": true,
        "supports_instant_delivery": true
      },
      "quote": {
        "amount": 123,
        "currency": "<string>",
        "exchange_rate": 123,
        "min_limit": 123,
        "max_limit": 123,
        "standard": {
          "fee": 123,
          "total_received": 123,
          "estimated_arrival": "2023-11-07T05:31:56Z"
        },
        "instant": {
          "fee": 123,
          "total_received": 123,
          "estimated_arrival": "2023-11-07T05:31:56Z"
        }
      }
    }
  ],
  "page_info": {
    "has_next_page": true,
    "end_cursor": "<string>",
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

An account API key, account scoped JWT, app API key, or user OAuth token.

Headers

​
Api-Version-Date
string<date>

Pins the request to a dated API version.

Example:

"2026-07-01"

Query Parameters

​
account_id
string

The owning account ID (a biz_ identifier). Provide this or user_id.

​
user_id
string

The owning user ID (a user_ identifier). Provide this or account_id.

​
status
enum<string>

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.

Available options:
created,
active,
broken
​
amount
number

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.

​
currency
string
default:usd

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

​
first
integer
default:20

Number of payout methods to return from the start of the window. Capped at 25 when an amount is provided.

Required range: x <= 100
​
after
string

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

​
last
integer

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

Required range: x <= 100
​
before
string

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

Response

internal stablecoin destinations omitted

​
data
object[]
required
​
page_info
object
required