Sign in

v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB
Funding Wallets

Create a recipient bank

Creates a new recipient bank. Returns the new recipient bank entity on success. entity.

post/v1beta/accounts/{account_id}/funding_wallet/recipient_bank

Path parameters

account_idstring required

UUID alpaca account ID

Request body

account_numberstring required

Bank account number.

account_type'checking' | 'savings'

Bank account type.

bank_account_holder_namestring

Bank account holder's name.

bank_countrystring required

Two-letter code for the country in which the beneficiary's bank account is held.

bank_namestring required
bic_swiftstring

BIC/SWIFT code

citystring required

City

currencystring required

Currency in which money is held in the beneficiary's bank account. ISO-3 currency code.

ibanstring

IBAN code

postal_codestring

Postal code

routing_codestring

Routing code for routing_code_type. If supplied, routing_code_type should also be supplied.

routing_code_type'sort_code' | 'aba' | 'bsb_code' | 'institution_no' | 'bank_code' | 'branch_code' | 'clabe' | 'cnaps' | 'ifsc'

Local payment routing system. If supplied, routing_code should also be supplied.

state_or_provincestring

State or province.

street_addressstring required

First line of address.

Response

Success.

account_numberstring

Bank account number.

bic_swiftstring

BIC/SWIFT code

citystring

City

company_namestring
countrystring

Two-letter ISO country code.

created_atstring date-time

Date the beneficiary record was created.

currencystring

Currency in which money is held in the beneficiary's bank account. Three-digit currency code.

first_namestring
ibanstring

IBAN code

idstring uuid
last_namestring
payment_typesFundingDetailPaymentType[]
postal_codestring

Postal code

routing_codestring

Value for "routing_code_type".

routing_code_typestring

Local payment routing system.

state_or_provincestring

State or province.

street_addressstring
updated_atstring date-time

Date the beneficiary record was last updated.