Skip to main content
POST
/
enrichments
/
{enrichmentId}
/
refund
Report that a refund occurred
curl --request POST \
  --url https://east.sandbox.spade.com/enrichments/{enrichmentId}/refund \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "refundNotes": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "isFraud": true,
  "fraudType": "card_not_present",
  "fraudNotes": "<string>"
}
'
{
  "details": "<string>"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
enrichmentId
string
required

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

Body

application/json
​
refundNotes
string

Any additional details related to a refund

Maximum string length: 512
Example:

"Frequently refunded item."

​
occurredAt
string<date-time>

The time the refund occurred. Formatted as an ISO 8601 date time.

Example:

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

​
isFraud
boolean

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

Example:

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 string length: 512
Example:

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

Response

Refund reported successfully.

Response for reporting any kind of enrichment feedback.

​
details
string
Example:

"Chargeback successfully reported."