Skip to main content
POST
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

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-29-1"

Body

application/json
fields
object
required

The supported payout method's required field values, keyed by field id — list them with GET /payouts/supported_methods?supported_payout_method_id=.... A Basis Theory token id may be passed in place of a raw value. A validation failure returns the method's full required_fields schema alongside the error.

nickname
string
required

A label for the payout method, unique per destination.

supported_payout_method_id
string
required

The supported payout method to save (a podst_ identifier from a previous listing).

account_id
string

The account to add the payout method for (a biz_ identifier). Provide this or user_id.

destination_currency
string
default:usd

Currency the supported payout method delivers payouts in.

is_default
boolean
default:false

Whether to make this the account's default payout method.

user_id
string

The user to add the payout method for (a user_ identifier). Provide this or account_id.

Response

a pre-tokenized Basis Theory value passes through unvaulted

account_reference
string | null
required

Masked identifier for the destination.

created_at
string<date-time>
required
destination_currency
string
required
estimated_arrival
object | null
required

Null on create. List payout methods to retrieve arrival estimates.

fee_structure
object | null
required

Null on create. List payout methods to retrieve the configured fee terms.

id
string
required

Payout method ID, usable as payout_method_id on POST /payouts.

institution_name
string | null
required
is_default
boolean
required
nickname
string | null
required
object
enum<string>
required
Available options:
payout_method
payer_name
string | null
required
quote
object | null
required

Always null on create.

status
enum<string>
required
Available options:
created,
active,
broken
supported_payout_method
object | null
required