This endpoint will be used to re-query for the status of a transaction (credit or debit or payment) that was previously posted.
Request Message description
| Field
# |
Field name | Data type | Max length | Required | Description |
| 1 | reference | String | 50 | false | The Reference for the Transaction that was posted with the earlier request. This is required for re-querying Do Payments requests. |
| 2. | loanId | Numeric String | 50 | false | The loan id of the loan for which the earlier transaction was done. This is required for Loan Debit or Credit. |
| 3. | providerCode | String | 50 | true | The Code of the Provider from which this request originates. |
Endpoint
| GET /payments/query |
Headers
Query Paramter One
| {
“reference”: “101202303404505”, “providerCode”: “ABC” } |
Query Paramter Two
| {
” loanId”: “090801”, “providerCode”: “ABC” } |
Response Message field description
| Field
# |
Field name | Data type | Max length | Required | Description |
| 1 | responseCode | Numeric String | 5 | true | The code indicating the result of the processing of this request. |
| 2 | responseMessage | String | 255 | true | The Description of the responseCode. |
| 3 | transactionReference | String | 50 | true | The Transaction Reference of the Transaction. |
| 4 | transactionStatus | String | 50 | true | The Status of the Transaction (whether failed, successful or pending). |
Sample Response (success)
| {
“responseCode”: “00”, “responseMessage”: “Successful”, “transactionReference”: “FBN|WEB|ILS|09092017090801|0098”, “transactionStatus”: “Successful” } |
Sample Response (failure)
| {
“responseCode” : “5000”, “responseMessage” : “System Error” } |