v1

latestOpenAPI 3.0.22026-07-26128245430.3 KB
Developers

Configure a fee External Account

Configure a fee External Account.

post/developer/fee_external_account

Headers

Idempotency-Keystring required

Request body

idstring

A UUID that uniquely identifies a resource

customer_idstring

The id of the Bridge customer that this External Account belongs to

bank_namestring

Bank name of the account (e.g. "Chase")

{"stackTrail":"components:schemas:ExternalAccountUs:allOf:properties:account_owner_name","oasType":"schema","type":"unknown","description":"Owner of the account Bank Account (e.g. \"John Doe\"). For ach, wire, and iban accounts, this field must be at least 3 characters, at most 35 characters, and follow the regex pattern for the given account type:\n- ach: `^(?!\\s*$)[\\x20-\\x7E]*$`\n- wire: \n"}
account_type'us' required

Type of the bank account.

currency'usd' required

Currency associated with the bank account. Must be usd for US accounts.

beneficiary_address_validboolean

Whether the beneficiary address is valid. A valid beneficiary address is required for all US External Accounts

last_4string

Last 4 digits of the bank account number. This field is getting deprecated in favor of the account.last_4 field

account_numberstring

Account number of your bank account. This field is getting deprecated in favor of the account.account_number field for US accounts.

routing_numberstring

Routing number of your bank account. This field is getting deprecated in favor of the account.routing_number field for US accounts.

Response

External Account object created

idstring

A UUID that uniquely identifies a resource

customer_idstring

The id of the Bridge customer that this External Account belongs to

bank_namestring

Bank name of the account (e.g. "Chase")

{"stackTrail":"components:schemas:ExternalAccountUs:allOf:properties:account_owner_name","oasType":"schema","type":"unknown","description":"Owner of the account Bank Account (e.g. \"John Doe\"). For ach, wire, and iban accounts, this field must be at least 3 characters, at most 35 characters, and follow the regex pattern for the given account type:\n- ach: `^(?!\\s*$)[\\x20-\\x7E]*$`\n- wire: \n"}
account_type'us' required

Type of the bank account.

currency'usd' required

Currency associated with the bank account. Must be usd for US accounts.

beneficiary_address_validboolean

Whether the beneficiary address is valid. A valid beneficiary address is required for all US External Accounts

last_4string

Last 4 digits of the bank account number. This field is getting deprecated in favor of the account.last_4 field

account_numberstring

Account number of your bank account. This field is getting deprecated in favor of the account.account_number field for US accounts.

routing_numberstring

Routing number of your bank account. This field is getting deprecated in favor of the account.routing_number field for US accounts.