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": {}
}
'import requests
url = "https://api.sandbox.lead.bank/v0/subledger_balances"
payload = {
"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": {}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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: {}
})
};
fetch('https://api.sandbox.lead.bank/v0/subledger_balances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.lead.bank/v0/subledger_balances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.lead.bank/v0/subledger_balances"
payload := strings.NewReader("{\n \"account_id\": \"account_v9K4p2M7nL1wQ8xR5zB6tY3jH0gA\",\n \"client_subledger_balance_name\": \"Personal Loan - Home Improvement\",\n \"currency_code\": \"USD\",\n \"type\": \"credit\",\n \"details\": {\n \"expected_maturity_date\": \"2027-09-01\",\n \"repayment_details\": [\n {\n \"expected_payment_frequency\": \"monthly\",\n \"expected_payment_frequency_interval_days\": 60,\n \"expected_number_of_payments\": 24,\n \"expected_first_payment_date\": \"2025-10-01\",\n \"expected_first_payment_amount\": 4167,\n \"expected_last_payment_date\": \"2027-09-01\",\n \"expected_last_payment_amount\": 4167,\n \"expected_payment_amount\": 4167\n }\n ],\n \"max_funding_amount\": 10000000,\n \"term\": {\n \"value\": 24,\n \"unit\": \"months\"\n },\n \"expected_finance_charge_amount\": 1000,\n \"balances\": {},\n \"autopay_method\": \"ach\",\n \"is_interest_based\": true,\n \"effective_apr\": \"10.250\",\n \"effective_interest_rate\": \"9.500000\",\n \"interest_rate\": \"9.990000\"\n },\n \"client_settlement_bank_account_id\": \"12345\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.lead.bank/v0/subledger_balances")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"account_v9K4p2M7nL1wQ8xR5zB6tY3jH0gA\",\n \"client_subledger_balance_name\": \"Personal Loan - Home Improvement\",\n \"currency_code\": \"USD\",\n \"type\": \"credit\",\n \"details\": {\n \"expected_maturity_date\": \"2027-09-01\",\n \"repayment_details\": [\n {\n \"expected_payment_frequency\": \"monthly\",\n \"expected_payment_frequency_interval_days\": 60,\n \"expected_number_of_payments\": 24,\n \"expected_first_payment_date\": \"2025-10-01\",\n \"expected_first_payment_amount\": 4167,\n \"expected_last_payment_date\": \"2027-09-01\",\n \"expected_last_payment_amount\": 4167,\n \"expected_payment_amount\": 4167\n }\n ],\n \"max_funding_amount\": 10000000,\n \"term\": {\n \"value\": 24,\n \"unit\": \"months\"\n },\n \"expected_finance_charge_amount\": 1000,\n \"balances\": {},\n \"autopay_method\": \"ach\",\n \"is_interest_based\": true,\n \"effective_apr\": \"10.250\",\n \"effective_interest_rate\": \"9.500000\",\n \"interest_rate\": \"9.990000\"\n },\n \"client_settlement_bank_account_id\": \"12345\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.lead.bank/v0/subledger_balances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"account_v9K4p2M7nL1wQ8xR5zB6tY3jH0gA\",\n \"client_subledger_balance_name\": \"Personal Loan - Home Improvement\",\n \"currency_code\": \"USD\",\n \"type\": \"credit\",\n \"details\": {\n \"expected_maturity_date\": \"2027-09-01\",\n \"repayment_details\": [\n {\n \"expected_payment_frequency\": \"monthly\",\n \"expected_payment_frequency_interval_days\": 60,\n \"expected_number_of_payments\": 24,\n \"expected_first_payment_date\": \"2025-10-01\",\n \"expected_first_payment_amount\": 4167,\n \"expected_last_payment_date\": \"2027-09-01\",\n \"expected_last_payment_amount\": 4167,\n \"expected_payment_amount\": 4167\n }\n ],\n \"max_funding_amount\": 10000000,\n \"term\": {\n \"value\": 24,\n \"unit\": \"months\"\n },\n \"expected_finance_charge_amount\": 1000,\n \"balances\": {},\n \"autopay_method\": \"ach\",\n \"is_interest_based\": true,\n \"effective_apr\": \"10.250\",\n \"effective_interest_rate\": \"9.500000\",\n \"interest_rate\": \"9.990000\"\n },\n \"client_settlement_bank_account_id\": \"12345\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"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
}
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}Subledger Balance
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
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": {}
}
'import requests
url = "https://api.sandbox.lead.bank/v0/subledger_balances"
payload = {
"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": {}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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: {}
})
};
fetch('https://api.sandbox.lead.bank/v0/subledger_balances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.lead.bank/v0/subledger_balances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.lead.bank/v0/subledger_balances"
payload := strings.NewReader("{\n \"account_id\": \"account_v9K4p2M7nL1wQ8xR5zB6tY3jH0gA\",\n \"client_subledger_balance_name\": \"Personal Loan - Home Improvement\",\n \"currency_code\": \"USD\",\n \"type\": \"credit\",\n \"details\": {\n \"expected_maturity_date\": \"2027-09-01\",\n \"repayment_details\": [\n {\n \"expected_payment_frequency\": \"monthly\",\n \"expected_payment_frequency_interval_days\": 60,\n \"expected_number_of_payments\": 24,\n \"expected_first_payment_date\": \"2025-10-01\",\n \"expected_first_payment_amount\": 4167,\n \"expected_last_payment_date\": \"2027-09-01\",\n \"expected_last_payment_amount\": 4167,\n \"expected_payment_amount\": 4167\n }\n ],\n \"max_funding_amount\": 10000000,\n \"term\": {\n \"value\": 24,\n \"unit\": \"months\"\n },\n \"expected_finance_charge_amount\": 1000,\n \"balances\": {},\n \"autopay_method\": \"ach\",\n \"is_interest_based\": true,\n \"effective_apr\": \"10.250\",\n \"effective_interest_rate\": \"9.500000\",\n \"interest_rate\": \"9.990000\"\n },\n \"client_settlement_bank_account_id\": \"12345\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.lead.bank/v0/subledger_balances")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"account_v9K4p2M7nL1wQ8xR5zB6tY3jH0gA\",\n \"client_subledger_balance_name\": \"Personal Loan - Home Improvement\",\n \"currency_code\": \"USD\",\n \"type\": \"credit\",\n \"details\": {\n \"expected_maturity_date\": \"2027-09-01\",\n \"repayment_details\": [\n {\n \"expected_payment_frequency\": \"monthly\",\n \"expected_payment_frequency_interval_days\": 60,\n \"expected_number_of_payments\": 24,\n \"expected_first_payment_date\": \"2025-10-01\",\n \"expected_first_payment_amount\": 4167,\n \"expected_last_payment_date\": \"2027-09-01\",\n \"expected_last_payment_amount\": 4167,\n \"expected_payment_amount\": 4167\n }\n ],\n \"max_funding_amount\": 10000000,\n \"term\": {\n \"value\": 24,\n \"unit\": \"months\"\n },\n \"expected_finance_charge_amount\": 1000,\n \"balances\": {},\n \"autopay_method\": \"ach\",\n \"is_interest_based\": true,\n \"effective_apr\": \"10.250\",\n \"effective_interest_rate\": \"9.500000\",\n \"interest_rate\": \"9.990000\"\n },\n \"client_settlement_bank_account_id\": \"12345\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.lead.bank/v0/subledger_balances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"account_v9K4p2M7nL1wQ8xR5zB6tY3jH0gA\",\n \"client_subledger_balance_name\": \"Personal Loan - Home Improvement\",\n \"currency_code\": \"USD\",\n \"type\": \"credit\",\n \"details\": {\n \"expected_maturity_date\": \"2027-09-01\",\n \"repayment_details\": [\n {\n \"expected_payment_frequency\": \"monthly\",\n \"expected_payment_frequency_interval_days\": 60,\n \"expected_number_of_payments\": 24,\n \"expected_first_payment_date\": \"2025-10-01\",\n \"expected_first_payment_amount\": 4167,\n \"expected_last_payment_date\": \"2027-09-01\",\n \"expected_last_payment_amount\": 4167,\n \"expected_payment_amount\": 4167\n }\n ],\n \"max_funding_amount\": 10000000,\n \"term\": {\n \"value\": 24,\n \"unit\": \"months\"\n },\n \"expected_finance_charge_amount\": 1000,\n \"balances\": {},\n \"autopay_method\": \"ach\",\n \"is_interest_based\": true,\n \"effective_apr\": \"10.250\",\n \"effective_interest_rate\": \"9.500000\",\n \"interest_rate\": \"9.990000\"\n },\n \"client_settlement_bank_account_id\": \"12345\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"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
}
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"status": "<string>",
"invalid_parameters": [
{
"parameter": "transaction_type",
"reason": "<string>"
}
],
"instance": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Idempotency key
Required string length:
5 - 255Body
application/json
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:
64Example:
"account_v9K4p2M7nL1wQ8xR5zB6tY3jH0gA"
A name for the product or Subledger Balance being offered to the end-user (e.g., Rainy Day Fund, BNPL loan).
Maximum string length:
64Example:
"Personal Loan - Home Improvement"
A three-letter currency code as defined in ISO 4217.
Available options:
USD Example:
"USD"
The type of Subledger Balance.
Available options:
credit Example:
"credit"
- Non-Revolving
- Revolving
Show child attributes
Show child attributes
ID of the underlying settlement bank account where funds for the Subledger Balance are held. Only applicable for certain use cases.
Example:
"12345"
A set of key-value pairs that can be used to store additional information related to this object.
Show child attributes
Show child attributes
Response
Subledger Balance created successfully
Unique identifier for the account that the Subledger Balance belongs to.
Example:
"account_v9K4p2M7nL1wQ8xR5zB6tY3jH0gA"
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"
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"
ID of the underlying settlement bank account where funds for the Subledger Balance are held. Only applicable for certain use cases.
Example:
"12345"
A three-letter currency code as defined in ISO 4217.
Available options:
USD Example:
"USD"
An ISO-8601 timestamp at which the Subledger Balance was created in Lead's system.
Example:
"2025-09-02T11:01:36Z"
An ISO-8601 timestamp at which the Subledger Balance was last updated in Lead's system.
Example:
"2025-09-02T11:05:00Z"
Status of the Subledger Balance.
Available options:
active, inactive, closed Example:
"active"
Reason associated with the status of the Subledger Balance.
Example:
"active"
The type of Subledger Balance.
Available options:
credit, deposit Example:
"credit"
A set of key-value pairs that can be used to store additional information related to this object.
Show child attributes
Show child attributes
- Non-Revolving
- Revolving
Show child attributes
Show child attributes
Was this page helpful?
⌘I