Skip to main content

GetCustomerLoanDetailsQuery

Overview​

Retrieves comprehensive details for a specific loan application including all supporting documents, approval status, and processing information.

Status: 📝 Documentation in progress

Command Structure​

{
  "cmd": "GetCustomerLoanDetailsQuery",
  "data": "{\"userId\":\"129\",\"loanQuoteId\":\"110\"}"
}

Parameters​

ParameterTypeRequiredDescription
userIdlongYesCustomer ID
loanQuoteIdlongYesLoan application ID

Response Fields​

Returns complete loan quote information including:

  • Loan amount, requested amount, approved amount, repayment amount
  • Branch metadata: branchId, branchName, branchCode, organisationCode, organisationName
  • Schedule metadata: LoanRepaymentSchedules with installment number, due date, principal, interest, total due, and outstanding balance
  • Approval state and current approval level
  • Disbursement status
  • All attached documents (identity, address, guarantors, credit reports, statements)
  • Approval history and comments
  • CanCustomerCancel, indicating whether the authenticated customer may cancel the draft
  • OfficerDetails for an admin-assisted application, including the officer's name, contact information, branch, and roles

Response Example​

{
  "isSuccessful": true,
  "statusCode": "00",
  "message": "Loan details retrieved successfully",
  "data": {
    "loanQuote": {
      "id": 110,
      "loanAmount": 500000,
      "requestedAmount": 500000,
      "approvedAmount": 500000,
      "approvedLoanAmount": 500000,
      "branchId": 23,
      "branchCode": "LAG-001",
      "branchName": "Ikeja Branch",
      "organisationCode": "ORG-001",
      "organisationName": "Main Organisation",
      "loanTenor": 12,
      "interestRate": 15,
      "repaymentAmount": 45620.5,
      "loanRepaymentSchedules": [
        {
          "installmentNumber": 1,
          "dueDate": "2026-10-05T00:00:00",
          "principalAmount": 37500,
          "interestAmount": 8120.5,
          "totalDue": 45620.5,
          "outstandingBalance": 462500,
          "status": 0,
          "statusDescription": "Pending"
        }
      ]
    }
  }
}

Notes​

  • requestedAmount is the customer-requested principal.
  • approvedAmount and approvedLoanAmount both resolve to LoanAmountRecommended when present; otherwise they fall back to RequestedAmount.
  • LoanRepaymentSchedules is the canonical installment list used by scripts and document rendering.
  • Branch and organisation metadata are populated from the branch hierarchy: branch → area → division → organisation.

See Also​