Sign in

v1

latestOpenAPI 3.0.0Forter License2026-07-1333204516.7 KB
Disputes

Evidence file upload

Upload a single file as dispute evidence.

post/v3/disputes/evidence/file

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

evidenceType'ACCEPTANCE_OF_RECURRING_BILLING_AGREEMENT' | 'AUTHENTICATION_CERTIFICATE' | 'BUYER_REVIEW_SURVEY' | 'CARDHOLDER_VERIFICATION_DOCUMENT' | 'CHARGEBACK_NOTIFICATION' | 'CONTRACT_PAGE' | 'CREDIT_BALANCE' | 'CUSTOMER_CORRESPONDENCE' | 'DELAY_DISCLOSURE' | 'DISPUTE_LETTER' | 'EMAIL_CONFIRMATION' | 'FLIGHT_MANIFEST' | 'HOTEL_NO_SHOW' | 'INVOICE' | 'OTHER' | 'PASSENGER_OR_CUSTOMER_DETAILS' | 'PROOF_OF_DELIVERY' | 'PROOF_OF_ORDER_REPLACEMENT' | 'PROOF_OF_POSSESSION_OR_USAGE' | 'PROOF_OF_RECURRING_AGREEMENT_NOTICE' | 'PROOF_OF_REFUND' | 'PROOF_OF_REQUESTED_CANCELLATION' | 'PROOF_OF_RESIDENCE' | 'PURCHASE_HELD_IN_CUSTOMS' | 'RECEIPT' | 'RECURRING_BILLING_AGREEMENT' | 'RELATED_INVOICE_HISTORY' | 'SIGNED_DELIVERY_FORM' | 'SIGNED_ORDER_FORM' | 'SOCIAL_NETWORK_REPUTATION' | 'STATEMENT_OF_UNAUTHORIZED_DEBIT' | 'TERMS_AND_CONDITIONS' | 'USER_TERMS_AND_CONDITION_ACCEPTANCE' required

The type of evidence being uploaded. The following types are supported:

  • ACCEPTANCE_OF_RECURRING_BILLING_AGREEMENT
  • AUTHENTICATION_CERTIFICATE
  • BUYER_REVIEW_SURVEY
  • CARDHOLDER_VERIFICATION_DOCUMENT
  • CHARGEBACK_NOTIFICATION
  • CONTRACT_PAGE
  • CREDIT_BALANCE
  • CUSTOMER_CORRESPONDENCE
  • DELAY_DISCLOSURE
  • DISPUTE_LETTER
  • EMAIL_CONFIRMATION
  • FLIGHT_MANIFEST
  • HOTEL_NO_SHOW
  • INVOICE
  • OTHER
  • PASSENGER_OR_CUSTOMER_DETAILS
  • PROOF_OF_DELIVERY
  • PROOF_OF_ORDER_REPLACEMENT
  • PROOF_OF_POSSESSION_OR_USAGE
  • PROOF_OF_RECURRING_AGREEMENT_NOTICE
  • PROOF_OF_REFUND
  • PROOF_OF_REQUESTED_CANCELLATION
  • PROOF_OF_RESIDENCE
  • PURCHASE_HELD_IN_CUSTOMS
  • RECEIPT
  • RECURRING_BILLING_AGREEMENT
  • RELATED_INVOICE_HISTORY
  • SIGNED_DELIVERY_FORM
  • SIGNED_ORDER_FORM
  • SOCIAL_NETWORK_REPUTATION
  • STATEMENT_OF_UNAUTHORIZED_DEBIT
  • TERMS_AND_CONDITIONS
  • USER_TERMS_AND_CONDITION_ACCEPTANCE
filePathstring required

An S3 pointer for the file

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).

Example request

{
  "evidenceType": "PROOF_OF_DELIVERY",
  "filePath": "s3:/ /<forter-bucket>/<client-folder>/example-16451.pdf",
  "orderId": "4306795",
  "processorCaseNumber": "CB-4343343219",
  "processorChargeId": "111111111"
}

Response

Example disputeEvidenceFileResponse

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

{
  "message": "EVIDENCE_UPLOADED",
  "status": "SUCCESS"
}