Manage cardholder transactions
A transaction is a collection of actions performed with a card. The actions are represented by individual messages such as an authorization, a reversal, a clearing first presentment, and a dispute. These messages define the transaction lifecycle.
During its lifecycle, a transaction will transition through various phases, depending on the actions taken by the cardholder, merchant, issuer, and card scheme. The sequence of these phases collectively defines the transaction's progression from initiation to completion.
Typically, a successful transaction will transition through authorization, clearing, and settlement phases.
In the European Union (EU), transactions are processed using Mastercard’s dual message system, in which:
The merchant first sends an authorization message to instantly verify and hold the funds in the cardholder’s account.
Upon verification, the merchant then sends a clearing message at a later point in time to debit or credit the cardholder.
For example, when a cardholder makes an online purchase:
- The purchase details are sent to the card issuer for approval. This is known as an authorization message.
- After the items are sent out, another message, called the first presentment, is sent to the issuer. This message initiates the clearing phase, where the merchant finalizes the transaction by submitting a capture request.
- The actual transfer of funds happens between the merchant and the cardholder issuer. This is known as the settlement phase.
Information
You can access transactional data using:
Webhooks are typically used to send automated notifications to cardholders or populate data in your system to follow how cards are used.
Webhooks provide an almost real-time, automated method for tracking transactional messages. You'll receive notifications as soon as a message is processed.
For more information, refer to the list of supported webhook event types.
Authorization approved
1{2"id": "evt_az5sblvku4ge3dwpztvyizgcau",3"type": "authorization_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_d3ozhf43pcq2xbldn2g45qnp65"11},12"entity":{13"id": "ent_fa6psq242dcd6fdn5gifcq1491"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"authorization_type": "final_authorization",23"transaction_amount": 1000,24"transaction_currency": "GBP",25"billing_amount": 900,26"billing_currency": "EUR",27"billing_conversion_rate": 0.925643,28"ecb_conversion_rate": 0.9,29"digital_card_information": {30"digital_card_id": "dcr_fa6psq242dcd6fdn5gifcq1491",31"device_type": "phone",32"wallet_type": "apple_pay"33},34"merchant": {35"merchant_id": "59889",36"name" : "The Family-Owned Travel Company",37"city": "Paris",38"state": "",39"country": "FRA",40"category_code": "5021",41"street_address": "123 Avenue de l'élégance"42},43"transit_information": {44"transaction_type": "authorized_aggregated_split_clearing",45"transportation_mode": "urban_bus"46},47"point_of_sale_transaction_date" : "2023-04-25",48"reference_transaction": {49"transaction_id": "trx_fa6psq242dcd6fdn5gifcq1491",50"reference_type": "original_mit"51},52"three_d_secure": {53"requested_exemption_or_exclusion": "merchant_initiated_transaction",54"sca_not_required_reason": "merchant_initiated_transaction"55},56"pos": {57"country_code": "GBR",58"postal_code": "SE100ER",59"card_present": "present",60"cardholder_present": "not_present",61"entry_mode": "ecommerce"62}63}64}
Presentment received
1{2"id": "evt_pq5sblvku4ge3dwpztvyizgtd",3"type": "presentment_received",4"version": "2.0.0",5"created_on": "2018-04-10T08:13:14Z",6"data": {7"id": "msg_abcd5fg6hievapshljklpovf8",8"card_id": "crd_fa6psq242dcd6fdn5gifcq1491",9"cardholder":{10"id": "crh_d3ozhf43pcq2xbldn2g45qnp65"11},12"entity":{13"id": "ent_fa6psq242dcd6fdn5gifcq1491"14},15"client":{16"id": "cli_urdihafyo75evcr55s62jmwwhy"17},18"transaction_id": "trx_y3oqhf46pyzuxjbcn2giaqnb44",19"transmission_date_time": "2018-04-12T08:12:14Z",20"clearing_amount": 1000,21"clearing_currency": "GBP",22"clearing_type": "debit",23"billing_amount": 900,24"billing_currency": "EUR",25"billing_conversion_rate": 0.925643,26"reconciliation_amount": 900,27"reconciliation_currency": "EUR",28"reconciliation_conversion_rate": 0.925643,29"ecb_conversion_rate": 0.9,30"digital_card_information": {31"digital_card_id": "dcr_fa6psq242dcd6fdn5gifcq1491",32"device_type": "phone",33"wallet_type": "ApplePay"34},35"local_transaction_date_time": "2018-04-10T04:12:14",36"original_transaction_type": "purchase",37"settlement_date": "2018-04-11",38"transit_information": {39"transaction_type": "authorized_aggregated_split_clearing",40"transportation_mode": "urban_bus"41},42"pos": {43"card_present": "present",44"cardholder_present": "not_present",45"entry_mode": "ecommerce"46}47}48}
With the Transaction API, you can view aggregated and granular-level data. It provides events associated with each transaction, and offers search capabilities to retrieve transactions using criteria.
The Transaction API can be used to help with your operational needs. For example, to investigate a transaction or monitor performance.
For the full API specification, see our API reference.
1{2"id": "trx_y3oqhf46pyzuxjbcn2giaqnb44",3"created_on": "2018-04-10T08:12:14Z",4"status": "cleared",5"transaction_type": "purchase",6"client": {7"id": "cli_urdihafyo75evcr55s62jmwwhy"8},9"entity": {10"id": "ent_fa6psq242dcd6fdn5gifcq1491"11},12"card": {13"id": "crd_fa6psq242dcd6fdn5gifcq1491",14"network": "mastercard"15},16"digital_card": {17"id": "dcr_5ngxzsynm2me3oxf73esbhda6q",18"wallet_type": "applepay"19},20"cardholder": {21"id": "crh_d3ozhf43pcq2xbldn2g45qnp65"22},23"amounts": {24"total_held": {25"amount": 0,26"currency": "EUR"27},28"total_authorized": {29"amount": 900,30"currency": "EUR"31},32"total_reversed": {33"amount": 0,34"currency": "EUR"35},36"total_cleared": {37"amount": 900,38"currency": "EUR"39},40"total_refunded": null41},42"merchant": {43"id": "59889",44"name": "The Family-Owned Travel Company",45"city": "Paris",46"state": "",47"country_code": "FR",48"street_address": "123 Avenue de l'élégance",49"category_code": 502150},51"reference_transaction": {52"transaction_id": "trx_aayhhfwbdyxwcaeyhhfwbd4xga",53"reference_type": "original_mit"54},55"messages": [56{57"id": "msg_abcd5fg6hievapshljklmnop4",58"initiator": "merchant",59"type": "authorization",60"result": "approved",61"is_relayed": false,62"indicator": "final_authorization",63"decline_reason": null,64"billing_amount": 900,65"billing_currency": "EUR",66"created_on": "2018-04-10T08:12:14Z"67},68{69"id": "msg_abcd5fg6hievapshljklpovf8",70"initiator": "acquirer",71"type": "presentment",72"result": "processed",73"is_relayed": false,74"indicator": "final_presentment",75"decline_reason": null,76"billing_amount": 900,77"billing_currency": "EUR",78"created_on": "2018-04-12T08:12:14Z"79}80],81"_links": {82"self": {83"href": "https://api.checkout.com/issuing/transactions/trx_y3oqhf46pyzuxjbcn2giaqnb44"84},85"card": {86"href": "https://api.checkout.com/issuing/cards/crd_fa6psq242dcd6fdn5gifcq1491"87},88"cardholder": {89"href": "https://api.checkout.com/issuing/cards/crh_d3ozhf43pcq2xbldn2g45qnp65"90},91"reference_transaction": {92"href": "https://api.checkout.com/issuing/transactions/trx_aayhhfwbdyxwcaeyhhfwbd4xga"93}94}95}
If you've set up webhook notifications, you'll be notified of changes in a transaction's status with a webhook.
Authorization, the initial phase of a transaction, is used to confirm that:
- the card and cardholder are genuine
- the cardholder has sufficient funds to complete the transaction
- the specific transaction is not restricted
Authorization requests are sent from the merchant to the issuer in near real-time, with responses typically being sent back to the merchant within 1 second.
If you’ve enabled the authorization relay service, submitting an authorization request will trigger a relay.
Clearing is also referred to as first presentment. A transaction enters the clearing phase when the merchant submits a capture request to finalize the hold on the funds and post the transaction on the cardholder’s account.
The merchant may choose to only capture a portion of the initial authorization amount in a capture request. This is known as a partial capture. The remainder can be captured in a subsequent capture request, canceled, or will expire if no action is taken.
Clearing messages contain additional information about the transaction. For example, reconciliation amounts, interchange fees, acquirer fees, and cardholder billing amounts. Mastercard uses this information to calculate the final amounts to be settled.
Information
Reconciliation amount is the amount settled with the card scheme, excluding interchange fees or any other fees. This amount is represented in the settlement currency of the issuer.
When clearing is completed, the transaction enters the settlement phase, in which funds are transferred between the merchant and card issuer.
Mastercard runs five daily settlements per week, which Checkout.com consumes and reports back to you. With shared BINs, this is reported on a per-cardholder basis.
A reversal is the process of canceling or updating a previous authorization before it enters the clearing phase. This process can be initiated by either the merchant or the issuer.
The merchant may also choose to only reverse a portion of the initial authorization amount, known as a partial reversal. The remainder can then be captured in a partial capture request from the acquirer and enter clearing.
A refund occurs when a cardholder requests that the merchant returns the funds from a transaction after clearing has been completed.
A refund can either be included within a transaction’s clearing information, or be preceded by a refund authorization request which the issuer can approve or decline.
A chargeback occurs when the issuer disputes a completed transaction on behalf of the cardholder. It can be raised for the full amount that was cleared or partial amount, and is sent to the merchant.
In some cases, the issuer can reverse a chargeback. For example, a cardholder accepts liability for a dispute after a chargeback is initiated but before it is responded to by the acquirer.
The transaction status field in the API response indicates the current phase of the transaction.
Status | Description |
---|---|
| At least one authorization is approved, but there has been no movement of money. A transaction can remain in this status for some time, such as until a clearing first presentment is received. |
| A transaction that cannot proceed further from the authorization phase is marked as declined. |
| A transaction moves to this status when a presentment is received, regardless of the amount. |
| A transaction that is fully reversed by the merchant or the issuer is considered canceled. If a transaction has been authorized and is partially reversed by the merchant or acquirer, it will remain in the authorized phase, with the amount updated accordingly. |
| This status indicates that a refund has been cleared, and the funds have been returned to the cardholder’s account. A transaction moves to this status irrespective of the amount that has been refunded (the refund can be full or partial). |
| This status applies to a cleared transaction that is being charged back. A chargeback is initiated during this phase. |
The amounts
object in our API provides a detailed breakdown of the financial aspects of a transaction. It aggregates various monetary amounts related to the current transaction.
Amount type | Description |
---|---|
| Amount held internally to cover the transaction, but not debited from the account. It represents the difference among the total amount authorized, the sum of the total amount reversed, and the total amount cleared. This value is useful to understand the current liability on the account pending final settlement. |
| Amount authorized for the transaction. It aggregates the billing amounts from all approved authorizations associated with this transaction. This value is useful to track the total amount approved for spending or withdrawal, offering a clear view of the potential financial commitment. |
| Amount reversed by either the merchant or the issuer. It includes the billing amounts from all approved reversals and issuer-initiated reversals tied to this transaction. This value is useful to understand the actual amounts that have moved through the transaction process and have been settled. |
| Amount cleared by the scheme, summing up the billing amounts from all presentments associated with this transaction. This value is useful to understand the actual amounts that have moved through the transaction process and have been settled. |
| Amount refunded to the cardholder. It includes the billing amounts from all presentments of the type This value is useful to track the total refunds processed, offering insight into the amount returned to the cardholder post-transaction. |