Record Funding

Records a funding that already settled externally and posts it immediately to the loan when the funding type is ledger-posted. Counterparty payout records remain off-ledger.

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

Loan identifier for the funding request.

Body Params

Funding record request for an externally settled funding. Provide effectiveDate with dateFormat and locale so the API can parse the settlement date.

number
required

Funding amount that settled externally. Must be greater than zero.

string
enum
required
Defaults to DISBURSEMENT

Funding type. DISBURSEMENT records a loan disbursement funding that posts to the loan ledger. REFUND records returned funds. COUNTERPARTY_PAYOUT records an off-ledger counterparty payout.

Allowed:
string
required

Date the externally settled funding should impact the loan or payout record.

string
enum
Defaults to ACH

Payment method used for the externally settled funding. Required when no payment instrument is linked.

Allowed:
string
required
Defaults to yyyy-MM-dd

Date format used to parse effectiveDate.

string
required
Defaults to en

Locale used with dateFormat to parse effectiveDate.

integer

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.

integer

Active counterparty identifier for the funding destination owner. Optional for DISBURSEMENT, where it means the loan disbursement was paid to the counterparty. Required for COUNTERPARTY_PAYOUT, where the payout stays off-ledger.

integer

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

string

Processor transaction, ACH, or wire reference stored with the recorded funding. Maximum length is 100 characters.

string

Processor return identifier when failures or returns occur. Maximum length is 100 characters.

string

Rail trace number stored for reconciliation. Maximum length is 100 characters.

string

Check number when the funding was issued by check. Maximum length is 100 characters.

string

Masked account number recorded for reconciliation. Maximum length is 100 characters.

string

Routing number associated with the externally settled funding. Maximum length is 100 characters.

string

Bank name recorded for the externally settled funding. Maximum length is 100 characters.

string

Payer name captured for audit. Maximum length is 100 characters.

string

Payee name captured for audit. Maximum length is 100 characters.

string

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

metadata
object

Optional structured metadata stored with the recorded funding.

string

Optional note trimmed to at most 1000 characters.

Headers
string
required
Defaults to default

Tenant routing identifier for Embarc.

Responses

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