Skip to main content
POST
/
v0
/
subledger_balances
Create a Subledger Balance
curl --request POST \
  --url https://api.sandbox.lead.bank/v0/subledger_balances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "account_id": "account_v9K4p2M7nL1wQ8xR5zB6tY3jH0gA",
  "client_subledger_balance_name": "Personal Loan - Home Improvement",
  "currency_code": "USD",
  "type": "credit",
  "details": {
    "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,
    "balances": {},
    "autopay_method": "ach",
    "is_interest_based": true,
    "effective_apr": "10.250",
    "effective_interest_rate": "9.500000",
    "interest_rate": "9.990000"
  },
  "client_settlement_bank_account_id": "12345",
  "metadata": {}
}
'
{
  "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",
  "metadata": {},
  "details": {
    "structure": "<string>",
    "balances": {
      "core": {
        "amount": 8944,
        "amount_in_usd": 8944,
        "outstanding_principal": 5000,
        "outstanding_interest": 2522,
        "outstanding_fees": 1422
      },
      "rewards": {
        "amount": 10,
        "unit": "points"
      },
      "dispute": {
        "amount": 0,
        "principal": 0,
        "interest": 0,
        "fees": 0
      },
      "charge_off": {
        "amount": 0,
        "principal": 0,
        "interest": 0,
        "fees": 0
      },
      "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
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string
required

Idempotency key

Required string length: 5 - 255

Body

application/json
​
account_id
string
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.

Maximum string length: 64
Example:

"account_v9K4p2M7nL1wQ8xR5zB6tY3jH0gA"

​
client_subledger_balance_name
string
required

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

Maximum string length: 64
Example:

"Personal Loan - Home Improvement"

​
currency_code
enum<string>
required

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

Available options:
USD
Example:

"USD"

​
type
enum<string>
required

The type of Subledger Balance.

Available options:
credit
Example:

"credit"

​
details
Non-Revolving · object
required
​
client_settlement_bank_account_id
string

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

Example:

"12345"

​
metadata
object

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

Response

Subledger Balance created successfully

​
account_id
string

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

Example:

"account_v9K4p2M7nL1wQ8xR5zB6tY3jH0gA"

​
id
string

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

Example:

"subledger_balance_k8L2n9QpW3xR5vT7mZ4jS1bA6cG"

​
client_subledger_balance_name
string

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

Example:

"Personal Loan - Home Improvement"

​
client_settlement_bank_account_id
string

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

Example:

"12345"

​
currency_code
enum<string>

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

Available options:
USD
Example:

"USD"

​
created_at
string<date-time>

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

Example:

"2025-09-02T11:01:36Z"

​
updated_at
string<date-time>

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

Example:

"2025-09-02T11:05:00Z"

​
status
enum<string>

Status of the Subledger Balance.

Available options:
active,
inactive,
closed
Example:

"active"

​
status_reason
string

Reason associated with the status of the Subledger Balance.

Example:

"active"

​
type
enum<string>

The type of Subledger Balance.

Available options:
credit,
deposit
Example:

"credit"

​
metadata
object

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

​
details
Non-Revolving · object