Sign in

v1

latestOpenAPI 3.1.02026-07-227350156.5 KB
Feedback and Reporting

Report that a chargeback occurred

An endpoint for reporting that a chargeback process has occurred on a transaction. The state and chargebackNotes properties can be used to provide information about the chargeback. The isFraud, fraudType, and fraudNotes are used to provide information about fraud or suspected fraud related to this chargeback. Note that this transaction must previously have been enriched to report the chargeback.

post/enrichments/{enrichmentId}/chargeback

Request body

state'chargeback_won' | 'chargeback_lost' | 'chargeback_pending' 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.

chargebackNotesstring

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

occurredAtstring 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.

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

{
  "state": "chargeback_won",
  "chargebackNotes": "Transaction was initiated in error.",
  "occurredAt": "2022-06-15 18:27:51Z",
  "fraudNotes": "Merchant is believed to commonly be used for card testing."
}

Response

Chargeback reported successfully.

detailsstring

Example response

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