Manage Beneficiary

Listed below are the various actions available to manage beneficiaries.

• Update Beneficiary: Update a beneficiary’s details such as name, email address, and phone number.
• Delete Beneficiary: Delete the beneficiary. Once deleted, the beneficiary cannot be restored.

Update Beneficiary

After adding a beneficiary, account holders can update the beneficiary’s details such as:

• Name
• Email
• Phone number

📘

Cannot Update Account Information

It is not possible to update a beneficiary's:

• Account number
• IFSC,
• VPA handle (UPI ID)

In such scenarios, you can delete the beneficiary with the incorrect details and create a new beneficiary.

Use the below endpoint to update the details of a beneficiary.

POST: https://api.zwitch.io/v1/accounts/beneficiaries/{beneficiary_id}.

Below is a sample request and response for the Update Beneficiary API.

{
  "name_of_account_holder": "Anil Reddy",
  "email": "[email protected]",
  "phone": "9876543210",
  "metadata": {
    "key_1": "updated_DD",
    "key_2": "updated_XOF"
  }
}

{
  "id": "vab_cXjVBV6x1KdjPQHlNWlyAsiOq",
  "object": "beneficiary",
  "type": "account_number",
  "name_of_account_holder": "Anil Reddy",
  "email": "[email protected]",
  "phone": "9876543210",
  "bank_account_number": "12345678901212",
  "bank_ifsc_code": "HDFC0000123",
  "bank_name": "hdfc",
  "vpa": null,
  "metadata": {
    "key_1": "updated_DD",
    "key_2": "updated_XOF"
  },
  "created_at": 1656068124,
  "is_sandbox": false,
  "account_id": "va_0S2gghUY2wZqayy4Mw95M8zzQ"
}

Learn more about the Update Beneficiary API.

Delete Beneficiary

Account holders can delete a beneficiary. Use the below endpoint to delete the beneficiary.

📘

Permanent Action

Once deleted, the beneficiary cannot be restored.

DELETE: https://api.zwitch.io/v1/accounts/beneficiaries/{beneficiary_id}

Below is a sample response for the Delete Beneficiary API.

{
  "id": "vab_U7x5hbvMxVkAwCrIMiejkBEkL",
  "object": "beneficiary",
  "deleted": true,
  "account_id": "va_0S2gghUY2wZqayy4Mw95M8zzQ",
  "deleted_at": 1656327491
}

Learn more about the Delete Beneficiary API.