This manual specifies API endpoints for ILS Channel Providers to collect payments through Quickteller channels

<\/h4>\n\n\n\n

Loan Status<\/h3>\n\n\n\n

This is a callback endpoint required to be provided by the channel provider to allow ILS get amount required to be paid back by the customer.<\/p>\n\n\n\n

Request Message description<\/h4>\n\n\n\n

Field#<\/th>	Field name<\/th>	Data type<\/th>	Max length<\/th>	Required<\/th>	Description<\/th><\/tr><\/thead>
1<\/td>	customerId<\/td>	String<\/td>	<\/td>	true<\/td>	The customer’s identification on the channel provider’s system<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong>Endpoint<\/strong><\/p>\n\n\n\n GET \/endpoint goes here. The Provider is expected to provide <\/code>this<\/code> and configured on the ILS Platform.<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Headers<\/strong>Headers<\/strong><\/p>\n\n\n\n Authorization : Bearer {token}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Sample Request<\/h5>\n\n\n\n Sample request<\/strong><\/p>\n\n\n\n ?customerId=2348012345678<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Response Message  field description<\/h4>\n\n\n\n Field#<\/th> Field name<\/th> Data type<\/th> <\/th> <\/th> <\/th><\/tr><\/thead> 1<\/td> responseCode<\/td> Numeric String<\/td> 5<\/td> true<\/td> The Code representing the status of the processing of the request. It shows whether the request to accept the offer is allowed or not.<\/td><\/tr> 2<\/td> responseMap<\/td> String<\/td> 255<\/td> true<\/td> The Description of the Response Code from above.<\/td><\/tr> 3<\/td> loan<\/td> Object<\/td> <\/td> <\/td> An Object containing the details of the loan requested.<\/td><\/tr> 3a<\/td> reference<\/td> String<\/td> 50<\/td> <\/td> This field is REQUIRED for all loans NOT disbursed through ILS. The Reference is a unique loan identifier and should only be sent for loans that do NOT exist on the ILS platform<\/td><\/tr> 3b<\/td> status<\/td> ENUM<\/td> <\/td> true<\/td> The Status of the Loan whether it has been paid or not, overdue or not.<\/td><\/tr> 3c<\/td> remainingAmount<\/td> Long<\/td> <\/td> true<\/td> The Amount remaining for the Customer to paid that will make the loan fully paid.<\/td><\/tr> 3d<\/td> dueDate<\/td> Date Time (UTC)<\/td> <\/td> true<\/td> The Date\/Time at which the Customer is expected to have paid back the loan.<\/td><\/tr><\/tbody><\/table>\n\n\n\n <\/em>Sample Response (success) 200 OK HTTP Status<\/h5>\n\n\n\n {<\/code>\"responseCode\"<\/code>: <\/code>\"00\"<\/code>,<\/code>\"responseMessage\"<\/code>: <\/code>\"Successful\"<\/code>,<\/code>\"loan\"<\/code>: {<\/code>\"reference\"<\/code>: <\/code>\"trans123456\"<\/code>\"status\"<\/code>: <\/code>\"CLOSED\"<\/code>,<\/code>\"remainingAmount\"<\/code>: 0,<\/code>\"dueDate\"<\/code>: <\/code>\"2017-06-12T11:46:15Z\"<\/code>}<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Sample Response (failure)<\/h5>\n\n\n\n {<\/code>\"responseCode\"<\/code>: <\/code>\"4004\"<\/code>,<\/code>\"responseMessage\"<\/code>: <\/code>\"Loan not found.\"<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Response Codes<\/h3>\n\n\n\n Response Code<\/th> Response Message<\/th><\/tr><\/thead> 00<\/td> Successful<\/td><\/tr> 4004<\/td> Loan not found<\/td><\/tr><\/tbody><\/table>\n\n\n\n <\/a> <\/p>\n","protected":false},"author":228,"featured_media":0,"parent":2232,"menu_order":8,"comment_status":"open","ping_status":"closed","template":"","meta":{"spay_email":""},"doc_tag":[],"_links":{"self":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4070"}],"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\/228"}],"replies":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/comments?post=4070"}],"version-history":[{"count":2,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4070\/revisions"}],"predecessor-version":[{"id":4072,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4070\/revisions\/4072"}],"up":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/2232"}],"next":[{"title":"Get Customer Virtual Account","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/ils\/get-customer-virtual-account\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4090"}],"prev":[{"title":"Credit score and Credit score history Api","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/ils\/credit-score\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4059"}],"wp:attachment":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/media?parent=4070"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/doc_tag?post=4070"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}