DELETE
/
api
/
v2.1
/
beneficiary
/
{beneficiaryId}
curl --request DELETE \
  --url https://sandbox.finhub.cloud/api/v2.1/beneficiary/{beneficiaryId} \
  --header 'X-Forwarded-For: <x-forwarded-for>'

​
Delete Beneficiary

This endpoint allows customers to delete a beneficiary from their account.

​
Request Parameters

​
Path Parameters

ParameterTypeRequiredDescription
beneficiaryIdstringYesThe unique identifier of the beneficiary to delete

​
Headers

NameRequiredDescription
AuthorizationYesBearer
X-Tenant-IDYesTenant identifier

​
Response

​
200 OK

A successful deletion returns a 200 OK response with a success message.

{
  "status": "success",
  "message": "Beneficiary deleted successfully"
}

​
Error Responses

Status CodeDescription
400Bad Request - Invalid beneficiary ID format
404Not Found - Beneficiary not found
403Forbidden - Insufficient permissions to delete this beneficiary

​
Security Considerations

  • Only the owner of the beneficiary or users with appropriate permissions can delete a beneficiary
  • Deleted beneficiaries cannot be recovered; consider implementing a soft delete mechanism
  • Consider implementing a confirmation step before deletion

Headers

​
X-Forwarded-For
string
required

Forwarded client IP address

​
User-Agent
string

Client user agent information

​
X-Tenant-ID
string

Tenant identifier for multi-tenant operations

Path Parameters

​
beneficiaryId
string
required

Response

204

Beneficiary deleted successfully