v8

latestOpenAPI 3.1.02026-08-033623795.0 MB
Payouts

List Supported Payout Methods

Lists the payout methods an account or user is eligible to add.

get/payouts/supported_methods

Query parameters

account_idstring

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

user_idstring

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

countrystring

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

amountnumber

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

currencystring

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

supported_payout_method_idstring

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_currencystring

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

firstinteger

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

afterstring

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

lastinteger

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

beforestring

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

Response

catalog failures degrade to no destinations