List Payout Methods
Lists the saved payout methods (bank accounts, digital wallets, crypto addresses) that an account or user can withdraw to, most recently added first. Pass exactly one of account_id (a biz_ identifier) or user_id (a user_ identifier). Pass an amount to additionally get a fee and delivery quote per method for withdrawing that amount.
Query parameters
The owning account ID (a biz_ identifier). Provide this or user_id.
The owning user ID (a user_ identifier). Provide this or account_id.
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.
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 code of the amount, for example usd. Only meaningful with amount or include_limits.
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.
When true, the response also carries limits — the live per-speed payout caps the account's payout requests are validated against, in the requested currency. Requires the payout:withdrawal:read scope.
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.
Currency the destination would deliver payouts in. Only meaningful with destination_id; required fields vary by destination currency.
Number of payout methods to return from the start of the window.
Cursor to fetch the page after (from page_info.end_cursor).
Number of payout methods to return from the end of the window.
Cursor to fetch the page before (from page_info.start_cursor).
Response
internal stablecoin destinations omitted