API Reference

Create Payment Instrument

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

Create a new bank account or card instrument for the client.

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

The unique identifier of the client.

Regex: ^\d+$

Example: 1

Body Params
string
enum
required
Defaults to BANK_ACCOUNT

Specifies the instrument type; must be BANK_ACCOUNT for this shape.

Allowed:
string
required
Defaults to Payroll Account

Friendly display name for the instrument.

string
enum
required
Defaults to INACTIVE

Initial activation status for the bank account.

Allowed:
string
required
Defaults to Maya Patel

Name of the individual or business that owns the account.

string
enum
required
Defaults to PERSONAL

Indicates whether the owner is PERSONAL or BUSINESS.

Allowed:
string
enum
required
Defaults to CHECKING

Bank account subtype such as CHECKING or SAVINGS.

Allowed:
string
required
Defaults to 123456789

Full account number collected during onboarding.

string
required
Defaults to 111000025

ABA routing number paired with the account.

string
Defaults to Cedar Ridge Bank

Name of the financial institution.

string
Defaults to PENDING

Latest verification state recorded for the account.

string
Defaults to PLAID-EXT-987

External reference such as a Plaid identifier.

accountAggregatorLink
object

Optional metadata for Plaid or MX-linked accounts.

Headers
string
required
Defaults to default

Tenant routing identifier for Embarc.

Example: default

Response

Updated 7 months ago

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

Updated 7 months ago

Did this page help you?