BRbridge
Developers

Configure a fee External Account

Changed on

Configure a fee External Account.

post/developer/fee_external_account

Request

  • Base URL
    https://api.bridge.xyz/v0
  • URL
    https://api.bridge.xyz/v0/developer/fee_external_account
  • Auth
    API key in header Api-Key

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")

account_owner_namestring required

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:

  • ach: ^(?!\s*$)[\x20-\x7E]*$
  • wire: ^[ \w!"#$%&'()+,\-./:;<=>?@\\_`~]*$
  • iban: ^(?![:\- ]*$)[a-zA-Z0-9\/\-?:().,'+ _]+$
created_atstring date-time

Time of creation of the External Account

updated_atstring date-time

Time of last update of the External Account

activeboolean

Whether or not this External Account is active

account_owner_type'individual' | 'business'
first_namestring

First name of the individual account holder. Required when the account_owner_type is individual

last_namestring

Last name of the individual account holder. Required when the account_owner_type is individual

business_namestring

Business name of the business account holder. Required when the account_owner_type is business

account_owner_countrystring

Three-letter alpha-3 country of residence of the account owner (ISO 3166-1).

deactivation_reason'plaid_item_error' | 'deactivated_due_to_bounceback' | 'deleted_by_developer' | 'requested_by_developer' | 'invalid_account_number' | 'invalid_bank_validation' | 'rejected_by_bank_provider'

Reason for deactivating an External Account

deactivation_detailsstring

Additional details about the deactivation when this External Account is inactive

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")

account_owner_namestring required

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:

  • ach: ^(?!\s*$)[\x20-\x7E]*$
  • wire: ^[ \w!"#$%&'()+,\-./:;<=>?@\\_`~]*$
  • iban: ^(?![:\- ]*$)[a-zA-Z0-9\/\-?:().,'+ _]+$
created_atstring date-time

Time of creation of the External Account

updated_atstring date-time

Time of last update of the External Account

activeboolean

Whether or not this External Account is active

account_owner_type'individual' | 'business'
first_namestring

First name of the individual account holder. Required when the account_owner_type is individual

last_namestring

Last name of the individual account holder. Required when the account_owner_type is individual

business_namestring

Business name of the business account holder. Required when the account_owner_type is business

account_owner_countrystring

Three-letter alpha-3 country of residence of the account owner (ISO 3166-1).

deactivation_reason'plaid_item_error' | 'deactivated_due_to_bounceback' | 'deleted_by_developer' | 'requested_by_developer' | 'invalid_account_number' | 'invalid_bank_validation' | 'rejected_by_bank_provider'

Reason for deactivating an External Account

deactivation_detailsstring

Additional details about the deactivation when this External Account is inactive

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.

Changes

  • a390532e9fc6Revision changes
    • breaking

      the ////// request property's minLength was increased from 0 to 1

    • breaking

      the ////// request property type changed from no type to string

    • breaking

      the ////// response's property type changed from no type to string for status

    • warning

      the ////// request property's maxLength was set to 256

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status