Webhook events available on ZWITCH.
The table below lists the various webhook events available on ZWITCH and gives a brief description of each.
Event | Description |
---|---|
accounts.created | Triggered when an account is successfully created or linked. This event is triggered for:
|
accounts.updated | Triggered when an account undergoes a status change or the account information is updated. This event is triggered for:
|
payments.created | Triggered when a new UPI collect request is created or a deposit is made to a virtual account VPA or account number. |
payments.updated | Triggered whenever a payment changes state. |
beneficiaries.created | Triggered when a beneficiary is successfully created. |
beneficiaries.updated | Triggered when beneficiary details are successfully updated. |
beneficiaries.deleted | Triggered when a beneficiary is successfully deleted. |
transfers.created | Triggered when a transfer is successfully created. |
transfers.updated | Triggered whenever a transfer changes state. |
kycs.digilocker.created | Triggered when a Digilocker redirection URL is created. |
kycs.digilocker.updated | Triggered when a user completes Aadhaar verification from the Digilocker redirection URL. |
kycs.aadhaar.created | Triggered when the Aadhaar via OTP: Send OTP API call is successfully made. The API can either be triggered automatically by us when during the account creation process or manually by you when verifying your customer’s Aadhaar. |
kycs.aadhaar.updated | Triggered when the Aadhaar via OTP: Download Aadhaar Details API call is successfully made. The API can either be triggered automatically by us when during the account creation process or manually by you when verifying your customer’s Aadhaar. |
kycs.pan.created | Triggered when you attempt to verify a customer's PAN details. |
accounts.schedule_kyc.created | Triggered when the Schedule KYC verification API call is successfully made. This webhook is triggered when the in-person KYC request goes to the scheduled or failed status.Learn more about the in-person KYC verification life cycle. |
accounts.schedule_kyc.updated | Triggered when the in-person KYC request:
Learn more about the in-person KYC verification life cycle. |
verifications.bank_account.created | Triggered when the Bank Account Validation API call is successfully made. |
verifications.vpa.created | Triggered when the VPA Validation API call is successfully made. |
cards.created | Triggered when a card is successfully created. |
cards.updated | Triggered when a card undergoes a status change or the card API object undergoes a change. |
cards.pin_set.updated | Triggered when the cardholder sets a PIN for their card. |
cards.preferences.updated | Triggered when the card preferences are changed. |