Webhook Events

All important activity on your ZWITCH account is recorded as an event. We use webhooks to notify you about important events on your account. These webhooks contain details about the event such as changes that occurred and the resources impacted by the change.

We send webhooks as HTTP POST call to a URL configured by you. Webhook payloads use the JSON format.

Learn how to set up webhooks.

Available Webhook Events

The table below lists the various webhook events triggered when creating and maintaining virtual accounts.

Webhook Event	Description
`accounts.created`	Triggered when a virtual account is successfully created.
`accounts.updated`	Triggered when a virtual account: Undergoes a status change. The account information is updated.

Sample Payloads

Accounts Created

Triggered when a virtual account is successfully created.

{
  "id": "evl_J2rLcx5jwKMkTwy2EgNKmQBhv",
  "object": "event",
  "name": "accounts.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "va_30wQnsND0KDBGqBpAzIrZAFYD",
      "object": "account.virtual",
      "type": "virtual",
      "used_as": "wallet",
      "bank_name": "yes_bank",
      "name": "Anil Reddy",
      "mobile_number": "9876543210",
      "email": "[email protected]",
      "account_number": "36363651858645026",
      "ifsc_code": "YESB0CMSNOC",
      "vpa": null,
      "additional_vpa": [],
      "whitelisted_remitters": [],
      "whitelisted_beneficiaries": [],
      "kyc": {
        "city": "Bangalore",
        "postal_code": "560010",
        "state_code": "KA",
        "pan": "XXXXXX000A",
        "business_type": "partnership",
        "business_category": "daily_wage",
        "contact_person": null,
        "pan_verification_id": "pan_ljR6vX3yDCx1hMe9i8crJWFoD"
      },
      "customer": {
        "id": "cus_OGOuL7NxzlUj27ECK6T6E0xCR",
        "mobile_number": "9876543210"
      },
      "metadata": {
        "order_id": "12345"
      },
      "status": "active",
      "created_at": 1707394369,
      "is_sandbox": true,
      "settlement_account_id": null,
      "verified_beneficiaries": [
        {
          "account_verification_id": "accver_zCOtuC1mzn66zmmRv0p2tVsJb",
          "name_match_id": "nm_zy1KQwcapQe0Ha3bwl8wlhcva"
        }
      ],
      "verified_remitters": []
    }
  }
}

Accounts Updated

Triggered when a virtual account undergoes a status change or the account information is updated.

{
  "id": "evl_lS9xQvS17TqhfoSY1A7514NZY",
  "object": "event",
  "name": "accounts.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "va_30wQnsND0KDBGqBpAzIrZAFYD",
      "object": "account.virtual",
      "type": "virtual",
      "used_as": "wallet",
      "bank_name": "yes_bank",
      "name": "Anil Reddy",
      "mobile_number": "9876543210",
      "email": "[email protected]",
      "account_number": "36363651858645026",
      "ifsc_code": "YESB0CMSNOC",
      "vpa": null,
      "additional_vpa": [],
      "whitelisted_remitters": [],
      "whitelisted_beneficiaries": [
        {
          "account_number": "012920022012",
          "ifsc_code": "HDFC0666666"
        }
      ],
      "kyc": {
        "city": "Bangalore",
        "postal_code": "560010",
        "state_code": "KA",
        "pan": "XXXXXX000A",
        "business_type": "partnership",
        "business_category": "daily_wage",
        "contact_person": null,
        "pan_verification_id": "pan_ljR6vX3yDCx1hMe9i8crJWFoD"
      },
      "customer": {
        "id": "cus_OGOuL7NxzlUj27ECK6T6E0xCR",
        "mobile_number": "9876543210"
      },
      "metadata": {
        "key_1": "DD+Cheque",
        "key_2": "MSF"
      },
      "status": "active",
      "created_at": 1707394369,
      "is_sandbox": true,
      "settlement_account_id": null,
      "verified_beneficiaries": [
        {
          "account_verification_id": "accver_zCOtuC1mzn66zmmRv0p2tVsJb",
          "name_match_id": "nm_zy1KQwcapQe0Ha3bwl8wlhcva"
        }
      ],
      "verified_remitters": []
    }
  }
}