Sign in
Payouts

Create Payout Method

Saves a new payout method for an account or user by submitting the destination's required fields, keyed by field id (list them with GET /payouts/methods?destination_id=...). Sensitive values are vaulted in transit and never stored raw; a Basis Theory token id may be passed in place of a raw value. The created method is immediately usable as payout_method_id on POST /payouts. A field validation failure returns the destination's full required_fields schema alongside the error.

post/payouts/methods

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

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

Request body

account_idstring

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

destination_currencystring

Currency the destination delivers payouts in.

destination_idstring required

The payout destination to add (a pd_ identifier from a previous listing).

fieldsobject required

The destination's required field values, keyed by field id.

is_defaultboolean

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

nicknamestring required

A label for the payout method, unique per destination.

user_idstring

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_referencestring nullable required

Masked identifier for the destination.

created_atstring date-time required
destination_currencystring required
idstring required

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

institution_namestring nullable required
is_defaultboolean required
nicknamestring nullable required
object'payout_method' required
payer_namestring nullable required
quoteobject nullable required

Always null on create.

status'created' | 'active' | 'broken' required

Changes