Sign in

v1

latestOpenAPI 3.1.02026-07-227350156.5 KB
Feedback and Reporting

Report that a refund occurred

An endpoint for reporting that a refund has occurred on a transaction associated with an enrichment. The refundNotes property can be used to provide information about the refund. The isFraud, fraudType, and fraudNotes are used to provide information about fraud or suspected fraud related to this refund. Note that this transaction must previously have been enriched to report the refund.

post/enrichments/{enrichmentId}/refund

Request body

refundNotesstring

Any additional details related to a refund

occurredAtstring date-time

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

isFraudboolean

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

fraudType'card_not_present' | 'card_testing' | 'chargeback_fraud' | 'counterfeit_card' | 'merchant_fraud' | 'other' | 'phishing' | 'stolen_card' | 'unknown' | 'none'

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

fraudNotesstring

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

Example request

{
  "refundNotes": "Frequently refunded item.",
  "occurredAt": "2022-06-15 18:27:51Z",
  "fraudNotes": "Merchant is believed to commonly be used for card testing."
}

Response

Refund reported successfully.

detailsstring

Example response

{
  "details": "Chargeback successfully reported."
}