presentment_received

Last updated: July 31, 2024


1{
2  "id": "evt_az5sblvku4ge3dwpztvyizgcau",
3  "type": "presentment_received",
4  "version": "2.0.0",
5  "created_on": "2018-04-10T08:13:14Z",
6  "data": {
7    "id": "msg_abcd5fg6hievapshljklmnop4",
8    "card": {
9      "id": "crd_fa6psq242dcd6fdn5gifcq1491",
10      "metadata": {
11        "reference": "X-123456-N11",
12        "udf1": "metadata1",
13        "udf2": "metadata2",
14        "udf3": "metadata3",
15        "udf4": "metadata4",
16        "udf5": "metadata5"
17      }
18    },
19    "cardholder":{
20      "id": "crh_urdihafyo75evcr55s62jmwwhy"
21    },
22    "entity":{
23      "id": "ent_urdihafyo75evcr55s62jmwwhy"
24    },
25    "client":{
26      "id": "cli_urdihafyo75evcr55s62jmwwhy"
27    },
28    "transaction_id": "trx_y3oqhf46pyzuxjbcn2giaqnb44",
29    "transmission_date_time": "2018-04-10T08:12:14Z",
30    "clearing_amount": 1000,
31    "clearing_currency": "GBP",
32    "clearing_type": "debit",
33    "billing_amount": 900,
34    "billing_currency": "EUR",
35    "billing_conversion_rate": 0.925643,
36    "reconciliation_amount": 900,
37    "reconciliation_currency": "EUR",
38    "reconciliation_conversion_rate": 0.925643,
39    "ecb_conversion_rate": 0.9,
40    "digital_card_information": {
41      "digital_card_id": "dcr_fa6psq242dcd6fdn5gifcq1491",
42      "device_type": "phone",
43      "wallet_type": "ApplePay"
44    },
45    "local_transaction_date_time": "2018-04-10T04:12:14",
46    "original_transaction_type": "purchase",
47    "settlement_date": "2018-04-11",
48    "transit_information": {
49        "transaction_type": "authorized_aggregated_split_clearing",
50        "transportation_mode": "urban_bus"
51    },
52    "pos": {
53      "card_present": "present",
54      "cardholder_present": "not_present",
55      "entry_mode": "ecommerce"
56    }
57  }
58}

Field name Description

Field name	Description
`id` string	The transaction's unique Checkout.com identifier.
`card` object	Information about the card associated with this transaction. See the Card section for more details.
`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 ID of the transaction, which links together all related authorization, reversal, and clearing messages.
`transmission_date_time` string	The date and time 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.
`clearing_amount` uint64	The clearing's transaction amount, in minor currency units. See our documentation on calculating currency values for more information.
`clearing_currency` string	The acquirer’s local currency, or the local currency of the transaction’s source location, as an ISO 4217 code.
`clearing_type` string	Type of clearing. This can be one of: `debit` `credit`
`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.
`reconciliation_amount` uint64	Represents the amount converted to the reconciliation currency.
`reconciliation_currency` string	Represents the fee's reconciliation currency, as an ISO 4217 code.
`reconciliation_conversion_rate` double	The scheme conversion rate used to convert the transaction amount to the reconciliation amount.
`ecb_conversion_rate` double optional	The European Central Bank (ECB) comparative rate that will be communicated to the cardholder for a currency conversion when the `transaction_currency` and `billing_currency` are different.
`digital_card_information` object	Information about the digital card associated with this transaction. See the Digital card information section for more details.
`local_transaction_time` string	The local date and time indicating when the transaction was initiated.
`original_transaction_type` string	Type of the original transaction. This can be one of: `purchase` `withdrawal` `cashback` `cash_advance` `refund` `remittance_payment` `payment` `remittance_funding` `balance_inquiry` `pin_unblock` `pin_change` `unique_transaction` `payment_or_balance_transfer` `convenience_check` `fee_collection_credit_to_transaction_originator` `fee_collection_debit_to_transaction_originator`
`settlement_date` string	Represents the date on which the scheme expects funds transfer to take place.
`transit_information` object	Information used to identify transit transactions. See the Transit information section for more details.
`pos` object	Indicates the conditions that exist at the point of sale at the time of the transaction. See the POS section for more details.

id

string

The transaction's unique Checkout.com identifier.

card

object

Information about the card associated with this transaction. See the Card section for more details.

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 ID of the transaction, which links together all related authorization, reversal, and clearing messages.

transmission_date_time

string

The date and time 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.

clearing_amount

uint64

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

See our documentation on calculating currency values for more information.

clearing_currency

string

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

clearing_type

string

Type of clearing. This can be one of:

debit
credit

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.

reconciliation_amount

uint64

Represents the amount converted to the reconciliation currency.

reconciliation_currency

string

Represents the fee's reconciliation currency, as an ISO 4217 code.

reconciliation_conversion_rate

double

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

ecb_conversion_rate

double

optional

The European Central Bank (ECB) comparative rate that will be communicated to the cardholder for a currency conversion when the transaction_currency and billing_currency are different.

digital_card_information

object

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

local_transaction_time

string

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

original_transaction_type

string

Type of the original transaction. This can be one of:

purchase
withdrawal
cashback
cash_advance
refund
remittance_payment
payment
remittance_funding
balance_inquiry
pin_unblock
pin_change
unique_transaction
payment_or_balance_transfer
convenience_check
fee_collection_credit_to_transaction_originator
fee_collection_debit_to_transaction_originator

settlement_date

string

Represents the date on which the scheme expects funds transfer to take place.

transit_information

object

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

pos

object

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

Field name Description

Field name	Description
`id` string	The card's unique Checkout.com identifier.
`metadata` object optional	User-defined metadata. For more details, refer to the request body fields in the Create a card endpoint.

id

string

The card's unique Checkout.com identifier.

metadata

object

optional

User-defined metadata. For more details, refer to the request body fields in the Create a card endpoint.

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

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
`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` `server` `other`

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
server
other

presentment_received

Example: Presentment received

Webhook response fields

Card

Cardholder

Entity

Client

Digital card information

Transit information

POS