Get Salary Loan

get/lending-service/api/v1/salary/loan

Request

  • Base URL
    https://sandbox.interswitchng.com
  • URL
    https://sandbox.interswitchng.com/lending-service/api/v1/salary/loan
  • Auth
    OAuth 2

Headers

Authorizationstring

Request body

customerIdstring required

The phone number of the customer in 234 format. Max: 13

channelCodestring required

The channel’s unique code. Max: 50

providerCodestring

The provider code of the salary lender. Max: 50

amountnumber double

The loan amount

amountPayableinteger

The amount to be repaid by the customer

accountNumberstring

The customer’s bank account. Max: 50

bankCodestring required

The bank code of the associated customer’s bank

tenurestring required

The loan tenure in days

offeridstring required

The unique offer identifier for the customer’s loan. Max: 50

interestnumber double required

The percentage interest on the loan

loanSchemeCodestring required

The channel’s identifier for the salary offer/loan record

Response

200

responseCodestring
responseMessagestring
transactionRefstring
transactionIdstring
loanIdstring

Example response

{
  "responseCode": "S00",
  "responseMessage": "Salary loan successfully disbursed",
  "transactionRef": "BOL|LOC|CA|FBN|AC|180121151014|9MUN9QE94J",
  "transactionId": "0432529007994",
  "loanId": "APPMRT12345"
}

Changes

No recorded changes to this operation across all 1 revision of this API.