Sign in
Loans

Loan Summary

get/v1/loan/summary/{loanId}

Path parameters

loanIdstring required

Headers

accept-languagestring

Language of the response, supported languages: en-us, in

Response

Loan summary details

statusCodenumber required

The HTTP status code of the error

messagestring required

Human-readable message containing all available details about the operation

successboolean required

A boolean indicating whether this was a success response or an error response

Example response

{
  "data": {
    "loanStatus": "active",
    "loanType": "BNPL",
    "loanTerm": 30,
    "loanAmount": 3500,
    "totalServiceFee": 99.17,
    "totalServiceFeeDue": 99.17,
    "loanDueDate": "18 September 2023",
    "dueDatePostGracePeriod": "21 September 2023",
    "gracePeriodInDays": 3,
    "requestedDate": "18 Aug 2023",
    "repaymentSchedule": [
      {
        "dueDate": "18 September 2023",
        "totalDueForPeriod": 3599.17,
        "totalServiceFeeForPeriod": 99.17,
        "totalServiceFeeDueForPeriod": 99.17,
        "principalDueForPeriod": 3500,
        "dueDatePostGracePeriod": "21 September 2023"
      }
    ],
    "payments": [
      {
        "paymentMethod": "Bank Transfer/UEN Payment/QR Code Payment"
      }
    ]
  }
}