This endpoint is to get offers available to a user/customer from all available providers.
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. | |
| 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 code |
Endpoint
GET /v2/offers?customerId={customerId}&channelCode={channelCode}&amount={amount}&serviceType={serviceType} |
Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJlbWVrYS5va29yb2Fmb3JAZ21haWwuY29tIiwianRpIjoiNTgwZTBhMDYtZDZkNS00OTAyLWE4OTItZGM1NjEyOGY1N2U0IiwiZW1haWwiOiJlbWVrYS5va29yb2Fmb3JAZ21haWwuY29tIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbW9iaWxlcGhvbmUiOiIyMzQ4MDMwNTgzOTYyIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvaGFzaCI6IiIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2NvdW50cnkiOiJORyIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJObmFlbWVrYSBPa29yb2Fmb3IiLCJpYXQiOjE1MjcwODg4MzUsIm5iZiI6MTUyNzA4ODc3NCwiZXhwIjoxNTI3MDkyNDM0LCJpc3MiOiJRdWlja3RlbGxlci5jb20iLCJhdWQiOiJRdWlja3RlbGxlci5jb20ifQ.gxe7BUT2ZWturIy74mDQ3kU64GiLnf_l002wGx2Kuwg |
Sample Request
Sample request
/v2/offers?customerId=2348123456789&channelCode=0002&amount=5000000&serviceType=MONEY |
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. |
| 5 | provider | The provider for the specified loan |
Sample Response (success)
{ "responseCode": "00", "offers": [{ "offerId": "OFFER1511245980103", "amountOffered": 3500000, "interest": 15, "amountPayable": 3875000, "tenure": 14, "expiryDate": "2017-06-30T09:24:09Z", "currency": "566", "description": "N35000 to pay N3875000 in 14 days", "provider": { "code": "MKT", "name": "MKT Loans", "description": "MKT" } }]} |
Sample Response (failure)
{ "responseCode": "3001", "responseMessage": "No offers available", "offers": []}
|