POST
/
enrichments
/
{enrichmentId}
/
chargeback
Report that a chargeback occurred
curl --request POST \
  --url https://east.sandbox.spade.com/enrichments/{enrichmentId}/chargeback \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "state": "chargeback_won",
  "chargebackNotes": "Transaction was initiated in error.",
  "occurredAt": "2022-06-15 18:27:51Z",
  "isFraud": false,
  "fraudType": "card_not_present",
  "fraudNotes": "Merchant is believed to commonly be used for card testing."
}'
{
  "details": "Chargeback successfully reported."
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
enrichmentId
string
required

The enrichmentId of enrichment associated with the transaction where a chargeback occurred.

Body

application/json
​
state
enum<string>
required

The state of the chargeback process. You can update a chargeback's state by submitting another request with a new state, for example, a new request could update the state from chargeback_pending to chargeback_won.

Available options:
chargeback_won,
chargeback_lost,
chargeback_pending
Examples:

"chargeback_won"

​
chargebackNotes
string

Any additional details related to the chargeback not covered by the state.

Maximum length: 512
Examples:

"Transaction was initiated in error."

​
occurredAt
string<date-time>

The time when the chargeback's state change. This could be the time when the chargeback was initiated and its state became chargeback_pending or the time when the chargeback was resolved its state moved to chargeback_won or chargeback_lost. Formatted as an ISO 8601 date time.

Examples:

"2022-06-15 18:27:51Z"

​
isFraud
boolean

A boolean indicating if this transaction was suspected to involve fraud.

Examples:

false

​
fraudType
enum<string>

The type of fraud suspected to have occurred. This field can only be provided if isFraud is true.

Available options:
card_not_present,
card_testing,
chargeback_fraud,
counterfeit_card,
merchant_fraud,
other,
phishing,
stolen_card,
unknown,
none
​
fraudNotes
string

Any additional details related to fraud suspected to have occurred on the associated transaction. This field can only be provided if isFraud is true.

Maximum length: 512
Examples:

"Merchant is believed to commonly be used for card testing."

Response

Chargeback reported successfully.

Response for reporting any kind of enrichment feedback.

​
details
string
Examples:

"Chargeback successfully reported."