1. Home
  2. Interswitch lending Service
  3. Channel Provider Collections Only API

Channel Provider Collections Only API

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

Loan Status

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.

Request Message description

Field#Field nameData typeMax lengthRequiredDescription
1customerIdString
trueThe customer’s identification on the channel provider’s system

EndpointEndpoint

GET /endpoint goes here. The Provider is expected to provide this and configured on the ILS Platform.

HeadersHeaders

Authorization : Bearer {token}
Sample Request

Sample request

?customerId=2348012345678

Response Message  field description

Field#Field nameData type


1responseCodeNumeric String5trueThe Code representing the status of the processing of the request. It shows whether the request to accept the offer is allowed or not.
2responseMapString255trueThe Description of the Response Code from above.
3loanObject

An Object containing the details of the loan requested.
3areferenceString50
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
3bstatusENUM
trueThe Status of the Loan whether it has been paid or not, overdue or not.
3cremainingAmountLong
trueThe Amount remaining for the Customer to paid that will make the loan fully paid.
3ddueDateDate Time (UTC)
trueThe Date/Time at which the Customer is expected to have paid back the loan.

Sample Response (success) 200 OK HTTP Status
{"responseCode""00","responseMessage""Successful","loan": {"reference""trans123456""status""CLOSED","remainingAmount": 0,"dueDate""2017-06-12T11:46:15Z"}}
Sample Response (failure)
{"responseCode""4004","responseMessage""Loan not found."}

Response Codes

Response CodeResponse Message
00Successful
4004Loan not found


Was this article helpful to you? Yes 1 No

How can we help?