API Reference

Create an Embarc Loan

post
https://embarc-api-qa.lendapi.com/embarc-core/api/v1/embarc/loans

Create a loan from a simplified Embarc payload while normalizing the request into the full core loan-create contract, optionally insert multiple loan-owned form datatable rows, then optionally continue into approval or funding through loanAction.

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

Simplified Embarc loan-origination payload. Unsupported parameters are rejected, loanTermFrequency and loanTermFrequencyType are accepted as repayment-shape aliases, optional formRecords inserts loan-owned datatable rows after create, and optional loanAction selects whether the wrapper stops after create or continues into approval or funding. formRecords is generic at the API layer; the keys inside fieldValues[] depend on the selected configured form. The current example shows Loan Discount Strategy Form, which uses required rate and optional delay.

Simplified request payload used to create an Embarc loan, optionally insert loan-owned form datatable rows, and optionally continue into approval or funding through loanAction.

string
enum

Optional routing discriminator. Set to MCA to route this request to the Merchant Cash Advance loan-creation pipeline (same behavior as POST /v1/mca/loans) instead of the standard loan-creation pipeline. This field is stripped before further validation and is not part of either downstream contract. See McaLoanCreateRequest and clarifi/docs/mca/mca-openapi.yaml for the MCA request shape, which replaces principal with advanceAmount, factorRate, and holdbackPercent.

Allowed:
integer
required
Defaults to 4

Loan product identifier. Must be greater than 0 and resolvable for the caller.

integer
required
Defaults to 1

Client identifier. Must be greater than 0 and visible to the caller.

number
required
Defaults to 10000

Principal amount to create. Must be greater than 0.

string
enum
Defaults to CREATE_ONLY

Optional post-create orchestration mode. When omitted or null, the wrapper defaults to CREATE_ONLY.

Allowed:
string

Disbursement date in MM/dd/yyyy format. When omitted, defaults to the current tenant business date.

string

First repayment date in MM/dd/yyyy format. When provided, it must not be earlier than disbursementDate.

integer

Number of repayments. Defaults from the loan product template when omitted.

integer

Loan-term frequency alias accepted to match the loan amortization request shape. If repaymentEvery is omitted, Embarc derives it as loanTermFrequency / numberOfRepayments when evenly divisible.

integer

Loan-term frequency-type alias accepted to match the loan amortization request shape. If repaymentFrequencyType is omitted, Embarc uses this value.

integer

Repayment interval. Defaults from the loan product template when omitted.

integer

Repayment frequency unit from PeriodFrequencyType. Defaults from the loan product template when omitted.

number

Nominal interest rate for the unit identified by interestRateFrequencyType. Defaults from the loan product template when omitted.

integer

Interest-rate frequency unit. Defaults from the loan product template when omitted.

integer

Interest method. Defaults from the loan product template when omitted.

integer

Amortization method. Defaults from the loan product template when omitted.

integer

Interest accrual basis. Defaults from the loan product template when omitted.

string

Loan transaction processing strategy code. Defaults from the loan product template when omitted.

charges
array of objects

Full effective charge list for the request. It is not merged with product default charges.

charges
fee
object

Simplified financed-origination-fee input for Embarc loan create. When the loan product has one active financed-origination-fee row, the request overrides it. When the loan product has no active financed-origination-fee rows, Embarc writes an ad hoc loan-level financed-origination-fee override. When the loan product has multiple active rows, the request is rejected as ambiguous.

formRecords
array of objects
length between 1 and 20

Optional loan-owned form datatable rows to insert after the loan is created. Each item targets one configured loan form.

formRecords
approval
object

Minimal wrapper-owned approval override object used when loanAction requires approval.

initiateFunding
object

Funding-initiate override object used only when loanAction initiates funding. It mirrors the implemented funding-initiate request shape except budgetDrawId, and it intentionally does not expose a method field.

fundingApproval
object

Minimal funding-approval override object used only when loanAction = AUTO_INITIATE_FUNDING_APPROVE.

recordFunding
object

Funding-record override object used only when loanAction = AUTO_RECORD_FUNDING. It mirrors the implemented funding-record request shape except budgetDrawId, and it intentionally does not expose a status field.

Response

Updated 2 months 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 2 months ago

Did this page help you?