Register a destination instrument (RTP bank)

Register a payee's bank account once and get back an instrument_id to use on every payout.

Send the routing and account number in this call only. Every POST /v1/payouts then references the instrument_id, so the raw account number is never sent again.

The account number is encrypted at rest and only its last4 is ever returned. The routing number is public bank data and is returned in full.

Only bank_account instruments (for RTP) are supported today. Card instruments (for OCT) are not available yet.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Recipient id.

Body Params
string
enum

Optional; defaults to bank_account.

Allowed:
string
required
length ≤ 140
string
enum
required
Allowed:
string
required

9-digit ABA routing number (Mod-10 checksum enforced).

string
required

4–17 digits. Stored encrypted; never returned.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json