Skip to main content
GET
/
loans
/
{loan_id}
/
balance
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>'
{
  "loan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "<string>",
  "as_of_date": "2023-12-25",
  "principal_outstanding_minor": "<string>",
  "interest_receivable_minor": "<string>",
  "fees_receivable_minor": "<string>",
  "total_exposure_minor": "<string>",
  "last_activity_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.clarivo.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

​
X-Trace-Id
string

Deprecated — use traceparent instead (ADR-0011). Client-supplied correlation ID. Accepted until 2026-10-01 for backward compatibility; will be removed after that date.

Pattern: ^[A-Za-z0-9\-]{8,128}$

Path Parameters

​
loan_id
string<uuid>
required
Pattern: ^[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}$
Example:

"11111111-1111-1111-1111-111111111111"

Query Parameters

​
as_of_date
string<date>

Point-in-time balance; defaults to now.

Response

Loan balance

​
loan_id
string<uuid>
required
Pattern: ^[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}$
Example:

"11111111-1111-1111-1111-111111111111"

​
currency
string
required

ISO 4217 three-letter currency code.

Required string length: 3
Pattern: ^[A-Z]{3}$
Examples:

"USD"

"MXN"

"EUR"

​
as_of_date
string<date>
required
​
principal_outstanding_minor
string
required

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.

Required string length: 1 - 19
Pattern: ^(0|[1-9][0-9]{0,18})$
Examples:

"88849"

"10000000"

​
interest_receivable_minor
string
required

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.

Required string length: 1 - 19
Pattern: ^(0|[1-9][0-9]{0,18})$
Examples:

"88849"

"10000000"

​
fees_receivable_minor
string
required

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.

Required string length: 1 - 19
Pattern: ^(0|[1-9][0-9]{0,18})$
Examples:

"88849"

"10000000"

​
total_exposure_minor
string
required

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.

Required string length: 1 - 19
Pattern: ^(0|[1-9][0-9]{0,18})$
Examples:

"88849"

"10000000"

​
last_activity_at
string<date-time>

RFC 3339 timestamp, UTC.