API Reference

Create a Counterparty Payment Instrument

post
https://embarc-api-qa.lendapi.com/embarc-core/api/v1/counterparties//payment-instruments

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
integer
required

Embarc 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. This endpoint only accepts BANK_ACCOUNT, even though the shared payment-instrument model also knows about other instrument types.

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

Account holder category. Use BUSINESS for a legal-entity-owned account and PERSONAL for an individual-owned account.

Allowed:
string
enum
required

Bank account subtype. CHECKING and SAVINGS are consumer account types. BUSINESS_CHECKING and BUSINESS_SAVINGS are business account types.

Allowed:
string
required

Raw bank account number used only at create time. The service requires 4 to 50 digits.

string
required

Nine-digit ABA routing number for the bank account.

string
length ≤ 100

Display bank name.

string
enum

Verification lifecycle state for the bank account. PENDING means not yet verified, VERIFIED means verification succeeded, FAILED means verification failed, and REVOKED means a previously usable verification was revoked. Defaults to PENDING when omitted.

Allowed:
string
enum

Initial payment-instrument status. ACTIVE makes the instrument usable immediately, and INACTIVE stores it without activating it. Defaults to INACTIVE when omitted.

Allowed:
string
length ≤ 100

External system identifier for the bank account record.

boolean
enum

Set to true to make this the counterparty's default payment instrument. When omitted, the first instrument is made default automatically.

Allowed:
accountAggregatorLink
object

Write-only account-aggregator metadata accepted during bank-account creation. It is never returned by counterparty UI responses.

Response

Updated 11 days ago

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

Updated 11 days ago

Did this page help you?