Initiate Funding

post

https://embarc-api-qa.lendapi.com/embarc-core/api/v1/loans/{loanId}/fundings/initiate

Creates a REQUESTED funding for a loan. The request requires an expected settlement date and date parsing metadata; method is inferred from the selected payment instrument. The funding type controls ledger behavior, while counterpartyId only changes the destination owner when supplied.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

loanId

integer

required

Defaults to 9001

Loan identifier for the funding request.

Body Params

Funding initiation request. Use expectedSettlementAt with dateFormat and locale so the API can parse the disbursal date.

amount

number

required

Funding amount. Must be greater than zero and align with budget draw totals when budget draw funding is enabled.

type

string

enum

required

Defaults to DISBURSEMENT

Funding type. DISBURSEMENT creates a loan disbursement funding that posts to the loan ledger after settlement, whether paid to the client or to a counterparty destination. REFUND returns funds. COUNTERPARTY_PAYOUT pays an active counterparty off-ledger and does not create a loan disbursement transaction.

Allowed:

paymentInstrumentId

integer

required

Active payment instrument for the destination owner. When counterpartyId is omitted, the instrument belongs to the loan client. When counterpartyId is supplied, the instrument belongs to that counterparty. Required for initiated non-fee-only funding.

expectedSettlementAt

string

required

Expected settlement or disbursal date parsed with dateFormat and locale.

dateFormat

string

required

Defaults to yyyy-MM-dd

Date format used to parse expectedSettlementAt. The frontend sends yyyy-MM-dd.

locale

string

required

Defaults to en

Locale used with dateFormat to parse expectedSettlementAt.

budgetDrawId

integer

Approved budget draw identifier when budgeted draw management requires linked funding. Allowed only for DISBURSEMENT.

counterpartyId

integer

Active counterparty identifier for the funding destination owner. Optional for DISBURSEMENT, where it means the loan disbursement is paid to the counterparty but still posts to the loan ledger after settlement. Required for COUNTERPARTY_PAYOUT, where the payout stays off-ledger.

externalId

string

Optional external identifier. When supplied, it is trimmed, must be unique, and must be no more than 100 characters.

metadata

object

Optional structured metadata stored with the funding request.

note

string

Optional note trimmed to at most 1000 characters.

Headers

x-embarc-tenant-id

string

required

Defaults to default

Tenant routing identifier for Embarc.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Funding request was accepted and a command result was returned.

400Invalid request payload.