Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Subledger Balances

Create a Subledger Balance

Create a Subledger Balance object. The newly created Subledger Balance will have a status of active and a status_reason of active, and a unique id with prefix subledger_balance_ will be auto-generated.

post/v0/subledger_balances

Headers

Idempotency-Keystring required

Idempotency key

Request body

account_idstring required

Unique identifier for the Account object that the Subledger Balance belongs to. Must reference an Account object in a permitted status (active or inactive). If the Account includes a capabilities array, the requested Subledger Balance type must be supported.

client_subledger_balance_namestring required

A name for the product or Subledger Balance being offered to the end-user (e.g., Rainy Day Fund, BNPL loan).

client_settlement_bank_account_idstring

ID of the underlying settlement bank account where funds for the Subledger Balance are held. Only applicable for certain use cases.

currency_code'USD' required

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

type'credit' required

The type of Subledger Balance.

metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

Example request

{
  "account_id": "account_v9K4p2M7nL1wQ8xR5zB6tY3jH0gA",
  "client_subledger_balance_name": "Personal Loan - Home Improvement",
  "client_settlement_bank_account_id": "12345",
  "currency_code": "USD",
  "type": "credit",
  "details": {
    "balances": {
      "rewards": {
        "unit": "points"
      }
    },
    "autopay_method": "ach",
    "is_interest_based": true,
    "effective_apr": "10.250",
    "effective_interest_rate": "9.500000",
    "interest_rate": "9.990000",
    "expected_maturity_date": "2027-09-01",
    "repayment_details": [
      {
        "expected_payment_frequency": "monthly",
        "expected_payment_frequency_interval_days": 60,
        "expected_number_of_payments": 24,
        "expected_first_payment_date": "2025-10-01",
        "expected_first_payment_amount": 4167,
        "expected_last_payment_date": "2027-09-01",
        "expected_last_payment_amount": 4167,
        "expected_payment_amount": 4167
      }
    ],
    "max_funding_amount": 10000000,
    "term": {
      "value": 24,
      "unit": "months"
    },
    "expected_finance_charge_amount": 1000
  }
}

Response

Subledger Balance created successfully

account_idstring

Unique identifier for the account that the Subledger Balance belongs to.

idstring

Lead-generated unique identifier for the Subledger Balance. This ID should subsequently be used when reporting on this object in the Balance file.

client_subledger_balance_namestring

A name for the product or Subledger Balance being offered to the end-user (e.g., Rainy Day Fund, BNPL loan).

client_settlement_bank_account_idstring

ID of the underlying settlement bank account where funds for the Subledger Balance are held. Only applicable for certain use cases.

currency_code'USD'

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

created_atstring date-time

An ISO-8601 timestamp at which the Subledger Balance was created in Lead's system.

updated_atstring date-time

An ISO-8601 timestamp at which the Subledger Balance was last updated in Lead's system.

status'active' | 'inactive' | 'closed'

Status of the Subledger Balance.

status_reasonstring

Reason associated with the status of the Subledger Balance.

type'credit' | 'deposit'

The type of Subledger Balance.

metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

Example response

{
  "account_id": "account_v9K4p2M7nL1wQ8xR5zB6tY3jH0gA",
  "id": "subledger_balance_k8L2n9QpW3xR5vT7mZ4jS1bA6cG",
  "client_subledger_balance_name": "Personal Loan - Home Improvement",
  "client_settlement_bank_account_id": "12345",
  "currency_code": "USD",
  "created_at": "2025-09-02T11:01:36Z",
  "updated_at": "2025-09-02T11:05:00Z",
  "status": "active",
  "status_reason": "active",
  "type": "credit",
  "details": {
    "balances": {
      "core": {
        "amount": 8944,
        "amount_in_usd": 8944,
        "outstanding_principal": 5000,
        "outstanding_interest": 2522,
        "outstanding_fees": 1422
      },
      "rewards": {
        "amount": 10,
        "unit": "points"
      },
      "past_due": {
        "amount": 15,
        "past_due_days": 15,
        "principal": 15,
        "interest": 15,
        "fees": 15
      }
    },
    "autopay_method": "ach",
    "is_interest_based": true,
    "effective_apr": "10.250",
    "effective_interest_rate": "9.500000",
    "interest_rate": "9.990000",
    "expected_maturity_date": "2027-09-01",
    "repayment_details": [
      {
        "expected_payment_frequency": "monthly",
        "expected_payment_frequency_interval_days": 60,
        "expected_number_of_payments": 24,
        "expected_first_payment_date": "2025-10-01",
        "expected_first_payment_amount": 4167,
        "expected_last_payment_date": "2027-09-01",
        "expected_last_payment_amount": 4167,
        "expected_payment_amount": 4167
      }
    ],
    "max_funding_amount": 10000000,
    "term": {
      "value": 24,
      "unit": "months"
    },
    "expected_finance_charge_amount": 100000
  }
}