1. Home
  2. Interswitch lending Service
  3. Interswitch Lending Service (Channels)
  4. Get Offers V3

Get Offers V3

This endpoint is to get offers available to a user/customer from a specified Credit Company (Provider / Lender).

Request Message Description

Field#Field nameData typeMax lengthRequiredDescription
1customerIdString
trueThe Email or Mobile Number of the Customer for which offers are been requested.
2channelCodeString
trueThe Code of the Channel from which this request is originating.
5amountNumeric String
falseThe Amount of Loan that the customer wishes to take (in Kobo).
6serviceTypeString
falseThe service type code
7bvnString
falseCustomer’s bank verification number
8dateOfBirthString
tureCustomer’s date of birth in the format yyyy-MM-dd

Endpoint

GET /v3/offers?customerId={customerId}&channelCode={channelCode}&providerCode={providerCode}&amount={amount}&serviceType={serviceType}&bvn={bvn}&dateOfBirth={dateOfBirth}

Headers

Authorization: Bearer {{token}}

Sample Request

/v3/offers?customerId=2348123456789&channelCode=0002&providerCode=ABCREDIT&amount=5000000&serviceType=LOAN&bvn=11111111111&dateOfBirth=1960-10-01

Response Message  field description

Field#Field nameDescription
1responseCodeThe Code representing the result of the request processing.
2responseMessageThe Description of the responseCode.
4offersArrays of the available offers.
4a.offerId
4b.amountOfferedThe Amount which the Credit Company is ready to loan the customer/user.
4c.interestThe Interest Percentage that applies to the loan.
4d.amountPayableThe Compound Interest which is to be paid by the Customer at the end of the loan tenure.
4e.feesArray of the many fees that applied with the offer.
4f.tenureThe Duration for which the loan is applied. After this duration, the loan is marked as due. (in days)
4g.termsThe Terms and Conditions that applied to the offer.
4h.expiryDateThe Date and Time at which this offer becomes invalid.(UTC)
4i.currencyThe Currency Code of the Amount offered.

Sample Response (success)

{
"responseCode": "00",
"responseMessage": "Offers available",
"offers": [
{
"offerId": "FI12345",
"amountOffered": 1000000, // Ten thousand naira only
"interest" : 12.5 // In percentage: 12.5%
"amountPayable": 1250000, // Ten thousand, two hundred and fifty naira only
"tenure": 30,
"expiryDate": "2017-05-30T16:49:12Z"
"currency": "566"
}
]
}

Sample Response (failure)

{
"responseCode": "01",
"responseMessage": "You have an existing loan",
"offers": []
}

Was this article helpful to you? Yes No

How can we help?