Skip to main content
GET
/
v1
/
loans
/
{loanId}
/
repayments
Get Repayment Schedule
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{loanId}/repayments \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
{
  "status": "success",
  "message": "Repayment schedule fetched",
  "data": {
    "schedule": [
      {
        "dueDate": "2025-02-15",
        "principalDue": 6666666,
        "interestDue": 533333,
        "totalDue": 7199999,
        "paidAmount": 0,
        "status": "UNPAID"
      },
      {
        "dueDate": "2025-03-15",
        "principalDue": 6666666,
        "interestDue": 480000,
        "totalDue": 7146666,
        "paidAmount": 0,
        "status": "UNPAID"
      }
    ]
  }
}

​
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

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
loanIdPathstringYesLoan ID from the application record (loan_id field).

​
Response

​
200 OK

{
  "status": "success",
  "message": "Repayment schedule fetched",
  "data": {
    "schedule": [
      {
        "dueDate": "2025-02-15",
        "principalDue": 6666666,
        "interestDue": 533333,
        "totalDue": 7199999,
        "paidAmount": 0,
        "status": "UNPAID"
      },
      {
        "dueDate": "2025-03-15",
        "principalDue": 6666666,
        "interestDue": 480000,
        "totalDue": 7146666,
        "paidAmount": 0,
        "status": "UNPAID"
      }
    ]
  }
}

​
Error Responses

StatusMessageCause
400Loan not foundloanId does not match any loan under this merchant
422No SME loan ID on recordLoan not yet registered in lending engine

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.