Get Payment Destination

curl --request GET \
  --url https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payment-destinations/{id} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payment-destinations/{id}"

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/{beneficiary_id}/payment-destinations/{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/ads/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payment-destinations/{id}",
  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/{beneficiary_id}/payment-destinations/{id}"

	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/{beneficiary_id}/payment-destinations/{id}")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payment-destinations/{id}")

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

{
  "object": "payment_destination",
  "id": "dest_8kpw2x7a3b9c1e5f2d4g6h8j",
  "beneficiary_id": "bene_5tql9z7a3b9c1e5f2d4g6h8j",
  "country": "GB",
  "payment_method": "wire",
  "type": "bank_account",
  "label": "Globex GBP",
  "currency": "GBP",
  "status": "active",
  "account_name": "Globex Limited",
  "payment_methods": ["wire"],
  "account_number_last4": "****6819",
  "clabe_last4": null,
  "iban_masked": "GB29****6819",
  "pix_key_masked": null,
  "is_default": true,
  "created": "2026-05-01T10:05:00Z",
  "updated": null,
  "created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
  "updated_by": null
}

GET

ads

accounts

{account_id}

beneficiaries

{beneficiary_id}

payment-destinations

{id}

Get Payment Destination

curl --request GET \
  --url https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payment-destinations/{id} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payment-destinations/{id}"

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/{beneficiary_id}/payment-destinations/{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/ads/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payment-destinations/{id}",
  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/{beneficiary_id}/payment-destinations/{id}"

	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/{beneficiary_id}/payment-destinations/{id}")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hopnow.io/ads/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payment-destinations/{id}")

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

{
  "object": "payment_destination",
  "id": "dest_8kpw2x7a3b9c1e5f2d4g6h8j",
  "beneficiary_id": "bene_5tql9z7a3b9c1e5f2d4g6h8j",
  "country": "GB",
  "payment_method": "wire",
  "type": "bank_account",
  "label": "Globex GBP",
  "currency": "GBP",
  "status": "active",
  "account_name": "Globex Limited",
  "payment_methods": ["wire"],
  "account_number_last4": "****6819",
  "clabe_last4": null,
  "iban_masked": "GB29****6819",
  "pix_key_masked": null,
  "is_default": true,
  "created": "2026-05-01T10:05:00Z",
  "updated": null,
  "created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
  "updated_by": null
}

Fetches a single payment destination with masked account fields. No request body.

Path Parameters

string

required

Id of the parent account (e.g. acct_...).

string

required

Id of the parent beneficiary (e.g. bene_...).

string

required

Destination id (e.g. dest_…).

Response

Returns the full payment_destination object. Account identifiers are always masked.

string

Destination id (e.g. dest_…).

string

Parent beneficiary id.

enum

Always bank_account.

enum

active, pending, or disabled.

enum | null

Primary payment method: wire, ach, fedwire, spei, pix, manual.

array

All supported payment methods (defaults to []).

string | null

Masked account number, e.g. ****7890.

string | null

Masked CLABE (Mexico).

string | null

Masked IBAN, e.g. GB29****6819.

string | null

Masked PIX key (Brazil).

boolean

Whether this is the beneficiary’s default destination.

The response also echoes country, currency, label, account_name, swift_code, routing_number, bank_name, bank_address, the correspondent-bank fields, account_holder, and the standard envelope fields (object, created, updated, created_by, updated_by).

{
  "object": "payment_destination",
  "id": "dest_8kpw2x7a3b9c1e5f2d4g6h8j",
  "beneficiary_id": "bene_5tql9z7a3b9c1e5f2d4g6h8j",
  "country": "GB",
  "payment_method": "wire",
  "type": "bank_account",
  "label": "Globex GBP",
  "currency": "GBP",
  "status": "active",
  "account_name": "Globex Limited",
  "payment_methods": ["wire"],
  "account_number_last4": "****6819",
  "clabe_last4": null,
  "iban_masked": "GB29****6819",
  "pix_key_masked": null,
  "is_default": true,
  "created": "2026-05-01T10:05:00Z",
  "updated": null,
  "created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
  "updated_by": null
}

List Payment Destinations Update Payment Destination

Getting Started

Integration Flows

Webhooks

Endpoints

Get Payment Destination

Path Parameters

Response

​Path Parameters

​Response

Path Parameters

Response