Get Tenured Offers<\/h3>\n

This endpoint is to get offers available to a user\/customer from a specified Credit Company (Provider) for purchasing items from the specified merchant<\/p>\n

Request Message description<\/h4>\n

\n\n\n\n\n\n\n\n<\/colgroup>\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	amount<\/td>\n	Numeric String<\/td>\n	<\/td>\n	true<\/td>\n	The Amount of Loan that the customer wishes to take (in Kobo).<\/td>\n<\/tr>\n
3<\/td>\n	merchantId<\/td>\n	String<\/td>\n	<\/td>\n	true<\/td>\n	The merchant Id<\/td>\n<\/tr>\n
4<\/td>\n	itemDescription<\/td>\n	String<\/td>\n	<\/td>\n	false<\/td>\n	Description of the item being purchased<\/td>\n<\/tr>\n
5<\/td>\n	bvn<\/td>\n	String<\/td>\n	<\/td>\n	false<\/td>\n	The customer’s Bank Verfication Number<\/td>\n<\/tr>\n
6<\/td>\n	dateOfBirth<\/td>\n	String<\/td>\n	<\/td>\n	false<\/td>\n	The customer’s date of birth in the format yyyy-MM-dd<\/td>\n<\/tr>\n
7<\/td>\n	serviceType<\/td>\n	String<\/td>\n	<\/td>\n	false<\/td>\n	<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n \n Endpoint<\/b><\/div>\n \n \n \n\n\n\n \n \n GET \/tenured-offers?customerId={customerId}&amount={amount}&merchantId={merchantId}&itemDescription={itemDescription}&bvn={bvn}&dateOfBirth=1960-10-01<\/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><\/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 \/tenured-offers?mercantId=3IPG001&customerId=2348030583962&amount=100000&bvn=1000000002&itemDescription=Samsung Tv<\/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<\/colgroup>\n\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 4j.<\/td>\n description<\/td>\n The desctiption of the offer. This is what will be displayed to the customer<\/td>\n<\/tr>\n 4k.<\/td>\n type<\/td>\n The type of offer. Possible values are One-Off and Installmental<\/td>\n<\/tr>\n 4l.<\/td>\n initialPayment<\/td>\n The value of the initial payment that will be deducted from the customer<\/td>\n<\/tr>\n 4m.<\/td>\n noOfInstallments<\/td>\n The number of installments the customer will be required to pay<\/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>\"responseMessage\"<\/code>:\u00a0<\/code>\"Offers available\"<\/code>,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0<\/code>\"offers\"<\/code>: [<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>{<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"offerId\"<\/code>:\u00a0<\/code>\"FI12345\"<\/code>,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"amountOffered\"<\/code>: 1000000,\u00a0<\/code>\/\/ Ten thousand naira only<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"interest\"<\/code>\u00a0: 12.5\u00a0<\/code>\/\/ In percentage: 12.5%<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"amountPayable\"<\/code>: 1250000,\u00a0<\/code>\/\/ Ten thousand, two hundred and fifty naira only<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"tenure\"<\/code>: 30,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>\"expiryDate\"<\/code>:\u00a0<\/code>\"2017-05-30T16:49:12Z\"<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0\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\u00a0\u00a0\u00a0\u00a0<\/code>\"description\"<\/code>:\u00a0<\/code>\"N10,000 to pay back N12,500 in 30 days\"<\/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>\"01\"<\/code>,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0<\/code>\"responseMessage\"<\/code>:\u00a0<\/code>\"You have an existing loan\"<\/code>,<\/code><\/div>\n \u00a0\u00a0\u00a0\u00a0<\/code>\"offers\"<\/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","protected":false},"author":169,"featured_media":0,"parent":2944,"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\/2945"}],"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=2945"}],"version-history":[{"count":2,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/2945\/revisions"}],"predecessor-version":[{"id":4384,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/2945\/revisions\/4384"}],"up":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/2944"}],"next":[{"title":"Accept Tenured Offer","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/ils\/value-financing\/accept-tenured-offer\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/2947"}],"wp:attachment":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/media?parent=2945"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/doc_tag?post=2945"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}