List Beneficiaries
curl --request GET \
--url https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries', 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/ads/v1/accounts/{account_id}/beneficiaries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"object": "beneficiary",
"id": "bene_9f2c1d7e8a4bx0y1z2a3b4c5",
"account_id": "acct_4d8e2a1b9c3fx0y1z2a3b4c5",
"beneficiary_type": "business",
"title": null,
"first_name": null,
"middle_name": null,
"last_name": null,
"display_name": "Globex Ltd",
"company_name": "Globex Limited",
"email": "ap@globex.example",
"phone": null,
"address": {
"address_line": "5 King St",
"city": "London",
"region": "London",
"postal_code": "EC2V 8AS",
"country": "GB"
},
"country_code": "GB",
"status": "active",
"verified": true,
"payment_destinations": [
{
"object": "payment_destination",
"id": "dest_7a3b9c1e5f2dx0y1z2a3b4c5",
"beneficiary_id": "bene_9f2c1d7e8a4bx0y1z2a3b4c5",
"type": "bank_account",
"country": "GB",
"currency": "GBP",
"label": "Globex GBP",
"status": "active",
"payment_method": "wire",
"account_number_last4": "****6819",
"clabe_last4": null,
"iban_masked": "GB29****6819",
"pix_key_masked": null,
"is_default": true,
"created": "2026-06-10T10:00:00Z",
"updated": null
}
],
"created": "2026-06-10T09:15:00Z",
"updated": "2026-06-10T10:00:00Z",
"created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
"updated_by": null
}
],
"page": 1,
"size": 10,
"total": 1,
"pages": 1
}
Beneficiaries
List Beneficiaries
List beneficiaries for an account with pagination and filters
GET
/
ads
/
v1
/
accounts
/
{account_id}
/
beneficiaries
List Beneficiaries
curl --request GET \
--url https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries', 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/ads/v1/accounts/{account_id}/beneficiaries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"object": "beneficiary",
"id": "bene_9f2c1d7e8a4bx0y1z2a3b4c5",
"account_id": "acct_4d8e2a1b9c3fx0y1z2a3b4c5",
"beneficiary_type": "business",
"title": null,
"first_name": null,
"middle_name": null,
"last_name": null,
"display_name": "Globex Ltd",
"company_name": "Globex Limited",
"email": "ap@globex.example",
"phone": null,
"address": {
"address_line": "5 King St",
"city": "London",
"region": "London",
"postal_code": "EC2V 8AS",
"country": "GB"
},
"country_code": "GB",
"status": "active",
"verified": true,
"payment_destinations": [
{
"object": "payment_destination",
"id": "dest_7a3b9c1e5f2dx0y1z2a3b4c5",
"beneficiary_id": "bene_9f2c1d7e8a4bx0y1z2a3b4c5",
"type": "bank_account",
"country": "GB",
"currency": "GBP",
"label": "Globex GBP",
"status": "active",
"payment_method": "wire",
"account_number_last4": "****6819",
"clabe_last4": null,
"iban_masked": "GB29****6819",
"pix_key_masked": null,
"is_default": true,
"created": "2026-06-10T10:00:00Z",
"updated": null
}
],
"created": "2026-06-10T09:15:00Z",
"updated": "2026-06-10T10:00:00Z",
"created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
"updated_by": null
}
],
"page": 1,
"size": 10,
"total": 1,
"pages": 1
}
Lists beneficiaries for an account with pagination and optional status / date filters. Disabled beneficiaries remain visible in listings. Returns a paginated list of beneficiary objects.
Each list item includes the same nested
payment_destinations returned by Get Beneficiary; the array is empty only when the beneficiary has no available payment destinations.Path Parameters
string
required
Id of the parent account (e.g.
acct_...).Query Parameters
int
default:"1"
Page number. Default 1, minimum 1.
int
default:"10"
Items per page. Default 10, range 1–100.
string[]
Filter by beneficiary status:
active, disabled. Repeat the parameter for multiple values.datetime
Filter by creation time, inclusive lower bound.
datetime
Filter by creation time, exclusive upper bound.
Response
Returns 200 with a paginated list of beneficiary objects.object[]
The beneficiary objects on this page. Each item has the same shape as Get Beneficiary, including the nested
payment_destinations array (available destinations only, with masked account fields).integer
Current page number.
integer
Items per page.
integer
Total number of items.
integer
Total number of pages.
{
"items": [
{
"object": "beneficiary",
"id": "bene_9f2c1d7e8a4bx0y1z2a3b4c5",
"account_id": "acct_4d8e2a1b9c3fx0y1z2a3b4c5",
"beneficiary_type": "business",
"title": null,
"first_name": null,
"middle_name": null,
"last_name": null,
"display_name": "Globex Ltd",
"company_name": "Globex Limited",
"email": "ap@globex.example",
"phone": null,
"address": {
"address_line": "5 King St",
"city": "London",
"region": "London",
"postal_code": "EC2V 8AS",
"country": "GB"
},
"country_code": "GB",
"status": "active",
"verified": true,
"payment_destinations": [
{
"object": "payment_destination",
"id": "dest_7a3b9c1e5f2dx0y1z2a3b4c5",
"beneficiary_id": "bene_9f2c1d7e8a4bx0y1z2a3b4c5",
"type": "bank_account",
"country": "GB",
"currency": "GBP",
"label": "Globex GBP",
"status": "active",
"payment_method": "wire",
"account_number_last4": "****6819",
"clabe_last4": null,
"iban_masked": "GB29****6819",
"pix_key_masked": null,
"is_default": true,
"created": "2026-06-10T10:00:00Z",
"updated": null
}
],
"created": "2026-06-10T09:15:00Z",
"updated": "2026-06-10T10:00:00Z",
"created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
"updated_by": null
}
],
"page": 1,
"size": 10,
"total": 1,
"pages": 1
}
⌘I