API Docs
Community

Sample Payloads

Below are sample payloads for the different webhook events available on ZWITCH.

Account Created

Triggered when an account is successfully created.

This event is triggered for:

  • Savings Account
  • Link Current Account
  • Virtual Account
{
  "id": "evl_4OueA8A9ZlmtcwyCA20TwDs42",
  "object": "event",
  "name": "accounts.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "va_AaKHmEo1sRZ63o6yz3vxZXgTM",
      "object": "account",
      "type": "virtual",
      "name": "Customer Two",
      "mobile_number": "9012345678",
      "account_number": "36363651312873875",
      "ifsc_code": "YESB0CMSNOC",
      "used_as": "wallet",
      "email": "[email protected]",
      "kyc": {
        "state_code": "KA",
        "city": "Bangalore",
        "postal_code": 560005,
        "pan": "XXXXXX567P",
        "business_type": "individual",
        "business_category": "auto_and_auto_ancillaries"
      },
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "bank_name": "yes_bank",
      "vpa": "zwch189362138@yesbank",
      "customer": {
        "id": "cus_1oycz5mgvxYSoxpDc8Ti6jRJY",
        "mobile_number": "9876543210"
      },
      "status": "active",
      "created_at": 1643304823,
      "is_sandbox": true
    }
  }
}

Account Updated

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

This event is triggered for:

  • Savings Account
  • Link Current Account
  • Virtual Account
{
  "id": "evl_v4jD99N9xxxm9R6ce1ixwx15a",
  "object": "event",
  "name": "accounts.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "va_SzGsoBFrKDcl5ZQCjheWWJxwS",
      "object": "account",
      "type": "virtual",
      "name": "Customer",
      "mobile_number": "9012345678",
      "account_number": "36363651196076156",
      "ifsc_code": "YESB0CMSNOC",
      "used_as": "wallet",
      "email": "[email protected]",
      "kyc": {
        "state_code": "KA",
        "city": "Bangalore",
        "postal_code": 560005,
        "pan": "XXXXXX567P",
        "business_type": "individual",
        "business_category": "auto_and_auto_ancillaries"
      },
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "bank_name": "yes_bank",
      "vpa": "zwch1068661580@yesbank",
      "customer": {
        "id": "cus_1oycz5mgvxYSoxpDc8Ti6jRJY",
        "mobile_number": "9876543210"
      },
      "status": "active",
      "created_at": 1643304823,
      "is_sandbox": true
    }
  }
}

Payment Created

Triggered when a new UPI collect request is created or a direct debit is made to a virtual account VPA.

{
  "id": "evl_g4DvzKdNfVAT9Wze5wCBf7nks",
  "object": "event",
  "name": "payments.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "tx_hA31o19jEv8EhBUO2Otivo54o",
      "object": "payment",
      "account_id": "va_7xo54w8886P3P4M8VoXX7VidV",
      "amount": 1,
      "currency": "inr",
      "transacted_at": null,
      "bank_reference_number": "115119578783",
      "status": "pending",
      "remitter_bank_account_number": null,
      "remitter_bank_ifsc_code": null,
      "remitter_full_name": null,
      "remitter_note": null,
      "remitter_vpa_handle": "sunil-reddy@example",
      "paid_mode": "upi",
      "paid_to": "zwch1979013864@yesbank",
      "transaction_reference_id": null,
      "remark": "Lego Death Star",
      "merchant_reference_id": "1000174",
      "expiry_in_minutes": 10,
      "mandate_id": null,
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "is_sandbox": true,
      "link": null,
      "created_at": 1648109938
    }
  }
}

Payment Updated

Triggered whenever a payment changes state.

{
  "id": "evl_g4DvzKdNfVAT9Wze5wCBf7nks",
  "object": "event",
  "name": "payments.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "tx_hA31o19jEv8EhBUO2Otivo54o",
      "object": "payment",
      "account_id": "va_7xo54w8886P3P4M8VoXX7VidV",
      "amount": 1,
      "currency": "inr",
      "transacted_at": null,
      "bank_reference_number": "115119578783",
      "status": "pending",
      "remitter_bank_account_number": null,
      "remitter_bank_ifsc_code": null,
      "remitter_full_name": null,
      "remitter_note": "Lego Death Star",
      "remitter_vpa_handle": "sunil-reddy@example",
      "paid_mode": "upi",
      "paid_to": "zwch1979013864@yesbank",
      "transaction_reference_id": "f0b4c98989e0455eaba43b2148e330f5",
      "remark": "Lego Death Star",
      "merchant_reference_id": "1000174",
      "expiry_in_minutes": 10,
      "mandate_id": null,
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "is_sandbox": true,
      "link": null,
      "created_at": 1648109938
    }
  }
}

Beneficiaries Created

Triggered when a beneficiary is successfully created.

{
  "id": "evl_6q558jOvd2a1uNhnazoZVbc2r",
  "object": "event",
  "name": "beneficiaries.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "vab_JGwBn8YWiqOAaZ48WKvVMB7D4",
      "object": "beneficiary",
      "type": "account_number",
      "name_of_account_holder": "Sunfeast Allrounder",
      "email": "[email protected]",
      "phone": "9012345678",
      "bank_account_number": "1112220021734988",
      "bank_ifsc_code": "RAZR0000001",
      "bank_name": "Yes",
      "is_sandbox": true
    }
  }
}

Beneficiaries Updated

Triggered when beneficiary details are successfully updated.

{
  "id": "evl_P9rM7JQ3JMeeu5ASE6tTqqy8E",
  "object": "event",
  "name": "beneficiaries.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "vab_Ls7XYxtHnp72Yd8Hd8T3nOn69",
      "object": "beneficiary",
      "type": "vpa",
      "name_of_account_holder": "Dino Raptor ",
      "email": "[email protected]",
      "phone": "8987654098",
      "bank_name": "Yes",
      "vpa": "tset@ybl",
      "is_sandbox": true
    }
  }
}

Beneficiaries Deleted

Triggered when a beneficiary is successfully deleted.

{
  "id": "evl_S6ikGRo03El73EOMLdk2Rtr4O",
  "object": "event",
  "name": "beneficiaries.deleted",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "vab_faleWdxW8dRoTmzk1g1lSiFcD",
      "object": "beneficiary",
      "deleted": true,
      "account_id": "va_Q6USeYXbx38cKa3NbBpoHDViW",
      "deleted_at": 1645696208
    }
  }
}

Transfer Created

Triggered when a transfer is successfully created.

{
  "id": "evl_jAdqpMxOePBBoOV3bzawgdnes",
  "object": "event",
  "name": "transfers.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "tr_Rn3RKrhFwEGxBpE0HkfIZY7QD",
      "object": "transfer",
      "type": "account_number",
      "amount": 1.23,
      "debit_account_id": "va_yW3Abz9lBEFGqk5qjS6zHKn2o",
      "beneficiary_id": "vab_2sW2JGMr62oDzCeyYCswWZxpR",
      "status": "initiated",
      "currency_code": "inr",
      "payment_mode": "neft",
      "payment_remark": "test from docs",
      "paid_to": "1112220016383604",
      "metadata": "{\"order_id\":\"1\"}",
      "merchant_reference_id": "1234567A",
      "transacted_at": 1640160914,
      "created_at": 1640160914
    }
  }
}

Transfer Updated

Triggered whenever a transfer changes state.

{
  "id": "evl_h7Bo2znzQ9ewZp0mGiFJdgl0P",
  "object": "event",
  "name": "transfers.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "tr_Rn3RKrhFwEGxBpE0HkfIZY7QD",
      "object": "transfer",
      "type": "account_number",
      "amount": 1.23,
      "debit_account_id": "va_yW3Abz9lBEFGqk5qjS6zHKn2o",
      "beneficiary_id": "vab_2sW2JGMr62oDzCeyYCswWZxpR",
      "status": "success",
      "bank_reference_number": "241591114938026",
      "currency_code": "inr",
      "payment_mode": "neft",
      "payment_remark": "test from docs",
      "paid_to": "1112220016383604",
      "metadata": "{\"order_id\":\"1\"}",
      "merchant_reference_id": "1234567A",
      "transacted_at": 1640161037,
      "created_at": 1640160914
    }
  }
}

KYC Digilocker Created

Triggered when a Digilocker redirection URL is created.

{
  "id": "evl_G5RA5TbFMWYrcYTbm4ibNna60",
  "object": "event",
  "name": "kycs.digilocker.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "dgl_CpqmZxj1Osgt4CBNUWHBYFlrt",
      "object": "digilocker",
      "url": "https://api.digitallocker.gov.in/public/oauth2/1/authorize?client_id=7E5773C4&dl_flow&redirect_uri=https%3A%2F%2Fdigilocker-preproduction.signzy.tech%2Fdigilocker-auth-complete&response_type=code&state=615ad2b383e52667a11ce0f0",
      "status": "success",
      "merchant_reference_id": "1234567J",
      "is_sandbox": true
    }
  }
}

KYC Digilocker Updated

Triggered when a user completes Aadhaar verification from the Digilocker redirection URL.

{
  "id": "evl_G5RA5TbFMWYrcYTbm4ibNna60",
  "object": "event",
  "name": "kycs.digilocker.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "dgl_2aojXQPhUnC47PScSytxuck67",
      "object": "digilocker",
      "status": "success",
      "name": "As per Aadhaar redords",
      "aadhaar_number": "xxxxxxxx0418",
      "date_of_birth": "DD/MM/YYYY",
      "gender": "MALE",
      "father_name": "",
      "address": "As per aadhaar records",
      "postal_code": "683105",
      "state_code": "KL",
      "merchant_reference_id": "zwch10121090@digilocker",
      "is_sandbox": false
    }
  }
}

KYC Aadhaar Created

Triggered when the Aadhaar via OTP: Send OTP API call is successfully made.

{
  "id": "evl_VSP06rZAirDFoDDv7pka9SIS5",
  "object": "event",
  "name": "kycs.aadhaar.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "adh_blunKzeig7qWeeZJNhD7IkOlw",
      "object": "aadhaar_verification",
      "aadhaar_number": "XXXXXXXX0000",
      "name": "Anil Reddy",
      "message": "OTP sent to registered mobile number",
      "status": "success",
      "remark": "verification for account_id: sa_ydSDLrZpnCPkh67xKU5CEYAl7",
      "merchant_reference_id": "1000059",
      "created_at": 1647328648,
      "is_sandbox": true
    }
  }
}

KYC Aadhaar Updated

Triggered when the Aadhaar via OTP: Download Aadhaar Details API call is successfully made.

{
  "id": "evl_LJNvjKV5X2bpp4r9DaV9Qv68f",
  "object": "event",
  "name": "kycs.aadhaar.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "adh_blunKzeig7qWeeZJNhD7IkOlw",
      "object": "aadhaar_verification",
      "message": "Aadhaar XML file downloaded successfully",
      "status": "success",
      "name": "Anil Reddy",
      "aadhaar_number": "XXXXXXXX0000",
      "date_of_birth": "1984-02-29",
      "gender": "M",
      "father_name": "Sunil Reddy",
      "address": "3rd Floor, Tower 2, RGA Techpark",
      "postal_code": "560005",
      "state": "Karnataka",
      "state_code": "KA",
      "city": "Bangalore",
      "remark": "verification for account_id: sa_ydSDLrZpnCPkh67xKU5CEYAl7",
      "merchant_reference_id": "1000059",
      "is_sandbox": true
    }
  }
}

KYC PAN Created

Triggered when you attempt to verify PAN details.

{
  "id": "evl_IfqdZZpkdnP3QdMy1SG2h7bRN",
  "object": "event",
  "name": "kycs.pan.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "pan_B2Oa5IeCEQu6vVa5t9puRjpt9",
      "object": "pan_verification",
      "pan": "ADBPH4800P",
      "name_on_pan": "Anil Reddy",
      "status": "success",
      "merchant_reference_id": "1000062",
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "created_at": 1647329124,
      "is_sandbox": true
    }
  }
}

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.

{
  "id": "evl_UjEguGQCHshxHYAmhM11CffJm",
  "object": "event",
  "name": "accounts.schedule_kyc.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "fkyc_E0ZV4UucDBSnScomhzxblVurq",
      "object": "schedule_kyc",
      "awb_number": "1210429525",
      "time_slot": "8am_to_12pm",
      "date": "2022-06-29",
      "merchant_reference_id": "1001150",
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "status": "scheduled",
      "accounts_id": "sa_DfDxREBkBM1lLXZ7mOB0qgHV0",
      "created_at": 1656402170,
      "is_sandbox": true
    }
  }
}

Accounts Schedule KYC Updated

Triggered when the in-person KYC request:

  • Undergoes a status change.
  • Is rescheduled.

Learn more about the in-person KYC verification.

{
  "id": "evl_2OO5PE7xZo10TgOu44SwX84Sn",
  "object": "event",
  "name": "accounts.schedule_kyc.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "fkyc_E0ZV4UucDBSnScomhzxblVurq",
      "object": "schedule_kyc",
      "awb_number": "1210429525",
      "time_slot": "12pm_to_4pm",
      "date": "2022-07-01",
      "merchant_reference_id": "1001150",
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "reschedule_count": 1,
      "status": "cancelled",
      "accounts_id": "sa_DfDxREBkBM1lLXZ7mOB0qgHV0",
      "created_at": 1656402170,
      "is_sandbox": true
    }
  }
}

Verifications Bank Account Created

Triggered when the Bank Account Validation API call is successfully made.

{
  "id": "evl_EIIEsCyLKw38snt9oefLc2dNZ",
  "object": "event",
  "name": "verifications.bank_account.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "accver_X7VSZPiWtWRy1knq15ZVA8Rsg",
      "object": "bank_account_verification",
      "bank_account_number": "10000000000057",
      "bank_ifsc_code": "HDFC0000123",
      "name_as_per_bank": "Anil Reddy",
      "force_penny_drop": false,
      "force_penny_drop_amount": 1.23,
      "status": "success",
      "message": "Transaction Successful",
      "last_verified_at": "2022-03-15",
      "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
      },
      "merchant_reference_id": "1000057",
      "created_at": 1647328219,
      "is_sandbox": true
    }
  }
}

Verifications VPA Created

Triggered when the VPA Validation API call is successfully made.

{
  "id": "evl_njoH8WftZ1dq2z3Xc9Kkpr0Nk",
  "object": "event",
  "name": "verifications.vpa.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "accver_hw6MLEV8sxB17RJuuZCX41wzX",
      "object": "vpa_verification",
      "vpa": "anil.reddy@example",
      "merchant_reference_id": "1000058",
      "name_as_per_bank": "Anil Reddy",
      "status": "success",
      "message": "VPA is available for transaction",
      "created_at": 1647328226,
      "is_sandbox": true
    }
  }
}

Card Created

Triggered when a card is successfully created.

{
  "id": "evl_oOlJYkjSA99ysSYF2K0Cy6bHY",
  "object": "event",
  "name": "cards.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "car_66ED4BlpUP66etzOzbYWG6ib2",
      "object": "card",
      "type": "physical",
      "account_id": "sa_sbm9lbEPJ6EhRKZH7RBCQRRFEgj0",
      "kit_id": "100000897",
      "last_4": "6141",
      "status": "issued",
      "card_category": "debit",
      "name_on_card": "Anil Reddy",
      "mobile_number": "9845002376",
      "is_sandbox": true,
      "shipping_address": {
        "type": "communication",
        "address": "221B Baker Street, Marylebone Rd,",
        "landmark": "Next to Wollaton Hall",
        "city": "Bangalore",
        "state_code": "KA",
        "postal_code": "560005"
      },
      "created_at": 1679392020,
      "is_pin_set": false
    }
  }
}

Card Updated

Triggered when a card undergoes a status change or the card API object undergoes a change.

{
  "id": "evl_oOlJYkjSA99ysSYF2K0Cy6bHY",
  "object": "event",
  "name": "cards.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "car_66ED4BlpUP66etzOzbYWG6ib2",
      "object": "card",
      "type": "physical",
      "account_id": "sa_sbm9lbEPJ6EhRKZH7RBCQRRFEgj0",
      "kit_id": "100000897",
      "last_4": "6141",
      "status": "active",
      "card_category": "debit",
      "name_on_card": "Anil Reddy",
      "mobile_number": "9845002376",
      "is_sandbox": true,
      "shipping_address": {
        "type": "communication",
        "address": "221B Baker Street, Marylebone Rd,",
        "landmark": "Next to Wollaton Hall",
        "city": "Bangalore",
        "state_code": "KA",
        "postal_code": "560005"
      },
      "created_at": 1679392020,
      "is_pin_set": false
    }
  }
}

Card PIN Set Updated

Triggered when the cardholder sets a PIN for their card.

{
  "id": "evl_MjqykIOpQZ1XxeuBDUwFdF6E1",
  "object": "event",
  "name": "cards.pin_set.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "pin_9JKW0993Z7HRmIHABuIwyVrB5",
      "object": "card_pin_set",
      "status": "success",
      "pin": "RxSIqW2oxOlxS6WDdcdbH9ft5HrmhiUVjn08v/voImdkKwGvrhE/wljsCXluKuTSTB20xKpocSbBEnqPTqgNPmFXATM9yAdWTRfdPLl+R5Q3qfSRv07iAL/aEMGj0DjqZTu1jn+JpA2k7n7hu7peQ5tqFKssP/ukJ5lJJI/sOldDAB0/ZCISkSoxczh4fZWqG7c13EOe0tY83Vgx07YRUfSmk4S3PBq+ljhW8LIc64V7i8fk+rTufcqKdrV/itx22dUMDmdKkuMkBtelH6tY3bJP6qCJQZOY1jDLilVf+LIhtTyDSA8bk2h60cy/8gDfNcYI3vUAf3r0G1bMDT+COw==",
      "pin_token_id": "pt_I5it0Xx4Sxdbc4fdGUNTGxsWU"
    }
  }
}

Card Preferences Updated

Triggered when the card preferences are changed.

{
  "id": "evl_5zCzppud1mE550M52uT7rCmFH",
  "object": "event",
  "name": "cards.preferences.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "crdpf_1N9YbnAu01LXxVLYfQl0zpimE",
      "object": "card_preference",
      "card_id": "car_rYHPZ6SJDAvSCekteluZ44sGS",
      "type": "physical",
      "account_id": "sa_DUsH5ydlmpMD9GewOihUrKfa9",
      "kit_id": "6660765432",
      "status": "active",
      "last_4": "9743",
      "preferences": {
        "transaction_modes": {
          "contactless": false,
          "atm": true,
          "pos": true,
          "ecom": true,
          "international": false
        },
        "limit_config": [
          {
            "txn_type": "atm",
            "max_amount": 1000
          },
          {
            "txn_type": "ecom",
            "max_amount": 1000
          },
          {
            "txn_type": "pos",
            "max_amount": 1000
          }
        ]
      },
      "is_sandbox": true,
      "created_at": 1652795520
    }
  }
}