SPspreedly
claim

Forward a claim to the protection provider

Forward a claim to the protection provider

post/protection/{transaction_token}/claims

Request

Request body

additional_amountnumber

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

amountnumber required

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

case_idstring required

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

charge_idstring 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

commentsstring

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

currencystring required

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

due_datestring 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

issue_datestring required

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

order_idstring 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

processor_namestring required

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

reason_codestring required

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

reason_descriptionstring required

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

reason_type'FRAUD' | 'SERVICE' | 'OTHER' | 'AUTHORIZATION' | 'PROCESSING_ERROR' required

The claim reason category type

source_type'PROCESSOR_CB' | 'AMEX' | 'DISCOVER' | 'PAYPAL' | 'PROCESSOR_INQUIRY' | 'CUSTOMER_SUPPORT' | 'SHIPPING_CARRIER' | 'THIRD_PARTY' | 'FORTER' | 'OTHER'

The category of the source of the claim

status'OPEN' | 'IN_DISPUTE' | 'WON' | 'LOST' | 'CANCELED' required

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

type'CHARGEBACK' | 'PRE_CHARGEBACK' | 'DEBIT_MEMO' | 'REQUEST_FOR_INFORMATION' | 'FRAUD_ALERT'

The type of the claim

Response

Forwarded

Changes

No recorded changes to this operation across all 2 revisions of this API.