authorization_advice_received

Last updated: July 31, 2024


1{
2  "id": "evt_az5sblvku4ge3dwpztvyizgcau",
3  "type": "authorization_advice_received",
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    "transaction_id": "trx_y3oqhf46pyzuxjbcn2giaqnb44",
19    "transaction_type": "purchase",
20    "transmission_date_time": "2018-04-10T08:12:14Z",
21    "local_transaction_date_time": "2018-04-10T08:12:14",
22    "transaction_amount": 1000,
23    "transaction_currency": "GBP",
24    "billing_amount": 900,
25    "billing_currency": "EUR",
26    "billing_conversion_rate": 0.925643,
27    "scheme_response_summary": "do_not_honour",
28    "digital_card_information": {             
29      "digital_card_id": "dcr_fa6psq242dcd6fdn5gifcq1491",
30      "device_type": "phone",                 
31      "wallet_type": "apple_pay"              
32    },
33    "merchant": {
34      "merchant_id": "59889",
35      "name" : "Carrefour",
36      "city": "Paris",
37      "state": "",                            
38      "country": "FRA",                   
39      "category_code": "5021",
40      "street_address": "Wenlock Works, Shepherdess Walk"
41    },
42    "advice_reason": "banknet_system_not_available",
43    "advice_initiator": "scheme",
44    "transit_information": {
45        "transaction_type": "authorized_aggregated_split_clearing",
46        "transportation_mode": "urban_bus"
47    },
48    "point_of_sale_transaction_date" : "2023-04-25",
49    "pos": {
50      "country_code": "GBR",
51      "postal_code": "SE100ER",
52      "card_present": "present",
53      "cardholder_present": "not_present",
54      "entry_mode": "ecommerce"
55    }
56  }
57}

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.
`transaction_id` string	The transaction's unique Checkout.com identifier.
`transaction_type` string	Type of transaction. This can be one of: `balance_inquiry` `bill_payment` `cashback` `pin_change` `pin_unblock` `purchase` `purchase_account_inquiry` `refund` `remittance_funding` `withdrawal`
`transmission_date_time` string	The date and time indicating when the message was received from the scheme, in UTC format.
`local_transaction_date_time` string	The local date and time indicating when the transaction was initiated.
`transaction_amount` uint64	The authorization's transaction amount, in minor currency units. See our documentation on calculating currency values for more information.
`transaction_currency` string	The acquirer’s local currency, or the local currency of the transaction’s source location, as an ISO 4217 code.
`billing_amount` uint64	The clearing's billing amount, in minor currency units. In case of a currency conversion, this will be based on Mastercard rates. See our documentation on calculating currency values for more information.
`billing_currency` string	The currency in which the issuer will bill the cardholder, as an ISO 4217 code.
`billing_conversion_rate` double	The scheme conversion rate used to convert the transaction amount to the billing amount.
`digital_card_information` object	Information about the digital card associated with this transaction. See the Digital card information section for more details.
`merchant` object	Information about the merchant associated with this transaction. See the Merchant section for more details.
`scheme_response_summary` string	The response decision received from the scheme network. This can be one of: `invalid_card_number` `system_malfunction` `do_not_honour` `invalid_pin` `security_violation` `approved` `restricted_card` `format_error` `security`
`advice_reason` string	Indicates the general purpose of the advice message. This can be one of: `issuer_selected_option` `issuer_not_available` `transaction_processed_via_x_code` `pin_processing_error` `scheme_error` `network_not_dispatched_error` `direct_down_option` `transaction_processed_via_on_behalf_service_decision` `invalid_merchant` `transaction_blocking` `account_lookup_service` `unable_to_convert_contactless_or_virtual_account_number` `cardholder_activated_terminal_risk_level_3` `pay_with_rewards_processing_advice_to_issuer` `mastercard_digital_enablement_service_advice_to_issuer` `token_service_provider_advice_to_issuer` `in_control_processing_advice_to_issuer_merchant_presented_qr_code` `authentication_advice_to_issuer` `m_chip_offline_advice_to_issuer` `in_control_processing_advice_to_issuer` `acquirer_generated_advice` `banknet_system_not_available` `administrative_textual_message_transmittal` `banknet_advice_aps_error_unable_to_deliver_response`
`advice_initiator` string	Specifies who initiated the advice. This can be one of: `scheme` `acquirer` `issuer`
`transit_information` object	The information used to identify transit transactions. See the Transit information section for more details.
`point_of_sale_transaction_date` string	The transaction date when the customer used the card at the point of sale.
`pos` object	(Optional) Indicates the conditions that exist at the point of sale (POS) at the time of the transaction. See the POS 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.

transaction_id

string

The transaction's unique Checkout.com identifier.

transaction_type

string

Type of transaction. This can be one of:

balance_inquiry
bill_payment
cashback
pin_change
pin_unblock
purchase
purchase_account_inquiry
refund
remittance_funding
withdrawal

transmission_date_time

string

The date and time indicating when the message was received from the scheme, in UTC format.

local_transaction_date_time

string

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

transaction_amount

uint64

The authorization's transaction amount, in minor currency units.

See our documentation on calculating currency values for more information.

transaction_currency

string

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

billing_amount

uint64

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

See our documentation on calculating currency values for more information.

billing_currency

string

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

billing_conversion_rate

double

The scheme conversion rate used to convert the transaction amount to the billing amount.

digital_card_information

object

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

merchant

object

Information about the merchant associated with this transaction. See the Merchant section for more details.

scheme_response_summary

string

The response decision received from the scheme network. This can be one of:

invalid_card_number
system_malfunction
do_not_honour
invalid_pin
security_violation
approved
restricted_card
format_error
security

advice_reason

string

Indicates the general purpose of the advice message. This can be one of:

issuer_selected_option
issuer_not_available
transaction_processed_via_x_code
pin_processing_error
scheme_error
network_not_dispatched_error
direct_down_option
transaction_processed_via_on_behalf_service_decision
invalid_merchant
transaction_blocking
account_lookup_service
unable_to_convert_contactless_or_virtual_account_number
cardholder_activated_terminal_risk_level_3
pay_with_rewards_processing_advice_to_issuer
mastercard_digital_enablement_service_advice_to_issuer
token_service_provider_advice_to_issuer
in_control_processing_advice_to_issuer_merchant_presented_qr_code
authentication_advice_to_issuer
m_chip_offline_advice_to_issuer
in_control_processing_advice_to_issuer
acquirer_generated_advice
banknet_system_not_available
administrative_textual_message_transmittal
banknet_advice_aps_error_unable_to_deliver_response

advice_initiator

string

Specifies who initiated the advice. This can be one of:

scheme
acquirer
issuer

transit_information

object

The information used to identify transit transactions. See the Transit information section for more details.

point_of_sale_transaction_date

string

The transaction date when the customer used the card at the point of sale.

pos

object

(Optional) Indicates the conditions that exist at the point of sale (POS) at the time of the transaction. See the POS section for more details.

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`

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

Field name	Description
`merchant_id` string	The merchant's identifier. This may vary from one acquirer to another.
`name` string	The merchant's name.
`city` string	The city where the merchant is located.
`state`	(Optional, applicable only for USA) The state where the merchant is located.
`country` string	The country where the merchant is located, as an ISO-3 code.
`category_code` string	The merchant's category codes.
`street_address` string	The merchant's street address.

Field name Description

Field name	Description
`transaction_type` string	The authorization model used by the transit operator. This can be one of: `prefunded` `real_time_authorized` `post_authorized_aggregated` `authorized_aggregated_split_clearing` `other` `post_authorized_aggregated_maestro` `debt_recovery`
`transportation_method` string	The transport method used to travel. This can be one of: `urban_bus` `interurban_bus` `light_train_mass_transit` `train` `commuter_train` `water_borne_vehicle` `toll` `parking` `taxi` `high_speed_train` `rural_bus` `express_commuter_train` `para_transit` `self_drive_vehicle` `coach` `locomotive` `powered_motor_vehicle` `trailer` `regional_train` `inter_city` `funicular_train` `cable_car` `other`

transaction_type

string

The authorization model used by the transit operator. This can be one of:

prefunded
real_time_authorized
post_authorized_aggregated
authorized_aggregated_split_clearing
other
post_authorized_aggregated_maestro
debt_recovery

transportation_method

string

The transport method used to travel. This can be one of:

urban_bus
interurban_bus
light_train_mass_transit
train
commuter_train
water_borne_vehicle
toll
parking
taxi
high_speed_train
rural_bus
express_commuter_train
para_transit
self_drive_vehicle
coach
locomotive
powered_motor_vehicle
trailer
regional_train
inter_city
funicular_train
cable_car
other

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
`country_code` string	The country code where the point of sale is located.
`postal_code` string	The postal code where the point of sale is located.
`card_present` string	Indicates if the card was present to initiate the transaction. This can be one of: `present` `not_present` `unspecified`
`cardholder_present` string	Indicates if the cardholder was present to initiate the transaction. This can be one of: `present` `not_present` `unspecified`
`entry_mode` string	The method by which a card initiates a transaction at a terminal. This can be one of: `contact_chip` `contactless_chip` `contactless_magstripe` `ecommerce` `magstripe` `manual` `optical_character_recognition` `optical_code` `server` `other`

country_code

string

The country code where the point of sale is located.

postal_code

string

The postal code where the point of sale is located.

card_present

string

Indicates if the card was present to initiate the transaction. This can be one of:

present
not_present
unspecified

cardholder_present

string

Indicates if the cardholder was present to initiate the transaction. This can be one of:

present
not_present
unspecified

entry_mode

string

The method by which a card initiates a transaction at a terminal. This can be one of:

contact_chip
contactless_chip
contactless_magstripe
ecommerce
magstripe
manual
optical_character_recognition
optical_code
server
other

authorization_advice_received

Example: Authorization advice received

Webhook response fields

Digital card information

Merchant

Transit information

Cardholder

Entity

Client

POS