Create a Counterparty Payment Instrument

Create a bank-account payment instrument for the counterparty.

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

Counterparty identifier.

Body Params

Bank-account payment-instrument payload for the counterparty.

Request payload used to create a counterparty-owned bank account payment instrument.

string
enum
required

Instrument type. Counterparty-owned instruments are bank accounts only.

Allowed:
string
length ≤ 50

Friendly display name for the payment instrument.

string
required
length between 2 and 100

Account holder name printed on the bank account.

string
enum
required

Whether the account is owned by a business or a person.

Allowed:
string
enum
required

Bank account type.

Allowed:
string
required

Raw account number used only at create time.

string
required

Nine-digit routing number for the bank account.

string
length ≤ 100

Display bank name.

string
enum

Verification state to persist for the bank account.

Allowed:
string
enum

Initial payment-instrument status.

Allowed:
string
length ≤ 100

External system identifier for the bank account record.

accountAggregatorLink
object
Response

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