Evidence - API Reference

Evidence

POST

Try it

Submit structured textual datapoints for a dispute.

Credentials

HTTP Basic basicAuth

Header Parameters

Name	Type	Required
api-version	string	*
x-forter-siteid	string	*

Body Parameters

Name	Type	Required
body	disputeEvidenceDatapointsRequestRequest	*
airlineTicketNumbers	string[]	nullable
customerCorrespondences	CustomerCorrespondence[]	nullable
fedexAccountNumber	string[]	nullable
itemsHeldInCustoms	string	nullable
orderId	string	nullable
other	string[]	nullable
processorCaseNumber	string	nullable
processorChargeId	string	nullable
proofsOfCreditBalance	ProofOfCreditBalance[]	nullable
proofsOfDelivery	ProofOfDelivery[]	nullable
proofsOfPickup	ProofOfPickup[]	nullable
proofsOfRefund	ProofOfRefund[]	nullable
proofsOfReplacement	ProofOfReplacement[]	nullable
reservationIds	string[]	nullable
subscriptionDetails	SubscriptionDetails[]	nullable

Responses

200
- Example disputeEvidenceDatapointsResponse
  - Description: The response object for dispute evidence datapoints uploads.
    - invalidEvidenceDatapoints: InvalidEvidenceDataPoint[] (nullable)
    - message: string <EVIDENCE_UPLOADED | SERVICE_UNAVAILABLE | SCHEMA_VALIDATION_FAILED>
    - status: string <SUCCESS | FAILED>
400 Bad Request (Often missing a required parameter)
401 Unauthorized (No valid API key provided)
404 Not Found (The requested item doesn't exist)
500 Server Error (Something went wrong on Forter's end)

Request

curl --request POST \
--url https://api.forter-secure.com/v3/disputes/evidence/datapoints \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'api-version: 10.1' \
--header 'x-forter-siteid: a1b2c3d4e5f6' \
--data '{\n  "customerCorrespondences": [\n    {\n      "contactId": "contact-123"\n    }\n  ],\n  "proofsOfCreditBalance": [\n    {\n      "appliedDate": "2022-11-15"\n    }\n  ],\n  "proofsOfDelivery": [\n    {\n      "trackingNumber": "123456"\n    }\n  ],\n  "proofsOfPickup": [\n    {\n      "status": "NOT_PICKED_UP"\n    }\n  ],\n  "proofsOfRefund": [\n    {\n      "refundTransactionId": "ABC123"\n    }\n  ],\n  "proofsOfReplacement": [\n    {\n      "replacementId": "REP-123456"\n    }\n  ],\n  "subscriptionDetails": [\n    {\n      "isRecurringCharge": false\n    }\n  ]\n}'

Responses

200

// Example disputeEvidenceDatapointsResponse
{\n  "invalidEvidenceDatapoints":[\n    {\n      "datapointPath":"",\n      "failureReason":"Missing required field"\n    }\n  ],\n  "message":"EVIDENCE_UPLOADED",\n  "status":"SUCCESS"\n}