Webhook Events

Learn about the different webhooks triggered when making a transfer from a physical account using ZWITCH APIs.

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 executing a create transfer API.

Webhook EventsDescription
transfers.createdTriggered when Create Transfer API call is successfully made.
transfers.updatedTriggered when the transfer undergoes a status change.

Sample Payload

Transfers Created

Triggered when Create Transfer API call is successfully made.

{
  "id": "evl_TxH4GEyWsXo0SU5ghi73lbSt5",
  "object": "event",
  "name": "transfers.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "tr_2X0E2345mkGD0QDNdAer7fZSt",
      "object": "transfer",
      "type": "account_number",
      "amount": 3.69,
      "debit_account_id": "va_NB6MHERYZRWuOEq3zB5qhnH7k",
      "beneficiary_id": "vab_z2O7HI3l7BY1w71SCzUJOAjZv",
      "status": "initiated",
      "currency_code": "inr",
      "payment_mode": "neft",
      "payment_remark": "Lego Death Star",
      "paid_to": "10000000002238",
      "otp_attempts": 0,
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "merchant_reference_id": "1002364",
      "transacted_at": 1663596486,
      "is_sandbox": true,
      "created_at": 1663596486
    }
  }
}

Transfers Updated

Triggered when the transfer undergoes a status change.

{
  "id": "evl_TxH4GEyWsXo0SU5ghi73lbSt5",
  "object": "event",
  "name": "transfers.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "tr_2X0E2345mkGD0QDNdAer7fZSt",
      "object": "transfer",
      "type": "account_number",
      "amount": 3.69,
      "debit_account_id": "va_NB6MHERYZRWuOEq3zB5qhnH7k",
      "beneficiary_id": "vab_z2O7HI3l7BY1w71SCzUJOAjZv",
      "status": "success",
      "currency_code": "inr",
      "payment_mode": "neft",
      "payment_remark": "Lego Death Star",
      "paid_to": "10000000002238",
      "otp_attempts": 0,
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "merchant_reference_id": "1002364",
      "transacted_at": 1663596486,
      "is_sandbox": true,
      "created_at": 1663596486
    }
  }
}