Record External Payment

Persist a payment that was completed externally so Embarc can link it to the loan ledger.

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

The unique identifier of the loan.

Regex: ^\d+$

Example: 2201

Body Params
double
required
Defaults to 500

Amount that was settled externally.

Example: 500.00

string
required
Defaults to ACH

Method used to complete the payment (ACH, CARD, CASH, etc.).

Example: ACH

string
required
Defaults to SETTLED

Processor status to reflect (SETTLED, RETURNED, FAILED, etc.).

Example: SETTLED

date
required
Defaults to 2025-10-13

Date when the payment should impact the loan.

Example: 2025-10-13

string
Defaults to TRC-10293

Processor trace number for auditing.

Example: TRC-10293

string
Defaults to EXT-456

Caller-supplied identifier for idempotency.

Example: EXT-456

metadata
object

Additional processor metadata captured with the record.

string
Defaults to Recording ACH debit for October installment

Context about the external settlement.

Headers
string
required
Defaults to default

Tenant routing identifier for Embarc.

Example: default

Responses

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