transfer_types are available for that address. Choose the right path based on the transfer rails you need.
Comparison
Which path should you use?
- Plaid-linked bank account — Use this when you need
ach_debitor want to provide a Plaid bank-linking experience for your users. This flow uses Plaid Link to securely connect a bank account and supportsach_debit,ach_credit, andrtp_credit. - Direct bank entry — Use this when you already have bank account details (account number, routing number) or need
wiretransfers. This flow supportswire,ach_credit,same_day_ach_credit, andrtp_credit.
Direct bank entry field requirements
For Direct bank entry, required fields depend on the transfer types you request.
If
transfer_types includes wire, wire requirements apply, even if the same address also includes ACH or RTP rails. For ACH/RTP-only addresses, omit bank_address and beneficiary_address unless you have accurate values—do not enter placeholder or generic bank addresses.
Plaid-linked bank account flow
This flow uses the Plaid Link SDK to securely connect a bank account in two steps:- Create a Plaid link token — Generate a
link_tokento launch Plaid Link in your front-end. - Register the account via Plaid — Exchange the
public_tokenfrom Plaid to create anaddress_id.
Direct bank entry flow
Submit bank account details directly using the Addresses API:- Create a new external address — ACH/RTP-only addresses require
owner,account_number,routing_number,account_type, andtransfer_types. Wire-capable addresses also requirebank_addressandbeneficiary_address. This path supportswire,ach_credit,same_day_ach_credit, andrtp_credit.
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" }