get https://sandbox.interswitchng.com/arbiter/api/v1/transactions/groups//channels/?
This is the transaction query endpoint. It is use to query transaction from different transaction group. The resulting transaction is use to create dispute.
REQUEST
The request query parameters are determined by the Transaction Group. However, a date range is always required.
| Field Name | Description | Type | Required | Constraints |
|---|---|---|---|---|
| transaction_group | The transaction group you want to search for | String | Required | See Get Transaction Groups |
| channel | A channel that is available within the transaction group | String | Required | See the channel from Get Transaction Groups |
| startDate | The start date and time of the date range. Format: yyyy-MM-dd HH:mm:ss | DateTime | Required | |
| endDate | The end date and time of the date range. Format: yyyy-MM-dd HH:mm:ss | DateTime | Required | |
| Any number of parameters as defined by the transaction group for example IPG group requires stan, maskedCardPan, retrievalReferenceNumber for finer filter, and AGENCY BANKING requires terminal and pan | Required | See the parameter in the Get Transaction Groups |
Sample Request
{{base_url}}/api/v1/transactions/groups/AGENCY BANKING/channels/ALL?startDate=2023-04-11 00:00:00&endDate=2023-04-11 23:59:59&terminal=20086919&pan=506120*****8033
RESPONSE
| Field Name | Description | Type | Constraints |
|---|---|---|---|
| issuerCode | The domain code of the issuer | String | |
| issuer | The domain name of the issuer | String | |
| acquirerCode | The domain code of the acquirer | String | |
| acquirer | The domain code of the acquirer | String | |
| merchantCode | If applicable, the domain code of the merchant | String | |
| merchant | If applicable, the domain name of the merchant | String | |
| merchantCountry | If applicable, the ISO Alpha-2 country code of the merchant | String | |
| merchantType | If applicable, the type of the merchant. | Enum | Regular, TSA, or Government |
| customerReference | The reference of the customer | String | |
| transactionStore | The store of the transaction | String | |
| transactionReference | The unique reference of the transaction in the store | String | |
| transactionType | The type of the transaction | String | See Get Transaction Types |
| transactionDate | The UTC date and time of the transaction | DateTime | |
| transactionAmount | The amount of the transaction | Long | |
| transactionCurrencyCode | The currency of the transaction. Format: ISO 4217 numeric | String | |
| surchargeAmount | If applicable, the surcharge (or fee) of the transaction | Long | |
| settlementAmount | If applicable, the settlement amount of the transaction | Long | |
| settlementCurrencyCode | If applicable, the currency of the transaction settlement. Format: ISO 4217 numeric | String | |
| terminalType | The type of the terminal | String | |
| terminalId | The unique identifier of the terminal | String | |
| stan | If applicable, the system trace audit number (Postilion) | String | |
| pan | If applicable, the PAN of the card used in the transaction | String | |
| retrievalReferenceNumber | The retrieval reference of the transaction | String | |
| cardAcceptorCode | If applicable, the unique identifier of the card acceptor | String | |
| cardAcceptorLocation | If applicable, the location of the card acceptor | String | |
| responseCode | The response code of the transaction | String | |
| settled | The settlement status of the transaction | Boolean | |
| hasMerchant | A flag to show if it is a merchant transaction | Boolean | |
| additionalInfo | If applicable, any additional relevant data not captured by any field above accountNumber - if applicable, the transaction account number | JSON Array |
Sample Response
[
{
"issuerCode": "IBTC",
"issuer": "IBTC",
"acquirerCode": "FBN",
"acquirer": "FBN",
"merchantCode": "200001119220077",
"merchant": "WT|ABUBAKAR MUHAMMAD MUST ZARIA NG",
"merchantType": "Regular",
"customerReference": "506120\*\*\*8033",
"transactionStore": "RJService",
"transactionReference": "136919902261_902261_20086919_-10000.00_0200",
"transactionDate": "2023-04-11T11:00:00Z",
"transactionType": "AGENCY_BANKING_TRANSFER",
"transactionAmount": "NGN 100.00",
"surchargeAmount": "NGN 0.00",
"transactionCurrencyCode": "566",
"settlementAmount": "NGN 0.00",
"settlementCurrencyCode": "566",
"terminalType": "2",
"terminalId": "20086919",
"stan": "902261",
"pan": "506120***8033",
"retrievalReferenceNumber": "136919902261",
"cardAcceptorCode": "200001119220077",
"cardAcceptorLocation": "WT|ABUBAKAR MUHAMMAD MUST ZARIA NG",
"responseCode": "00",
"settled": true,
"hasMerchant": true,
"additionalInfo": {}
}
]