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 more about our webhooks.

Available Webhook Events

The table below lists the various webhook events triggered when transferring money from a physical account.

Webhook Events	Description
transfers.created	Triggered when Create Transfer API call is successfully made.
transfers.updated	Triggered when: The transfer undergoes a status change An invalid OTP is entered against the transfer The transfer fails.

Sample Payload

Transfers Created

Triggered when Create Transfer API call is successfully made.

{
  "id": "evl_DlfFSrd76B30y0pebxAvGiatT",
  "object": "event",
  "name": "transfers.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "tr_PMXrJy7xKcFW97xx1z8QigcLo",
      "object": "transfer",
      "type": "account_number",
      "amount": 3.69,
      "debit_account_id": "sa_WWAHxveQ4TXAEs2dxRSbeDh9V",
      "beneficiary_id": "sab_eKiCE1tH8GVAkmzbTUzOLNqqg",
      "status": "otp_required",
      "currency_code": "inr",
      "message": "OTP verification is pending",
      "payment_mode": "neft",
      "payment_remark": "Lego Death Star",
      "paid_to": "10000000001642",
      "otp_attempts": 0,
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "merchant_reference_id": "1002358",
      "transacted_at": 1663585262,
      "is_sandbox": true,
      "created_at": 1663585262
    }
  }
}

Transfers Updated

Triggered when:

The transfer undergoes a status change
An invalid OTP is entered against the transfer
The transfer fails.

{
  "id": "evl_EO05HMw47dE5ZrdYvnhjcDkSt",
  "object": "event",
  "name": "transfers.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "tr_PMXrJy7xKcFW97xx1z8QigcLo",
      "object": "transfer",
      "type": "account_number",
      "amount": 3.69,
      "debit_account_id": "sa_WWAHxveQ4TXAEs2dxRSbeDh9V",
      "beneficiary_id": "sab_eKiCE1tH8GVAkmzbTUzOLNqqg",
      "status": "success",
      "bank_reference_number": "STCB220221051342",
      "currency_code": "inr",
      "message": "success",
      "payment_mode": "neft",
      "payment_remark": "Lego Death Star",
      "paid_to": "10000000001642",
      "otp_attempts": 1,
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "merchant_reference_id": "1002358",
      "transacted_at": 1663585417,
      "is_sandbox": true,
      "created_at": 1663585262
    }
  }
}