get https://sandbox.interswitchng.com/arbiter/api/v1/disputes
This is the disputes query endpoint. It is use to query created disputes.
REQUEST
| Field Name | Description | Type | Required | Constraints |
|---|---|---|---|---|
| pageNum | The number of the page to start from. | String | Optional | Default: 1 |
| pageSize | The number of items returned per page. | String | Optional | Default: 100. Max: 100 |
| logCode | The log code of the dispute | String | Optional | |
| issuerCode | The domain code of the issuer | String | Optional | |
| acquirerCode | The domain code of the acquirer | String | Optional | |
| merchantCode | The domain code of the merchant | String | Optional | |
| region | The region of the dispute | String | Optional | |
| category | The name of the dispute category | Enum | Optional | INQUIRY, CHARGEBACK, GOVERNMENT_BILLER, TSA_BILLER, REFUND, GOOD_FAITH, CO_ACQUIRED, FRAUD |
| status | The status of the dispute | Enum | Optional | INQUIRY, CHARGEBACK, REPRESENTMENT, PRE_ARBITRATION, PRE_ARBITRATION_II, ARBITRATION, REFUND, GOOD_FAITH, ACCEPTED, DECLINED |
| transactionStartDate | The start date and time of the transaction. | DateTime | Optional | Format: yyyy-MM-dd HH:mm:ss |
| transactionEndDate | The end date and time of the transaction. | DateTime | Optional | Format: yyyy-MM-dd HH:mm:ss |
| createdStartDate | The created start date and time of the transaction. | DateTime | Optional | Format: yyyy-MM-dd HH:mm:ss |
| createdEndDate | The created end date and time of the transaction. | DateTime | Optional | Format: yyyy-MM-dd HH:mm:ss |
| expiryStartDate | The expiration start date and time of the transaction. | DateTime | Optional | Format: yyyy-MM-dd HH:mm:ss |
| expiryEndDate | The expiration end date and time of the transaction. | DateTime | Optional | Format: yyyy-MM-dd HH:mm:ss |
Sample Request
{{base_url}}/api/v1/disputes?pageSize=10&pageNum=1
RESPONSE
| Field Name | Description | Type | Constraint |
|---|---|---|---|
| count | The total number of records available. | Integer | |
| content | An array of the returned records | JSON Array | |
| logCode | The log code of the dispute | String | |
| 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 name of the acquirer | String | |
| merchantCode | The domain code of the merchant, if applicable | String | |
| merchant | The domain name of the merchant, if applicable | String | |
| 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 | |
| transactionDate | The UTC date and time of the transaction | String | |
| transactionType | The type of the transaction | String | refer to Get Transaction Types |
| transactionAmount | The amount of the transaction | String | |
| surchargeAmount | The surcharge (or fee) of the transaction, if applicable | String | |
| transactionCurrencyCode | The currency of the transaction. Format: ISO 4217 numeric | String | |
| settlementAmount | The settlement amount of the transaction | String | |
| settlementCurrencyCode | The currency of the transaction settlement. Format: ISO 4217 numeric | String | |
| terminalType | The type of the terminal | String | |
| disputeAmountType | The type of the dispute amount | Enum | FULL or PARTIAL |
| disputeAmount | The amount of the dispute | String | |
| additionalInfo | Any additional data from the transaction | JSON String | |
| reasonCode | The code of reason of the dispute | String | refer to Get Dispute Reasons |
| reason | The reason for the dispute | String | refer to Get Dispute Reasons |
| category | The category of the dispute | String | refer to Get Dispute Categories |
| region | The region of the dispute | String | |
| merchantDisputant | Indicates whether the dispute is managed by the merchant or the acquirer | Boolean | |
| domainCode | The domain code of the issuer of the dispute | String | |
| status | The current status of the dispute | String | |
| statusStartDate | The UTC date and time the current status began | DateTime | |
| createdBy | The user that logged the dispute | String | |
| createdOn | The UTC date and time the dispute was logged | DateTime | |
| accountNumber | The transaction account number | String | |
| merchantEmail | The email address of the merchant if applicable | String | |
| pan | The masked PAN of the card used in the transaction | String |
Sample Response
{
"count": 436,
"content": [
{
"logCode": "UBA00II62954",
"issuerCode": "UBA",
"issuer": "UNITED BANK FOR AFRICA",
"acquirerCode": "FBN",
"acquirer": "FIRST BANK OF NIGERIA",
"merchantCode": "",
"merchant": "",
"customerReference": "519911******4156",
"transactionStore": "RJService",
"transactionReference": "18NE19567994_567994_2011NE19_-300000.00_0200",
"transactionDate": "2023-08-23T11:00:00Z",
"transactionType": "AGENCY_BANKING_TRANSFER",
"transactionAmount": "NGN 3,000.00",
"surchargeAmount": "NGN 0.00",
"transactionCurrencyCode": "566",
"settlementAmount": "NGN 0.00",
"settlementCurrencyCode": "566",
"terminalType": "2",
"disputeAmountType": "Full",
"disputeAmount": "NGN 3,000.00",
"additionalInfo": {
"Card Acceptor Code": "200001131070045",
"Card Acceptor Location": "WT|IBADAN NG",
"Card Scheme": "Verve",
"Has Merchant": true,
"Merchant Type": "REGULAR",
"Response Code": "00",
"Retrieval Reference Number": "18NE19567994",
"Settled": true,
"Stan": "567994",
"Terminal Id": "2011NE19"
},
"reasonCode": "RG",
"reason": "Non-Receipt of Goods and Services",
"category": "Chargeback",
"region": "DOMESTIC_AGENCY_TRANSFERS",
"merchantDisputant": false,
"domainCode": "UBA",
"status": "Accepted",
"previousStatus": "Chargeback",
"statusStartDate": "2023-09-28T21:08:05.763Z",
"createdBy": "Jideobi.Onuora@ISW",
"createdOn": "2023-09-28T21:07:15.47Z",
"lastUpdatedBy": "Jideobi.Onuora@FBN",
"lastUpdatedOn": "2023-09-28T21:08:05.827Z",
"pan": "519911******4156"
},
{
"logCode": "FBN00II62951",
"issuerCode": "FBN",
"issuer": "FIRST BANK OF NIGERIA",
"acquirerCode": "FBN",
"acquirer": "FIRST BANK OF NIGERIA",
"merchantCode": "MX19575",
"merchant": "Refeay limited_SANDBOX",
"customerReference": "2SgqpVq5RR",
"transactionStore": "IPG",
"transactionReference": "474549881",
"transactionDate": "2023-09-25T12:32:25Z",
"transactionType": "WEB",
"transactionAmount": "NGN 101.00",
"surchargeAmount": "NGN 0.00",
"transactionCurrencyCode": "566",
"settlementCurrencyCode": "566",
"terminalType": "WEB",
"disputeAmountType": "Full",
"disputeAmount": "NGN 101.00",
"additionalInfo": {
"Issuer Country": "NG",
"Has Merchant": true,
"Card Scheme": "Verve",
"Response Description": "Approved by Financial Institution",
"Settled": true,
"Stan": "000008",
"Retrieval Reference Number": "000106923853",
"Terminal Id": "3PXM0001",
"Merchant Type": "REGULAR",
"Response Code": "00"
},
"reasonCode": "RG",
"reason": "Non-Receipt of Goods and Services",
"category": "Chargeback",
"region": "IPG",
"merchantDisputant": false,
"domainCode": "FBN",
"status": "Chargeback",
"statusStartDate": "2023-09-28T11:07:41.417Z",
"createdBy": "Ayobami.Ajibade@ISW",
"createdOn": "2023-09-28T11:07:42.69Z",
"accountNumber": "6231148695",
"pan": "506099*********7499"
},
{
"logCode": "FBN00II62949",
"issuerCode": "FBN",
"issuer": "FIRST BANK OF NIGERIA",
"acquirerCode": "GTB",
"acquirer": "GUARANTY TRUST BANK",
"merchantCode": "",
"merchant": "",
"customerReference": "539923******6739",
"transactionStore": "RJService",
"transactionReference": "221126105827_695565_2KUD3MM6_-50000.00_0200",
"transactionDate": "2023-08-23T11:00:00Z",
"transactionType": "AGENCY_BANKING_TRANSFER",
"transactionAmount": "NGN 500.00",
"surchargeAmount": "NGN 0.00",
"transactionCurrencyCode": "566",
"settlementAmount": "NGN 0.00",
"settlementCurrencyCode": "566",
"terminalType": "2",
"disputeAmountType": "Full",
"disputeAmount": "NGN 500.00",
"additionalInfo": {
"Card Acceptor Code": "2KUD47210086313",
"Card Acceptor Location": "2KUD3MM6-221126105827 LA LANG",
"Card Scheme": "MasterCard",
"Has Merchant": true,
"Merchant Type": "REGULAR",
"Response Code": "00",
"Retrieval Reference Number": "221126105827",
"Settled": true,
"Stan": "695565",
"Terminal Id": "2KUD3MM6"
},
"reasonCode": "RG",
"reason": "Non-Receipt of Goods and Services",
"category": "Chargeback",
"region": "DOMESTIC_AGENCY_TRANSFERS",
"merchantDisputant": false,
"domainCode": "FBN",
"status": "Accepted",
"previousStatus": "Chargeback",
"statusStartDate": "2023-09-26T12:44:08.523Z",
"createdBy": "Emmanuel.Kpoudosu@FBN",
"createdOn": "2023-09-26T11:48:45.79Z",
"lastUpdatedBy": "Emmanuel.Kpoudosu@GTB",
"lastUpdatedOn": "2023-09-26T12:44:08.633Z",
"pan": "539923******6739"
},
{
"logCode": "IBTC0II62943",
"issuerCode": "IBTC",
"issuer": "Stanbic IBTC Bank",
"acquirerCode": "FBN",
"acquirer": "FIRST BANK OF NIGERIA",
"merchantCode": "",
"merchant": "",
"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",
"disputeAmountType": "Full",
"disputeAmount": "NGN 100.00",
"additionalInfo": {
"Card Acceptor Code": "200001119220077",
"Card Acceptor Location": "WT|ABUBAKAR MUHAMMAD MUST ZARIA NG",
"Card Scheme": "Verve",
"Has Merchant": true,
"Merchant Type": "REGULAR",
"Response Code": "00",
"Retrieval Reference Number": "136919902261",
"Settled": true,
"Stan": "902261",
"Terminal Id": "20086919"
},
"reasonCode": "RG",
"reason": "Non-Receipt of Goods and Services",
"category": "Chargeback",
"region": "DOMESTIC_AGENCY_TRANSFERS",
"merchantDisputant": false,
"domainCode": "IBTC",
"status": "Accepted",
"previousStatus": "Chargeback",
"statusStartDate": "2023-09-23T22:46:58.637Z",
"createdBy": "Jideobi.Onuora@ISW",
"createdOn": "2023-09-23T22:30:07.087Z",
"lastUpdatedBy": "Jideobi.Onuora@FBN",
"lastUpdatedOn": "2023-09-23T22:46:58.653Z",
"pan": "506120*********8033"
},
{
"logCode": "FBN00II62937",
"issuerCode": "FBN",
"issuer": "FIRST BANK OF NIGERIA",
"acquirerCode": "EBN",
"acquirer": "ECOBANK OF NIGERIA",
"customerReference": "506105*********8439_3096434667",
"transactionStore": "RJService",
"transactionReference": "001696895925_000740_10503615_-2000000.00_0200",
"transactionDate": "2023-06-07T07:45:33Z",
"transactionType": "ATM_CASH_WITHDRAWAL",
"transactionAmount": "NGN 20,000.00",
"surchargeAmount": "NGN 0.00",
"transactionCurrencyCode": "566",
"settlementAmount": "NGN 20,000.00",
"settlementCurrencyCode": "566",
"terminalType": "1",
"disputeAmountType": "Full",
"disputeAmount": "NGN 20,000.00",
"additionalInfo": {
"Card Acceptor Code": "EBN000000003611",
"Card Acceptor Location": "ENG EN AGBANI RD EN ENNG",
"Card Scheme": "Verve",
"Has Merchant": false,
"Response Code": "00",
"Response Description": "Approved",
"Retrieval Reference Number": "001696895925",
"Settled": true,
"Sink Node Name": "SWTFBNsnk",
"Source Node Name": "SWTEBNsrc",
"Stan": "000740",
"Terminal Id": "10503615"
},
"reasonCode": "100",
"reason": "Test Reason",
"category": "Chargeback",
"region": "DOMESTIC_ATM_WITHDRAWAL",
"merchantDisputant": false,
"domainCode": "FBN",
"status": "Chargeback",
"statusStartDate": "2023-09-18T13:07:38.003Z",
"createdBy": "Emmanuel.Kpoudosu@ISW",
"createdOn": "2023-09-18T13:07:38.113Z",
"accountNumber": "3096434667",
"pan": "506105*********8439"
},
{
"logCode": "FBN00II62935",
"issuerCode": "FBN",
"issuer": "FIRST BANK OF NIGERIA",
"acquirerCode": "EBN",
"acquirer": "ECOBANK OF NIGERIA",
"customerReference": "506105*********0800_3047530781",
"transactionStore": "RJService",
"transactionReference": "001696916320_007573_10500873_-2000000.00_0200",
"transactionDate": "2023-06-07T08:08:40Z",
"transactionType": "ATM_CASH_WITHDRAWAL",
"transactionAmount": "NGN 20,000.00",
"surchargeAmount": "NGN 0.00",
"transactionCurrencyCode": "566",
"settlementAmount": "NGN 20,000.00",
"settlementCurrencyCode": "566",
"terminalType": "1",
"disputeAmountType": "Full",
"disputeAmount": "NGN 20,000.00",
"additionalInfo": {
"Card Acceptor Code": "EBN000000000871",
"Card Acceptor Location": "EBN NKPOR NKPOR ANNG",
"Card Scheme": "Verve",
"Has Merchant": false,
"Response Code": "00",
"Response Description": "Approved",
"Retrieval Reference Number": "001696916320",
"Settled": true,
"Sink Node Name": "SWTFBNsnk",
"Source Node Name": "SWTEBNsrc",
"Stan": "007573",
"Terminal Id": "10500873"
},
"reasonCode": "100",
"reason": "Test Reason",
"category": "Chargeback",
"region": "DOMESTIC_ATM_WITHDRAWAL",
"merchantDisputant": false,
"domainCode": "FBN",
"status": "Chargeback",
"statusStartDate": "2023-09-18T13:07:26.357Z",
"createdBy": "Emmanuel.Kpoudosu@ISW",
"createdOn": "2023-09-18T13:07:27.24Z",
"accountNumber": "3047530781",
"pan": "506105*********0800"
},
{
"logCode": "ABP00II62934",
"issuerCode": "ABP",
"issuer": "ACCESS BANK PLC",
"acquirerCode": "FBN",
"acquirer": "FIRST BANK OF NIGERIA",
"customerReference": "506124*********1442_0970144110",
"transactionStore": "RJService",
"transactionReference": "009309150012_007259_17017411_-500000.00_0200",
"transactionDate": "2023-06-07T08:25:39Z",
"transactionType": "ATM_CASH_WITHDRAWAL",
"transactionAmount": "NGN 5,000.00",
"surchargeAmount": "NGN 0.00",
"transactionCurrencyCode": "566",
"settlementAmount": "NGN 5,000.00",
"settlementCurrencyCode": "566",
"terminalType": "1",
"disputeAmountType": "Full",
"disputeAmount": "NGN 5,000.00",
"additionalInfo": {
"Card Acceptor Code": "00000000000417",
"Card Acceptor Location": "Ibadan Town Planing 1 Ibadan NG",
"Card Scheme": "Verve",
"Has Merchant": false,
"Response Code": "00",
"Response Description": "Approved",
"Retrieval Reference Number": "009309150012",
"Settled": true,
"Sink Node Name": "SWTASPsnk",
"Source Node Name": "SWTFBNsrc",
"Stan": "007259",
"Terminal Id": "17017411"
},
"reasonCode": "100",
"reason": "Test Reason",
"category": "Chargeback",
"region": "DOMESTIC_ATM_WITHDRAWAL",
"merchantDisputant": false,
"domainCode": "ABP",
"status": "Chargeback",
"statusStartDate": "2023-09-18T11:51:19.453Z",
"createdBy": "Emmanuel.Kpoudosu@ISW",
"createdOn": "2023-09-18T11:51:19.633Z",
"accountNumber": "0970144110",
"pan": "506124*********1442"
},
{
"logCode": "AMJU0II62927",
"issuerCode": "AMJU",
"issuer": "AMJU",
"acquirerCode": "FBN",
"acquirer": "FIRST BANK OF NIGERIA",
"merchantCode": "",
"merchant": "",
"customerReference": "506124*********6609_3002005896",
"transactionStore": "RJService",
"transactionReference": "18XU08172895_172895_2011XU08_-110000.00_0200",
"transactionDate": "2023-09-11T17:43:01Z",
"transactionType": "AGENCY_BANKING_TRANSFER",
"transactionAmount": "NGN 1,100.00",
"surchargeAmount": "NGN 0.00",
"transactionCurrencyCode": "566",
"settlementAmount": "NGN 1,100.00",
"settlementCurrencyCode": "566",
"terminalType": "2",
"disputeAmountType": "Full",
"disputeAmount": "NGN 1,100.00",
"additionalInfo": {
"Card Acceptor Code": "200001110240171",
"Card Acceptor Location": "WT|WARRI NG",
"Card Scheme": "Verve",
"Has Merchant": true,
"Merchant Type": "REGULAR",
"Response Code": "00",
"Response Description": "Approved",
"Retrieval Reference Number": "18XU08172895",
"Settled": true,
"Sink Node Name": "SWTASPsnk",
"Source Node Name": "SWTFBNsrc",
"Stan": "172895",
"Terminal Id": "2011XU08"
},
"reasonCode": "100",
"reason": "Test Reason",
"category": "Chargeback",
"region": "DOMESTIC_AGENCY_TRANSFERS",
"merchantDisputant": false,
"domainCode": "AMJU",
"status": "Chargeback",
"statusStartDate": "2023-09-15T20:31:57.87Z",
"createdBy": "Emmanuel.Kpoudosu@ISW",
"createdOn": "2023-09-15T20:31:57.92Z",
"accountNumber": "3002005896",
"pan": "506124*********6609"
},
{
"logCode": "FBN00II52918",
"issuerCode": "FBN",
"issuer": "FIRST BANK OF NIGERIA",
"acquirerCode": "ABP",
"acquirer": "ACCESS BANK PLC",
"merchantCode": "MX6072",
"merchant": "sadd",
"customerReference": "72632691686563684590388287",
"transactionStore": "IPG",
"transactionReference": "474492633",
"transactionDate": "2023-06-12T09:56:46Z",
"transactionType": "WEB",
"transactionAmount": "NGN 200.00",
"surchargeAmount": "NGN 0.00",
"transactionCurrencyCode": "566",
"settlementCurrencyCode": "566",
"terminalType": "WEB",
"disputeAmountType": "Full",
"disputeAmount": "NGN 200.00",
"additionalInfo": {
"Issuer Country": "NG",
"Has Merchant": true,
"Card Scheme": "Verve",
"Response Description": "Approved by Financial Institution",
"Settled": true,
"Stan": "000008",
"Retrieval Reference Number": "000106923853",
"Terminal Id": "3PXM0001",
"Merchant Type": "REGULAR",
"Response Code": "00"
},
"reasonCode": "05",
"reason": "Good Faith Investigation",
"category": "Good Faith",
"region": "IPG",
"merchantDisputant": true,
"domainCode": "FBN",
"status": "Good Faith",
"statusStartDate": "2023-08-23T12:44:19.903Z",
"createdBy": "Ayobami.Ajibade@FBN",
"createdOn": "2023-08-23T12:44:19.903Z",
"accountNumber": "6231148695",
"pan": "506099*********7499"
},
{
"logCode": "FBN00II52916",
"issuerCode": "FBN",
"issuer": "FIRST BANK OF NIGERIA",
"acquirerCode": "FBN",
"acquirer": "FIRST BANK OF NIGERIA",
"merchantCode": "MX54439",
"merchant": "UNLIMINT_SANDBOX",
"customerReference": "682829181",
"transactionStore": "IPG",
"transactionReference": "3611404",
"transactionDate": "2022-08-02T14:27:58Z",
"transactionType": "WEB",
"transactionAmount": "NGN 3.00",
"surchargeAmount": "NGN 0.00",
"transactionCurrencyCode": "566",
"settlementCurrencyCode": "566",
"terminalType": "WEB",
"disputeAmountType": "Full",
"disputeAmount": "NGN 3.00",
"additionalInfo": {
"Issuer Country": "NG",
"Has Merchant": true,
"Card Scheme": "Verve",
"Response Description": "Approved by Financial Institution",
"Settled": true,
"Stan": "000008",
"Retrieval Reference Number": "000106923853",
"Terminal Id": "3PXM0001",
"Merchant Type": "REGULAR",
"Response Code": "00"
},
"reasonCode": "Test1",
"reason": "Test",
"category": "Refund",
"region": "IPG",
"merchantDisputant": false,
"domainCode": "FBN",
"status": "Accepted",
"previousStatus": "Refund",
"statusStartDate": "2023-08-22T21:07:03.703Z",
"createdBy": "Ayobami.Ajibade@FBN",
"createdOn": "2023-08-22T21:05:14.667Z",
"lastUpdatedBy": "Simon.Imoh@FBN",
"lastUpdatedOn": "2023-08-22T21:07:03.817Z",
"accountNumber": "1078513024",
"pan": "506099*********7499"
}
]
}