Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Funding

Create a Funding

Creates a Funding object to request that Lead move funds from a Lead GL to the partner's funding FBO account.

post/v0/fundings

Headers

Idempotency-Keystring required

Idempotency key

Request body

subledger_balance_idstring required

Unique ID of the credit subledger balance object that a funding object is being created for. The referenced Subledger Balance must be in an active status. If the Subledger Balance has an expected_maturity_date, it must not be in the past.

currency_code'USD' required

A three-letter currency code as defined in ISO 4217. Must match the currency_code on the associated Subledger Balance object.

metadataobject

Additional metadata associated with the funding.

Example request

{
  "subledger_balance_id": "subledger_balance_1HCpXwx2EK9oYluWbacgeCnFcLf",
  "currency_code": "USD",
  "principal": {
    "external_disbursement_amount": 100000,
    "withheld_amount": 1000,
    "merchant_origination_fee_amount": 100
  },
  "other_fees": {
    "borrower_origination_fee_amount": 200
  },
  "metadata": {
    "client_draw_id": "X67BU"
  }
}

Response

Successful response

idstring

Unique ID of the funding object.

subledger_balance_idstring

Unique ID of the credit subledger balance object that a funding object is being created for. The referenced Subledger Balance must be in an active status. If the Subledger Balance has an expected_maturity_date, it must not be in the past.

currency_code'USD'

A three-letter currency code as defined in ISO 4217.

metadataobject

Additional metadata associated with the funding.

status'processing' | 'posted' | 'rejected'

The current status of the Funding object.

created_atstring date-time

The ISO-8601 timestamp at which the Funding object was created.

updated_atstring date-time

The ISO-8601 timestamp at which the Funding object was last updated.

Example response

{
  "id": "funding_123",
  "subledger_balance_id": "subledger_balance_123",
  "currency_code": "USD",
  "principal": {
    "external_disbursement_amount": 100000,
    "withheld_amount": 1000,
    "merchant_origination_fee_amount": 100
  },
  "other_fees": {
    "borrower_origination_fee_amount": 200
  },
  "metadata": {
    "client_draw_id": "X67BU"
  },
  "status": "processing",
  "rejection": {
    "reason": "internal_error",
    "details": "Funding object rejected due to an internal error."
  },
  "created_at": "2025-09-02T11:01:36Z",
  "updated_at": "2025-09-02T11:05:00Z"
}