Forward a claim to the protection provider

Forward a claim to the protection provider

Path Params
string
required

The token of the disputed transaction

Body Params
number

Additional fees associated with the claim such as processor fees or shipping recovery fees

number
required

The amount representing the value of the goods that were not retrieved

string
required

The case number from the payment processor. (For Braintree, please map the Dispute Id instead of Case Number)

string
required

The unique transaction identifier from the gateway. If the fraud check and gateway transaction were done through Spreedly, this will be the gateway_transaction_id

string

Additional comments by the merchant, e.g. Contacted customer via phone

string
required

Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code

string
required

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

string
required

Date the chargeback was issued / the prechargeback notification was sent. Use YYYY-MM-DD format. The expected date timezone is UTC

string
required

The unique protect check identifier from the provider. If the transaction was completed through Spreedly this will be the token returned in the protect_fraud_check response

string
required

The name of the gateway if the fraud check and gateway transaction were completed through Spreedly, e.g. Stripe

string
required

The claim code as supplied by the claim source. For example, the chargeback reason provided in the chargeback notification. Ex: 83

string
required

The claim reason as supplied by the claim source. For example, the chargeback reason provided in the chargeback notification

string
enum
required
Defaults to FRAUD

The claim reason category type

Allowed:
string
enum
Defaults to PROCESSOR_CB

The category of the source of the claim

string
enum
required
Defaults to OPEN

Claim status mapping from the current status of the claim. For example, a mapping of the processor chargeback dispute status

Allowed:
string
enum
Defaults to CHARGEBACK

The type of the claim

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
Response
Choose an example:
application/json