Get Dispute Batches

Use this endpoint to retrieve available dispute batches

REQUEST

Field NameDescriptionTypeRequiredConstraints
pageNumThe number of the page to start from.StringOptionalDefault: 1
pageSizeThe number of items returned per page.StringOptionalDefault: 100. Max: 100

Sample Request

{{base_url}}/api/v1/disputes/batches?pageNum=1&pageSize=5

RESPONSE

Field NameDescriptionTypeConstraints
domainCodeThe domain code of the uploaderString
domainThe n
transactionGroupThe transaction groupStringSee Get Transaction Groups
transactionChannelThe channel of the transaction.StringSee Get Transaction Groups
disputeCategoryThe name of the dispute categoryEnumINQUIRY, CHARGEBACK, GOVERNMENT_BILLER, TSA_BILLER, REFUND, GOOD_FAITH, CO_ACQUIRED, FRAUD
batchFileThe name of the fileString
recordCountThe total number of records in the fileInteger
processedCountThe total number of processed recordsInteger
errorCountThe total number of failed recordsInteger
statusThe processing status of the fileString
createdByThe user that created the fileString
createdOnThe time the file was createdDateTime
countThe total number of records availableInteger
contentAn array of the returned recordsJSON Array

Sample Response

{
    "count": 205,
    "content": [
        {
            "domainCode": "ISW",
            "domain": "INTERSWITCH",
            "transactionGroup": "Bill Payment",
            "transactionChannel": "All",
            "disputeCategory": "Chargeback",
            "batchFile": "ISW-2023-09-29-733C41F1-6A39-4D52-A6BF-6C07DE1A973C.xlsx",
            "recordCount": 3,
            "processedCount": 3,
            "errorCount": 3,
            "status": "Completed",
            "createdBy": "Jideobi.Onuora@ISW",
            "createdOn": "2023-09-29T00:26:31.157Z",
            "lastUpdatedOn": "2023-09-29T00:29:21.477Z"
        },
        {
            "domainCode": "ISW",
            "domain": "INTERSWITCH",
            "transactionGroup": "Transfer Service",
            "transactionChannel": "All",
            "disputeCategory": "Chargeback",
            "batchFile": "ISW-2023-09-28-255A094E-DA80-496B-AF9B-1AEC5AF76384.xls",
            "recordCount": 1,
            "processedCount": 1,
            "errorCount": 0,
            "status": "Completed",
            "createdBy": "Ayobami.Ajibade@ISW",
            "createdOn": "2023-09-28T17:05:58.86Z",
            "lastUpdatedOn": "2023-09-28T17:06:57.547Z"
        },
        {
            "domainCode": "ISW",
            "domain": "INTERSWITCH",
            "transactionGroup": "IPG",
            "transactionChannel": "All",
            "disputeCategory": "Chargeback",
            "batchFile": "ISW-2023-09-28-34C0CDD8-3309-4F65-B72B-B02FCE45108A.xls",
            "recordCount": 1,
            "processedCount": 1,
            "errorCount": 0,
            "status": "Completed",
            "createdBy": "Ayobami.Ajibade@ISW",
            "createdOn": "2023-09-28T11:06:04.54Z",
            "lastUpdatedOn": "2023-09-28T11:07:43.837Z"
        },
        {
           "domainCode": "ISW",
            "domain": "INTERSWITCH",
            "transactionGroup": "Bill Payment",
            "transactionChannel": "All",
            "disputeCategory": "Chargeback",
            "batchFile": "ISW-2023-09-28-E9CEF254-59FC-4D32-BB16-992E6174185D.xlsx",
            "recordCount": 3,
            "processedCount": 0,
            "errorCount": 0,
            "status": "Cancelled",
            "createdBy": "Jideobi.Onuora@ISW",
            "createdOn": "2023-09-28T10:30:28.95Z",
            "lastUpdatedOn": "2023-09-28T11:03:21.357Z"
        },
        {
            "domainCode": "ISW",
            "domain": "INTERSWITCH",
            "transactionGroup": "CASH WITHDRAWAL",
            "transactionChannel": "ALL",
            "disputeCategory": "Chargeback",
            "batchFile": "ISW-2023-09-25-91EF6EE3-7225-45BA-B6BF-60D200360BCD.xls",
            "recordCount": 5,
            "processedCount": 5,
            "errorCount": 1,
            "status": "Completed",
            "createdBy": "Ayobami.Ajibade@ISW",
            "createdOn": "2023-09-25T10:50:18.633Z",
            "lastUpdatedOn": "2023-09-25T10:52:56.207Z"
        }
    ]
}
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!