/
/2
DocsSign in
Sign in
  • APIs
  • Generators
  • Stacks
  • Projects
  • Docs
  • History
  • Schema
Checked 4w ago · Updated 4w ago
  • getGet All Accounts
  • postCreate Virtual Account used as Collection Tool
  • postDeactivate Virtual Account
  • post[Sandbox Only] Add Test Balance
  • getGet Account by ID
  • getGet Account Balance
  • getGet Account Statement
  • postCreate Payment Token
  • getStatus check API with payment_token
  • getGet All Sub-Accounts
  • putUpdate Sub Account
  • postSub Account Onboarding API
  • getGet Sub Account By ID
  • postUPI QR & Intent String
  • postBatch Refund API
  • getRequery Batch Refund
  • getGet All Beneficiaries
  • postCreate Bank Account Beneficiary
  • getGet Beneficiary by ID
  • postUpdate Beneficiary
  • deleteDelete Beneficiary
  • getGet All Transfers
  • postCreate Transfer - Account Beneficiary
  • postCreate Bulk Transfer
  • getGet Bulk Transfer by ID
  • getGet Transfer by ID
  • postPAN Verification
  • postName Verification - PAN vs Account Verification
  • postBank Account Verification
  • postBank Account Verification Pennyless
  • postVPA (UPI ID) Verification
  • getGet All Webhook Events
  • getBank IFSC
  • getBusiness Categories
  • getBusiness Types
  • getState Codes

Delete Beneficiary

Use this API to delete a beneficiary.

delete/v1/accounts/beneficiaries/{beneficiary_id}

Path parameters

beneficiary_idstring required

Unique identifier of the beneficiary that should be deleted.<br><br>Example: vab_EFQeD9s8dPOqsPEUZPELmpgwm

Response

200

idstring
objectstring
deletedboolean
account_idstring
deleted_atinteger

Example response

{
  "id": "vab_faleWdxW8dRoTmzk1g1lSiFcD",
  "object": "beneficiary",
  "deleted": true,
  "account_id": "va_Q6USeYXbx38cKa3NbBpoHDViW",
  "deleted_at": 1645696208
}