Skip to main content
GET
TypeScript

Autorizaciones

Authorization
string
header
requerido

An Account API key, an App API key, an account access token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

payout:destination:read

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de consulta

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 country of supported_payout_method_id when one is given, otherwise the payout account's country.

amount
number

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

currency
string
predeterminado: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
predeterminado:usd

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

party_type
enum<string>
predeterminado:first_party

Who will own the payout method. first_party is the account itself. third_party is a recipient the account pays, saved with recipient on POST /payouts/methods, which needs no identity fields. Only meaningful with supported_payout_method_id.

Opciones disponibles:
first_party,
third_party
include_individual_banks
boolean
predeterminado:false

Whether to list each bank as its own payout method in countries where people choose a bank by name. Each bank has parent_id set to the bank deposit method that lists it. When false, these countries list one bank deposit method instead.

first
integer
predeterminado:20

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

Rango requerido: x <= 100
after
string

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

last
integer

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

Rango requerido: x <= 100
before
string

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

Respuesta

supported payout methods listed

data
object[]
requerido
page_info
object
requerido