This endpoint is to get offers available to a user\/customer from all available providers.<\/p>\n

Request Message description<\/h4>\n

\n\n\n\n\n\n\n\n\n\n

\n \n Field<\/p>\n #<\/p>\n<\/div>\n<\/th>\n	\n Field name<\/div>\n<\/th>\n	\n Data type<\/div>\n<\/th>\n	\n Max length<\/div>\n<\/th>\n	\n Required<\/div>\n<\/th>\n	\n Description<\/div>\n<\/th>\n<\/tr>\n<\/thead>\n
1<\/td>\n	customerId<\/td>\n	String<\/td>\n	<\/td>\n	true<\/td>\n	The Email or Mobile Number of the Customer for which offers are been requested.<\/td>\n<\/tr>\n
2<\/td>\n	channelCode<\/td>\n	String<\/td>\n	<\/td>\n	true<\/td>\n	The Code of the Channel from which this request is originating.<\/td>\n<\/tr>\n
4<\/td>\n	fullname<\/td>\n	String<\/td>\n	<\/td>\n	false<\/td>\n	The Full name of the Customer.<\/td>\n<\/tr>\n
5<\/td>\n	amount<\/td>\n	Numeric String<\/td>\n	<\/td>\n	false<\/td>\n	The Amount of Loan that the customer wishes to take (in Kobo).<\/td>\n<\/tr>\n
6<\/td>\n	serviceType<\/td>\n	String<\/td>\n	<\/td>\n	false<\/td>\n	The service type code<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n \n Endpoint<\/b><\/div>\n \n \n \n\n\n\n \n \n GET \/v2\/offers?customerId={customerId}&channelCode={channelCode}&amount={amount}&serviceType={serviceType}<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n \n Headers<\/b><\/div>\n \n \n \n\n\n\n \n \n \u00a0<\/code>Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJlbWVrYS5va29yb2Fmb3JAZ21haWwuY29tIiwianRpI<\/code><\/div>\n joiN<\/code>TgwZTBhMDYtZDZkNS00OTAyLWE4OTItZGM1NjEyOGY1N2U0IiwiZW1haWwiOiJlbWVrYS5va29yb2Fmb3JAZ21haW<\/code><\/div>\n wuY29tIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbW9iaWx<\/code><\/div>\n lcGhvbmUiOiIyMzQ4MDMwNTgzOTYyIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVu<\/code><\/div>\n dGl0eS9jbGFpbXMvaGFzaCI6IiIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpd<\/code><\/div>\n HkvY2xhaW1zL2NvdW50cnkiOiJORyIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbn<\/code><\/div>\n RpdHkvY2xhaW1zL25hbWUiOiJObmFlbWVrYSBPa29yb2Fmb3IiLCJpYXQiOjE1MjcwODg4MzUsIm5iZiI6MTUyNzA<\/code><\/div>\n 4ODc3NCwiZXhwIjoxNTI3MDkyNDM0LCJpc3MiOiJRdWlja3RlbGxlci5jb20iLCJhdWQiOiJRdWlja3RlbGxlci5j<\/code><\/div>\n b20ifQ.gxe7BUT2ZWturIy74mDQ3kU64GiLnf_l002wGx2Kuwg<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n Sample Request<\/h5>\n \n Sample request<\/b><\/div>\n \n \n \n\n\n\n \n \n \/v2\/offers?customerId=2348123456789&channelCode=0002&amount=5000000&serviceType=MONEY<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n Response Message\u00a0 field description<\/h4>\n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n Field<\/p>\n #<\/p>\n<\/div>\n<\/th>\n \n Field name<\/div>\n<\/th>\n \n Description<\/div>\n<\/th>\n<\/tr>\n<\/thead>\n 1<\/td>\n responseCode<\/td>\n The Code representing the result of the request processing.<\/td>\n<\/tr>\n 2<\/td>\n responseMessage<\/td>\n The Description of the responseCode.<\/td>\n<\/tr>\n 4<\/td>\n offers<\/td>\n Arrays of the available offers.<\/td>\n<\/tr>\n 4a.<\/td>\n offerId<\/td>\n <\/td>\n<\/tr>\n 4b.<\/td>\n amountOffered<\/td>\n The Amount which the Credit Company is ready to loan the customer\/user.<\/td>\n<\/tr>\n 4c.<\/td>\n interest<\/td>\n The Interest Percentage that applies to the loan.<\/td>\n<\/tr>\n 4d.<\/td>\n amountPayable<\/td>\n The Compound Interest which is to be paid by the Customer at the end of the loan tenure.<\/td>\n<\/tr>\n 4e.<\/td>\n fees<\/td>\n Array of the many fees that applied with the offer.<\/td>\n<\/tr>\n 4f.<\/td>\n tenure<\/td>\n The Duration for which the loan is applied. After this duration, the loan is marked as due. (in days<\/em>)<\/td>\n<\/tr>\n 4g.<\/td>\n terms<\/td>\n The Terms and Conditions that applied to the offer.<\/td>\n<\/tr>\n 4h.<\/td>\n expiryDate<\/td>\n The Date and Time at which this offer becomes invalid.(UTC)<\/td>\n<\/tr>\n 4i.<\/td>\n currency<\/td>\n The Currency Code of the Amount offered.<\/td>\n<\/tr>\n 5<\/td>\n provider<\/td>\n The provider for the specified loan<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n Sample Response (success)<\/h5>\n \n \n \n \n\n\n\n \n \n {<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0<\/code>\"responseCode\"<\/code>:\u00a0<\/code>\"00\"<\/code>,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0<\/code>\"offers\"<\/code>: [{<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"offerId\"<\/code>:\u00a0<\/code>\"OFFER1511245980103\"<\/code>,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"amountOffered\"<\/code>: 3500000,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"interest\"<\/code>: 15,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"amountPayable\"<\/code>: 3875000,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"tenure\"<\/code>: 14,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"expiryDate\"<\/code>:\u00a0<\/code>\"2017-06-30T09:24:09Z\"<\/code>,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"currency\"<\/code>:\u00a0<\/code>\"566\"<\/code>,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"description\"<\/code>:\u00a0<\/code>\"N35000 to pay N3875000 in 14 days\"<\/code>,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"provider\"<\/code>: {<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"code\"<\/code>:\u00a0<\/code>\"MKT\"<\/code>,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"name\"<\/code>:\u00a0<\/code>\"MKT Loans\"<\/code>,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"description\"<\/code>:\u00a0<\/code>\"MKT\"<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>}<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0<\/code>}]<\/code><\/div>\n }<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n Sample Response (failure)<\/h5>\n \n \n \n \n\n\n\n \n \n {<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0<\/code>\"responseCode\"<\/code>:\u00a0<\/code>\"3001\"<\/code>,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0<\/code>\"responseMessage\"<\/code>:\u00a0<\/code>\"No offers available\"<\/code>,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0<\/code>\"offers\"<\/code>: []<\/code><\/div>\n }<\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n  <\/p>\n","protected":false},"author":169,"featured_media":0,"parent":2807,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"spay_email":""},"doc_tag":[],"_links":{"self":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/2811"}],"collection":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/users\/169"}],"replies":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/comments?post=2811"}],"version-history":[{"count":5,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/2811\/revisions"}],"predecessor-version":[{"id":2819,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/2811\/revisions\/2819"}],"up":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/2807"}],"next":[{"title":"Accept Offer","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/ils\/channels\/api-specification-for-pos\/accept-offer\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/2817"}],"wp:attachment":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/media?parent=2811"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/doc_tag?post=2811"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}