Skip to main content
GET
Paginated journal history for a loan

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.

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

from_date
string<date>
to_date
string<date>
event_type
enum<string>
Available options:
disbursement,
disbursement_settled,
accrual,
payment_received,
payment_allocated,
payment_returned,
fee_assessed,
fee_waived,
chargeoff,
recovery,
refinance,
restructure,
reversal,
manual_adjustment
page_size
integer
default:50
Required range: 1 <= x <= 500
page_token
string
Maximum string length: 512

Response

200 - application/json

Page of journal entries

items
object[]
required
next_page_token
string

Opaque cursor. Absent when no more pages.