Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.
" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "Submit structured textual datapoints for a dispute.", "customType": "disputeEvidenceDatapointsRequestRequest", "schema": [ { "name": "airlineTicketNumbers", "kind": "optional", "type": "array", "nullable": true, "description": "Array of airline ticket numbers for the order", "example": "[\"TK123456\",\"TK789012\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "buyerReviewSurveys", "kind": "optional", "type": "array", "nullable": true, "description": "Array of objects describing structured buyer review/survey responses regarding the purchase.
", "modelRef": "#/components/schemas/BuyerReviewSurvey", "customType": "BuyerReviewSurvey[]", "schema": [ { "name": "overallRating", "kind": "required", "type": "number", "description": "The buyer's overall rating, 1-5 stars
", "example": 5, "minimum": 1, "maximum": 5 }, { "name": "reviewItems", "kind": "optional", "type": "array", "nullable": true, "description": "Per-question ratings making up the survey
", "modelRef": "#/components/schemas/BuyerReviewSurveyItem", "customType": "BuyerReviewSurveyItem[]", "schema": [ { "name": "question", "kind": "required", "type": "string", "description": "The survey question the rating corresponds to", "example": "communication with seller", "maxLength": 255 }, { "name": "rating", "kind": "required", "type": "number", "description": "The buyer's rating for this question, 1-5 stars
", "example": 5, "minimum": 1, "maximum": 5 } ] }, { "name": "reviewText", "kind": "optional", "type": "string", "nullable": true, "description": "Free-text review comment left by the buyer
", "example": "The product looked great! It was basically exactly what I wanted.", "maxLength": 2000 } ] }, { "name": "customerCorrespondences", "kind": "optional", "type": "array", "nullable": true, "description": "Array of objects describing correspondence between the merchant and the customer.", "modelRef": "#/components/schemas/CustomerCorrespondence", "customType": "CustomerCorrespondence[]", "schema": [ { "name": "contactDateTime", "kind": "optional", "type": "stringFedEx account number associated with the order's shipments. When provided, Forter uses an account number together with the FedEx tracking number to retrieve a richer Proof-of-Delivery PDF (with recipient address). FedEx-only.
", "example": "[\"123456789\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "itemsHeldInCustoms", "kind": "optional", "type": "array", "nullable": true, "description": "Array of item names that are being held in customs", "example": "[\"iPhone 15 Pro\",\"Leather Jacket\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "itemDescriptions", "kind": "optional", "type": "array", "nullable": true, "description": "Array of descriptions of the items as they were advertised to the buyer", "example": "[\"Nintendo Switch OLED, 64GB, white\",\"PlayStation 5 DualSense controller\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "orderId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nUnique 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.
", "example": "4306795", "maxLength": 40 }, { "name": "other", "kind": "optional", "type": "array", "nullable": true, "description": "Free-form text for any additional documentation or notes related to the disputed purchase. Each entry is rendered in the Main Arguments section of the dispute letter.
", "example": "[\"The order was placed by a returning customer with a verified delivery address.\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "processorCaseNumber", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nThe case number from the payment processor.", "example": "CB-4343343219", "maxLength": 40 }, { "name": "processorChargeId", "kind": "optional", "type": "string", "nullable": true, "description": "The unique identifier of the payment, such as Acquirer Reference Number (ARN).
", "example": "111111111", "maxLength": 100 }, { "name": "proofsOfCreditBalance", "kind": "optional", "type": "array", "nullable": true, "description": "Array of objects describing credit balance applications", "modelRef": "#/components/schemas/ProofOfCreditBalance", "customType": "ProofOfCreditBalance[]", "schema": [ { "name": "amount", "kind": "optional", "type": "number", "nullable": true, "description": "Amount of the credit balance", "example": 105.55, "maxLength": 20 }, { "name": "appliedDate", "kind": "required", "type": "stringDate the credit balance was applied. Use YYYY-MM-DD format.
", "example": "2022-11-15", "format": "date" }, { "name": "currency", "kind": "optional", "type": "string", "nullable": true, "description": "Currency of the credit balance, 3-letter ISO-4217 format currency code
", "example": "USD", "minLength": 3, "maxLength": 3, "pattern": "[A-Z]{3}" } ] }, { "name": "proofsOfDelivery", "kind": "optional", "type": "array", "nullable": true, "description": "Data proofs of delivery - array of objects with details of deliveries made.
", "modelRef": "#/components/schemas/ProofOfDelivery", "customType": "ProofOfDelivery[]", "schema": [ { "name": "carrier", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nShipping carrier name", "example": "UPS", "maxLength": 50 }, { "name": "date", "kind": "optional", "type": "stringDelivery date. Use YYYY-MM-DD format.
", "example": "2022-11-15", "format": "date" }, { "name": "deliveryStatus", "kind": "optional", "type": "string", "nullable": true, "description": "Current status of the delivery", "example": "Delivered", "maxLength": 50 }, { "name": "didCustomerSignForDelivery", "kind": "optional", "type": "boolean", "nullable": true, "description": "Whether the customer signed for the delivery", "example": false }, { "name": "trackingNumber", "kind": "required", "type": "string", "description": "Order tracking number", "example": "123456", "maxLength": 50 } ] }, { "name": "proofsOfPickup", "kind": "optional", "type": "array", "nullable": true, "description": "Array of objects describing pickup details", "modelRef": "#/components/schemas/ProofOfPickup", "customType": "ProofOfPickup[]", "schema": [ { "name": "pickupDate", "kind": "optional", "type": "stringDate of the pickup. Use YYYY-MM-DD format.
", "example": "2022-11-15", "format": "date" }, { "name": "providedIdentityVerificationMethods", "kind": "optional", "type": "array", "nullable": true, "description": "List of methods used to verify customer identity", "example": "[\"ORDER_NUMBER\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "status", "kind": "required", "type": "", "description": "Current status of the pickup", "example": "NOT_PICKED_UP", "enum": [ "NOT_PICKED_UP", "PICKED_UP" ] } ] }, { "name": "proofsOfRefund", "kind": "optional", "type": "array", "nullable": true, "description": "Data proofs of refund - Array of objects describing refunds issued.
", "modelRef": "#/components/schemas/ProofOfRefund", "customType": "ProofOfRefund[]", "schema": [ { "name": "refundAmount", "kind": "optional", "type": "number", "conditional": true, "nullable": true, "description": "Conditional.\nRefund amount in currency chosen by the buyer", "example": 105.55, "maxLength": 20 }, { "name": "refundAuthorizationCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nRefund authorization code from payment gateway", "example": "B44233", "maxLength": 255 }, { "name": "refundChargeId", "kind": "optional", "type": "string", "nullable": true, "description": "The unique identifier associated with the refund charge.\nFor example: ARN in Adyen, charge ID in Stripe, referenceNumber in Braintree, etc.
", "example": "111111111", "maxLength": 100 }, { "name": "refundCurrency", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nTransaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
", "example": "USD", "minLength": 3, "maxLength": 3, "pattern": "[A-Z]{3}" }, { "name": "refundDate", "kind": "optional", "type": "stringDate the refund was paid. Use YYYY-MM-DD format.
", "example": "2015-06-12", "format": "date" }, { "name": "refundTransactionId", "kind": "required", "type": "string", "description": "Refund transaction id", "example": "ABC123", "maxLength": 50 }, { "name": "replacementItems", "kind": "optional", "type": "array", "nullable": true, "description": "List of items that were replaced as part of the refund", "example": "[\"Item XYZ\",\"Item ABC\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "proofsOfReplacement", "kind": "optional", "type": "array", "nullable": true, "description": "Array of objects describing order replacements", "modelRef": "#/components/schemas/ProofOfReplacement", "customType": "ProofOfReplacement[]", "schema": [ { "name": "replacementAmount", "kind": "optional", "type": "number", "nullable": true, "description": "Amount of the replacement order", "example": 105.55, "maxLength": 20 }, { "name": "replacementCurrency", "kind": "optional", "type": "string", "nullable": true, "description": "Currency of the replacement order, 3-letter ISO-4217 format currency code
", "example": "USD", "minLength": 3, "maxLength": 3, "pattern": "[A-Z]{3}" }, { "name": "replacementDate", "kind": "optional", "type": "stringDate the replacement was processed. Use YYYY-MM-DD format.
", "example": "2022-11-15", "format": "date" }, { "name": "replacementId", "kind": "required", "type": "string", "description": "Unique identifier for the replacement order", "example": "REP-123456", "maxLength": 50 }, { "name": "replacementItems", "kind": "optional", "type": "array", "nullable": true, "description": "List of items that were replaced", "example": "[\"Item XYZ\",\"Item ABC\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "replacementTrackingNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Tracking number for the replacement shipment", "example": "123456", "maxLength": 50 }, { "name": "shippingCarrier", "kind": "optional", "type": "string", "nullable": true, "description": "Shipping carrier name for the replacement", "example": "UPS", "maxLength": 50 } ] }, { "name": "proofsOfUsage", "kind": "optional", "type": "array", "nullable": true, "description": "Array of objects describing when the buyer accessed or used the purchased order.", "modelRef": "#/components/schemas/ProofOfUsage", "customType": "ProofOfUsage[]", "schema": [ { "name": "usageTimestamp", "kind": "required", "type": "stringTimestamp of when the buyer accessed/used the order (e.g. clicked the order attachment). Use ISO 8601 date-time format.
", "example": "2022-11-15T10:30:00Z", "format": "date-time" } ] }, { "name": "reservationIds", "kind": "optional", "type": "array", "nullable": true, "description": "Array of reservation IDs for the order", "example": "[\"RES-123456\",\"RES-789012\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "subscriptionDetails", "kind": "optional", "type": "array", "nullable": true, "description": "Array of objects describing subscription details", "modelRef": "#/components/schemas/SubscriptionDetails", "customType": "SubscriptionDetails[]", "schema": [ { "name": "billingAgreementPolicy", "kind": "optional", "type": "string", "nullable": true, "description": "The merchant's recurring billing agreement policy", "example": "Customer can cancel anytime before the next billing cycle", "maxLength": 1000 }, { "name": "isRecurringCharge", "kind": "required", "type": "boolean", "description": "Whether this is a recurring subscription charge", "example": false } ] } ], "modelRef": "#/components/schemas/disputeEvidenceDatapointsRequestRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "basicAuth", "name": "basicAuth", "kind": "optional", "type": "http", "scheme": "basic" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Example disputeEvidenceDatapointsResponse", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "The response object for dispute evidence datapoints uploads.", "customType": "disputeEvidenceDatapointsResponse", "schema": [ { "name": "invalidEvidenceDatapoints", "kind": "optional", "type": "array", "nullable": true, "description": "Array of invalid datapoint entries, if any
", "modelRef": "#/components/schemas/InvalidEvidenceDataPoint", "customType": "InvalidEvidenceDataPoint[]", "schema": [ { "name": "datapointPath", "kind": "required", "type": "string", "description": "The path to the faulty datapoint in the evidence file\nex: /customerCorrespondences/0/contactReason
" }, { "name": "failureReason", "kind": "required", "type": "string", "description": "The reason why the evidence was considered invalid", "example": "Missing required field", "maxLength": 255 } ] }, { "name": "message", "kind": "required", "type": "stringBad Request (Often missing a required parameter)
", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Unauthorized (No valid API key provided)
", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not Found (The requested item doesn't exist)
", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Server Error (Something went wrong on Forter's end)
", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "cAhI2bmi0SjQ8LJZgV6cU", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.forter-secure.com/v3/disputes/evidence/datapoints \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'api-version: 10.3' \\\n --header 'x-forter-siteid: a1b2c3d4e5f6' \\\n --data '{\n \"buyerReviewSurveys\": [\n {\n \"overallRating\": 5,\n \"reviewItems\": [\n {\n \"question\": \"communication with seller\",\n \"rating\": 5\n }\n ]\n }\n ],\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 \"proofsOfUsage\": [\n {\n \"usageTimestamp\": \"2022-11-15T10:30:00Z\"\n }\n ],\n \"subscriptionDetails\": [\n {\n \"isRecurringCharge\": false\n }\n ]\n }'" }, { "id": "sudaiR7cb2KjMK6gmmxLa", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"api-version\", \"10.3\");\nmyHeaders.append(\"x-forter-siteid\", \"a1b2c3d4e5f6\");\n\nvar raw = JSON.stringify({\n \"buyerReviewSurveys\": [\n {\n \"overallRating\": 5,\n \"reviewItems\": [\n {\n \"question\": \"communication with seller\",\n \"rating\": 5\n }\n ]\n }\n ],\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 \"proofsOfUsage\": [\n {\n \"usageTimestamp\": \"2022-11-15T10:30:00Z\"\n }\n ],\n \"subscriptionDetails\": [\n {\n \"isRecurringCharge\": false\n }\n ]\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.forter-secure.com/v3/disputes/evidence/datapoints\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "TXORo-gPbCoS0IQjrxcVm", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.forter-secure.com/v3/disputes/evidence/datapoints\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"api-version\"] = \"10.3\"\nrequest[\"x-forter-siteid\"] = \"a1b2c3d4e5f6\"\nrequest.body = JSON.dump({\n \"buyerReviewSurveys\": [\n {\n \"overallRating\": 5,\n \"reviewItems\": [\n {\n \"question\": \"communication with seller\",\n \"rating\": 5\n }\n ]\n }\n ],\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 \"proofsOfUsage\": [\n {\n \"usageTimestamp\": \"2022-11-15T10:30:00Z\"\n }\n ],\n \"subscriptionDetails\": [\n {\n \"isRecurringCharge\": false\n }\n ]\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "7LYOAOHFRjerss0XpmhKX", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.forter-secure.com/v3/disputes/evidence/datapoints\"\n\npayload = json.dumps({\n \"buyerReviewSurveys\": [\n {\n \"overallRating\": 5,\n \"reviewItems\": [\n {\n \"question\": \"communication with seller\",\n \"rating\": 5\n }\n ]\n }\n ],\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 \"proofsOfUsage\": [\n {\n \"usageTimestamp\": \"2022-11-15T10:30:00Z\"\n }\n ],\n \"subscriptionDetails\": [\n {\n \"isRecurringCharge\": False\n }\n ]\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'api-version': '10.3',\n 'x-forter-siteid': 'a1b2c3d4e5f6'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "cAhI2bmi0SjQ8LJZgV6cU" }, "results": { "languages": [ { "id": "Ng3UaR11ZmZ8Vx0l9tNlX", "language": "200", "code": "// Example disputeEvidenceDatapointsResponse\n{\n \"invalidEvidenceDatapoints\": [\n {\n \"datapointPath\": \"\",\n \"failureReason\": \"Missing required field\"\n }\n ],\n \"message\": \"EVIDENCE_UPLOADED\",\n \"status\": \"SUCCESS\"\n}" }, { "id": "2WZ14OqhdcMLtE0NVdLDs", "language": "400", "code": "// Bad Request (Often missing a required parameter)\n" }, { "id": "_iIHxQhmD80RFLcXiXF3e", "language": "401", "code": "// Unauthorized (No valid API key provided)\n" }, { "id": "_OuXBgq6CX3lRklzXzAEm", "language": "404", "code": "// Not Found (The requested item doesn't exist)\n" }, { "id": "fdpkzHFirUbi9e-r_15kg", "language": "500", "code": "// Server Error (Something went wrong on Forter's end)\n" } ], "selectedLanguageId": "Ng3UaR11ZmZ8Vx0l9tNlX" } }, "children": [ { "text": "" } ] }