This endpoint is to get offers available to a user/customer from a specified Credit Company (Provider / lender).
Request Message description
| Field
# | Field name | Data type | Max length | Required | Description |
| 1 | customerId | String | true | The Email or Mobile Number of the Customer for which offers are been requested. | |
| 2 | channelCode | String | true | The Code of the Channel from which this request is originating. | |
| 3 | providerCode | String | true | The Code of the Provider from which offers will be retrieved. | |
| 4 | fullname | String | false | The Full name of the Customer. | |
| 5 | amount | Numeric String | false | The Amount of Loan that the customer wishes to take (in Kobo).
| |
| 6 | serviceType | String | false | The service type for the loan. e.g MONEY or RECHARGE
|
Endpoint
GET /offers?customerId={customerId}&channelCode={channelCode}&providerCode={providerCode}&amount={amount}&serviceType={serviceType}
Headers
Authorization: Bearer {{token}}
Sample request
/offers?customerId=2348123456789&channelCode=0002&providerCode=ABCREDIT&amount=5000000&serviceType=LOAN |
Response Message field description
| Field# | Field name | Description |
|---|---|---|
| 1 | responseCode | The Code representing the result of the request processing. |
| 2 | responseMessage | The Description of the responseCode. |
| 4 | offers | Arrays of the available offers. |
| 4a. | offerId | |
| 4b. | amountOffered | The Amount which the Credit Company is ready to loan the customer/user. |
| 4c. | interest | The Interest Percentage that applies to the loan. |
| 4d. | amountPayable | The Compound Interest which is to be paid by the Customer at the end of the loan tenure. |
| 4e. | fees | Array of the many fees that applied with the offer. |
| 4f. | tenure | The Duration for which the loan is applied. After this duration, the loan is marked as due. (in days) |
| 4g. | terms | The Terms and Conditions that applied to the offer. |
| 4h. | expiryDate | The Date and Time at which this offer becomes invalid.(UTC) |
| 4i. | currency | The 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-06-12T11:46:15Z"
"currency": "566"
}
]
}
Sample Response (failure)
{
"responseCode": "01",
"responseMessage": "You have an existing loan",
"offers": []
}