Transaction Status Query
Description: Endpoint for querying transaction status
- Request Parameters
- Response Parameters
Request Parameters
Parameter | Type | Description | Required |
---|---|---|---|
id | Integer | Unique Identifier | Yes |
terminalId | string | Terminal Identifier | Yes |
terminalCard | boolean | Terminal Card parameter | Yes |
direction | string | Parameter to identify of message is a request or response. Value “request” is to be passed for requests | Yes |
transaction | object | An object holding the transaction information as follows: | Yes |
pin | string | AES encrypted pin | Yes |
bankCode | string | Bank Code | No |
reference | string | Reference number | Yes |
senderName | string | Sender Name | Yes |
action | string | Action to be performed e.g. TS. The transaction type to be performed. Possible actions are; | Yes |
destinationCountry | string | Destination Country | Yes |
Response Parameters
Parameter | Type | Description | Required |
---|---|---|---|
direction | string | Parameter to identify of message is a request or response. Value “response” is to be returned for response | Yes |
reference | string | Reference Number | Yes |
companyId | string | Company Identifier | No |
date | string | date | No |
amount | decimal | Transaction amount | Yes |
totalFailed | integer | Total number of transactions that failed | No |
totalSuccess | integer | Total number of transactions that succeeded | No |
error | integer | Error code. If there are no error, value here will be 0 | Yes |
message | string | Message received as response data | Yes |
bulkItems | object | Object holding bulk items | No |
otherReference | string | Other reference number | No |
action | string | Action performed e.g. TS. The transaction type performed. Refer to section 1.2 for possible actions | Yes |
records | string | Not used | No |
currency | string | Currency Code | No |
openingBalance | decimal | Opening Balance | No |
closingBalance | decimal | Closing Balance | No |
bankCode | string | Bank Code | No |
- Sample Request
- Sample Response
Request Parameters
POST {base_url}/transaction-status
curl `${base_url}/transaction-status`
-H "Content-type: application/json"
-X POST
-d '{
"action":"TS",
"terminalId": "7000000004",
"id":"0006",
"terminalCard": false,
"direction": "request",
"transaction": {
"reference": "reference-49144333",
"destinationCountry": "NG",
"bankCode": "",
"senderName": "Ugochukwu Michael",
"pin": "kghxqwveJ3eSQJip\/cmaMQ=="
},
}
'
Sample Success Response
POST {base_url}/transaction-status
{
"direction": "response",
"reference": "Pending Transaction upon confirmation from bank",
"companyId": null,
"date": null,
"amount": 0,
"totalFailed": 0,
"totalSuccess": 0,
"error": "31",
"message": "Unknown",
"bulkItems": null,
"otherReference": "reference53641",
"action": "TS",
"records": null,
"currency": null,
"openingBalance": 0,
"closingBalance": 0,
"bankCode": null
}
Sample Failure Response
POST {base_url}/transaction-status
{
"direction": "response",
"reference": "Could not determine Transaction status",
"companyId": null,
"date": null,
"amount": 0,
"totalFailed": 0,
"totalSuccess": 0,
"error": "-1",
"message": "Transaction TimeOut",
"bulkItems": null,
"otherReference": "reference17001",
"action": "TS",
"records": null,
"currency": null,
"openingBalance": 0,
"closingBalance": 0,
"bankCode": null
}