Skip to main content
POST
https://apis.hopnow.io
/
v1
/
accounts
/
{account_id}
/
beneficiaries
/
{beneficiary_id}
/
disable
Disable Beneficiary
curl --request POST \
  --url https://apis.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/disable \
  --header 'Authorization: Bearer <token>'

​
Path Parameters

​
account_id
string
required
The account’s external ID (starts with acc_)
​
beneficiary_id
string
required
The beneficiary’s external ID (starts with ben_)

​
Response

Returns the beneficiary object with updated status.

​
Response Example

{
  "id": "ben_1234567890abcdef",
  "object": "beneficiary",
  "account_id": "acc_1234567890abcdef",
  "beneficiary_type": "individual",
  "title": null,
  "first_name": "John",
  "middle_name": null,
  "last_name": "Doe",
  "display_name": "John Doe",
  "company_name": null,
  "email": "[email protected]",
  "phone": "+1234567890",
  "address": {
    "address_line": "123 Main St",
    "city": "New York",
    "region": "NY",
    "postal_code": "10001",
    "country": "US"
  },
  "tax_id": "123-45-6789",
  "country_code": "US",
  "note": null,
  "status": "disabled",
  "verified": true,
  "payout_destinations": [],
  "created": "2024-01-15T10:00:00Z",
  "updated": "2024-01-16T10:00:00Z"
}