Vault a bank-account instrument

Save a bank account as a payment instrument, so you can use it for ACH payments.

Use one of two modes:

  • Direct: send the routing and account numbers. They are checked, encrypted and stored in one call.
  • Linked: send the bankAccountId of a recipient bank account that already exists.

The response returns an instrument_id, which you then pass as payment_method.instrument_id.

Authenticate with a dashboard session token or a merchant secret key (X-API-Key). A secret key acts only for its own merchant: instruments it creates belong to that merchant, and another merchant's instruments return 404. Publishable, payout_write and agent_onboarding keys are refused. Available to merchant and tenant users.

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

Direct-custody ingest: raw routing + account are validated and encrypted here; the account number is never persisted or returned in the clear (only last4).

string
enum
required

For ACH acceptance (debiting a customer), use payer.

Allowed:
uuid
required
string
required
^[0-9]{9}$

9-digit ABA routing (checksum-validated).

string
required
^[0-9]{4,17}$

4–17 digits. Plaintext in transit only; encrypted at rest, never returned.

string
enum
required
Allowed:
string
required
length ≤ 255
Responses

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