v1

latestOpenAPI 3.1.02026-07-24260142.2 KB

/merchant-disputes/file

Sandbox (Testing): https://gateway.sand.us.zip.co/merchant-disputes/file<br><br> Upload an evidence file using a blob. Note all blobs provided must not assume containers or implicit security. (e.g. for Azure blobs, these have SAS tokens if required).

post/merchant-disputes/file

Headers

QP-Territorystring required

Territory of the request. Available values: US

X-QP-Signaturestring required

The signature for merchant validation

Request body

MerchantIdstring required

Gets or sets the merchant Id

DisputeIdstring required

The dispute ID.

Categorystring

Receipt, RefundPolicy, ServiceDocumentation, ShippingDocumentation, CancellationPolicy, CustomerCommunication, CustomerSignature, DuplicateChargeDocumentation, UncategorizedFile

Blobstring required

A block of data or information related to dispute.

FileNamestring

The name of the file

ContentTypestring

Examples: image/png, image/jpeg, text/plain

Response

200

Example response

{
  "disputeDetail": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "disputeId": "string",
    "currency": "string",
    "isChargeRefundable": true,
    "evidenceDueOn": "2023-09-06T15:36:02.381Z",
    "disputedOn": "2023-09-06T15:36:02.381Z",
    "status": "string",
    "reason": "string",
    "evidence": {
      "receipt": {
        "id": "string",
        "created": "2023-09-06T15:36:02.381Z",
        "expiresAt": "2023-09-06T15:36:02.381Z",
        "filename": "string",
        "category": "string",
        "title": "string",
        "type": "string"
      },
      "refundPolicy": {
        "id": "string",
        "created": "2023-09-06T15:36:02.381Z",
        "expiresAt": "2023-09-06T15:36:02.381Z",
        "filename": "string",
        "category": "string",
        "title": "string",
        "type": "string"
      },
      "refundPolicyDisclosure": "string",
      "refundRefusalExplanation": "string",
      "serviceDate": "string",
      "serviceDocumentation": {
        "id": "string",
        "created": "2023-09-06T15:36:02.381Z",
        "expiresAt": "2023-09-06T15:36:02.381Z",
        "filename": "string",
        "category": "string",
        "title": "string",
        "type": "string"
      },
      "shippingAddress": "string",
      "shippingCarrier": "string",
      "shippingDate": "string",
      "shippingDocumentation": {
        "id": "string",
        "created": "2023-09-06T15:36:02.381Z",
        "expiresAt": "2023-09-06T15:36:02.381Z",
        "filename": "string",
        "category": "string",
        "title": "string",
        "type": "string"
      },
      "shippingTrackingNumber": "string",
      "uncategorizedFile": {
        "id": "string",
        "created": "2023-09-06T15:36:02.381Z",
        "expiresAt": "2023-09-06T15:36:02.381Z",
        "filename": "string",
        "category": "string",
        "title": "string",
        "type": "string"
      },
      "productDescription": "string",
      "duplicateChargeExplanation": "string",
      "accessActivityLog": "string",
      "billingAddress": "string",
      "cancellationPolicy": {
        "id": "string",
        "created": "2023-09-06T15:36:02.381Z",
        "expiresAt": "2023-09-06T15:36:02.381Z",
        "filename": "string",
        "category": "string",
        "title": "string",
        "type": "string"
      },
      "cancellationPolicyDisclosure": "string",
      "cancellationRebuttal": "string",
      "customerCommunication": {
        "id": "string",
        "created": "2023-09-06T15:36:02.381Z",
        "expiresAt": "2023-09-06T15:36:02.381Z",
        "filename": "string",
        "category": "string",
        "title": "string",
        "type": "string"
      },
      "customerEmailAddress": "string",
      "customerName": "string",
      "customerPurchaseIp": "string",
      "customerSignature": {
        "id": "string",
        "created": "2023-09-06T15:36:02.381Z",
        "expiresAt": "2023-09-06T15:36:02.381Z",
        "filename": "string",
        "category": "string",
        "title": "string",
        "type": "string"
      },
      "duplicateChargeDocumentation": {
        "id": "string",
        "created": "2023-09-06T15:36:02.381Z",
        "expiresAt": "2023-09-06T15:36:02.381Z",
        "filename": "string",
        "category": "string",
        "title": "string",
        "type": "string"
      },
      "duplicateChargeId": "string",
      "uncategorizedText": "string"
    },
    "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "orderNumber": "string",
    "customerFirstName": "string",
    "customerLastName": "string",
    "customerEmail": "string",
    "issuerEvidence": [
      {
        "evidenceType": "string",
        "textEvidence": "string",
        "fileEvidence": [
          {
            "id": "string",
            "created": "2023-09-06T15:36:02.381Z",
            "expiresAt": "2023-09-06T15:36:02.381Z",
            "filename": "string",
            "category": "string",
            "title": "string",
            "type": "string"
          }
        ]
      }
    ],
    "orderDate": "2023-09-06T15:36:02.381Z",
    "settledOn": "2023-09-06T15:36:02.381Z",
    "evidenceSubmittedOn": "2023-09-06T15:36:02.381Z",
    "acceptedOn": "2023-09-06T15:36:02.381Z",
    "paymentProcessorUnavailable": true,
    "orderMerchantReference": "string"
  }
}