This Service receives a Transaction Notification response from a Value Financing Channel (such as Webpay). Subsequently, it is expected to send a request down to the Provider to notify them of the final status of the transaction. The Provider is in-turn expected to return a response acknowledging receipt of the request.
Request Message Description
Field# | Field name | Data type | Max length | Required | Description |
---|---|---|---|---|---|
1 | requestCode | String | true | The request code indicating the status of the loan application | |
2 | requestMessage | String | true | The description of the requestCode. | |
3 | loanId | String | 50 | true | The Id of the accepted loan from the provider |
4 | customerId | String | 50 | true | The Mobile Number of the User who is requesting the loan. |
5 | customerRef | string | Optional | Customer reference number | |
6 | loanStatus | ENUM | true | The Status of the Loan whether it is successful or not. Expected values are “OPEN” or “FAILED” | |
7 | amount | long | true | The loan amount | |
8 | transactionRef | String | 50 | true | Transaction Id generated by lending service to the downstream payment service. To be used for investigating the transaction. |
9 | paymentRef | String | 50 | false | The Reference to the payment that was done. This can be used by the Provider to do dispute settlement or investigate. |
10 | paymentDate | Date Time (UTC) | true | The Date/Time at which merchant was paid for the service for which the customer requested the loan. |
Endpoint
POST /endpoint goes here. The Provider is expected to provide this and configured on the ILS Platform. |
Sample Request
Sample request
{ “customerId”: “2348067517051”, “customerRef”: “2348067517051”, “loanId”: “BC7KL0000002”, “amount”: 20000, “loanStatus”: “OPEN”, “transactionRef”: “zyPodVNkzNIvQ0F3ePcxzOKi4”, “paymentRef”: “KSB|WEB|MX1065|07-02-2023|976453665|122316”, “paymentDate”: “2023-02-07T10:54:02.020+00:00”, “requestCode”: “00”, “requestMessage”: “Approved by Financial Institution” } |
Response Message field description
Field# | Field name | Description |
---|---|---|
1 | responseCode | The response message code |
2 | responseMessage | The message description for the response |
Sample Response (success)
{ "responseCode" : 00, "responseMessage" : "Successful" } |
Sample Response (failure)
{ "responseCode" : 500, "responseMessage" : "Something we wrong" } |