Search for a single dispute
How to retrieve a single dispute
Use the Retrieve a single dispute endpoint to retrieve the individual details for a dispute and to see the list of events and associated allowedActions to respond to a dispute. See Responding to a Dispute page for more details.
{
"id": "20220602835125",
"status": "OPEN",
"stageCode": "CBK1",
"stageDescription": "Dispute",
"lastAction": "2022-06-02T10:43:22Z",
"posted": "2022-06-02",
"due": "2022-07-28",
"cardScheme": "VISA",
"acquirerReferenceNumber": "74720942152221525431867",
"reasonCode": "441",
"reasonDescription": "CBK: Processing Error",
"visaConditionCode": "4",
"visaConditionDescription": "Incorrect Account Number",
"amount": 17.99,
"currency": "AUD",
"visaId": "1000000000",
"tcn": "-1662613832",
"merchantId": "174062834992",
"merchantTransactionRef": "79754762",
"transactions": [
{
"id": "20220602695614",
"date": "2022-06-01T00:00:00Z",
"typeCode": "005",
"typeDescription": "Purchase",
"captureMethodCode": "054",
"captureMethodDescription": "eCommerce, Channel Encrypt",
"posted": "2022-06-01",
"cardNumber": "400203XXCJYR0008",
"originalTransactionAmount": 100,
"originalTransactionCurrency": "HKD",
"networkSettlementAmount": 17.99,
"networkSettlementCurrency": "AUD",
"merchantFundingAmount": 100,
"merchantFundingCurrency": "HKD",
"reversal": false,
"duplicate": false,
"arn": "74720942152221525431867",
"authCode": "601801"
}
],
"documents": [
{
"id": "20220627739641",
"description": "PRE_ARBITRATION",
"filename": "image.tiff",
"filetype": "TIFF",
"status": "RECEIVED",
"uploadedBy": "API_USER",
"uploaded": "2022-06-27T08:52:26Z"
}
],
"events": [
{
"id": "TXN-20220602695615",
"type": "DISPUTE",
"longDescription": "Dispute",
"reversal": false,
"partial": false,
"received": "2022-06-02",
"networkSettlementAmount": 17.99,
"networkSettlementCurrency": "AUD",
"merchantFundingAmount": 17.99,
"merchantFundingCurrency": "AUD",
"allowedActions": [
{
"code": "040",
"description": "Chargeback Accepted",
"extendedDescription": "Chargeback Accepted",
"status": "AVAILABLE",
"requiredDataFields": [
{
"name": "tcn",
"description": "Transaction Control Number of the Dispute",
"type": "integer",
"format": "int64",
"example": "-943823606",
"minLength": -19000101000000,
"maxLength": 99999999999999,
"required": "Y"
},
{
"name": "code",
"description": "unique code(actionCode) represent an action",
"type": "string",
"example": "086",
"required": "Y",
"pattern": "^[0-9]{3}$"
}
]
},
{
"code": "088-FULL-CNLD",
"description": "Initiate VCR Collab. Resp",
"extendedDescription": "Dispute Response and disputeResponse is full and disputeResponseReason is Cardholder doesnt dispute anymore(CNLD)",
"status": "AVAILABLE",
"requiredDataFields": [
{
"name": "code",
"description": "unique code(actionCode) represent an action",
"type": "string",
"example": "086",
"required": "Y",
"pattern": "^[0-9]{3}$"
},
{
"name": "tcn",
"description": "Transaction Control Number of the Dispute",
"type": "integer",
"format": "int64",
"example": "-943823606",
"minLength": -19000101000000,
"maxLength": 99999999999999,
"required": "Y"
},
{
"name": "documentId",
"description": "The document Id linked to the transaction Id on which we are taking an action",
"type": "intger",
"format": "int64",
"example": "20190101921021",
"minLength": 19000101000000,
"maxLength": 99991231999999,
"required": "Y"
},
{
"name": "evidence",
"description": "Evidence such as photographs or emails, to prove a link between the person receiving the merchandise or services and the cardholder, or to prove that the cardholder disputing the transaction is in possession of the merchandise and/or is using the services. We support files formatted as TIFF, PDF, DOCX and DOC",
"notes": "This is a document used in evidence as part of the dispute. Maximum supported file size is 5MB",
"type": "string",
"format": "binary",
"required": "Y"
},
{
"name": "disputeResponseReasonExplanation",
"description": "dispute response reason explanation",
"type": "string",
"example": "name",
"required": "N",
"pattern": "^[\\p{L}\\d\\s\\.\\,\\;\\'\\-\\\"\\“\\„&\\(\\)\\[\\]\\{\\}\\:\\!\\?<>]{0,10000}$"
},
{
"name": "issuerAcquirerContactName",
"description": "issuer or Acquirer Contact name",
"notes": "This will be populate internally by API",
"type": "string",
"example": "name",
"required": "Y"
}
]
}
],
"previousActions": [
{
"id": "20220602511639",
"code": "002",
"description": "Transfer to Merch",
"extendedDescription": "Transfer the value of the transaction to the Merchants account",
"status": "PROCESSED",
"modified": "2022-06-02T10:42:53Z",
"modifiedBy": "SYSTEM"
}
],
"reasonCode": "12",
"reasonDescription": "CBK: Processing Error",
"visaConditionCode": "4",
"visaConditionDescription": "Incorrect Account Number"
},
{
"id": "DOC-20220627739640",
"type": "VISA_COLLABORATION_PREARBITRATION",
"reversal": false,
"partial": false,
"received": "2022-06-27",
"merchantFundingAmount": 10,
"merchantFundingCurrency": "HKD",
"allowedActions": [],
"previousActions": [],
"reasonCode": "11",
"reasonDescription": "CBK: Authorization",
"visaConditionCode": "3",
"visaConditionDescription": "No Authorization"
}
],
"authorisations": [
{
"id": "18372942346",
"date": "2022-06-01T00:00:00Z",
"authCode": "601517",
"amount": 700,
"currency": "HKD",
"posEntryMode": "810",
"eciSli": "07"
}
],
"notes": [
{
"id": "20220721948337",
"content": "Such a beautiful day to test an API!",
"tcn": -1662361782,
"createdBy": "API_USER",
"created": "2022-07-21T15:27:07Z",
"updated": "2022-07-21T15:27:07Z"
}
]
}
What does dispute data look like?
Transactions
Transactions contain a list of financial transactions associated with this dispute and will contain the original disputed transaction, refunds or further adjustments made during the processing of this dispute.
Documents
Documents contains a list of various evidences and other pieces of documentation either provided by the Merchant, Cardholder, Issuer or Card Scheme during the processing of the dispute and can be used for reference when responding.
Dispute Events
Disputes can get a little complicated as they reach the later stages of the dispute cycle and you can have multiple actions that can be performed at the same times on different parts of a dispute. We make this very simple for you by providing a list of events that can then each be individually actioned using their previousActions array with the actions you have already taken being displayed in the allowedActions array allowing you to get a quick overview of permitted actions on this particular dispute.
Updated about 1 year ago
