v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Loan Accounts

Get active loan schedule

Returns ordered active loan installment schedule entries. A malformed UUID yields 422, distinct from 404.

get/api/v1/loan-accounts/{id}/schedule

Path parameters

idstring uuid required

Loan account identifier (UUID).

Example:550e8400-e29b-41d4-a716-446655440000

Loan account identifier (UUID).

Response

jurisdictionCodestring required

ISO 3166-1 jurisdiction code the account operates under (e.g. BR).

profileVersionstring required

Product profile version applied to this account.

Example response

{
  "data": [
    {
      "dueDate": "2026-06-14",
      "feesAmount": "1.50",
      "installmentNumber": 3,
      "interestAmount": "12.34",
      "penaltiesAmount": "0.00",
      "principalAmount": "100.00",
      "status": "upcoming",
      "totalAmount": "113.84"
    }
  ],
  "jurisdictionCode": "BR",
  "profileVersion": "1.0.0"
}