Sign in

v1

latestOpenAPI 3.0.0Forter License2026-07-1333204516.7 KB
Disputes

Evidence

Submit structured textual datapoints for a dispute.

post/v3/disputes/evidence/datapoints

Headers

api-versionstring required
Example:10.1

Specify the version of the API to target.

x-forter-siteidstring required
Example:a1b2c3d4e5f6

Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.

Authorizationstring required
Example:Basic <base64-encoded-api-key:>

Basic Authentiation in the form of a username and password. Use the API Key as the username and leave the password empty.

Request body

airlineTicketNumbersstring[] nullable

Array of airline ticket numbers for the order

itemsHeldInCustomsstring[] nullable

Array of item names that are being held in customs

orderIdstring nullable

Unique order/transaction identifier. Should match the order id sent to Forter at checkout. Note that Forter treats this ID as case-insensitive; Order123 and ORDER123 will be identified as the same order.

processorCaseNumberstring nullable

The case number from the payment processor.

processorChargeIdstring nullable

The unique identifier of the payment, such as Acquirer Reference Number (ARN).

reservationIdsstring[] nullable

Array of reservation IDs for the order

Example request

{
  "airlineTicketNumbers": [
    "TK123456",
    "TK789012"
  ],
  "customerCorrespondences": [
    {
      "contactDateTime": "2022-11-15",
      "contactDescription": "Customer called to cancel the order",
      "contactId": "contact-123",
      "contactReason": "CANCELING"
    }
  ],
  "itemsHeldInCustoms": [
    "iPhone 15 Pro",
    "Leather Jacket"
  ],
  "orderId": "4306795",
  "processorCaseNumber": "CB-4343343219",
  "processorChargeId": "111111111",
  "proofsOfCreditBalance": [
    {
      "amount": 105.55,
      "appliedDate": "2022-11-15",
      "currency": "USD"
    }
  ],
  "proofsOfDelivery": [
    {
      "carrier": "UPS",
      "date": "2022-11-15",
      "deliveryStatus": "Delivered",
      "trackingNumber": "123456"
    }
  ],
  "proofsOfPickup": [
    {
      "pickupDate": "2022-11-15",
      "providedIdentityVerificationMethods": [
        "ORDER_NUMBER"
      ],
      "status": "NOT_PICKED_UP"
    }
  ],
  "proofsOfRefund": [
    {
      "refundAmount": 105.55,
      "refundAuthorizationCode": "B44233",
      "refundChargeId": "111111111",
      "refundCurrency": "USD",
      "refundDate": "2015-06-12",
      "refundTransactionId": "ABC123",
      "replacementItems": [
        "Item XYZ",
        "Item ABC"
      ]
    }
  ],
  "proofsOfReplacement": [
    {
      "replacementAmount": 105.55,
      "replacementCurrency": "USD",
      "replacementDate": "2022-11-15",
      "replacementId": "REP-123456",
      "replacementItems": [
        "Item XYZ",
        "Item ABC"
      ],
      "replacementTrackingNumber": "123456",
      "shippingCarrier": "UPS"
    }
  ],
  "reservationIds": [
    "RES-123456",
    "RES-789012"
  ],
  "subscriptionDetails": [
    {
      "billingAgreementPolicy": "Customer can cancel anytime before the next billing cycle"
    }
  ]
}

Response

Example disputeEvidenceDatapointsResponse

message'EVIDENCE_UPLOADED' | 'SERVICE_UNAVAILABLE' | 'SCHEMA_VALIDATION_FAILED' | 'CLAIM_NOT_FOUND' required

The message containing status response text

status'SUCCESS' | 'FAILED' required

Status of the request processing

Example response

{
  "invalidEvidenceDatapoints": [
    {
      "failureReason": "Missing required field"
    }
  ],
  "message": "EVIDENCE_UPLOADED",
  "status": "SUCCESS"
}