争い

POST

https://api.forter-secure.com/v2/claims

Inform of a dispute initiated by a customer. This endpoint should be used to report any disputes not already reported via webhook from the payment processor. While no decision is provided on this request, it is a required input that both improves the decision model and enables chargeback recovery.

Header Parameters

api-versionstringrequired
Example
10.1
Description
Specify the version of the API to target.
Default
10.1
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.
Default
8b47c6d423ba

Body Parameters

bodyclaimRequestrequired
Description
Inform of a dispute initiated by a customer. This endpoint should be used to report any disputes not already reported via webhook from the payment processor. While no decision is provided on this request, it is a required input that both improves the decision model and enables chargeback recovery.
- additionalCostAmountrequired
  Description
  Additional fees associated with the claim such as processor fees or shipping recovery fees.
  - amountLocalCurrencystring
    Description
    Transaction amount in currency chosen by the buyer
    Default
    105.55
  - amountUSDstring
    Description
    Transaction amount in USD
    Default
    99.95
  - currencystring
    Description
    Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
    Default
    CAD
- amountAmountrequired
  Description
  The amount representing the value of the goods that were not retrieved.
  - amountLocalCurrencystring
    Description
    Transaction amount in currency chosen by the buyer
    Default
    105.55
  - amountUSDstring
    Description
    Transaction amount in USD
    Default
    99.95
  - currencystring
    Description
    Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
    Default
    CAD
- chargeIdstring
  Description
  The unique identifier of the payment, such as Acquirer Reference Number (ARN). *
  Default
  111111111
- chargebackShippingInfoobject
  - ChargebackShippingInfo
    - additionalShippingInfostring
      Description
      Aditional identification document details and verification
      Default
      PO Box 3297
    - carrierstring
      Description
      Shipping carrier name
      Default
      UPS
    - proofOfShippingURLstring
      Description
      URL to the proof of shipping in the merchant's system
      Default
      true
    - signedProofOfShippingboolean
      Description
      Whether the user has signed a proof of shipping
      Default
      true
    - trackingNumberstring
      Description
      Order tracking number
      Default
      123456
- commentsstring
  Description
  Additional comments by the merchant
  Default
  Contacted customer via phone
- dueDatestring<date>required
  Description
  Due date for disputing the claim which was stated by the processor in case of a chargeback. Otherwise, the issue date. Use YYYY-MM-DD format. The expected date timezone is UTC.
  Default
  2016-01-30
- externalClaimStatusstring
  Description
  Detailed claim status in the claim source system
  Default
  pending merchant response
- goodsRecoveredboolean
  Description
  Relevant only for the prechargeback claim type, in case the goods were not sent or delivered yet. Indication of whether or not the goods were recovered
  Default
  false
- invoiceURLstring
  Description
  url to a copy of the invoice sent to the customer
  Default
  mystore.com/invoices/abc123
- issueDatestring<date>required
  Description
  Date the chargeback was issued / the prechargeback notification was sent. Use YYYY-MM-DD format. The expected date timezone is UTC.
  Default
  2016-01-20
- orderIdstring
  Description
  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.
  Default
  4306795
- originalPayloadobject
  - GeneralPayloadMap
- processorChargebackCaseIdstring
  Description
  The case number from the payment processor.
  Default
  CB-4343343219
- processorNamestring<Adyen | Airwallex | AmazonPay | AMEX | AuthorizeNet | Be2bill | BlueSnap | Braintree | BusinessTrack | Chase | Checkout | Citcon | Citibank | ConcoraCredit | Credorax | Cybersource | Dalenys | Discover | Dlocal | Ebanx | Elavon | Fidelity | FirstData | Fiserv | Fortis | Globalpay | Ingenico | IQ | Klarna | MerchantConnect | Merlink | NCR | Nuvei | OceanPay | OmniPayGroup | Paymentech | Paymenttech | PayPal | PayPlus | PaySafe | PayU | PayUEastEurope | PayULatam | Privvy | Przelewy | Revolut | Safecharge | Shift4 | Shopify | Sofort | Square | Stripe | Vantiv | Wirecard | Worldline | Worldnet | WorldpayAccertify | WorldpayDisputes | WorldpayMAI | Zen>
  Description
  Payment processor name.
  Default
  Braintree
- reasonstring
  Description
  The claim reason as supplied by the claim source. For example, the chargeback reason provided in the chargeback notification.
  Default
  Fraudulent Transaction: Card Not Present Environment
- reasonCodestring
  Description
  The claim code as supplied by the claim source. For example, the chargeback reason provided in the chargeback notification.
  Default
  83
- reasonTypestring<FRAUD | SERVICE | OTHER | AUTHORIZATION | PROCESSING_ERROR>required
  Description
  The claim reason category type.
  Default
  FRAUD
- sourceDetailsstring
  Description
  Specifics about the source of the claim such as the processor name / 3rd party name, etc.
  Default
  UPS
- sourceTypestring<PROCESSOR_CB | AMEX | DISCOVER | PAYPAL | PROCESSOR_INQUIRY | CUSTOMER_SUPPORT | SHIPPING_CARRIER | THIRD_PARTY | FORTER | OTHER>required
  Description
  The category of the source of the claim.
  Default
  PROCESSOR_CB
- statusstring<OPEN | IN_DISPUTE | WON | LOST | CANCELED>required
  Description
  Claim status mapping from the current status of the claim. For example, a mapping of the processor chargeback dispute status.
  Default
  OPEN
- typestring<CHARGEBACK | PRE_CHARGEBACK | DEBIT_MEMO | REQUEST_FOR_INFORMATION | FRAUD_ALERT>required
  Description
  Type of claim.
  Default
  CHARGEBACK
- wasRefundedboolean
  Description
  Relevant only for the prechargeback claim type. Indication of whether or not the buyer was refunded
  Default
  false

Responses

200Example claimResponse

claimResponse
Description
The response object following claims request to the system
- messagestringrequired
  Description
  The message containing status response text
  Default
  Claim received
- statusstringrequired
  Description
  Status of the request processing
  Default
  success

400Bad Request (Often missing a required parameter)

401Unauthorized (No valid API key provided)

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

500Server Error (Something went wrong on Forter's end)

curl

curl --request POST \
     --url https://api.forter-secure.com/v2/claims \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'api-version: 10.1' \
     --header 'x-forter-siteid: 8b47c6d423ba' \
     --header 'authorization: Basic <base64-encoded-api-key:>' \
     --data '{
     "additionalCost": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     },
     "amount": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     },
     "chargeId": "111111111",
     "chargebackShippingInfo": {
     "additionalShippingInfo": "PO Box 3297",
     "carrier": "UPS",
     "proofOfShippingURL": "true",
     "signedProofOfShipping": true,
     "trackingNumber": "123456"
     },
     "comments": "Contacted customer via phone",
     "dueDate": "2016-01-30",
     "externalClaimStatus": "pending merchant response",
     "invoiceURL": "mystore.com/invoices/abc123",
     "issueDate": "2016-01-20",
     "orderId": "4306795",
     "originalPayload": {},
     "processorChargebackCaseId": "CB-4343343219",
     "processorName": "Braintree",
     "reason": "Fraudulent Transaction: Card Not Present Environment",
     "reasonCode": "83",
     "reasonType": "FRAUD",
     "sourceDetails": "UPS",
     "sourceType": "PROCESSOR_CB",
     "status": "OPEN",
     "type": "CHARGEBACK"
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("api-version", "10.1");
myHeaders.append("x-forter-siteid", "8b47c6d423ba");
myHeaders.append("authorization", "Basic <base64-encoded-api-key:>");

var raw = JSON.stringify({
   "additionalCost": {
      "amountLocalCurrency": "105.55",
      "amountUSD": "99.95",
      "currency": "CAD"
   },
   "amount": {
      "amountLocalCurrency": "105.55",
      "amountUSD": "99.95",
      "currency": "CAD"
   },
   "chargeId": "111111111",
   "chargebackShippingInfo": {
      "additionalShippingInfo": "PO Box 3297",
      "carrier": "UPS",
      "proofOfShippingURL": "true",
      "signedProofOfShipping": true,
      "trackingNumber": "123456"
   },
   "comments": "Contacted customer via phone",
   "dueDate": "2016-01-30",
   "externalClaimStatus": "pending merchant response",
   "invoiceURL": "mystore.com/invoices/abc123",
   "issueDate": "2016-01-20",
   "orderId": "4306795",
   "originalPayload": {},
   "processorChargebackCaseId": "CB-4343343219",
   "processorName": "Braintree",
   "reason": "Fraudulent Transaction: Card Not Present Environment",
   "reasonCode": "83",
   "reasonType": "FRAUD",
   "sourceDetails": "UPS",
   "sourceType": "PROCESSOR_CB",
   "status": "OPEN",
   "type": "CHARGEBACK"
});

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

fetch("https://api.forter-secure.com/v2/claims", 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/v2/claims")

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.1"
request["x-forter-siteid"] = "8b47c6d423ba"
request["authorization"] = "Basic <base64-encoded-api-key:>"
request.body = JSON.dump({
   "additionalCost": {
      "amountLocalCurrency": "105.55",
      "amountUSD": "99.95",
      "currency": "CAD"
   },
   "amount": {
      "amountLocalCurrency": "105.55",
      "amountUSD": "99.95",
      "currency": "CAD"
   },
   "chargeId": "111111111",
   "chargebackShippingInfo": {
      "additionalShippingInfo": "PO Box 3297",
      "carrier": "UPS",
      "proofOfShippingURL": "true",
      "signedProofOfShipping": true,
      "trackingNumber": "123456"
   },
   "comments": "Contacted customer via phone",
   "dueDate": "2016-01-30",
   "externalClaimStatus": "pending merchant response",
   "invoiceURL": "mystore.com/invoices/abc123",
   "issueDate": "2016-01-20",
   "orderId": "4306795",
   "originalPayload": {},
   "processorChargebackCaseId": "CB-4343343219",
   "processorName": "Braintree",
   "reason": "Fraudulent Transaction: Card Not Present Environment",
   "reasonCode": "83",
   "reasonType": "FRAUD",
   "sourceDetails": "UPS",
   "sourceType": "PROCESSOR_CB",
   "status": "OPEN",
   "type": "CHARGEBACK"
})

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

python

import requests
import json

url = "https://api.forter-secure.com/v2/claims"

payload = json.dumps({
   "additionalCost": {
      "amountLocalCurrency": "105.55",
      "amountUSD": "99.95",
      "currency": "CAD"
   },
   "amount": {
      "amountLocalCurrency": "105.55",
      "amountUSD": "99.95",
      "currency": "CAD"
   },
   "chargeId": "111111111",
   "chargebackShippingInfo": {
      "additionalShippingInfo": "PO Box 3297",
      "carrier": "UPS",
      "proofOfShippingURL": "true",
      "signedProofOfShipping": True,
      "trackingNumber": "123456"
   },
   "comments": "Contacted customer via phone",
   "dueDate": "2016-01-30",
   "externalClaimStatus": "pending merchant response",
   "invoiceURL": "mystore.com/invoices/abc123",
   "issueDate": "2016-01-20",
   "orderId": "4306795",
   "originalPayload": {},
   "processorChargebackCaseId": "CB-4343343219",
   "processorName": "Braintree",
   "reason": "Fraudulent Transaction: Card Not Present Environment",
   "reasonCode": "83",
   "reasonType": "FRAUD",
   "sourceDetails": "UPS",
   "sourceType": "PROCESSOR_CB",
   "status": "OPEN",
   "type": "CHARGEBACK"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'api-version': '10.1',
   'x-forter-siteid': '8b47c6d423ba',
   'authorization': 'Basic <base64-encoded-api-key:>'
}

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

print(response.text)

200

// Example claimResponse
{
  "message": "",
  "status": ""
}

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)

顧客によって開始された紛争を通知します。このエンドポイントは、支払い処理業者からのウェブフックを介してまだ報告されていない紛争を報告するために使用されるべきです。このリクエストに対して決定は提供されませんが、これは決定モデルを改善し、チャージバック回収を可能にするための必須入力です。