BRbrale
Financial Institutions

Create External financial institution

Changed on

Creates a record of an external financial institution that can be used to receive funds.

post/accounts/{account_id}/financial-institutions/external

Request

  • Base URL
    https://api.brale.xyz
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.brale.xyz/oauth2/token scopes: financial-institutions:write

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

Request body

account_holder_type'individual' | 'business'

Whether the bank account belongs to an individual or a business. Decides the ACH SEC code: PPD for an individual, CCD for a business.

account_numberstring required
account_typestring required
date_of_birthstring

Date of birth of an individual recipient (format: YYYY-MM-DD). Cannot be sent when account_holder_type is business. Not supported on POST /accounts/{account_id}/financial-institutions/external.

namestring
ownerstring required
ownership'self-owned' | 'customer-owned'

Ownership type of the financial institution

routing_numberstring required
transfer_typesstring[] required

Transfer types to support for this financial institution. When wire is included, bank_address and beneficiary_address are required. fednow_credit is available only to accounts it has been enabled for.

Example request

{
  "account_holder_type": "business",
  "account_number": "123456789",
  "account_type": "checking",
  "bank_address": {
    "city": "Springfield",
    "country": "US",
    "street_line_1": "100 Example St.",
    "street_line_2": "Suite 500",
    "zip": "90001"
  },
  "beneficiary_address": {
    "city": "Springfield",
    "country": "US",
    "street_line_1": "100 Example St.",
    "street_line_2": "Suite 500",
    "zip": "90001"
  },
  "date_of_birth": "1990-01-31",
  "name": "First Last Bank",
  "owner": "Jane Doe",
  "ownership": "customer-owned",
  "routing_number": "123456789",
  "transfer_types": [
    "ach_credit",
    "wire"
  ]
}

Response

OK

account_holder_type'individual' | 'business' nullable

Whether the bank account belongs to an individual or a business. Null when not provided.

account_numberstring nullable

Masked account number showing only last 4 digits for security (format: ****1234). Full number never returned.

account_type'checking' | 'savings' nullable
createdstring date-time required

ISO-8601 timestamp that includes date and time

date_of_birthstring nullable

Masked date of birth of the recipient showing only the year (format: YYYY--). Full date never returned. Null when not provided.

idstring required

ID of the resource

last_updatedstring date_time

Last update timestamp

namestring nullable required
needs_updateboolean

Whether this FI needs Plaid reauthorization

ownerstring nullable

Beneficiary name for wire transfers (maps from POST request owner field)

ownership'self-owned' | 'customer-owned'

Ownership type of the financial institution

routingNumberstring required
status'active' | 'archived' required
transfer_typesstring[] nullable

Example response

{
  "account_holder_type": "business",
  "account_number": "****1234",
  "account_type": "checking",
  "bank_address": {
    "city": "Springfield",
    "country": "US",
    "street_line_1": "100 Example St.",
    "street_line_2": "Suite 500",
    "zip": "90001"
  },
  "beneficiary_address": {
    "city": "Springfield",
    "country": "US",
    "street_line_1": "100 Example St.",
    "street_line_2": "Suite 500",
    "zip": "90001"
  },
  "created": "2020-01-01T12:00:00Z",
  "date_of_birth": "1990-**-**",
  "id": "2VZvtmVc2j3gQ80CTlcuQXbGrwC",
  "last_updated": "2024-01-15T10:30:00Z",
  "name": "First Last Bank",
  "owner": "Jane Doe",
  "ownership": "customer-owned",
  "routingNumber": "123456789",
  "transfer_types": [
    "ach_debit"
  ]
}

Changes

  • 3378b8f911e0Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 5648b7f3a014Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status