This is the disputes query endpoint. It is use to query created disputes.
Resource URL: <base url>arbiter/api/v1/disputes
HTTP Verb: GET
Authentication: User Access Token
REQUEST
| Field | Description |
|---|---|
| pageNum | The number of the page to start from. Default: 1 |
| pageSize | The number of items returned per page. Default: 100. Max: 100 |
| logCode | The logCode of the dispute |
| issuerCode | The domain code of the issuer |
| acquirerCode | The domain code of the acquirer |
| merchantCode | The domain code of the merchant |
| region | The region of the dispute |
| category | The category of the dispute |
| status | The status of the dispute |
| transactionStartDate | |
| transactionEndDate | |
| createdStartDate | |
| createdEndDate | |
| expiryStartDate | |
| expiryEndDate |
Sample Request
with parameters
<base url>arbiter/api/v1/disputes?acquirerCode=GTB&category=CHARGEBACK&status=CHARGEBACK&expiryStartDate=2017-08-1500:00:00&expiryEndDate=2017-08-1523:59:59
RESPONSE
| Field | Description |
|---|---|
| id | The id of the dispute |
| logCode | The log code of the dispute |
| issuerCode | The domain code of the issuer |
| issuer | The domain name of the issuer |
| acquirerCode | The domain code of the acquirer |
| acquirer | The domain name of the acquirer |
| merchantCode | The domain code of the merchant, if applicable |
| merchant | The domain name of the merchant, if applicable |
| merchantReference | The reference of the transaction in the merchant’s system, if applicable |
| 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 date and time of the transaction |
| transactionAmount | The amount of the transaction |
| surchargeAmount | The surcharge (or fee) of the transaction, if applicable |
| transactionCurrencyCode | The currency of the transaction. Format: ISO 4217 numeric |
| settlementAmount | The settlement amount of the transaction |
| settlementCurrencyCode | The currency of the transaction settlement. Format: ISO 4217 numeric |
| schemeAmount | The amount of the transaction in the card scheme’s currency |
| schemeCurrencyCode | The currency of the transaction from the card scheme’s system. Format: ISO 4217 numeric |
| terminalType | The type of the terminal |
| disputeAmountType | The type of the dispute amount |
| disputeAmount | The amount of the dispute |
| additionalInfo | Any additional data from the transaction |
| reasonCode | The code of the dispute reason |
| reason | The name of the dispute reason |
| category | The category of the dispute |
| region | The region of the dispute |
| merchantDisputant | Indicates whether the dispute is managed by the merchant or the acquirer |
| domainCode | The domain code of the initiator of the dispute |
| status | The current status of the dispute |
| statusStartDate | The date and time the current status began |
| statusScheduledEndDate | The date and time the current status is scheduled to expire, if applicable |
| createdBy | The user that logged the dispute |
| createdOn | The date and time the dispute was logged |
| lastUpdatedBy | The user that last updated the dispute |
| lastUpdatedOn | The date and time the dispute was last updated |
| accountNumber | the transaction account number |
Sample Response
{"count": 5,"content": [{"id": 48,"logCode": "ABP00II48","issuerCode": "ABP","issuer": "ACCESS BANK PLC","acquirerCode": "GTB","acquirer": "GUARANTY TRUST BANK","merchantCode": "","merchant": "","merchantReference": "","customerReference": "506104*********7109","transactionStore": "ISW_TRANSACTIONS","transactionReference": "506104*********7109|2017-06-05|10584434|009099|000845948826","transactionDate": "2017-06-05 22:54:27","transactionType": "ATM_WITHDRAWAL","transactionAmount": "NGN 1,000.00","transactionCurrencyCode": "566","terminalType": "ATM","disputeAmountType": "FULL","disputeAmount": "NGN 1,000.00","additionalInfo": {"sourceNodeName": "SWTGTBsrc","retrievalReferenceNumber": "000845948826","settlementCurrencyCode": "566","sinkNodeName": "SWTABPsnk","terminalId": "10584434","responseCode": "00","cardAcceptorCode": "GTB000000000639","cardAcceptorLocation": "GTBank Al-Hikmah Uni Ilorin KWNG","responseDescription": "Approved or completed successfully","merchantCategoryCode": "6011","stan": "009099","acquirerInstitutionCode": "627787","merchantType": "REGULAR"},"reasonCode": "NF","reason": "Non-Receipt of Cash from ATM","category": "CHARGEBACK","region": "DOMESTIC_ATM_WITHDRAWAL","merchantDisputant": false,"status": "CHARGEBACK","statusStartDate": "2017-08-11 11:21:23","statusScheduledEndDate": "2017-08-15 11:21:23","createdBy": "Selenium.Access@ABP","createdOn": "2017-08-11 11:21:24"},{"id": 46,"logCode": "FBN00II46","issuerCode": "FBN","issuer": "FIRST BANK OF NIGERIA","acquirerCode": "GTB","acquirer": "GUARANTY TRUST BANK","merchantCode": "","merchant": "","merchantReference": "","customerReference": "0000000001","transactionStore": "PAYDIRECT","transactionReference": "7604","transactionDate": "2012-03-25 00:00:01","transactionType": "BillPayment","transactionAmount": "NGN 100.00","transactionCurrencyCode": "566","terminalType": "WEB","disputeAmountType": "FULL","disputeAmount": "NGN 1,000.00","additionalInfo": {"PaymentReference": "FBN|Web|3PBL0001|HiTV|230312145656|00000048","responseDescription": "Approved or completed successfully","terminalId": "2069018M","IsSettled": false,"merchantType": "REGULAR","responseCode": "00"},"reasonCode": "AA","reason": "Does Not Recognize","category": "CHARGEBACK","region": "DOMESTIC_BILL_PAYMENT","merchantDisputant": false,"status": "CHARGEBACK","statusStartDate": "2017-08-03 18:16:26","statusScheduledEndDate": "2017-08-15 13:05:53","createdBy": "Selenium.FBN@FBN","createdOn": "2017-08-03 18:13:45","lastUpdatedBy": "Selenium.GTB@GTB","lastUpdatedOn": "2017-08-03 18:16:26"},{"id": 45,"logCode": "FBN00II45","issuerCode": "FBN","issuer": "FIRST BANK OF NIGERIA","acquirerCode": "GTB","acquirer": "GUARANTY TRUST BANK","merchantCode": "","merchant": "","merchantReference": "","customerReference": "0000000001","transactionStore": "PAYDIRECT","transactionReference": "7696","transactionDate": "2012-03-27 00:00:01","transactionType": "BillPayment","transactionAmount": "NGN 100.00","transactionCurrencyCode": "566","terminalType": "WEB","disputeAmountType": "FULL","disputeAmount": "NGN 1,000.00","additionalInfo": {"PaymentReference": "FBN|Web|3PBL0001|HiTV|270312191923|00000085","responseDescription": "Approved or completed successfully","terminalId": "2069018M","IsSettled": false,"merchantType": "REGULAR","responseCode": "00"},"reasonCode": "DP","reason": "Duplicate Processing","category": "CHARGEBACK","region": "DOMESTIC_BILL_PAYMENT","merchantDisputant": false,"status": "CHARGEBACK","statusStartDate": "2017-08-03 18:16:07","statusScheduledEndDate": "2017-08-15 16:11:19","createdBy": "Selenium.FBN@FBN","createdOn": "2017-08-03 18:13:11","lastUpdatedBy": "Selenium.GTB@GTB","lastUpdatedOn": "2017-08-03 18:16:07"}]}