# Client-Side Events

Track user interactions and payment flow events in real-time using client-side event listeners. These events help you monitor the checkout journey and implement custom analytics or user experience enhancements.

| Event Name  | Payload  | Description  |
|  --- | --- | --- |
| `checkout.rendered`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string"
}
```
 | Fired when checkout page initially loads after consent check
 |
| `checkout.bank_redirection`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string"
}
```
 | Fired when user is redirected to bank for authentication
 |
| `checkout.closed`
 | null
 | Fired when user closes/exits the checkout
 |
| `consent.screen_shown`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string"
}
```
 | Fired when consent screen is mounted and displayed
 |
| `consent.accepted`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string"
}
```
 | Fired when user accepts consent and clicks continue
 |
| `consent.rejected`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string"
}
```
 | Fired when user clicks deny button on consent screen
 |
| `bank.list_viewed`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string"
}
```
 | Fired when bank selection screen is mounted
 |
| `bank.bank_selected`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string",
  "preSelected": "Yes" | "No"
}
```
 | Fired when user selects a bank or bank is pre-selected
 |
| `bank_account.account_details_screen`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string",
  "preFilled": "Yes" | "No" | "Partial"
}
```
 | Fired when enter/verify bank account details screen is mounted
 |
| `bank_account.entry_submitted`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string",
  "preFilled": "Yes" | "No" | "Partial"
}
```
 | Fired when user submits bank account details form
 |
| `bank.document_upload`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string"
}
```
 | Fired when document upload screen is mounted
 |
| `bank.document_uploaded`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string"
}
```
 | Fired when document is successfully uploaded
 |
| `otp.bank_auth.screen_shown`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string"
}
```
 | Fired when OTP verification screen is mounted
 |
| `otp.bank_auth.submit_clicked`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string"
}
```
 | Fired when user submits OTP for verification
 |
| `otp.bank_auth.failed`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string"
}
```
 | Fired when OTP verification API returns failure
 |
| `payment.success`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string",
  "paymentId": "string",
  "signature": "string",
  "status": "string"
}
```
 | Fired when payment is successfully initiated
 |
| `payment.failure`
 | 
```json
{
  "orderId": "string",
  "mode": "string",
  "resourceType": "string",
  "merchantName": "string",
  "merchantEmail": "string",
  "customerId": "string",
  "paymentMethod": "LRS",
  "repeatUser": boolean,
  "bankName": "string",
  "paymentId": "string",
  "signature": "string",
  "status": "string",
  "error": {
    "errorCode": "string",
    "errorMessage": "string"
  }
}
```
 | Fired when payment initiation fails
 |