Get loan specific transaction

GET /api/v1/Loans/:LoanId/transactions

Description

This endpoint is used to retrieve all transactions associated with a specific loan.

Tags:
Loans

URL:
/api/v{version}/Loans/{LoanId}/transactions

ApiKey:
No API key required

Content-Type:
No request body

Query Parameters:
version: string, required
Accept-Language: header, optional, change the default response message language from English (en) to French (fr) or English (en)

Response:
Success, returns the list of transactions associated with the loan.

Error Codes:
400: Bad Request
404: Resource not found
500: Internal server error

Example:

GET /api/v1/Loans/123/transactions
Accept-Language: fr

/api/v1/Loans/:LoanId/transactions

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Accept	text/plain

Response: 200

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": [
    {
      "id": `<integer>`,
      "officeId": `<integer>`,
      "officeName": `<string>`,
      "type": {
        "id": `<integer>`,
        "code": `<string>`,
        "value": `<string>`,
        "disbursement": `<boolean>`,
        "repaymentAtDisbursement": `<boolean>`,
        "repayment": `<boolean>`,
        "contra": `<boolean>`,
        "waiveInterest": `<boolean>`,
        "waiveCharges": `<boolean>`,
        "accrual": `<boolean>`,
        "writeOff": `<boolean>`,
        "recoveryRepayment": `<boolean>`,
        "initiateTransfer": `<boolean>`,
        "approveTransfer": `<boolean>`,
        "withdrawTransfer": `<boolean>`,
        "rejectTransfer": `<boolean>`,
        "chargePayment": `<boolean>`,
        "refund": `<boolean>`,
        "refundForActiveLoans": `<boolean>`
      },
      "date": [
        `<integer>`,
        `<integer>`
      ],
      "currency": {
        "code": `<string>`,
        "name": `<string>`,
        "decimalPlaces": `<integer>`,
        "displaySymbol": `<string>`,
        "nameCode": `<string>`,
        "displayLabel": `<string>`,
        "inMultiplesOf": `<integer>`
      },
      "amount": `<double>`,
      "netDisbursalAmount": `<double>`,
      "principalPortion": `<integer>`,
      "interestPortion": `<double>`,
      "feeChargesPortion": `<integer>`,
      "penaltyChargesPortion": `<integer>`,
      "overpaymentPortion": `<integer>`,
      "unrecognizedIncomePortion": `<integer>`,
      "outstandingLoanBalance": `<double>`,
      "submittedOnDate": [
        `<integer>`,
        `<integer>`
      ],
      "manuallyReversed": `<boolean>`,
      "numberOfRepayments": `<integer>`
    },
    {
      "id": `<integer>`,
      "officeId": `<integer>`,
      "officeName": `<string>`,
      "type": {
        "id": `<integer>`,
        "code": `<string>`,
        "value": `<string>`,
        "disbursement": `<boolean>`,
        "repaymentAtDisbursement": `<boolean>`,
        "repayment": `<boolean>`,
        "contra": `<boolean>`,
        "waiveInterest": `<boolean>`,
        "waiveCharges": `<boolean>`,
        "accrual": `<boolean>`,
        "writeOff": `<boolean>`,
        "recoveryRepayment": `<boolean>`,
        "initiateTransfer": `<boolean>`,
        "approveTransfer": `<boolean>`,
        "withdrawTransfer": `<boolean>`,
        "rejectTransfer": `<boolean>`,
        "chargePayment": `<boolean>`,
        "refund": `<boolean>`,
        "refundForActiveLoans": `<boolean>`
      },
      "date": [
        `<integer>`,
        `<integer>`
      ],
      "currency": {
        "code": `<string>`,
        "name": `<string>`,
        "decimalPlaces": `<integer>`,
        "displaySymbol": `<string>`,
        "nameCode": `<string>`,
        "displayLabel": `<string>`,
        "inMultiplesOf": `<integer>`
      },
      "amount": `<double>`,
      "netDisbursalAmount": `<double>`,
      "principalPortion": `<integer>`,
      "interestPortion": `<double>`,
      "feeChargesPortion": `<integer>`,
      "penaltyChargesPortion": `<integer>`,
      "overpaymentPortion": `<integer>`,
      "unrecognizedIncomePortion": `<integer>`,
      "outstandingLoanBalance": `<double>`,
      "submittedOnDate": [
        `<integer>`,
        `<integer>`
      ],
      "manuallyReversed": `<boolean>`,
      "numberOfRepayments": `<integer>`
    }
  ]
}