Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-18"

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.

include_available
boolean
default:false

When true, the response also carries available_destinations — payout rails the account could add as a new payout method, with per-currency quotes when an amount is provided.

destination_id
string

Narrows available_destinations to this one destination (a pd_ identifier from a previous listing) and includes its required_fields — the values to collect to add it as a payout method. Implies include_available.

destination_currency
string
default:usd

Currency the destination would deliver payouts in. Only meaningful with destination_id; required fields vary by destination currency.

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
available_destinations
object[]

Payout rails the account could add as a new payout method. Only present when include_available is true; empty when the account has no payout setup yet.