Update Beneficiary
curl --request PATCH \
--url https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--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>",
"self_owned": true,
"note": "<string>"
}
'import requests
url = "https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}"
payload = {
"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>",
"self_owned": True,
"note": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>',
self_owned: true,
note: '<string>'
})
};
fetch('https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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>',
'self_owned' => true,
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}"
payload := strings.NewReader("{\n \"beneficiary_type\": \"<string>\",\n \"title\": \"<string>\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {},\n \"tax_id\": \"<string>\",\n \"country_code\": \"<string>\",\n \"self_owned\": true,\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"beneficiary_type\": \"<string>\",\n \"title\": \"<string>\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {},\n \"tax_id\": \"<string>\",\n \"country_code\": \"<string>\",\n \"self_owned\": true,\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"beneficiary_type\": \"<string>\",\n \"title\": \"<string>\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {},\n \"tax_id\": \"<string>\",\n \"country_code\": \"<string>\",\n \"self_owned\": true,\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyBeneficiaries
Update Beneficiary
Update beneficiary information
PATCH
/
v1
/
accounts
/
{account_id}
/
beneficiaries
/
{beneficiary_id}
Update Beneficiary
curl --request PATCH \
--url https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--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>",
"self_owned": true,
"note": "<string>"
}
'import requests
url = "https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}"
payload = {
"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>",
"self_owned": True,
"note": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>',
self_owned: true,
note: '<string>'
})
};
fetch('https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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>',
'self_owned' => true,
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}"
payload := strings.NewReader("{\n \"beneficiary_type\": \"<string>\",\n \"title\": \"<string>\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {},\n \"tax_id\": \"<string>\",\n \"country_code\": \"<string>\",\n \"self_owned\": true,\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"beneficiary_type\": \"<string>\",\n \"title\": \"<string>\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {},\n \"tax_id\": \"<string>\",\n \"country_code\": \"<string>\",\n \"self_owned\": true,\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"beneficiary_type\": \"<string>\",\n \"title\": \"<string>\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {},\n \"tax_id\": \"<string>\",\n \"country_code\": \"<string>\",\n \"self_owned\": true,\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyPath Parameters
string
required
The account’s external ID (starts with
acct_)string
required
The beneficiary’s external ID (starts with
bene_)Request Body
All fields are optional. Only include fields you want to update.string
Type of beneficiary:
individual or businessstring
Title (e.g., Mr, Ms, Dr)
string
First name
string
Middle name
string
Last name
string
Display name
string
Company name
string
Email address
string
Phone number
object
Beneficiary address
string
Tax identification number
string
Payout country code
boolean
The beneficiary is the account holder’s own account at another institution
string
Internal notes or comments
Response
Returns the updated beneficiary object with same structure as Create Beneficiary response.Response Example
{
"id": "bene_9gt1ummgx127biovlurm9mq2",
"object": "beneficiary",
"account_id": "acct_ka44qsvpo8q3wtzuwfqf0h6u",
"beneficiary_type": "individual",
"title": null,
"first_name": "John",
"middle_name": null,
"last_name": "Smith",
"display_name": "John Smith",
"company_name": null,
"email": "john.smith@example.com",
"phone": "+1987654321",
"address": {
"address_line": "123 Main St",
"city": "New York",
"region": "NY",
"postal_code": "10001",
"country": "US"
},
"country_code": "US",
"status": "active",
"verified": true,
"payout_destinations": [],
"created": "2024-01-15T10:00:00Z",
"updated": "2024-01-16T10:00:00Z"
}