Reversal approved

Last updated: April 30, 2025

This event occurs when a reversal is approved.

A reversal is a technical cancellation where an authorization hold is voided, without any movement of funds.

Information

For PIN change transactions, the online PIN is also reverted.


1{
2  "id": "evt_az5sblvku4ge3dwpztvyizgcau",
3  "type": "reversal_approved",
4  "version": "2.0.0",
5  "created_on": "2018-04-10T08:13:14Z",
6  "data": {
7    "id": "msg_abcd5fg6hievapshljklmnop4",
8    "card_id": "crd_fa6psq242dcd6fdn5gifcq1491",
9    "cardholder":{
10      "id": "crh_urdihafyo75evcr55s62jmwwhy"
11    },
12    "entity":{
13      "id": "ent_urdihafyo75evcr55s62jmwwhy"
14    },
15    "client":{
16      "id": "cli_urdihafyo75evcr55s62jmwwhy"
17    },
18    "decision_source": "issuer",
19    "transaction_id": "trx_y3oqhf46pyzuxjbcn2giaqnb44",
20    "transaction_type": "purchase",
21    "reversal_type": "full",
22    "transmission_date_time": "2018-04-10T08:12:14Z",
23    "local_transaction_date_time": "2018-04-10T08:12:14",
24    "reversal_amount": 1000,
25    "reversal_currency": "GBP",
26    "reversal_billing_amount": 900,
27    "reversal_billing_currency": "EUR",
28    "digital_card_information": {             
29      "digital_card_id": "dcr_fa6psq242dcd6fdn5gifcq1491",
30      "device_type": "phone",                 
31      "wallet_type": "apple_pay"              
32    }
33  }
34}

Field name Description

Field name	Description
`id` string	The transaction's unique Checkout.com identifier.
`card_id` string	The card's unique Checkout.com identifier.
`cardholder` object	Information about the cardholder associated with this transaction. See the Cardholder section for more details.
`entity` object	Information about the entity associated with this transaction. See the Entity section for more details.
`client` object	Information about the client associated with this transaction. See the Client section for more details.
`decision_source` string optional	The party that made the decision to approve or decline the authorization. This can be one of: `issuer` – You have authorization relay stand-in mode enabled and Checkout.com made the decision on your behalf while your server was temporarily unavailable. `scheme` – In the rare event that Checkout.com's server was temporarily unavailable, the card scheme made the decision based on risk rules.
`transaction_id` string	The transaction's unique Checkout.com identifier.
`transaction_type` string	The nature of the transaction. This can be one of: `balance_inquiry` `bill_payment` `cashback` `pin_change` `pin_unblock` `purchase` `purchase_account_inquiry` `refund` `remittance_funding` `withdrawal`
`reversal_type` string	Indicates the type of the reversal we've received. This can be one of: `partial` `full`
`transmission_date_time` string	The date and time that a message is entered into the scheme network, in UTC format.
`local_transaction_date_time` string	The local date and time indicating when the transaction was initiated.
`reversal_amount` uint64	The reversal's transaction amount, in minor currency units. For more information on how to calculate currency units, see Format the amount value.
`reversal_currency` string	The acquirer’s local currency, or the local currency of the transaction’s source location, as an ISO 4217 code.
`reversal_billing_amount` uint64	The reversal's billing amount, in minor currency units. In case of a currency conversion, this will be based on Mastercard rates. For more information on how to calculate currency units, see Format the amount value.
`reversal_billing_currency` string	The currency in which the issuer will bill the cardholder, as an ISO 4217 code.
`digital_card_information` object	Information about the digital card associated with this transaction. See the Digital card information section for more details.

id

string

The transaction's unique Checkout.com identifier.

card_id

string

The card's unique Checkout.com identifier.

cardholder

object

Information about the cardholder associated with this transaction. See the Cardholder section for more details.

entity

object

Information about the entity associated with this transaction. See the Entity section for more details.

client

object

Information about the client associated with this transaction. See the Client section for more details.

decision_source

string

optional

The party that made the decision to approve or decline the authorization.
This can be one of:

issuer – You have authorization relay stand-in mode enabled and Checkout.com made the decision on your behalf while your server was temporarily unavailable.
scheme – In the rare event that Checkout.com's server was temporarily unavailable, the card scheme made the decision based on risk rules.

transaction_id

string

The transaction's unique Checkout.com identifier.

transaction_type

string

The nature of the transaction. This can be one of:

balance_inquiry
bill_payment
cashback
pin_change
pin_unblock
purchase
purchase_account_inquiry
refund
remittance_funding
withdrawal

reversal_type

string

Indicates the type of the reversal we've received. This can be one of:

partial
full

transmission_date_time

string

The date and time that a message is entered into the scheme network, in UTC format.

local_transaction_date_time

string

The local date and time indicating when the transaction was initiated.

reversal_amount

uint64

The reversal's transaction amount, in minor currency units.
For more information on how to calculate currency units, see Format the amount value.

reversal_currency

string

The acquirer’s local currency, or the local currency of the transaction’s source location, as an ISO 4217 code.

reversal_billing_amount

uint64

The reversal's billing amount, in minor currency units. In case of a currency conversion, this will be based on Mastercard rates.

For more information on how to calculate currency units, see Format the amount value.

reversal_billing_currency

string

The currency in which the issuer will bill the cardholder, as an ISO 4217 code.

digital_card_information

object

Information about the digital card associated with this transaction. See the Digital card information section for more details.

Field name Description

Field name	Description
`id` string	The cardholder's unique Checkout.com identifier.

id

string

The cardholder's unique Checkout.com identifier.

Field name Description

Field name	Description
`id` string	The entity's unique Checkout.com identifier.

id

string

The entity's unique Checkout.com identifier.

Field name Description

Field name	Description
`id` string	The client's unique Checkout.com identifier.

id

string

The client's unique Checkout.com identifier.

Field name Description

Field name	Description
`digital_card_id` string	The digital card's unique Checkout.com identifier
`device_type` string	Type of device. This can be one of: `pc` `tag` `card` `phone` `key_fob` `garment` `jewelry` `sticker` `vehicle` `wristband` `mobile_tag` `tablet_or_e_reader` `watch_or_wristband` `device_peripheral` `fashion_accessory` `domestic_appliance` `media_or_gaming_device` `mobile_phone_case_or_sleeve` `watch_payment_application_host_processor` `watch_payment_application_tee_host_processor` `mobile_phone_payment_application_host_processor` `tablet_or_e_reader_payment_application_host_processor` `mobile_phone_payment_application_tee_host_processor` `tablet_or_e_reader_payment_application_tee_host_processor` `removable_secure_element_not_network_operator_controlled` `mobile_phone_network_operator_controlled_fixed_secure_element` `tablet_or_e_book_network_operator_controlled_fixed_secure_element` `mobile_phone_not_network_operator_controlled_fixed_secure_element` `tablet_or_e_book_not_network_operator_controlled_fixed_secure_element` `mobile_phone_network_operator_controlled_removable_secure_element` `tablet_or_e_reader_network_operator_controlled_removable_secure_element` `mobile_phone_not_network_operator_controlled_removable_secure_element` `watch_contactless_chip_or_not_network_operator_controlled_secure_element`
`wallet_type` string	(Optional) Type of wallet. This can be one of: `apple_pay` `google_pay` `samsung_pay` `merchant_tokenization_program`

digital_card_id

string

The digital card's unique Checkout.com identifier

device_type

string

Type of device. This can be one of:

pc
tag
card
phone
key_fob
garment
jewelry
sticker
vehicle
wristband
mobile_tag
tablet_or_e_reader
watch_or_wristband
device_peripheral
fashion_accessory
domestic_appliance
media_or_gaming_device
mobile_phone_case_or_sleeve
watch_payment_application_host_processor
watch_payment_application_tee_host_processor
mobile_phone_payment_application_host_processor
tablet_or_e_reader_payment_application_host_processor
mobile_phone_payment_application_tee_host_processor
tablet_or_e_reader_payment_application_tee_host_processor
removable_secure_element_not_network_operator_controlled
mobile_phone_network_operator_controlled_fixed_secure_element
tablet_or_e_book_network_operator_controlled_fixed_secure_element
mobile_phone_not_network_operator_controlled_fixed_secure_element
tablet_or_e_book_not_network_operator_controlled_fixed_secure_element
mobile_phone_network_operator_controlled_removable_secure_element
tablet_or_e_reader_network_operator_controlled_removable_secure_element
mobile_phone_not_network_operator_controlled_removable_secure_element
watch_contactless_chip_or_not_network_operator_controlled_secure_element

wallet_type

string

(Optional) Type of wallet. This can be one of:

apple_pay
google_pay
samsung_pay
merchant_tokenization_program

Reversal approved

Information

Example webhook

Webhook fields

Cardholder

Entity

Client

Digital card information