Update a Credit Balance
curl --request PATCH \
--url https://api.sandbox.lead.bank/v2/user_credit_balances/{user_credit_balance_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"metadata": {},
"past_due": {
"amount": 123,
"days": 123,
"amount_breakdown": {
"principal": 123,
"interest": 123,
"fees": 123
}
},
"terms": {
"effective_interest_rate": "5.250000",
"interest_rate": "5.250000",
"expected_maturity_date": "2023-12-25",
"duration": {
"length": 1
},
"repayment": {
"expected_payment_frequency_interval_days": 365,
"expected_number_of_payments": 1,
"expected_first_payment_date": "2023-12-25",
"expected_first_payment_amount": 1,
"expected_last_payment_date": "2023-12-25",
"expected_last_payment_amount": 1,
"expected_payment_amount": 1
}
}
}
'import requests
url = "https://api.sandbox.lead.bank/v2/user_credit_balances/{user_credit_balance_id}"
payload = {
"metadata": {},
"past_due": {
"amount": 123,
"days": 123,
"amount_breakdown": {
"principal": 123,
"interest": 123,
"fees": 123
}
},
"terms": {
"effective_interest_rate": "5.250000",
"interest_rate": "5.250000",
"expected_maturity_date": "2023-12-25",
"duration": { "length": 1 },
"repayment": {
"expected_payment_frequency_interval_days": 365,
"expected_number_of_payments": 1,
"expected_first_payment_date": "2023-12-25",
"expected_first_payment_amount": 1,
"expected_last_payment_date": "2023-12-25",
"expected_last_payment_amount": 1,
"expected_payment_amount": 1
}
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
metadata: {},
past_due: {
amount: 123,
days: 123,
amount_breakdown: {principal: 123, interest: 123, fees: 123}
},
terms: {
effective_interest_rate: '5.250000',
interest_rate: '5.250000',
expected_maturity_date: '2023-12-25',
duration: {length: 1},
repayment: {
expected_payment_frequency_interval_days: 365,
expected_number_of_payments: 1,
expected_first_payment_date: '2023-12-25',
expected_first_payment_amount: 1,
expected_last_payment_date: '2023-12-25',
expected_last_payment_amount: 1,
expected_payment_amount: 1
}
}
})
};
fetch('https://api.sandbox.lead.bank/v2/user_credit_balances/{user_credit_balance_id}', 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/v2/user_credit_balances/{user_credit_balance_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'metadata' => [
],
'past_due' => [
'amount' => 123,
'days' => 123,
'amount_breakdown' => [
'principal' => 123,
'interest' => 123,
'fees' => 123
]
],
'terms' => [
'effective_interest_rate' => '5.250000',
'interest_rate' => '5.250000',
'expected_maturity_date' => '2023-12-25',
'duration' => [
'length' => 1
],
'repayment' => [
'expected_payment_frequency_interval_days' => 365,
'expected_number_of_payments' => 1,
'expected_first_payment_date' => '2023-12-25',
'expected_first_payment_amount' => 1,
'expected_last_payment_date' => '2023-12-25',
'expected_last_payment_amount' => 1,
'expected_payment_amount' => 1
]
]
]),
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/v2/user_credit_balances/{user_credit_balance_id}"
payload := strings.NewReader("{\n \"metadata\": {},\n \"past_due\": {\n \"amount\": 123,\n \"days\": 123,\n \"amount_breakdown\": {\n \"principal\": 123,\n \"interest\": 123,\n \"fees\": 123\n }\n },\n \"terms\": {\n \"effective_interest_rate\": \"5.250000\",\n \"interest_rate\": \"5.250000\",\n \"expected_maturity_date\": \"2023-12-25\",\n \"duration\": {\n \"length\": 1\n },\n \"repayment\": {\n \"expected_payment_frequency_interval_days\": 365,\n \"expected_number_of_payments\": 1,\n \"expected_first_payment_date\": \"2023-12-25\",\n \"expected_first_payment_amount\": 1,\n \"expected_last_payment_date\": \"2023-12-25\",\n \"expected_last_payment_amount\": 1,\n \"expected_payment_amount\": 1\n }\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.sandbox.lead.bank/v2/user_credit_balances/{user_credit_balance_id}")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {},\n \"past_due\": {\n \"amount\": 123,\n \"days\": 123,\n \"amount_breakdown\": {\n \"principal\": 123,\n \"interest\": 123,\n \"fees\": 123\n }\n },\n \"terms\": {\n \"effective_interest_rate\": \"5.250000\",\n \"interest_rate\": \"5.250000\",\n \"expected_maturity_date\": \"2023-12-25\",\n \"duration\": {\n \"length\": 1\n },\n \"repayment\": {\n \"expected_payment_frequency_interval_days\": 365,\n \"expected_number_of_payments\": 1,\n \"expected_first_payment_date\": \"2023-12-25\",\n \"expected_first_payment_amount\": 1,\n \"expected_last_payment_date\": \"2023-12-25\",\n \"expected_last_payment_amount\": 1,\n \"expected_payment_amount\": 1\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.lead.bank/v2/user_credit_balances/{user_credit_balance_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": {},\n \"past_due\": {\n \"amount\": 123,\n \"days\": 123,\n \"amount_breakdown\": {\n \"principal\": 123,\n \"interest\": 123,\n \"fees\": 123\n }\n },\n \"terms\": {\n \"effective_interest_rate\": \"5.250000\",\n \"interest_rate\": \"5.250000\",\n \"expected_maturity_date\": \"2023-12-25\",\n \"duration\": {\n \"length\": 1\n },\n \"repayment\": {\n \"expected_payment_frequency_interval_days\": 365,\n \"expected_number_of_payments\": 1,\n \"expected_first_payment_date\": \"2023-12-25\",\n \"expected_first_payment_amount\": 1,\n \"expected_last_payment_date\": \"2023-12-25\",\n \"expected_last_payment_amount\": 1,\n \"expected_payment_amount\": 1\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "user_credit_balance_1HCpXwx2EK9oYluWbacgeCnFcLf",
"created_at": "2023-11-07T05:31:56Z",
"user_account_id": "user_account_xyz123",
"name": "Personal Loan - Jane Smith",
"status": "active",
"status_reason": "active",
"currency_code": "USD",
"amount": 123,
"amount_in_usd": 123,
"amount_breakdown": {
"principal": 123,
"interest": 123,
"fees": 123
},
"fees": {
"accrued": 123
},
"rewards": {
"amount": 123,
"unit": "USD"
},
"dispute": {
"amount": 123,
"amount_breakdown": {
"principal": 123,
"interest": 123,
"fees": 123
}
},
"charge_off": {
"amount": 123,
"amount_breakdown": {
"principal": 123,
"interest": 123,
"fees": 123
}
},
"past_due": {
"amount": 123,
"days": 123,
"amount_breakdown": {
"principal": 123,
"interest": 123,
"fees": 123
}
},
"autopay_method": "ach",
"terms": {
"structure": "revolving",
"interest_rate": "5.250000",
"effective_interest_rate": "5.250000",
"effective_apr": "5.250000",
"expected_maturity_date": "2023-12-25",
"repayment": {
"expected_payment_frequency": "business_daily",
"expected_payment_frequency_interval_days": 123,
"expected_number_of_payments": 123,
"expected_first_payment_date": "2023-12-25",
"expected_first_payment_amount": 123,
"expected_last_payment_date": "2023-12-25",
"expected_last_payment_amount": 123,
"expected_payment_amount": 123
},
"max_funding_amount": 123,
"duration": {
"length": 123,
"unit": "days"
},
"expected_finance_charge_amount": 123
},
"metadata": {},
"closed_at": "2023-11-07T05:31:56Z"
}{
"code": "authentication_missing",
"message": "The request has no authentication credentials. Send your API token in the Authorization header.",
"errors": [
{
"code": "authentication_missing",
"message": "The Authorization header is missing. Send your API token as a bearer token.",
"parameters": [
"Authorization"
]
}
]
}{
"code": "internal_server_error",
"message": "Internal server error. Retry with exponential backoff. For a POST, PATCH or DELETE, reuse the same Idempotency-Key so the request isn't processed twice. If it keeps failing, contact Lead with the Lead-Request-ID."
}User Credit Balances
Update a User Credit Balance
Update a User Credit Balance. Amounts (amount, amount_breakdown, rewards, dispute, charge_off) change only through User Credit Transactions, not PATCH.
PATCH
/
v2
/
user_credit_balances
/
{user_credit_balance_id}
Update a Credit Balance
curl --request PATCH \
--url https://api.sandbox.lead.bank/v2/user_credit_balances/{user_credit_balance_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"metadata": {},
"past_due": {
"amount": 123,
"days": 123,
"amount_breakdown": {
"principal": 123,
"interest": 123,
"fees": 123
}
},
"terms": {
"effective_interest_rate": "5.250000",
"interest_rate": "5.250000",
"expected_maturity_date": "2023-12-25",
"duration": {
"length": 1
},
"repayment": {
"expected_payment_frequency_interval_days": 365,
"expected_number_of_payments": 1,
"expected_first_payment_date": "2023-12-25",
"expected_first_payment_amount": 1,
"expected_last_payment_date": "2023-12-25",
"expected_last_payment_amount": 1,
"expected_payment_amount": 1
}
}
}
'import requests
url = "https://api.sandbox.lead.bank/v2/user_credit_balances/{user_credit_balance_id}"
payload = {
"metadata": {},
"past_due": {
"amount": 123,
"days": 123,
"amount_breakdown": {
"principal": 123,
"interest": 123,
"fees": 123
}
},
"terms": {
"effective_interest_rate": "5.250000",
"interest_rate": "5.250000",
"expected_maturity_date": "2023-12-25",
"duration": { "length": 1 },
"repayment": {
"expected_payment_frequency_interval_days": 365,
"expected_number_of_payments": 1,
"expected_first_payment_date": "2023-12-25",
"expected_first_payment_amount": 1,
"expected_last_payment_date": "2023-12-25",
"expected_last_payment_amount": 1,
"expected_payment_amount": 1
}
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
metadata: {},
past_due: {
amount: 123,
days: 123,
amount_breakdown: {principal: 123, interest: 123, fees: 123}
},
terms: {
effective_interest_rate: '5.250000',
interest_rate: '5.250000',
expected_maturity_date: '2023-12-25',
duration: {length: 1},
repayment: {
expected_payment_frequency_interval_days: 365,
expected_number_of_payments: 1,
expected_first_payment_date: '2023-12-25',
expected_first_payment_amount: 1,
expected_last_payment_date: '2023-12-25',
expected_last_payment_amount: 1,
expected_payment_amount: 1
}
}
})
};
fetch('https://api.sandbox.lead.bank/v2/user_credit_balances/{user_credit_balance_id}', 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/v2/user_credit_balances/{user_credit_balance_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'metadata' => [
],
'past_due' => [
'amount' => 123,
'days' => 123,
'amount_breakdown' => [
'principal' => 123,
'interest' => 123,
'fees' => 123
]
],
'terms' => [
'effective_interest_rate' => '5.250000',
'interest_rate' => '5.250000',
'expected_maturity_date' => '2023-12-25',
'duration' => [
'length' => 1
],
'repayment' => [
'expected_payment_frequency_interval_days' => 365,
'expected_number_of_payments' => 1,
'expected_first_payment_date' => '2023-12-25',
'expected_first_payment_amount' => 1,
'expected_last_payment_date' => '2023-12-25',
'expected_last_payment_amount' => 1,
'expected_payment_amount' => 1
]
]
]),
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/v2/user_credit_balances/{user_credit_balance_id}"
payload := strings.NewReader("{\n \"metadata\": {},\n \"past_due\": {\n \"amount\": 123,\n \"days\": 123,\n \"amount_breakdown\": {\n \"principal\": 123,\n \"interest\": 123,\n \"fees\": 123\n }\n },\n \"terms\": {\n \"effective_interest_rate\": \"5.250000\",\n \"interest_rate\": \"5.250000\",\n \"expected_maturity_date\": \"2023-12-25\",\n \"duration\": {\n \"length\": 1\n },\n \"repayment\": {\n \"expected_payment_frequency_interval_days\": 365,\n \"expected_number_of_payments\": 1,\n \"expected_first_payment_date\": \"2023-12-25\",\n \"expected_first_payment_amount\": 1,\n \"expected_last_payment_date\": \"2023-12-25\",\n \"expected_last_payment_amount\": 1,\n \"expected_payment_amount\": 1\n }\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.sandbox.lead.bank/v2/user_credit_balances/{user_credit_balance_id}")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {},\n \"past_due\": {\n \"amount\": 123,\n \"days\": 123,\n \"amount_breakdown\": {\n \"principal\": 123,\n \"interest\": 123,\n \"fees\": 123\n }\n },\n \"terms\": {\n \"effective_interest_rate\": \"5.250000\",\n \"interest_rate\": \"5.250000\",\n \"expected_maturity_date\": \"2023-12-25\",\n \"duration\": {\n \"length\": 1\n },\n \"repayment\": {\n \"expected_payment_frequency_interval_days\": 365,\n \"expected_number_of_payments\": 1,\n \"expected_first_payment_date\": \"2023-12-25\",\n \"expected_first_payment_amount\": 1,\n \"expected_last_payment_date\": \"2023-12-25\",\n \"expected_last_payment_amount\": 1,\n \"expected_payment_amount\": 1\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.lead.bank/v2/user_credit_balances/{user_credit_balance_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": {},\n \"past_due\": {\n \"amount\": 123,\n \"days\": 123,\n \"amount_breakdown\": {\n \"principal\": 123,\n \"interest\": 123,\n \"fees\": 123\n }\n },\n \"terms\": {\n \"effective_interest_rate\": \"5.250000\",\n \"interest_rate\": \"5.250000\",\n \"expected_maturity_date\": \"2023-12-25\",\n \"duration\": {\n \"length\": 1\n },\n \"repayment\": {\n \"expected_payment_frequency_interval_days\": 365,\n \"expected_number_of_payments\": 1,\n \"expected_first_payment_date\": \"2023-12-25\",\n \"expected_first_payment_amount\": 1,\n \"expected_last_payment_date\": \"2023-12-25\",\n \"expected_last_payment_amount\": 1,\n \"expected_payment_amount\": 1\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "user_credit_balance_1HCpXwx2EK9oYluWbacgeCnFcLf",
"created_at": "2023-11-07T05:31:56Z",
"user_account_id": "user_account_xyz123",
"name": "Personal Loan - Jane Smith",
"status": "active",
"status_reason": "active",
"currency_code": "USD",
"amount": 123,
"amount_in_usd": 123,
"amount_breakdown": {
"principal": 123,
"interest": 123,
"fees": 123
},
"fees": {
"accrued": 123
},
"rewards": {
"amount": 123,
"unit": "USD"
},
"dispute": {
"amount": 123,
"amount_breakdown": {
"principal": 123,
"interest": 123,
"fees": 123
}
},
"charge_off": {
"amount": 123,
"amount_breakdown": {
"principal": 123,
"interest": 123,
"fees": 123
}
},
"past_due": {
"amount": 123,
"days": 123,
"amount_breakdown": {
"principal": 123,
"interest": 123,
"fees": 123
}
},
"autopay_method": "ach",
"terms": {
"structure": "revolving",
"interest_rate": "5.250000",
"effective_interest_rate": "5.250000",
"effective_apr": "5.250000",
"expected_maturity_date": "2023-12-25",
"repayment": {
"expected_payment_frequency": "business_daily",
"expected_payment_frequency_interval_days": 123,
"expected_number_of_payments": 123,
"expected_first_payment_date": "2023-12-25",
"expected_first_payment_amount": 123,
"expected_last_payment_date": "2023-12-25",
"expected_last_payment_amount": 123,
"expected_payment_amount": 123
},
"max_funding_amount": 123,
"duration": {
"length": 123,
"unit": "days"
},
"expected_finance_charge_amount": 123
},
"metadata": {},
"closed_at": "2023-11-07T05:31:56Z"
}{
"code": "authentication_missing",
"message": "The request has no authentication credentials. Send your API token in the Authorization header.",
"errors": [
{
"code": "authentication_missing",
"message": "The Authorization header is missing. Send your API token as a bearer token.",
"parameters": [
"Authorization"
]
}
]
}{
"code": "internal_server_error",
"message": "Internal server error. Retry with exponential backoff. For a POST, PATCH or DELETE, reuse the same Idempotency-Key so the request isn't processed twice. If it keeps failing, contact Lead with the Lead-Request-ID."
}See Errors for the common errors every v2 endpoint can return.
Authorizations
Path Parameters
Body
application/json
Request body for updating an existing User Credit Balance. Only autopay_method,
metadata, past_due, and terms can be updated. Amount-row fields
(amount, amount_in_usd, amount_breakdown, rewards, dispute, charge_off)
and other fields can't be changed after the balance is created.
Response
Credit Balance updated successfully
A user credit balance — a virtual end-customer credit position.
Was this page helpful?

