Use this endpoint to retrieve a non VAS transaction in dispute with the aim of logging it in Arbiter
Resource URL: <base url>/arbiter/api/v1/transactions.json
HTTP Verb: GET
Authentication: User Access Token
REQUEST
Sample Request
GET <base url>/arbiter/api/v1/transactions.json?pan=539983******0103&stan=196011&startDate=2014-08-21&endDate=2014-08-21&pageNum=1&pageSize=5
Request Header
Content-Type: application/json
Authorization: Bearer <AccessToken>
Request Parameters Description
Field # | Field name | Data type | Max length | Required | Default | Description |
---|---|---|---|---|---|---|
1 | transactionType | String | Variable | No | Default | Expected value is any one of these: [ Default | Transfers ] |
2 | pan | String | Variable | Yes | N/A | PAN – first 6 and last 4 characters plain, all characters in between masked |
3 | startDate | Date | 10 | Yes | N/A | start date for the date range to search using date format yyyy-MM-dd |
4 | endDate | Date | 10 | Yes | N/A | end date for the date range to search using date format yyyy-MM-dd |
5 | pageNum | int | No | 1 | Page Number for result pagination | |
6 | pageSize | int | No | 5 | Page Size determines the maximum number of results to be returned per page | |
7 | terminalId | String | 8 | No | N/A | Terminal ID |
8 | stan | String | 6 | No | N/A | System Trace Audit Number |
9 | fromAccount | String | Variable | No | N/A | Source Account Number |
10 | toAccount | String | Variable | No | N/A | Destination Account Number |
Response Message Field Description
Field# | Field name | Description |
---|---|---|
1 | remoteTranId | transaction reference |
2 | acquirerCode | The acquirer code |
3 | tranType | The type of transaction that was done |
4 | terminalId | The ID of the terminal where the transaction was done |
5 | tranDate | The date the transaction was done |
6 | pan | The PAN |
7 | retrievalReferenceNo | request date and time in date format yyyy-MM-dd hh:mm:ss |
8 | stan | The system audit trace number |
9 | transactionAmount | The amount requested for the transaction |
10 | surchargeAmount | The transaction fee if any |
11 | sinkNodeName | The sink node |
12 | sourceNodeName | The source node |
13 | merchantType | They type of Merchant if it was a merchant trasaction |
14 | fromAccountNo | The account |
15 | issuerCode | The code of the issuer |
16 | responseCode | The response code for the transaction |
17 | transactionCurrency | Numeric currency code of issuer |
18 | settlementCurrency | Numeric currency code of acquirer |
19 | cardAcceptorIdCode | ID of card acceptor |
20 | settlementCurrencyAlphaCode | ISO 4217 currency code of the acquirer |
21 | transactionCurrencyAlphaCode | ISO 4217 currency code of the issuer |
22 | settleAmount | The amount that was debited during the transaction |
23 | settleAmountImpact | |
24 | cardAcceptorNameLoc | Card acceptor name and location |
RESPONSE
Sample Response (success)
[
{
“remoteTranId”: 42715110189,
“acquirerCode”: “ZIB”,
“tranType”: “Bet”,
“terminalId”: “3IPG0001”,
“tranDate”: “2019-09-11 05:10:00”,
“pan”: “537010******2211”,
“retrievalReferenceNo”: “001122403690”,
“stan”: “117185”,
“transactionAmount”: 300.0,
“surchargeAmount”: 0.0,
“sinkNodeName”: “SWTEBNsnk”,
“sourceNodeName”: “SWTASPWEBsrc”,
“merchantType”: “7399”,
“fromAccountNo”: “1403008575”,
“toAccountNo”: null,
“issuerCode”: “EBN”,
“responseCode”: “00”,
“transactionCurrency”: null,
“settlementCurrency”: null,
“cardAcceptorIdCode”: “IPG000000000786”,
“settlementCurrencyAlphaCode”: “NGN”,
“transactionCurrencyAlphaCode”: null,
“settleAmount”: 0.0,
“settleAmountImpact”: null,
“cardAcceptorNameLoc”: “Sporty_t262397575i10785interswitchdeLANG”
}
]
Sample Response (Failure)
{
"code": "10400",
"description": "Pan is required",
"errors": null
}
Response Code
Response Code | Response Message | HTTP Code |
---|---|---|
Success | 200 or 201 or 204 | |
10400 | Bad request | 400 |
10404 | Not found | 404 |
10409 | Conflict / Duplicate | 409 |
10500 | Internal server error | 500 |