v1

latestOpenAPI 3.1.02026-07-26261466.6 KB

Withdrawals

Save a bank destination

Saves a bank account the user can withdraw to. ach needs routing_number, account_number, and account_type; international_wire needs iban and swift_code. Some countries need extra fields via country_specific (for example ifsc, clabe, bsb); the validation error names any missing key. A user can hold up to 25 active destinations.

post/api/v2/wallet/withdrawal-recipients

Request body

user_idstring required

The connected user's id.

type'ach' | 'international_wire' required

beneficiary_namestring required

The account holder's legal name.

country_codestring required

ISO 3166-1 alpha-2 country of the bank account.

nicknamestring

emailstring email

routing_numberstring

ACH: 9-digit ABA routing number.

account_numberstring

ACH: the account number.

account_type'checking' | 'savings'

ACH only.

ibanstring

International wire: the IBAN (spaces ok, normalized on save).

swift_codestring

International wire: the SWIFT/BIC.

bank_namestring

address_line1string

address_line2string

citystring

regionstring

postal_codestring

country_specificobject

Country-specific banking fields, e.g. {"ifsc": "..."} for India or {"clabe": "..."} for Mexico.

Response

The saved destination, masked.

object'withdrawal_recipient'

user_idstring

The connected user this destination belongs to.

idstring

Recipient id (wrec_...). Pass it as recipient_id when creating a withdrawal.

type'ach' | 'international_wire'

nicknamestring nullable

beneficiary_namestring

country_codestring

ISO 3166-1 alpha-2 country of the bank account.

currencystring nullable

bank_namestring nullable

account_number_last4string nullable

Masked, ACH only. Example: ••••6789.

routing_numberstring nullable

ACH only.

account_type'checking' | 'savings' nullable

iban_last4string nullable

Masked, international wire only.

swift_codestring nullable

International wire only.

created_atstring date-time