Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-29-1"

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.

country
string

ISO 3166-1 alpha-2 country code for the bank account or wallet, such as US. Defaults to the payout account's country.

amount
number

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

currency
string
default:usd

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

supported_payout_method_id
string

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_currency
string
default:usd

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

first
integer
default:20

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

Required range: x <= 100
after
string

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

last
integer

Number of supported 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

catalog failures degrade to no destinations

data
object[]
required
page_info
object
required