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 verifying a bank account or VPA handle.

Sample Payloads

Below are sample payloads for the different VPA Verification webhook events.

Verifications VPA Created

Triggered when the VPA Verification API call is successfully made.

{
  "id": "evl_EIIEsCyLKw38snt9oefLc2dNZ",
  "object": "event",
  "name": "verifications.vpa.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "accver_i6zRFbynIxVqbVvJOEA8ZgyOb",
      "object": "vpa_verification",
      "vpa": "anil.reddy@example",
      "merchant_reference_id": "1665404667",
      "name_as_per_bank": "Anil Reddy",
      "status": "success",
      "message": "VPA is available for transaction",
      "created_at": 1665404668,
      "is_sandbox": false,
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      }
    }
  }
}