> For the complete documentation index, see [llms.txt](https://docs.hyperswitch.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperswitch.io/integration-guide/payment-experience/readme-1/custom-events-1.md).

# Custom Events

### Listen to Expiry Date event

This event is triggered when the expiry date changes. Merchants can listen to this event and implement checks and validations based on the received value.\\

```javascript
// CheckoutForm.js
window.addEventListener("message", (ev) => {
    // Collecting Expiry Date
    if (ev.data.expiryDate) {
      console.log("Expiry date => ", ev.data.expiryDate);
    }
  });
```

### Listen to Payment Method event

Merchants can listen to the Payment Method Info event to receive real-time updates when a customer selects or changes their payment method. This event provides essential details about the selected payment method, allowing merchants to implement custom checks, validations, or UI updates based on the received data.

For card payments, the event will include additional details such as:

* **Card Brand**: The card network, e.g., **Visa, Mastercard,** etc.

```javascript
// CheckoutForm.js
window.addEventListener("message", (ev) => {
    // Collecting Expiry Date
    if (ev.data.expiryDate) {
      console.log("Expiry date => ", ev.data.expiryDate);
    }
  });
```

## Subscription Events

Subscription events provide real-time updates from the SDK about the state of the selected payment method and checkout experience. Merchants can subscribe to specific events and react to changes during the checkout flow.

### surchargeInfo

The `surchargeInfo` event is emitted whenever surcharge information is calculated or updated for a card payment method, including both saved cards and newly entered card details.

#### Event Output

```
{
  "eventName": "surchargeInfo",
  "payload": {
    "surcharge": {
      "type": "fixed",
      "value": 162
    },
    "taxOnSurcharge": null,
    "displaySurchargeAmount": 1.62,
    "displayTaxOnSurchargeAmount": 0,
    "displayTotalSurchargeAmount": 1.62
  }
}
```

The surcharge details are available under the payload property.

#### Payload Fields

| **Field**                   | **Description**                                |
| --------------------------- | ---------------------------------------------- |
| surcharge.type              | Type of surcharge applied (`fixed` or `rate`). |
| surcharge.value             | Surcharge value in the lowest currency unit.   |
| taxOnSurcharge              | Tax applied on the surcharge, if applicable.   |
| displaySurchargeAmount      | Formatted surcharge amount.                    |
| displayTaxOnSurchargeAmount | Formatted tax amount on surcharge.             |
| displayTotalSurchargeAmount | Total surcharge amount including tax.          |

#### JavaScript & React Integration

To receive surcharge updates, include `"surchargeInfo"` in the `subscriptionEvents` configuration when creating the payment element. Refer to [React](/integration-guide/payment-experience/pay-then-vault/web/react-with-rest-api-integration.md) and [Js](/integration-guide/payment-experience/pay-then-vault/web/js-with-rest-api-integration.md) integration documentation for implementation details.<br>

Js Integration

```js
const unifiedCheckoutOptions = {
    ...
    subscriptionEvents: ["surchargeInfo"],
    ...
  };

const unifiedCheckout = widgets.create("payment", unifiedCheckoutOptions);

unifiedCheckout.mount("#unified-checkout");

unifiedCheckout.on("surchargeInfo", (event) => {
    console.log("surchargeInfo is", event);
  });
```

\
React Integration

```js
// react integration
export const paymentElementOptions = {
  ...
  subscriptionEvents: [
     "surchargeInfo",
   ],
  
  ...
};

...


<PaymentElement
  id="payment-element"
  onChange={(event) => {
    if (event?.eventName === "surchargeInfo") {
      console.log("PaymentElement changed:", event);
    }
  }}
  options={paymentElementOptions}
/>      

```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.hyperswitch.io/integration-guide/payment-experience/readme-1/custom-events-1.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.