# Authorization approved

This [Issuing](https://www.checkout.com/docs/card-issuing.md) event occurs when an authorization request for a transaction is approved.

## Example webhook

```json
{
  "id": "evt_az5sblvku4ge3dwpztvyizgcau",
  "type": "authorization_approved",
  "version": "2.0.0",
  "created_on": "2018-04-10T08:13:14Z",
  "data": {
    "id": "msg_abcd5fg6hievapshljklmnop4",
    "card": {
      "id": "crd_fa6psq242dcd6fdn5gifcq1491",
      "scheme" : "mastercard",
      "metadata": {
        "reference": "X-123456-N11",
        "udf1": "metadata1",
        "udf2": "metadata2",
        "udf3": "metadata3",
        "udf4": "metadata4",
        "udf5": "metadata5"
      }
    },
    "cardholder":{
      "id": "crh_urdihafyo75evcr55s62jmwwhy"
    },
    "entity":{
      "id": "ent_urdihafyo75evcr55s62jmwwhy"
    },
    "client":{
      "id": "cli_urdihafyo75evcr55s62jmwwhy"
    },
    "initiator": "cardholder",
    "decision_source": "issuer",
    "transaction_id": "trx_y3oqhf46pyzuxjbcn2giaqnb44",
    "transaction_type": "purchase",
    "transmission_date_time": "2018-04-10T08:12:14Z",
    "local_transaction_date_time": "2018-04-10T08:12:14",
    "authorization_type": "final_authorization",
    "authorization_code": "03C0C0",
    "transaction_amount": 1000,
    "transaction_currency": "GBP",
    "billing_amount": 900,
    "billing_currency": "EUR",
    "billing_conversion_rate": 0.925643,
    "ecb_conversion_rate": 0.9,
    "digital_card_information": {             
      "digital_card_id": "dcr_fa6psq242dcd6fdn5gifcq1491",
      "device_type": "phone",                 
      "wallet_type": "apple_pay"              
    },
    "acquirer": {
      "id": "748846"
    },
    "merchant": {
      "merchant_id": "59889",
      "name" : "Acme Corporation",
      "city": "Paris",
      "state": "",                            
      "country": "FRA",                   
      "category_code": "5021",
      "street_address": "Wenlock Works, Shepherdess Walk"
    },
    "transit_information": {
        "transaction_type": "authorized_aggregated_split_clearing",
        "transportation_mode": "urban_bus"
    },
    "point_of_sale_transaction_date" : "2023-04-25",
    "reference_transaction": {
        "transaction_id": "trx_fa6psq242dcd6fdn5gifcq1491",
        "reference_type": "original_recurring"
    },
    "three_d_secure": {
      "requested_exemption_or_exclusion": "merchant_initiated_transaction",
      "sca_not_required_reason": "merchant_initiated_transaction",
      "authentication_status": "authenticated"
    },
    "pos": {
      "country_code": "GBR",
      "postal_code": "SE100ER",
      "card_present": "present",
      "cardholder_present": "not_present",
      "entry_mode": "ecommerce"
    },
    "authorization_relay": {
      "result": "approved",
      "client_response": {
        "result": "server_error"
      },
      "stand_in": {
          "result": "approved"
      }
    }
  }
}
```
---

## Webhook fields

| Field name | Description |
| --- | --- |
| `id`<br>`string` | The event's unique identifier, prefixed with `evt_`. |
| `type`<br>`string` | The type of event. <br><br>This value is `authorization_approved`. |
| `version`<br>`string` | The webhook's version. |
| `created_on`<br>`date-time` | The date and time when the event occurred, in UTC. <br>Standard – ISO 8601 code <br>Example – `yyyy-mm-ddThh:mm:ss.sss` |
| `data`<br>`object` | The webhook message. <br><br>See the [Data](#Data_object) object. |

## Data object

| Field name | Description |
| --- | --- |
| `id`<br>`string` | The transaction message's unique identifier, prefixed with `msg_`. |
| `card`<br>`object` | The card details. <br><br>See the [Card](#Card_object) object. |
| `cardholder`<br>`object` | The cardholder's details. <br><br>See the [Cardholder](#Cardholder_object) object. |
| `entity`<br>`object` | The entity's details. <br><br>See the [Entity](#Entity_object) object. |
| `client`<br>`object` | Your details as a Checkout.com client. <br><br>See the [Client](#Client_object) object. |
| `initiator`<br>`string`<br>`optional` | The party who initiated the message. <br><br>This can be one of:<br><br>- `cardholder` – The cardholder initiated the message.<br>- `merchant` – The merchant initiated the message. |
| `decision_source`<br>`string`<br>`optional` | The party who made the decision to approve or decline the authorization. <br><br>This can be one of:<br><br>- `issuer` – You have authorization relay [stand-in mode](https://www.checkout.com/docs/card-issuing/manage-issuing-transactions/relay-authorization-requests.md) enabled and Checkout.com made the decision on your behalf while your server was temporarily unavailable.<br>- `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`<br>`string` | The transaction's unique identifier, which links together all related authorization, reversal, and clearing messages. This is prefixed with `trx_`. |
| `transaction_type`<br>`string` | The type of transaction. This can be one of:<br><br>- `balance_inquiry`<br>- `bill_payment`<br>- `cashback`<br>- `pin_change`<br>- `pin_unblock`<br>- `purchase`<br>- `purchase_account_inquiry`<br>- `refund`<br>- `remittance_funding`<br>- `withdrawal` |
| `transmission_date_time`<br>`date-time` | The date and time when the transaction message entered the card scheme's network, in UTC. <br>Standard – ISO 8601 code <br>Example – `yyyy-mm-ddThh:mm:ss.sss` |
| `local_transaction_date_time`<br>`string`<br>`optional` | The local date and time when the transaction was initiated. <br>Standard – ISO 8601 code <br>Format – `yyyy-mm-ddThh:mm:ss.sss` |
| `authorization_type`<br>`string` | The type of authorization we received from the card scheme. This can be one of:<br><br>- `authorization`<br>- `deferred_authorization`<br>- `final_authorization`<br>- `incremental_pre_authorization`<br>- `pre_authorization` |
| `authorization_code`<br>`string` | The authorization code we generate when we approve the transaction. |
| `transaction_amount`<br>`uint64` | The transaction amount, in the [minor currency unit](https://www.checkout.com/docs/payments/accept-payments/format-the-amount-value.md). |
| `transaction_currency`<br>`string` | The acquirer’s local currency, or the local currency of the transaction’s source location. <br>Standard – [ISO 4217 code](https://www.checkout.com/docs/developer-resources/testing/codes/currency-codes.md) <br>Example – `USD` |
| `billing_amount`<br>`uint64` | The amount you bill the cardholder for, in the [minor currency unit](https://www.checkout.com/docs/payments/accept-payments/format-the-amount-value.md).<br><br>If currency conversion is required, this is based on [Mastercard rates](https://www.mastercard.com/global/en/personal/get-support/convert-currency.html). |
| `billing_currency`<br>`string` | The currency in which you bill the cardholder. <br>Standard – [ISO 4217 code](https://www.checkout.com/docs/developer-resources/testing/codes/currency-codes.md) <br>Example – `USD` |
| `billing_conversion_rate`<br>`double` | The card scheme conversion rate used to convert the transaction amount to the billing amount. |
| `ecb_conversion_rate`<br>`double`<br>`optional` | The European Central Bank (ECB) comparative rate that is communicated to the cardholder for a currency conversion when the `transaction_currency` and `billing_currency` are different. |
| `digital_card_information`<br>`object`<br>`optional` | The digital card's details. <br><br>See the [Digital card information](#Digital_card_information_object) object. |
| `acquirer`<br>`object` | The acquirer details. <br><br>See the [Acquirer](#Acquirer_object) object. |
| `merchant`<br>`object` | The merchant's details. <br><br>See the [Merchant](#Merchant_object) object. |
| `transit_information`<br>`object`<br>`optional` | The transit transaction details. <br><br>See the [Transit information](#Transit_information_object) object. |
| `point_of_sale_transaction_date`<br>`string`<br>`optional` | The date of the transaction at the point of sale. <br>Format – `yyyy-mm-dd` |
| `reference_transaction`<br>`object`<br>`optional` | The reference transaction details. <br><br>See the [Reference transaction](#Reference_transaction_object) object. |
| `three_d_secure`<br>`object`<br>`optional` | The 3D Secure (3DS) challenge details. <br><br>See the [ThreeDSecure](#ThreeDSecure_object) object. |
| `pos`<br>`object` | The conditions at the point of sale (PoS) at the time of the transaction. <br><br>See the [POS](#POS_object) object. |
| `authorization_relay`<br>`object`<br>`optional` | The [authorization relay](https://www.checkout.com/docs/card-issuing/manage-issuing-transactions/relay-authorization-requests.md) response details. <br><br>See the [Authorization relay](#Authorization_relay_object) object. |

## Card object

| Field name | Description |
| --- | --- |
| `id`<br>`string` | The card's unique identifier, prefixed with `crd`. |
| `scheme`<br>`string` | The card scheme that processed the payment. <br><br>This can be one of:<br><br>- `mastercard`<br>- `visa` |
| `metadata`<br>`object`<br>`optional` | Your user-defined metadata details. <br><br>See the request body of the [Create a card endpoint](https://api-reference.checkout.com/tag/Cards/#operation/createCard!path=0/reference&t=request). |

## Cardholder object

| Field name | Description |
| --- | --- |
| `id`<br>`string` | The cardholder's unique identifier, prefixed with `crh_`. |

## Entity object

| Field name | Description |
| --- | --- |
| `id`<br>`string` | The entity's unique identifier, prefixed with `ent_`. |

## Client object

| Field name | Description |
| --- | --- |
| `id`<br>`string` | Your unique identifier as a Checkout.com client, prefixed with `cli_`. |

## Digital card information object

| Field name | Description |
| --- | --- |
| `digital_card_id`<br>`string` | The digital card's unique identifier, prefixed with `dcr_`. |
| `device_type`<br>`string`<br>`optional` | The type of device used for the transaction. This can be one of:<br>- `card`<br>- `device_peripheral`<br>- `domestic_appliance`<br>- `fashion_accessory`<br>- `garment`<br>- `jewelry`<br>- `key_fob`<br>- `media_or_gaming_device`<br>- `mobile_phone_case_or_sleeve`<br>- `mobile_phone_network_operator_controlled_fixed_secure_element`<br>- `mobile_phone_network_operator_controlled_removable_secure_element`<br>- `mobile_phone_not_network_operator_controlled_fixed_secure_element`<br>- `mobile_phone_not_network_operator_controlled_removable_secure_element`<br>- `mobile_phone_payment_application_host_processor`<br>- `mobile_phone_payment_application_tee_host_processor`<br>- `mobile_tag`<br>- `pc`<br>- `phone`<br>- `removable_secure_element_not_network_operator_controlled`<br>- `sticker`<br>- `tablet_or_e_book_network_operator_controlled_fixed_secure_element`<br>- `tablet_or_e_book_not_network_operator_controlled_fixed_secure_element`<br>- `tablet_or_e_reader`<br>- `tablet_or_e_reader_payment_application_host_processor`<br>- `tablet_or_e_reader_payment_application_tee_host_processor`<br>- `tablet_or_e_reader_network_operator_controlled_removable_secure_element`<br>- `tag`<br>- `vehicle`<br>- `watch_contactless_chip_or_not_network_operator_controlled_secure_element`<br>- `watch_or_wristband`<br>- `watch_payment_application_host_processor`<br>- `watch_payment_application_tee_host_processor`<br>- `wristband` |
| `wallet_type`<br>`string`<br>`optional` | The type of wallet. This can be one of:<br>- `apple_pay`<br>- `google_pay`<br>- `merchant`<br>- `samsung_pay` |

## Acquirer object

| Field name | Description |
| --- | --- |
| `id`<br>`string` | The unique identifier for the acquirer. |

## Merchant object

| Field name | Description |
| --- | --- |
| `merchant_id`<br>`string` | The merchant's unique identifier.<br><br>This may vary from one acquirer to another. |
| `name`<br>`string` | The merchant's name. |
| `city`<br>`string` | The city of the merchant's address. |
| `state`<br>`string`<br>`optional` | For US merchants, the state of the merchant's address.<br><br>For other merchants, the value is `null`. |
| `country`<br>`string` | The country of the merchant's address. <br>Standard – [ISO-3 code](https://www.checkout.com/docs/developer-resources/testing/codes/country-codes.md) <br>Example – `USA` |
| `category_code`<br>`string` | The four-digit [merchant category code (MCC)](https://www.checkout.com/docs/developer-resources/testing/codes/merchant-category-codes.md) for the transaction.<br><br>Merchants can have multiple category codes. |
| `street_address`<br>`string` | The street of the merchant's address. |

## Transit information object

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

## Reference transaction object

| Field name | Description |
| --- | --- |
| `transaction_id`<br>`string` | The reference transaction's unique identifier, prefixed with `trx`. |
| `reference_type`<br>`string` | The type of reference transaction. This can be one of:<br><br>- `original_mit` – An initial merchant-initiated transaction<br>- `original_recurring` – An initial recurring transaction |

## ThreeDSecure object

| Field name | Description |
| --- | --- |
| `requested_exemption_or_exclusion`<br>`string`<br>`optional` | The exemption or exclusion requested by the acquirer/merchant. This can be one of:<br>- `acquirer_transaction_risk_analysis`<br>- `authentication_outage_exception`<br>- `low_value_payment`<br>- `merchant_initiated_transaction`<br>- `not_requested recurring_payment`<br>- `secure_corporate_payment`<br>- `strong_customer_authentication_delegation` |
| `sca_not_required_reason`<br>`string`<br>`optional` | The exemption or exclusion used to approve an unauthenticated authorization. This can be one of:<br><br>- `acquirer_transaction_risk_analysis`<br>- `authentication_outage_exception`<br>- `issuer_secure_corporate_payment`<br>- `low_value_payment`<br>- `merchant_initiated_transaction`<br>- `mobile_order_telephone_order`<br>- `one_leg_out`<br>- `other`<br>- `recurring_payment`<br>- `secure_corporate_payment`<br>- `strong_customer_authentication_delegation`<br>- `zero_amount_asi` |
| `authentication_status`<br>`string`<br>`optional` | The outcome of the authentication process for an authorization. This can be one of:<br><br>- `authenticated` – The authorization was authenticated successfully.<br>- `authentication_attempted` – Either the issuer or cardholder did not participate in the authentication flow.<br>- `not_authenticated` – Either the authentication failed or the acquirer did not initiate authentication.<br>- `not_applicable` – Authentication was not required for this authorization. |

## POS object

| Field name | Description |
| --- | --- |
| `country_code`<br>`string` | The country where the PoS is located. <br>Standard – [ISO alpha-3 country code](https://www.checkout.com/docs/developer-resources/testing/codes/country-codes.md) <br>Example – `USA` |
| `postal_code`<br>`string` | The ZIP or postal code where the PoS is located. |
| `card_present`<br>`string` | Indicates if the card was present to initiate the transaction. This can be one of:<br><br>- `not_present`<br>- `present`<br>- `unspecified` |
| `cardholder_present`<br>`string` | Indicates if the cardholder was present to initiate the transaction. This can be one of:<br>- `not_present`<br>- `present`<br>- `unspecified` |
| `entry_mode`<br>`string` | The way the card initiated the transaction at the terminal. This can be one of:<br><br>- `contact_chip`<br>- `contactless_chip`<br>- `contactless_magstripe`<br>- `credential_on_file`<br>- `ecommerce`<br>- `magstripe`<br>- `manual`<br>- `optical_character_recognition`<br>- `optical_code`<br>- `server`<br>- `other` |

## Authorization relay object

| Field name | Description |
| --- | --- |
| `result`<br>`string` | The final authorization decision returned by the [authorization relay](https://www.checkout.com/docs/card-issuing/manage-issuing-transactions/relay-authorization-requests.md). This can be one of:<br><br>- `approved` – The authorization is approved.<br>- `declined` – The authorization is declined. In this case, you receive an [Authorization declined](https://www.checkout.com/docs/developer-resources/event-notifications/event-types/authorization_declined.md) webhook.<br>- `not_applied` – The authorization request was not relayed to you. For example, because the request was already declined. |
| `client_response`<br>`object`<br>`optional` | The authorization decision details returned by your server. |
| `client_response.result`<br>`string` | Your authorization decision. This can be one of:<br><br>- `approved` – You approved the authorization.<br>- `declined` – You declined the authorization.<br>- `invalid_response` – Your response to the authorization request was invalid.<br>- `server_error` – Your server encountered an error.<br>- `timeout` – You did not provide a decision within the timeout limit.<br>- `unauthorized` – The authorization request could not be authenticated.<br><br>If you have stand-in mode enabled for this entity, it is triggered if `result` is `server_error` or `timeout`. |
| `stand_in`<br>`object`<br>`optional` | The authorization decision details returned by [stand-in mode](https://www.checkout.com/docs/card-issuing/manage-issuing-transactions/relay-authorization-requests.md), if enabled. |
| `stand_in.result`<br>`string` | The authorization decision returned by stand-in mode. This can be one of:<br>- `approved` – Stand-in mode approved the authorization.<br>- `declined` – Stand-in mode declined the authorization.<br>- `not_applied` – Stand-in mode was not triggered. |