curl --request GET \
--url https://ledger.clarivo.co/v1/loans/{loan_id}/balance \
--header 'Authorization: Bearer <token>'import requests
url = "https://ledger.clarivo.co/v1/loans/{loan_id}/balance"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://ledger.clarivo.co/v1/loans/{loan_id}/balance', 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://ledger.clarivo.co/v1/loans/{loan_id}/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://ledger.clarivo.co/v1/loans/{loan_id}/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://ledger.clarivo.co/v1/loans/{loan_id}/balance")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://ledger.clarivo.co/v1/loans/{loan_id}/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"loan_id": "11111111-1111-1111-1111-111111111111",
"currency": "USD",
"as_of_date": "2023-12-25",
"principal_outstanding_minor": "88849",
"interest_receivable_minor": "88849",
"fees_receivable_minor": "88849",
"total_exposure_minor": "88849",
"last_activity_at": "2023-11-07T05:31:56Z"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}Current balance for a loan (all sub-accounts)
curl --request GET \
--url https://ledger.clarivo.co/v1/loans/{loan_id}/balance \
--header 'Authorization: Bearer <token>'import requests
url = "https://ledger.clarivo.co/v1/loans/{loan_id}/balance"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://ledger.clarivo.co/v1/loans/{loan_id}/balance', 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://ledger.clarivo.co/v1/loans/{loan_id}/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://ledger.clarivo.co/v1/loans/{loan_id}/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://ledger.clarivo.co/v1/loans/{loan_id}/balance")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://ledger.clarivo.co/v1/loans/{loan_id}/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"loan_id": "11111111-1111-1111-1111-111111111111",
"currency": "USD",
"as_of_date": "2023-12-25",
"principal_outstanding_minor": "88849",
"interest_receivable_minor": "88849",
"fees_receivable_minor": "88849",
"total_exposure_minor": "88849",
"last_activity_at": "2023-11-07T05:31:56Z"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}{
"type": "https://errors.hpts.example.com/bad_request",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"trace_id": "<string>"
}Authorizations
OAuth2 JWT bearer tokens. Tokens are validated at API Gateway via a
Lambda Authorizer that verifies signature against the issuer's JWKS,
checks iss, aud, exp, nbf, and the tenant_id custom claim.
Granular scopes are required per operation.
Headers
Deprecated — use traceparent instead (ADR-0011).
Client-supplied correlation ID. Accepted until 2026-10-01 for
backward compatibility; will be removed after that date.
^[A-Za-z0-9\-]{8,128}$Path Parameters
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"11111111-1111-1111-1111-111111111111"
Query Parameters
Point-in-time balance; defaults to now.
Response
Loan balance
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"11111111-1111-1111-1111-111111111111"
ISO 4217 three-letter currency code.
3^[A-Z]{3}$"USD"
"MXN"
"EUR"
Non-negative integer amount in the currency's minor unit, serialized as a string to preserve precision (JS numbers cannot safely represent values above 2^53). BIGINT on the wire, BIGINT in the database.
1 - 19^(0|[1-9][0-9]{0,18})$"88849"
"10000000"
Non-negative integer amount in the currency's minor unit, serialized as a string to preserve precision (JS numbers cannot safely represent values above 2^53). BIGINT on the wire, BIGINT in the database.
1 - 19^(0|[1-9][0-9]{0,18})$"88849"
"10000000"
Non-negative integer amount in the currency's minor unit, serialized as a string to preserve precision (JS numbers cannot safely represent values above 2^53). BIGINT on the wire, BIGINT in the database.
1 - 19^(0|[1-9][0-9]{0,18})$"88849"
"10000000"
Non-negative integer amount in the currency's minor unit, serialized as a string to preserve precision (JS numbers cannot safely represent values above 2^53). BIGINT on the wire, BIGINT in the database.
1 - 19^(0|[1-9][0-9]{0,18})$"88849"
"10000000"
RFC 3339 timestamp, UTC.
