Evidence file upload

POST

https://api.forter-secure.com/v3/disputes/evidence/file

Upload a single file as dispute evidence.

Header Parameters

api-versionstringrequired
Example
10.3
Description
Specify the version of the API to target.
x-forter-siteidstringrequired
Example
a1b2c3d4e5f6
Description
Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.

Body Parameters

bodydisputeEvidenceFileRequestRequestrequired
Description
Upload a single file as dispute evidence.
- evidenceTypestring<PROOF_OF_DELIVERY | PROOF_OF_REFUND | CUSTOMER_CORRESPONDENCE | CONTRACT_PAGE | INVOICE | RECURRING_BILLING_AGREEMENT | PROOF_OF_RECURRING_AGREEMENT_NOTICE | ACCEPTANCE_OF_RECURRING_BILLING_AGREEMENT | PROOF_OF_REQUESTED_CANCELLATION | PROOF_OF_ORDER_REPLACEMENT | PROOF_OF_POSSESSION_OR_USAGE | SOCIAL_NETWORK_REPUTATION | PROOF_OF_RESIDENCE | EMAIL_CONFIRMATION | PASSENGER_OR_CUSTOMER_DETAILS | FLIGHT_MANIFEST | HOTEL_NO_SHOW | AUTHENTICATION_CERTIFICATE | TERMS_AND_CONDITIONS | USER_TERMS_AND_CONDITION_ACCEPTANCE | CARDHOLDER_VERIFICATION_DOCUMENT | RELATED_INVOICE_HISTORY | PURCHASE_HELD_IN_CUSTOMS | DELAY_DISCLOSURE | BUYER_REVIEW_SURVEY | ITEM_DESCRIPTION | OTHER>required
  Example
  PROOF_OF_DELIVERY
  Description
  The type of evidence being uploaded. The following types are supported:
  
  PROOF_OF_DELIVERY
  
  PROOF_OF_REFUND
  
  CUSTOMER_CORRESPONDENCE
  
  CONTRACT_PAGE
  
  INVOICE
  
  RECURRING_BILLING_AGREEMENT
  
  PROOF_OF_RECURRING_AGREEMENT_NOTICE
  
  ACCEPTANCE_OF_RECURRING_BILLING_AGREEMENT
  
  PROOF_OF_REQUESTED_CANCELLATION
  
  PROOF_OF_ORDER_REPLACEMENT
  
  PROOF_OF_POSSESSION_OR_USAGE
  
  SOCIAL_NETWORK_REPUTATION
  
  PROOF_OF_RESIDENCE
  
  EMAIL_CONFIRMATION
  
  PASSENGER_OR_CUSTOMER_DETAILS
  
  FLIGHT_MANIFEST
  
  HOTEL_NO_SHOW
  
  AUTHENTICATION_CERTIFICATE
  
  TERMS_AND_CONDITIONS
  
  USER_TERMS_AND_CONDITION_ACCEPTANCE
  
  CARDHOLDER_VERIFICATION_DOCUMENT
  
  RELATED_INVOICE_HISTORY
  
  PURCHASE_HELD_IN_CUSTOMS
  
  DELAY_DISCLOSURE
  
  BUYER_REVIEW_SURVEY
  
  OTHER
  Allowed
  PROOF_OF_DELIVERYPROOF_OF_REFUNDCUSTOMER_CORRESPONDENCECONTRACT_PAGEINVOICERECURRING_BILLING_AGREEMENTPROOF_OF_RECURRING_AGREEMENT_NOTICEACCEPTANCE_OF_RECURRING_BILLING_AGREEMENTPROOF_OF_REQUESTED_CANCELLATIONPROOF_OF_ORDER_REPLACEMENTPROOF_OF_POSSESSION_OR_USAGESOCIAL_NETWORK_REPUTATIONPROOF_OF_RESIDENCEEMAIL_CONFIRMATIONPASSENGER_OR_CUSTOMER_DETAILSFLIGHT_MANIFESTHOTEL_NO_SHOWAUTHENTICATION_CERTIFICATETERMS_AND_CONDITIONSUSER_TERMS_AND_CONDITION_ACCEPTANCECARDHOLDER_VERIFICATION_DOCUMENTRELATED_INVOICE_HISTORYPURCHASE_HELD_IN_CUSTOMSDELAY_DISCLOSUREBUYER_REVIEW_SURVEYITEM_DESCRIPTIONOTHER
- filePathstringrequired
  Example
  s3:/ /forter-bucket/client-folder/dispute-evidence/example-16451.pdf
  Description
  An S3 pointer for the file
  Pattern
  s3:.+\.(pdf|jpg|jpeg|png|PDF|JPG|JPEG|PNG)
- orderIdstring
  Example
  4306795
  Description
  Conditional.
  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.
  Max Length
  40
- processorCaseNumberstring
  Example
  CB-4343343219
  Description
  Conditional. The case number from the payment processor.
  Max Length
  40
- processorChargeIdstring
  Example
  111111111
  Description
  The unique identifier of the payment, such as Acquirer Reference Number (ARN).
  Max Length
  100

Responses

200Example disputeEvidenceFileResponse

disputeEvidenceFileResponse
Description
The response object following uploading dispute evidence file request to the system
- messagerequired
  Example
  EVIDENCE_UPLOADED
  Description
  The message containing status response text
  Allowed
  EVIDENCE_UPLOADED
  Max Length
  1000
- statusrequired
  Example
  SUCCESS
  Description
  Status of the request processing
  Allowed
  SUCCESS
  Max Length
  50

400Bad Request

object
- messagestring<CLAIM_NOT_FOUND | SCHEMA_VALIDATION_FAILED>required
  Example
  CLAIM_NOT_FOUND
  Description
  The message containing status response text
  Allowed
  CLAIM_NOT_FOUNDSCHEMA_VALIDATION_FAILED
- statusstring<FAILED>required
  Example
  FAILED
  Description
  Status of the request processing
  Allowed
  FAILED

401

Unauthorized (No valid API key provided)

404

Not Found (The requested item doesn't exist)

500Server Error

object
- messagestring<SERVICE_UNAVAILABLE>required
  Example
  SERVICE_UNAVAILABLE
  Description
  The message containing status response text
  Allowed
  SERVICE_UNAVAILABLE
- statusstring<FAILED>required
  Example
  FAILED
  Description
  Status of the request processing
  Allowed
  FAILED

curl

curl --request POST \
     --url https://api.forter-secure.com/v3/disputes/evidence/file \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'api-version: 10.3' \
     --header 'x-forter-siteid: a1b2c3d4e5f6' \
     --data '{
     "evidenceType": "PROOF_OF_DELIVERY",
     "filePath": "s3:/ /forter-bucket/client-folder/dispute-evidence/example-16451.pdf"
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("api-version", "10.3");
myHeaders.append("x-forter-siteid", "a1b2c3d4e5f6");

var raw = JSON.stringify({
   "evidenceType": "PROOF_OF_DELIVERY",
   "filePath": "s3:/ /forter-bucket/client-folder/dispute-evidence/example-16451.pdf"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.forter-secure.com/v3/disputes/evidence/file", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.forter-secure.com/v3/disputes/evidence/file")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["api-version"] = "10.3"
request["x-forter-siteid"] = "a1b2c3d4e5f6"
request.body = JSON.dump({
   "evidenceType": "PROOF_OF_DELIVERY",
   "filePath": "s3:/ /forter-bucket/client-folder/dispute-evidence/example-16451.pdf"
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.forter-secure.com/v3/disputes/evidence/file"

payload = json.dumps({
   "evidenceType": "PROOF_OF_DELIVERY",
   "filePath": "s3:/ /forter-bucket/client-folder/dispute-evidence/example-16451.pdf"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'api-version': '10.3',
   'x-forter-siteid': 'a1b2c3d4e5f6'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Example disputeEvidenceFileResponse
{
  "message": "EVIDENCE_UPLOADED",
  "status": "SUCCESS"
}

400

// Bad Request
{
  "message": "CLAIM_NOT_FOUND",
  "status": "FAILED"
}

401

// Unauthorized (No valid API key provided)

404

// Not Found (The requested item doesn't exist)

500

// Server Error
{
  "message": "SERVICE_UNAVAILABLE",
  "status": "FAILED"
}