Dispute - API Reference

Dispute

POST

Try it

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.

Credentials

HTTP Basic basicAuth

Header Parameters

Parameter	Type	Required
api-version	string	\*
x-forter-siteid	string	\*

Body Parameters

Parameter	Type	Required
body	claimRequest	\*
additionalCost	Amount	\*
amount	Amount	\*
chargeId	string	nullable
chargebackShippingInfo	object	All Of
comments	string	nullable
dueDate	string	\*
externalClaimStatus	string	nullable
goodsRecovered	boolean	nullable
invoiceURL	string	nullable
issueDate	string	\*
orderId	string	nullable
originalPayload	object	All Of
processorChargebackCaseId	string	nullable
processorName	string<Adyen	Airwallex
reason	string	nullable
reasonCode	string	nullable
reasonType	string<FRAUD	SERVICE
sourceDetails	string	nullable
sourceType	string<PROCESSOR_CB	AMEX
status	string<OPEN	IN_DISPUTE
type	string<CHARGEBACK	PRE_CHARGEBACK
wasRefunded	boolean	nullable

Responses

200

Example claimResponse

Field	Type	Required
message	string	\*
status	string	\*

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

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: a1b2c3d4e5f6' \ 
--data '{
  "additionalCost": {},
  "amount": {},
  "chargebackShippingInfo": {},
  "dueDate": "2016-01-30",
  "issueDate": "2016-01-20",
  "originalPayload": {},
  "reasonType": "FRAUD",
  "sourceType": "PROCESSOR_CB",
  "status": "OPEN",
  "type": "CHARGEBACK"
}'

Responses

200

Example claimResponse

{
  "message": "Claim received",
  "status": "success"
}