---
title: 争い
slug: 6QJMJj7i7WG2T00Z6abbs
createdAt: 2025-08-12T21:15:13.774Z
---
{
"id": "cLkVz_5fKmEbWVsWxWO_W",
"type": "api-oas-v2",
"data": {
"method": "POST",
"url": "https://api.forter-secure.com/v2/claims",
"servers": [
{
"url": "https://api.forter-secure.com/v2/claims"
}
],
"name": "Dispute",
"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.
",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"kind": "required",
"name": "api-version",
"type": "string",
"example": "10.1",
"description": "Specify the version of the API to target.",
"default": "10.1"
},
{
"kind": "required",
"name": "x-forter-siteid",
"type": "string",
"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"
},
{
"kind": "required",
"name": "Authorization",
"type": "string",
"example": "Basic ",
"description": "Basic Authentiation in the form of a username and password. Use the API Key as the username and leave the password empty.",
"default": "Basic "
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "required",
"name": "body",
"type": "object",
"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.",
"customType": "claimRequest",
"schema": [
{
"name": "additionalCost",
"kind": "required",
"type": "object",
"description": "Additional fees associated with the claim such as processor fees or shipping recovery fees.",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amountLocalCurrency",
"kind": "optional",
"type": "string",
"description": "Transaction amount in currency chosen by the buyer",
"example": "",
"default": "105.55"
},
{
"name": "amountUSD",
"kind": "optional",
"type": "string",
"description": "Transaction amount in USD",
"example": "",
"default": "99.95"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": "Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code",
"example": "",
"default": "CAD"
}
]
},
{
"name": "amount",
"kind": "required",
"type": "object",
"description": "The amount representing the value of the goods that were not retrieved.",
"modelRef": "#/components/schemas/Amount",
"customType": "Amount",
"schema": [
{
"name": "amountLocalCurrency",
"kind": "optional",
"type": "string",
"description": "Transaction amount in currency chosen by the buyer",
"example": "",
"default": "105.55"
},
{
"name": "amountUSD",
"kind": "optional",
"type": "string",
"description": "Transaction amount in USD",
"example": "",
"default": "99.95"
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": "Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code",
"example": "",
"default": "CAD"
}
]
},
{
"name": "chargeId",
"kind": "optional",
"type": "string",
"description": "The unique identifier of the payment, such as Acquirer Reference Number (ARN).\n*",
"example": "",
"default": "111111111"
},
{
"name": "chargebackShippingInfo",
"kind": "optional",
"type": "object",
"complexType": "allOf",
"complexItems": [
{
"name": "ChargebackShippingInfo",
"description": "",
"modelRef": "#/components/schemas/ChargebackShippingInfo",
"schema": [
{
"name": "additionalShippingInfo",
"kind": "optional",
"type": "string",
"description": "Aditional identification document details and verification",
"example": "",
"default": "PO Box 3297"
},
{
"name": "carrier",
"kind": "optional",
"type": "string",
"description": "Shipping carrier name",
"example": "",
"default": "UPS"
},
{
"name": "proofOfShippingURL",
"kind": "optional",
"type": "string",
"description": "URL to the proof of shipping in the merchant's system",
"example": "",
"default": "true"
},
{
"name": "signedProofOfShipping",
"kind": "optional",
"type": "boolean",
"description": "Whether the user has signed a proof of shipping",
"example": "",
"default": true
},
{
"name": "trackingNumber",
"kind": "optional",
"type": "string",
"description": "Order tracking number",
"example": "",
"default": "123456"
}
]
}
],
"schema": []
},
{
"name": "comments",
"kind": "optional",
"type": "string",
"description": "Additional comments by the merchant",
"example": "",
"default": "Contacted customer via phone"
},
{
"name": "dueDate",
"kind": "required",
"type": "string",
"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.\nThe expected date timezone is UTC.",
"example": "",
"default": "2016-01-30"
},
{
"name": "externalClaimStatus",
"kind": "optional",
"type": "string",
"description": "Detailed claim status in the claim source system",
"example": "",
"default": "pending merchant response"
},
{
"name": "goodsRecovered",
"kind": "optional",
"type": "boolean",
"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",
"example": "",
"default": false
},
{
"name": "invoiceURL",
"kind": "optional",
"type": "string",
"description": "url to a copy of the invoice sent to the customer",
"example": "",
"default": "mystore.com/invoices/abc123"
},
{
"name": "issueDate",
"kind": "required",
"type": "string",
"description": "Date the chargeback was issued / the prechargeback notification was sent. Use YYYY-MM-DD format.\nThe expected date timezone is UTC.",
"example": "",
"default": "2016-01-20"
},
{
"name": "orderId",
"kind": "optional",
"type": "string",
"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.",
"example": "",
"default": "4306795"
},
{
"name": "originalPayload",
"kind": "optional",
"type": "object",
"complexType": "allOf",
"complexItems": [
{
"name": "GeneralPayloadMap",
"description": "",
"modelRef": "#/components/schemas/GeneralPayloadMap",
"schema": []
}
],
"schema": []
},
{
"name": "processorChargebackCaseId",
"kind": "optional",
"type": "string",
"description": "The case number from the payment processor.",
"example": "",
"default": "CB-4343343219"
},
{
"name": "processorName",
"kind": "optional",
"type": "string",
"description": "Payment processor name.",
"example": "",
"default": "Braintree"
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"description": "The claim reason as supplied by the claim source. For example, the chargeback reason provided in the chargeback notification.",
"example": "",
"default": "Fraudulent Transaction: Card Not Present Environment"
},
{
"name": "reasonCode",
"kind": "optional",
"type": "string",
"description": "The claim code as supplied by the claim source. For example, the chargeback reason provided in the chargeback notification.",
"example": "",
"default": "83"
},
{
"name": "reasonType",
"kind": "required",
"type": "string",
"description": "The claim reason category type.",
"example": "",
"default": "FRAUD"
},
{
"name": "sourceDetails",
"kind": "optional",
"type": "string",
"description": "Specifics about the source of the claim such as the processor name / 3rd party name, etc.",
"example": "",
"default": "UPS"
},
{
"name": "sourceType",
"kind": "required",
"type": "string",
"description": "The category of the source of the claim.",
"example": "",
"default": "PROCESSOR_CB"
},
{
"name": "status",
"kind": "required",
"type": "string",
"description": "Claim status mapping from the current status of the claim. For example, a mapping of the processor chargeback dispute status.",
"example": "",
"default": "OPEN"
},
{
"name": "type",
"kind": "required",
"type": "string",
"description": "Type of claim.",
"example": "",
"default": "CHARGEBACK"
},
{
"name": "wasRefunded",
"kind": "optional",
"type": "boolean",
"description": "Relevant only for the prechargeback claim type. Indication of whether or not the buyer was refunded",
"example": "",
"default": false
}
],
"modelRef": "#/components/schemas/claimRequest",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "basicAuth",
"name": "basicAuth",
"kind": "optional",
"type": "http",
"scheme": "basic"
}
]
},
"responses": [
{
"statusCode": "200",
"description": "Example claimResponse",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "The response object following claims request to the system",
"customType": "claimResponse",
"schema": [
{
"name": "message",
"kind": "required",
"type": "string",
"description": "The message containing status response text",
"example": "",
"default": "Claim received"
},
{
"name": "status",
"kind": "required",
"type": "string",
"description": "Status of the request processing",
"example": "",
"default": "success"
}
],
"modelRef": "#/components/schemas/claimResponse",
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "Bad 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": "example-0-curl",
"language": "curl",
"label": "cURL",
"code": "curl --request POST \\\n --url https://api.forter-secure.com/v2/claims \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'api-version: 10.1' \\\n --header 'x-forter-siteid: 8b47c6d423ba' \\\n --header 'authorization: Basic ' \\\n --data '{\n \"additionalCost\": {\n \"amountLocalCurrency\": \"105.55\",\n \"amountUSD\": \"99.95\",\n \"currency\": \"CAD\"\n },\n \"amount\": {\n \"amountLocalCurrency\": \"105.55\",\n \"amountUSD\": \"99.95\",\n \"currency\": \"CAD\"\n },\n \"chargeId\": \"111111111\",\n \"chargebackShippingInfo\": {\n \"additionalShippingInfo\": \"PO Box 3297\",\n \"carrier\": \"UPS\",\n \"proofOfShippingURL\": \"true\",\n \"signedProofOfShipping\": true,\n \"trackingNumber\": \"123456\"\n },\n \"comments\": \"Contacted customer via phone\",\n \"dueDate\": \"2016-01-30\",\n \"externalClaimStatus\": \"pending merchant response\",\n \"invoiceURL\": \"mystore.com/invoices/abc123\",\n \"issueDate\": \"2016-01-20\",\n \"orderId\": \"4306795\",\n \"originalPayload\": {},\n \"processorChargebackCaseId\": \"CB-4343343219\",\n \"processorName\": \"Braintree\",\n \"reason\": \"Fraudulent Transaction: Card Not Present Environment\",\n \"reasonCode\": \"83\",\n \"reasonType\": \"FRAUD\",\n \"sourceDetails\": \"UPS\",\n \"sourceType\": \"PROCESSOR_CB\",\n \"status\": \"OPEN\",\n \"type\": \"CHARGEBACK\"\n }'"
},
{
"id": "example-1-javascript",
"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.1\");\nmyHeaders.append(\"x-forter-siteid\", \"8b47c6d423ba\");\nmyHeaders.append(\"authorization\", \"Basic \");\n\nvar raw = JSON.stringify({\n \"additionalCost\": {\n \"amountLocalCurrency\": \"105.55\",\n \"amountUSD\": \"99.95\",\n \"currency\": \"CAD\"\n },\n \"amount\": {\n \"amountLocalCurrency\": \"105.55\",\n \"amountUSD\": \"99.95\",\n \"currency\": \"CAD\"\n },\n \"chargeId\": \"111111111\",\n \"chargebackShippingInfo\": {\n \"additionalShippingInfo\": \"PO Box 3297\",\n \"carrier\": \"UPS\",\n \"proofOfShippingURL\": \"true\",\n \"signedProofOfShipping\": true,\n \"trackingNumber\": \"123456\"\n },\n \"comments\": \"Contacted customer via phone\",\n \"dueDate\": \"2016-01-30\",\n \"externalClaimStatus\": \"pending merchant response\",\n \"invoiceURL\": \"mystore.com/invoices/abc123\",\n \"issueDate\": \"2016-01-20\",\n \"orderId\": \"4306795\",\n \"originalPayload\": {},\n \"processorChargebackCaseId\": \"CB-4343343219\",\n \"processorName\": \"Braintree\",\n \"reason\": \"Fraudulent Transaction: Card Not Present Environment\",\n \"reasonCode\": \"83\",\n \"reasonType\": \"FRAUD\",\n \"sourceDetails\": \"UPS\",\n \"sourceType\": \"PROCESSOR_CB\",\n \"status\": \"OPEN\",\n \"type\": \"CHARGEBACK\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.forter-secure.com/v2/claims\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "example-2-ruby",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.forter-secure.com/v2/claims\")\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.1\"\nrequest[\"x-forter-siteid\"] = \"8b47c6d423ba\"\nrequest[\"authorization\"] = \"Basic \"\nrequest.body = JSON.dump({\n \"additionalCost\": {\n \"amountLocalCurrency\": \"105.55\",\n \"amountUSD\": \"99.95\",\n \"currency\": \"CAD\"\n },\n \"amount\": {\n \"amountLocalCurrency\": \"105.55\",\n \"amountUSD\": \"99.95\",\n \"currency\": \"CAD\"\n },\n \"chargeId\": \"111111111\",\n \"chargebackShippingInfo\": {\n \"additionalShippingInfo\": \"PO Box 3297\",\n \"carrier\": \"UPS\",\n \"proofOfShippingURL\": \"true\",\n \"signedProofOfShipping\": true,\n \"trackingNumber\": \"123456\"\n },\n \"comments\": \"Contacted customer via phone\",\n \"dueDate\": \"2016-01-30\",\n \"externalClaimStatus\": \"pending merchant response\",\n \"invoiceURL\": \"mystore.com/invoices/abc123\",\n \"issueDate\": \"2016-01-20\",\n \"orderId\": \"4306795\",\n \"originalPayload\": {},\n \"processorChargebackCaseId\": \"CB-4343343219\",\n \"processorName\": \"Braintree\",\n \"reason\": \"Fraudulent Transaction: Card Not Present Environment\",\n \"reasonCode\": \"83\",\n \"reasonType\": \"FRAUD\",\n \"sourceDetails\": \"UPS\",\n \"sourceType\": \"PROCESSOR_CB\",\n \"status\": \"OPEN\",\n \"type\": \"CHARGEBACK\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "example-3-python",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.forter-secure.com/v2/claims\"\n\npayload = json.dumps({\n \"additionalCost\": {\n \"amountLocalCurrency\": \"105.55\",\n \"amountUSD\": \"99.95\",\n \"currency\": \"CAD\"\n },\n \"amount\": {\n \"amountLocalCurrency\": \"105.55\",\n \"amountUSD\": \"99.95\",\n \"currency\": \"CAD\"\n },\n \"chargeId\": \"111111111\",\n \"chargebackShippingInfo\": {\n \"additionalShippingInfo\": \"PO Box 3297\",\n \"carrier\": \"UPS\",\n \"proofOfShippingURL\": \"true\",\n \"signedProofOfShipping\": True,\n \"trackingNumber\": \"123456\"\n },\n \"comments\": \"Contacted customer via phone\",\n \"dueDate\": \"2016-01-30\",\n \"externalClaimStatus\": \"pending merchant response\",\n \"invoiceURL\": \"mystore.com/invoices/abc123\",\n \"issueDate\": \"2016-01-20\",\n \"orderId\": \"4306795\",\n \"originalPayload\": {},\n \"processorChargebackCaseId\": \"CB-4343343219\",\n \"processorName\": \"Braintree\",\n \"reason\": \"Fraudulent Transaction: Card Not Present Environment\",\n \"reasonCode\": \"83\",\n \"reasonType\": \"FRAUD\",\n \"sourceDetails\": \"UPS\",\n \"sourceType\": \"PROCESSOR_CB\",\n \"status\": \"OPEN\",\n \"type\": \"CHARGEBACK\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'api-version': '10.1',\n 'x-forter-siteid': '8b47c6d423ba',\n 'authorization': 'Basic '\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "example-0-curl"
},
"results": {
"languages": [
{
"id": "response-0-200",
"language": "200",
"code": "// Example claimResponse\n{\n \"message\": \"\",\n \"status\": \"\"\n}"
},
{
"id": "response-1-400",
"language": "400",
"code": "// Bad Request (Often missing a required parameter)\n"
},
{
"id": "response-2-401",
"language": "401",
"code": "// Unauthorized (No valid API key provided)\n"
},
{
"id": "response-3-404",
"language": "404",
"code": "// Not Found (The requested item doesn't exist)\n"
},
{
"id": "response-4-500",
"language": "500",
"code": "// Server Error (Something went wrong on Forter's end)\n"
}
],
"selectedLanguageId": "response-0-200"
}
},
"children": [
{
"id": "S5xKphhUThxRFA8a4hWLt",
"type": "paragraph",
"children": [
{
"text": "顧客によって開始された紛争を通知します。このエンドポイントは、支払い処理業者からのウェブフックを介してまだ報告されていない紛争を報告するために使用されるべきです。このリクエストに対して決定は提供されませんが、これは決定モデルを改善し、チャージバック回収を可能にするための必須入力です。"
}
]
}
]
}