m2pfintech

Get loans by status

Retrieves a list of loan details for a given entity filtered by loan status. Supports pagination via offset and pageNo query parameters. Optionally allows discarding specific response components.

POST
/loan/getByStatus

Query Parameters

offset?integer

Number of records per page. Defaults to 5.

Default5
pageNo?integer

Zero-based page number. Defaults to 0.

Default0
discard_components?string

Comma-separated list of response components to discard.

Header Parameters

TENANT*string

Tenant identifier for the request.

Request Body

application/json

entityId*string

The entity (customer) identifier.

status?string

Enumeration of possible loan statuses.

Value in"ACTIVE" | "CANCELLED" | "CLOSED" | "PRE_CLOSED" | "RETURNED"

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://uat-m2p-ccms.m2pfintech.com/loan/getByStatus" \  -H "TENANT: string" \  -H "Content-Type: application/json" \  -d '{    "entityId": "string"  }'
[
  {
    "actualLoanId": "string",
    "loanId": "string",
    "loanAmount": 0,
    "interestRate": 0,
    "tenure": "string",
    "emiAmount": 0,
    "brokenPeriodInterest": "string",
    "totalPrincipal": 0,
    "principalOverdue": 0,
    "principalPaid": 0,
    "principalOutstanding": 0,
    "totalPaid": 0,
    "totalInterest": 0,
    "interestOutstanding": 0,
    "interestOverdue": 0,
    "interestWaived": 0,
    "interestPaid": 0,
    "totalFee": 0,
    "feeOverdue": 0,
    "feeOutstanding": 0,
    "feeWaived": 0,
    "totalFeePaid": 0,
    "totalTax": 0,
    "processingFee": 0,
    "processingFeeTax": 0,
    "numberOfDueRepayments": "string",
    "numberOfPaidRepayments": "string",
    "numberOfRepayments": "string",
    "disbursedDate": "string",
    "discountAmount": 0,
    "totalRepayment": 0,
    "totalExpectedRepayment": 0,
    "totalOutstanding": 0,
    "totalOverDue": 0,
    "totalWaivedOff": 0,
    "currentAmortizations": [
      {
        "installmentNumber": 0,
        "dueDate": "2019-08-24",
        "emiAmount": 0,
        "principal": 0,
        "interest": 0,
        "fee": 0,
        "tax": 0,
        "outstandingPrincipal": 0,
        "status": "string"
      }
    ],
    "originalAmortizations": [
      {
        "installmentNumber": 0,
        "dueDate": "2019-08-24",
        "emiAmount": 0,
        "principal": 0,
        "interest": 0,
        "fee": 0,
        "tax": 0,
        "outstandingPrincipal": 0,
        "status": "string"
      }
    ],
    "transactions": [
      {
        "transactionId": "string",
        "transactionDate": "2019-08-24",
        "transactionType": "string",
        "amount": 0,
        "description": "string",
        "status": "string"
      }
    ],
    "loanStatus": "ACTIVE",
    "isLoanCancelApplicable": true,
    "isLoanRescheduleApplicable": true,
    "isLoanPreClosureApplicable": true,
    "description": "string",
    "category": "string",
    "loanProductId": "string",
    "created": "2024-01-15 10:30:00",
    "refundDetails": [
      {
        "refundId": "string",
        "refundAmount": 0,
        "refundDate": "2019-08-24",
        "refundStatus": "string",
        "description": "string"
      }
    ],
    "loanAgreementFileUrl": "string"
  }
]
{
  "code": "string",
  "message": "string",
  "details": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "code": "string",
  "message": "string",
  "details": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "code": "string",
  "message": "string",
  "details": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}