Skip to main content
PATCH
https://apis.hopnow.io
/
v1
/
accounts
/
{account_id}
/
beneficiaries
/
{beneficiary_id}
Update Beneficiary
curl --request PATCH \
  --url https://apis.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "beneficiary_type": "<string>",
  "title": "<string>",
  "first_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "display_name": "<string>",
  "company_name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "address": {},
  "tax_id": "<string>",
  "country_code": "<string>",
  "note": "<string>"
}
'

​
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_)

​
Request Body

All fields are optional. Only include fields you want to update.
​
beneficiary_type
string
Type of beneficiary: individual or business
​
title
string
Title (e.g., Mr, Ms, Dr)
​
first_name
string
First name
​
middle_name
string
Middle name
​
last_name
string
Last name
​
display_name
string
Display name
​
company_name
string
Company name
​
email
string
Email address
​
phone
string
Phone number
​
address
object
Beneficiary address
​
tax_id
string
Tax identification number
​
country_code
string
Payout country code
​
note
string
Internal notes or comments

​
Response

Returns the updated beneficiary object with same structure as Create Beneficiary response.

​
Response Example

{
  "id": "ben_1234567890abcdef",
  "object": "beneficiary",
  "account_id": "acc_1234567890abcdef",
  "beneficiary_type": "individual",
  "title": null,
  "first_name": "John",
  "middle_name": null,
  "last_name": "Smith",
  "display_name": "John Smith",
  "company_name": null,
  "email": "[email protected]",
  "phone": "+1987654321",
  "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": "active",
  "verified": true,
  "payout_destinations": [],
  "created": "2024-01-15T10:00:00Z",
  "updated": "2024-01-16T10:00:00Z"
}