Claims API

The Claims API notifies Forter about chargebacks and fraud alerts. This is extremely important because it enables Forter’s system to learn and continually improve future decisions, tailoring our system to your company’s needs.

While the Claims API is used to notify Forter about chargebacks, Forter also supports claims webhooks for supported payment gateways including:

  • Braintree
  • PayPal
  • Stripe
  • Adyen


Key fields in the requests include:

  • orderId/matching transaction ID - the ID that corresponds to the original transaction that Forter received
  • amount of the claim
  • claim currency - the currency the claim is generated in
  • reason Code - the code provided by the payment processor (from the list of card scheme codes) to determine if the Chargeback is due to Fraud or Service issues
  • processorChargebackCaseId - the unique identifier of the claim that can be used for disputing it.
  • type of claim (e.g. Chargeback, Fraud alert)
  • additionalCost - any supplementary fees associated with the chargeback
  • status of the claim (e.g. OPEN / WON / LOST)
  • sourceType of the claim (e.g. PROCESSOR_CB) and sourceDetails (e.g. Worldpay)
  • issue date of the chargeback
  • due date to dispute the chargeback


curl --request POST \
     --url \
     --header 'accept: application/json' \
     --header 'api-version: 2.0' \
     --header 'content-type: application/json' \
     --header 'x-forter-siteid: abcde123456' \
     --data '
  "orderId": "4306795",
  "processorChargebackCaseId": "CB-4343343219",
  "status": "OPEN",
  "externalClaimStatus": "pending merchant response",
  "amount": {
    "amountUSD": "99.95",
    "amountLocalCurrency": "105.55",
    "currency": "CAD"
  "additionalCost": {
    "amountUSD": "99.95",
    "amountLocalCurrency": "105.55",
    "currency": "CAD"
  "type": "CHARGEBACK",
  "sourceType": "PROCESSOR_CB",
  "sourceDetails": "UPS",
  "reasonType": "FRAUD",
  "reason": "Fraudulent Transaction: Card Not Present Environment",
  "reasonCode": "83",
  "issueDate": "2016-01-20",
  "dueDate": "2016-01-30",
  "goodsRecovered": false,
  "wasRefunded": false,
  "invoiceURL": "",
  "comments": "Contacted customer via phone"


The response details whether or not the claim was received successfully. Chargebacks will also show on the original transaction in the Forter portal and can be included in relevant claims reporting in the portal as well.