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

# Payment Notification

When the Service receives a Payment Notification request, it is expected to send a request down to the Provider to notify them of the payment. The provider is in-turn expected to return a response containing the status and other details of the loan.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "lending-service",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://lender.com"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/endpoint": {
      "post": {
        "summary": "Payment Notification",
        "description": "",
        "operationId": "payment-notification",
        "parameters": [
          {
            "name": "username",
            "in": "header",
            "description": "Username to be used by the Lender",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "password",
            "in": "header",
            "description": "Password to be used by the lender",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "loanId",
                  "paymentRef",
                  "Amount",
                  "customerId"
                ],
                "properties": {
                  "loanId": {
                    "type": "string",
                    "description": "The id of the Loan for which the payment is made."
                  },
                  "paymentRef": {
                    "type": "string",
                    "description": "The Reference to the payment that was done. This can be used by the Provider to do dispute settlement or investigate."
                  },
                  "Amount": {
                    "type": "string",
                    "description": "The Code of the Loan generated by ILS. This will be used by the provider for later requests to the ILS."
                  },
                  "customerId": {
                    "type": "string",
                    "description": "The Email or Mobile Number of the User who made the payment."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{ \n  “responseCode”: “00”, \n “responseMessage”: “Successful”, \n  “loanStatus”: “CLOSED”\n}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{ \n“responseCode”: “4004”,\n “responseMessage”: “Invalid offer Id.” \n}"
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```