Skip to main content
GET
Get Repayment Schedule

Overview

Returns the complete repayment schedule for an active loan, including due dates, principal, interest, and payment status per instalment.
Note: The :loanId path parameter is the loan ID (field loan_id on the application record, populated after disbursement) — not the application_id.

Request

Method: GET
URL: /v1/loans/:loanId/repayments

Parameters

Response

200 OK

Error Responses

Authorizations

apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

x-carbon-key
string
required

Path Parameters

loanId
string
required

Loan ID from the application record (loan_id field, not application_id)

Response

200 - application/json

Successful response

The response is of type object.