v1

latestOpenAPI 3.1.02026-07-227350156.5 KB
Feedback and Reporting

Report that a card decline occurred

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

post/enrichments/{enrichmentId}/decline

Request body

declineCodestring

A two digit alphanumeric code indicating why a card transaction was declined. For reference, see the Visa Action Code or the Mastercard Network Response Codes.

declineDescriptionstring

A plain text description associated with a decline code.

declineNotesstring

Any additional details related to a card decline not covered by the declineCode or declineDescription.

occurredAtstring date-time

The time the decline 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

{
  "declineCode": "51",
  "declineDescription": "Insufficient funds",
  "declineNotes": "Unknown reason for decline.",
  "occurredAt": "2022-06-15 18:27:51Z",
  "fraudNotes": "Merchant is believed to commonly be used for card testing."
}

Response

Decline reported successfully.

detailsstring

Example response

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