Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.brale.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Brale supports two paths for creating an external off-chain bank address, each unlocking different transfer types. When you create an external bank address, the path you choose determines which transfer_types are available for that address. Choose the right path based on the transfer rails you need.

​
Comparison

CapabilityPlaid-linked bank accountDirect bank entry
ach_debitSupportedNot supported
ach_creditSupportedSupported
rtpSupportedSupported
wireNot supportedSupported
ACH debit is only available through the Plaid-linked bank account flow. You cannot enable ach_debit via Direct bank entry.
Wire is only available through the Direct bank entry flow. You cannot enable wire via the Plaid-linked bank account flow.

​
Which path should you use?

  • Plaid-linked bank account — Use this when you need ach_debit or want to provide a Plaid bank-linking experience for your users. This flow uses Plaid Link to securely connect a bank account and supports ach_debit, ach_credit, and rtp.
  • Direct bank entry — Use this when you already have bank account details (account number, routing number) or need wire transfers. This flow supports wire, ach_credit, and rtp.

​
Plaid-linked bank account flow

This flow uses the Plaid Link SDK to securely connect a bank account in two steps:
  1. Create a Plaid link token — Generate a link_token to launch Plaid Link in your front-end.
  2. Register the account via Plaid — Exchange the public_token from Plaid to create an address_id.
For a full walkthrough, see Key Concepts → Addresses → Create addresses through Plaid.

​
Direct bank entry flow

Submit bank account details directly using the Addresses API:
  • Create a new external address — Provide account number, routing number, and bank details to create an address_id supporting wire, ach_credit, and rtp.
For examples, see Key Concepts → Addresses → Create via Direct bank entry.

​
Archive and unarchive

If you need to stop using a previously linked external bank address without deleting the record, use the PATCH address endpoint to archive it. If the customer later wants to restore the same external address, unarchive it.
  • Archive: PATCH /accounts/{account_id}/addresses/{address_id} with { "status": "archived" }
  • Unarchive: PATCH /accounts/{account_id}/addresses/{address_id} with { "status": "active" }
Archive and unarchive apply only to external addresses. See Address lifecycle for details.