Dispute
Dispute: Add File Evidence
You can submit an evidence file for a dispute through this method. You can only submit evidence for disputes that have a status of "open"
.
- Java
Result<DisputeEvidence> result = gateway.dispute().addFileEvidence(
"a_dispute_id",
documentResult.getTarget().getId()
);
If the evidence is successfully added to the dispute, the result will be successful and will include the evidence object. Otherwise, check for validation errors.
- Java
if (result.isSuccess()) {
// evidence file added successfully
DisputeEvidence evidence = result.getTarget();
} else {
System.out.println(result.getErrors());
}
Arguments
disputeId
required, stringAdditional Parameters
.category(…)
string.documentId(…)
stringThe unique identifier for a Document Upload
object. The document must have a kind of EVIDENCE_DOCUMENT.
Valid file evidence categories
If a dispute requires compelling evidence, use the following category codes to indicate what type of evidence you're submitting. Depending on the dispute reason code, additional validations may apply.
Category | Description |
---|---|
LEGIT_PAYMENTS_FOR_SAME_MERCHANDISE | Evidence of spending across multiple payment types for the same merchandise. |
MERCHANT_WEBSITE_OR_APP_ACCESS | Evidence of merchant website or app access. |
PROFILE_SETUP_OR_APP_ACCESS | Evidence of a profile setup or app access. |
PROOF_OF_AUTHORIZED_SIGNER | Evidence the transaction was completed by an authorized signer that the cardholder knows. |
PROOF_OF_DELIVERY_EMP_ADDRESS | Proof of delivery to the cardholder's company address. |
PROOF_OF_DELIVERY | Proof of delivery to the address on the AVS match. |
PROOF_OF_POSSESSION_OR_USAGE | Proof that the customer is in possession of and/or using the merchandise. |
SIGNED_DELIVERY_FORM | A signed delivery form, or a copy of the cardholder's ID as proof that the goods were picked up at your business location. |
SIGNED_ORDER_FORM | A signed order form for a mail or phone transaction. |
TICKET_PROOF | Evidence the ticket was received or scanned at gate, or evidence of other transactions related to the original (e.g. frequent flyer miles). |
Examples
Submitting categorized evidence
When responding to disputes with compelling evidence, specify the appropriate category for all evidence.
- Java
FileEvidenceRequest fileEvidenceRequest = new FileEvidenceRequest().
documentId(documentResult.getTarget().getId()).
category("MERCHANT_WEBSITE_OR_APP_ACCESS");
result = gateway.dispute().addFileEvidence(
"a_dispute_id",
fileEvidenceRequest
);
Submitting uncategorized evidence
- Java
DocumentUploadRequest uploadRequest = new DocumentUploadRequest(
DocumentUpload.Kind.EVIDENCE_DOCUMENT,
new File("local_file.pdf")
);
Result<DocumentUpload> documentResult = gateway.documentUpload().create(uploadRequest);
if (documentResult.isSuccess()) {
Result<DisputeEvidence> result = gateway
.dispute()
.addFileEvidence("a_dispute_id", documentResult.getTarget().getId());
}