This is the transaction query endpoint. It is use to query transaction from different transaction group. The resulting transaction is use to create dispute.
Resource URL: <base url>/groups/<transaction group>/channels/<transaction group channel>
HTTP Verb: GET
Authentication: User Access Token
REQUEST
The request query parameters are determined by the Transaction Group. However, a date range is always required.
| Field | Description |
|---|---|
| startDate | The start date and time of the date range. Format: yyyy-MM-dd HH:mm:ss |
| endDate | The end date and time of the date range. Format: yyyy-MM-dd HH:mm:ss |
| … | Any number of parameters as defined by the transaction group for example IPG group requires stan, maskedCardPan, retrievalReferenceNumber for finer filter. |
Sample Request
<base url>/groups/IPG/channels/All?startDate=2018-05-3000:00:00&endDate=2018-05-3023:59:59
RESPONSE
| Field | Description |
|---|---|
| issuerCode | The domain code of the issuer |
| issuer | The domain name of the issuer |
| issuerCountry | The ISO Alpha-2 country code of the issuer |
| acquirerCode | The domain code of the acquirer |
| acquirer | The domain name of the acquirer |
| acquirerCountry | The ISO Alpha-2 country code of the acquirer |
| merchantCode | If applicable, the domain code of the merchant |
| merchant | If applicable, the domain name of the merchant |
| merchantCountry | If applicable, the ISO Alpha-2 country code of the merchant |
| merchantType | If applicable, the type of the merchant. Either Regular, TSA, or Government |
| merchantReference | If applicable, the unique reference of the transaction in the merchant’s system |
| customerReference | The reference of the customer |
| transactionStore | The store of the transaction |
| transactionReference | The unique reference of the transaction in the store |
| transactionType | The type of the transaction |
| transactionDate | The UTC date and time of the transaction |
| transactionAmount | The amount of the transaction |
| transactionCurrencyCode | The currency of the transaction. Format: ISO 4217 numeric |
| surchargeAmount | If applicable, the surcharge (or fee) of the transaction |
| settlementAmount | If applicable, the settlement amount of the transaction |
| settlementCurrencyCode | If applicable, the currency of the transaction settlement. Format: ISO 4217 numeric |
| schemeAmount | If applicable, the amount of the transaction from the card scheme’s system |
| schemeCurrencyCode | If applicable, the currency of the transaction from the card scheme’s system. Format: ISO 4217 numeric |
| terminalType | The type of the terminal |
| terminalId | The unique identifier of the terminal |
| stan | If applicable, the system trace audit number (Postilion) |
| pan | If applicable, the PAN of the card used in the transaction |
| cardScheme | If applicable, the scheme of the card used in the transaction |
| cardAcceptorCode | If applicable, the unique identifier of the card acceptor |
| cardAcceptorLocation | If applicable, the location of the card acceptor |
| merchantCategoryCode | If applicable, the category of the merchant |
| sourceNodeName | If applicable, the name of the source node (Postilion) |
| sinkNodeName | If applicable, the name of the sink node (Postilion) |
| responseCode | The response code of the transaction |
| responseDescription | The user-friendly description of the response code |
| settled | The settlement status of the transaction |
| additionalInfo | If applicable, any additional relevant data not captured by any field above |
| accountNumber | if applicable, the transaction account number |
Sample Response
[
{
“issuerCode”: “FBN”,
“issuer”: “First Bank of Nigeria”,
“issuerCountry”: “NG”,
“acquirerCode”: “FCMB”,
“acquirer”: “”,
“acquirerCountry”: “”,
“merchantCode”: “MX1209”,
“merchantType”: “Regular”,
“customerReference”: “0000000000000014844”,
“transactionStore”: “IPG”,
“transactionReference”: “307200”,
“transactionDate”: “2020-01-24T19:07:02Z”,
“transactionType”: “WEB”,
“transactionAmount”: “NGN 1,000.00”,
“surchargeAmount”: “NGN 0.00”,
“transactionCurrencyCode”: “566”,
“settlementCurrencyCode”: “566”,
“terminalType”: “WEB”,
“terminalId”: “3IPG0001”,
“stan”: “000274”,
“pan”: “628051******0095”,
“retrievalReferenceNumber”: “000855279594”,
“responseCode”: “91”,
“responseDescription”: “Issuer or Switch Inoperative”,
“settled”: false,
“hasMerchant”: true
},
{
“issuerCode”: “FBN”,
“issuer”: “First Bank of Nigeria”,
“issuerCountry”: “NG”,
“acquirerCode”: “FCMB”,
“acquirer”: “”,
“acquirerCountry”: “”,
“merchantCode”: “MX1209”,
“merchantType”: “Regular”,
“customerReference”: “0000000000000014844”,
“transactionStore”: “IPG”,
“transactionReference”: “945695”,
“transactionDate”: “2020-01-24T19:07:02Z”,
“transactionType”: “WEB”,
“transactionAmount”: “NGN 1,000.00”,
“surchargeAmount”: “NGN 0.00”,
“transactionCurrencyCode”: “566”,
“settlementCurrencyCode”: “566”,
“terminalType”: “WEB”,
“terminalId”: “3IPG0001”,
“stan”: “000274”,
“pan”: “628051******0095”,
“retrievalReferenceNumber”: “000855279594”,
“responseCode”: “91”,
“responseDescription”: “Issuer or Switch Inoperative”,
“settled”: false,
“hasMerchant”: true
},
{
“issuerCode”: “FBN”,
“issuer”: “First Bank of Nigeria”,
“issuerCountry”: “NG”,
“acquirerCode”: “FCMB”,
“acquirer”: “”,
“acquirerCountry”: “”,
“merchantCode”: “MX1209”,
“merchantType”: “Regular”,
“customerReference”: “0000000000000014843”,
“transactionStore”: “IPG”,
“transactionReference”: “307199”,
“transactionDate”: “2020-01-24T18:58:17Z”,
“transactionType”: “WEB”,
“transactionAmount”: “NGN 1,000.00”,
“surchargeAmount”: “NGN 0.00”,
“transactionCurrencyCode”: “566”,
“settlementCurrencyCode”: “566”,
“terminalType”: “WEB”,
“terminalId”: “3IPG0001”,
“stan”: “000273”,
“pan”: “628051******0095”,
“retrievalReferenceNumber”: “000855277452”,
“responseCode”: “91”,
“responseDescription”: “Issuer or Switch Inoperative”,
“settled”: false,
“hasMerchant”: true
}
]