API Reference

Create a Scheduled Funding

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

Create a future disbursement or counterparty payout funding instruction for an approved loan. The schedule does not create a funding row immediately; execution later records, initiates, or initiates and approves funding based on fundingMode when the loan is approved or active.

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

Loan identifier for the scheduled funding.

Body Params

Scheduled funding create payload. Defaults are fundingMode INITIATE_AUTO_APPROVE, amountStrategy AVAILABLE_AMOUNT, and type DISBURSEMENT. Include counterpartyId with DISBURSEMENT when the disbursement should route to a counterparty payment instrument while retaining funding_type DISBURSEMENT. Use type COUNTERPARTY_PAYOUT only for explicit counterparty payout schedules. scheduledAt must be an ISO-8601 timestamp with an explicit offset or Z. Unsupported properties are rejected.

string
required

Timestamp when the scheduled funding becomes due. Must include an explicit timezone offset or Z, must not be in the past, and is normalized to UTC for persistence and due-row comparison.

string
enum
Defaults to INITIATE_AUTO_APPROVE

Controls whether execution logs external funding, initiates provider funding only, or initiates and auto-approves provider funding.

Allowed:
string
enum
Defaults to AVAILABLE_AMOUNT

Controls whether execution uses a stored fixed amount or resolves the currently available amount when the schedule runs.

Allowed:
number

Required when amountStrategy is FIXED_AMOUNT. Must be greater than zero. Omit when amountStrategy is AVAILABLE_AMOUNT.

string
enum
Defaults to DISBURSEMENT

Funding type. Use DISBURSEMENT for customer/loan disbursement schedules, including counterparty-routed disbursements when counterpartyId is provided. Use COUNTERPARTY_PAYOUT only for explicit counterparty payout schedules.

Allowed:
string
enum

Funding method used by logged funding when required by the record flow.

integer

Payment instrument used for initiated funding. Required when fundingMode is INITIATE_REQUEST_ONLY or INITIATE_AUTO_APPROVE. Optional for LOG_ONLY.

integer

Counterparty identifier. Required when type is COUNTERPARTY_PAYOUT. Optional when type is DISBURSEMENT; when provided, the disbursement routes to that counterparty payment instrument while retaining funding_type DISBURSEMENT.

integer

Budget draw identifier. When supplied, the scheduled funding targets that draw and only one blocking open schedule is allowed for the same draw unless the existing schedule links to terminal unsuccessful funding.

metadata
object

Optional metadata stored with the schedule and copied to the eventual funding request.

string

Optional note stored with the schedule and copied to the eventual funding request. Maximum 1000 characters.

string

Optional external reference. If omitted at execution, a deterministic scheduled-funding id is generated from the scheduled funding id.

Headers
string

Tenant identifier used by hosted Embarc environments.

Response

Updated 20 days 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 20 days ago

Did this page help you?