v1

latestOpenAPI 3.1.02026-07-24360204.4 KB

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
}