---
updatedAt: 2025-11-11T00:10:14.000Z
agentTools:
  projectIndex: https://docs.interswitchgroup.com/v1.1/llms.txt
---

# Get Loan Status

Lender is meant to provide an endpoint to this specification

# sample request:

<https://lender.com/api/v1/interswitchlending/webhook/get-loan-status/1392?customerId=2347030066532&providerCode=MKT&channelCode=QTUSSD>

## Response Descriptions

| Field | Field Name      | Data Type       | Max Length | Required | Description                                                                                                                            |
| ----- | --------------- | --------------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| 1     | responseCode    | string          |            | true     | The Code representing the status of the processing of the request. It shows whether the request to accept the offer is allowed or not. |
| 2     | responseMessage | string          |            | true     | The Description of the Response Code from above.                                                                                       |
| 3     | loan            | string          |            | true     | An Object containing the details of the loan requested.                                                                                |
| 4     | status          | ENUM            |            | true     | The Status of the Loan whether it has been paid or not, overdue or not.                                                                |
| 5     | remainingAmount | Long            |            | true     | The Amount remaining for the Customer to paid that will make the loan fully paid.                                                      |
|       | dueDate         | Date Time (UTC) |            | true     | The Date/Time at which the Customer is expected to have paid back the loan.                                                            |

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "lending-service",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://lender.com"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/{endpoint}/{loanId}?customerId={customerId}&channelCode={channelCode}": {
      "get": {
        "summary": "Get Loan Status",
        "description": "Lender is meant to provide an endpoint to this specification",
        "operationId": "get-loan-status",
        "parameters": [
          {
            "name": "customerId",
            "in": "query",
            "description": "The Mobile Number of the User.",
            "required": true,
            "schema": {
              "type": "string",
              "default": "2348123456789"
            }
          },
          {
            "name": "loanId",
            "in": "query",
            "description": "The ID of the Loan for which status is being requested.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "providerCode",
            "in": "query",
            "description": "The Code of the Provider that offered the loan.",
            "required": true,
            "schema": {
              "type": "string",
              "default": "PTB"
            }
          },
          {
            "name": "channelCode",
            "in": "query",
            "description": "The Code of the Channel from which this request originates.",
            "required": true,
            "schema": {
              "type": "string",
              "default": "QTUSSD"
            }
          },
          {
            "name": "loanId",
            "in": "path",
            "schema": {
              "type": "string",
              "default": "10000000058"
            },
            "required": true
          },
          {
            "name": "Authorization",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "\n{\n“responseCode”: “00”,\n“responseMessage”: “Successful”,\n“loan”: {\n“status”: “OPEN”,\n“remainingAmount”: “0.00”,\n“dueDate”: “2017-06-12T11:46:15Z”\n}\n"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n“responseCode”: “4004”,\n“responseMessage”: “Unknown offer”\n\n}"
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "x-readme": {
          "code-samples": [
            {
              "language": "text",
              "code": "https://lender.com/api/v1/interswitchlending/webhook/get-loan-status/1392?customerId=2347030066532&providerCode=MKT&channelCode=QTUSSD"
            }
          ],
          "samples-languages": [
            "text"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```