Webhook Guide

Notification Events

Complete catalog of 40+ notification events — customer, card lifecycle, transaction, delivery, and balance events.

Complete reference of all notification events grouped by category with supported channels and template variables.

Customer Events

Event Type	Trigger	Channels	Template Variables
`CUSTOMER_ONBOARDING`	New customer created	SMS, Email	`{name}`, `{mobile}`, `{product_name}`
`GPR_ONBOARDING`	GPR customer onboarded	SMS, Email	`{name}`, `{mobile}`, `{card_number}`, `{product_name}`
`DIY_VKYC_APPLICATION`	DIY VKYC application submitted	SMS, Email, Push	`{name}`, `{application_ref}`
`DIY_APPROVAL`	DIY application approved	SMS, Email, Push	`{name}`, `{application_ref}`
`DIY_REJECTION`	DIY application rejected	SMS, Email, Push	`{name}`, `{application_ref}`, `{error_reason}`

Event Type	Trigger	Channels	Template Variables
`LOGIN_OTP`	OTP generated for login	SMS	`{name}`, `{mobile}`
`OTP_FOR_ACTION`	OTP for secure action	SMS	`{name}`, `{mobile}`

Card Lifecycle Events

Event Type	Trigger	Channels	Variables
`PRE_CARD_ACTIVATION`	Card ready for activation	SMS, Push	`{name}`, `{card_number}`, `{kit}`
`CARD_ACTIVATION`	Card activated	SMS, Email, Push	`{name}`, `{card_number}`, `{kit}`, `{expiry}`
`POST_CARD_ACTIVATION`	Post-activation follow-up	Email, Push	`{name}`, `{card_number}`, `{product_name}`
`NTB_PICKUP_CARD_ACTIVATION`	New-to-bank pickup activation	SMS, Push	`{name}`, `{kit}`
`ETB_PICKUP_CARD_ACTIVATION`	Existing-to-bank pickup activation	SMS, Push	`{name}`, `{kit}`
`CARD_ACTIVATION_LINK_EXPIRY`	Activation link expired	SMS, Email	`{name}`, `{card_number}`
`HANDOVER_ACTIVATION`	Card handed over & activated	SMS	`{name}`, `{kit}`

Event Type	Trigger	Channels	Variables
`CARD_LOCK`	Temporarily locked	SMS, Push	`{name}`, `{card_number}`, `{date_time}`
`CARD_UNLOCK`	Unlocked	SMS, Push	`{name}`, `{card_number}`, `{date_time}`
`CARD_TEMP_BLOCK`	Temporarily blocked	SMS, Push	`{name}`, `{card_number}`
`CARD_TEMP_UNBLOCK`	Temporarily unblocked	SMS, Push	`{name}`, `{card_number}`
`CARD_BLOCK`	Permanently blocked	SMS, Email, Push	`{name}`, `{card_number}`, `{date_time}`
`POST_CARD_LOCKED`	Follow-up after lock	Email	`{name}`, `{card_number}`
`CARD_CLOSURE`	Card closed	SMS, Email	`{name}`, `{card_number}`, `{balance_amount}`

Event Type	Trigger	Channels	Variables
`PRE_CARD_EXPIRY`	N days before expiry	SMS, Email, Push	`{name}`, `{card_number}`, `{expiry}`
`CARD_EXPIRY`	Card expired	SMS, Email	`{name}`, `{card_number}`, `{expiry}`
`POST_CARD_EXPIRY`	Post-expiry follow-up	Email	`{name}`, `{card_number}`

Event Type	Trigger	Channels	Variables
`CARD_REPLACEMENT`	Card replaced	SMS, Email	`{name}`, `{card_number}`, `{kit}`
`PIN_CHANGE`	PIN changed successfully	SMS	`{name}`, `{card_number}`, `{date_time}`
`CHANGE_PIN`	PIN change initiated	SMS	`{name}`, `{card_number}`

Event Type	Trigger	Channels	Variables
`CARD_USAGE_SETTINGS`	Usage settings modified	SMS, Push	`{name}`, `{card_number}`
`USAGE_SETTINGS_ENABLED`	Channel enabled	Push	`{name}`, `{card_number}`, `{mode}`
`USAGE_SETTINGS_DISABLED`	Channel disabled	Push	`{name}`, `{card_number}`, `{mode}`
`CARD_INACTIVE_DUE_TO_INACTIVITY`	Dormancy inactivation	SMS, Email	`{name}`, `{card_number}`
`ACCOUNT_DORMANCY_ALERT`	Dormancy warning	SMS, Email	`{name}`, `{card_number}`

Transaction Events

Event Type	Trigger	Channels	Variables
`TRANSACTION_SUCCESS`	Any successful transaction	SMS, Push	`{amount}`, `{balance_amount}`, `{card_number}`, `{merchant}`, `{date_time}`, `{currency_code}`, `{rrn}`
`CARD_TXN_SUCCESS`	POS/ECOM success	SMS, Push	`{amount}`, `{balance_amount}`, `{card_number}`, `{merchant}`, `{mode}`, `{date_time}`
`ATM_WITHDRAWAL_SUCCESS`	ATM withdrawal success	SMS	`{amount}`, `{balance_amount}`, `{card_number}`, `{date_time}`, `{fees}`
`CARD_LOAD`	Card/wallet loaded	SMS, Push	`{amount}`, `{balance_amount}`, `{card_number}`, `{date_time}`
`LOAD`	Load transaction	SMS	`{amount}`, `{balance_amount}`, `{card_number}`
`RELOAD`	Reload transaction	SMS	`{amount}`, `{balance_amount}`, `{card_number}`

Event Type	Trigger	Channels	Variables
`TRANSACTION_FAILURE`	Transaction failed	SMS, Push	`{amount}`, `{card_number}`, `{merchant}`, `{error_reason}`, `{date_time}`
`CARD_TXN_DECLINE`	POS/ECOM/ATM decline	SMS, Push	`{amount}`, `{card_number}`, `{merchant}`, `{error_reason}`, `{mode}`
`ATM_WITHDRAWAL_FAILURE`	ATM withdrawal failure	SMS	`{amount}`, `{card_number}`, `{error_reason}`, `{date_time}`
`INVALID_TRANSACTION`	Invalid transaction attempt	SMS	`{amount}`, `{card_number}`, `{error_reason}`

Event Type	Trigger	Channels	Variables
`TRANSACTION_REVERSED`	Transaction reversed	SMS, Push	`{amount}`, `{balance_amount}`, `{card_number}`, `{rrn}`, `{date_time}`

Event Type	Trigger	Channels	Variables
`ATM_BALANCE_INQUIRY`	ATM balance check	SMS	`{balance_amount}`, `{card_number}`, `{date_time}`
`BALANCE_INQUIRY`	Balance inquiry	—	`{balance_amount}`, `{card_number}`

Delivery Events

Event Type	Trigger	Channels	Variables
`DISPATCH_NOTIFICATION`	Card dispatched from warehouse	SMS, Push	`{name}`, `{kit}`, `{card_type}`
`DELIVERY_NOTIFICATION`	Card delivered to customer	SMS, Push	`{name}`, `{kit}`
`RTO_NOTIFICATION`	Card returned to origin	SMS, Email	`{name}`, `{kit}`
`HANDOVER_NOTIFICATION`	Card handed over at branch	SMS	`{name}`, `{kit}`
`CARD_PICKUP`	Card ready for pickup	SMS, Push	`{name}`, `{kit}`

Event Subscriptions

Configure webhook event subscriptions — CRUD APIs for registering, updating, and managing event callbacks.

Webhook Integration

Webhook payload formats, retry policy, signature verification, and security requirements.

On this page

Customer Events

Card Lifecycle Events

Transaction Events

Delivery Events