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

# Get Salary Loan

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "ipg",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://sandbox.interswitchng.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/lending-service/api/v1/salary/loan": {
      "post": {
        "summary": "Get Salary Loan",
        "description": "",
        "operationId": "get-salary-loan",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "customerId",
                  "channelCode",
                  "providerCode",
                  "amount",
                  "amountPayable",
                  "accountNumber",
                  "bankCode",
                  "tenure",
                  "offerid",
                  "interest",
                  "loanSchemeCode",
                  "borrowerName",
                  "accountName",
                  "companyName",
                  "phoneNumber"
                ],
                "properties": {
                  "customerId": {
                    "type": "string",
                    "description": "The phone number of the customer in 234 format. Max: 13",
                    "default": "2348161286422"
                  },
                  "channelCode": {
                    "type": "string",
                    "description": "The channel’s unique code. Max: 50",
                    "default": "APT"
                  },
                  "providerCode": {
                    "type": "string",
                    "description": "The provider code of the salary lender. Max: 50"
                  },
                  "amount": {
                    "type": "number",
                    "description": "The loan amount  in minor denomination (#1000===100000)",
                    "format": "double"
                  },
                  "amountPayable": {
                    "type": "integer",
                    "description": "The amount to be repaid by the customer",
                    "format": "int64"
                  },
                  "accountNumber": {
                    "type": "string",
                    "description": "The customer’s bank account. Max: 50"
                  },
                  "bankCode": {
                    "type": "string",
                    "description": "The bank code of the associated customer’s bank"
                  },
                  "tenure": {
                    "type": "string",
                    "description": "The loan tenure in days"
                  },
                  "offerid": {
                    "type": "string",
                    "description": "The unique offer identifier for the customer’s loan. Max: 50"
                  },
                  "interest": {
                    "type": "number",
                    "description": "The percentage interest on the loan",
                    "format": "double"
                  },
                  "loanSchemeCode": {
                    "type": "string",
                    "description": "The channel’s identifier for the salary offer/loan record"
                  },
                  "borrowerName": {
                    "type": "string",
                    "description": "The customer’s name"
                  },
                  "accountName": {
                    "type": "string",
                    "description": "The customer’s account name"
                  },
                  "companyName": {
                    "type": "string",
                    "description": "The customer’s company name"
                  },
                  "phoneNumber": {
                    "type": "string",
                    "description": "The phone number of the customer in 234 format"
                  },
                  "bvn": {
                    "type": "string",
                    "description": "The customer’s BVN"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"responseCode\": \"S00\",\n  \"responseMessage\": \"Salary loan successfully disbursed\",\n  \"transactionRef\": \"BOL|LOC|CA|FBN|AC|180121151014|9MUN9QE94J\",\n  \"transactionId\": \"0432529007994\",\n  \"loanId\": \"APPMRT12345\"\n}\n"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "responseCode": {
                      "type": "string",
                      "example": "S00"
                    },
                    "responseMessage": {
                      "type": "string",
                      "example": "Salary loan successfully disbursed"
                    },
                    "transactionRef": {
                      "type": "string",
                      "example": "BOL|LOC|CA|FBN|AC|180121151014|9MUN9QE94J"
                    },
                    "transactionId": {
                      "type": "string",
                      "example": "0432529007994"
                    },
                    "loanId": {
                      "type": "string",
                      "example": "APPMRT12345"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"responseCode\": \"01\",\n  \"responseMessage\": \"Failed (Unrecognized terminal owner)\",\n  \"transactionId\": \"0432498810390\"\n}\n"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "responseCode": {
                      "type": "string",
                      "example": "01"
                    },
                    "responseMessage": {
                      "type": "string",
                      "example": "Failed (Unrecognized terminal owner)"
                    },
                    "transactionId": {
                      "type": "string",
                      "example": "0432498810390"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```