Skip to main content
GET
/
v1
/
accounts
/
{account_id}
/
beneficiaries
/
{beneficiary_id}
/
payout-destinations
/
{destination_id}
Get Payout Destination
curl --request GET \
  --url https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payout-destinations/{destination_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "<string>",
  "beneficiary_id": "<string>",
  "country": "<string>",
  "payout_method": "<string>",
  "type": "<string>",
  "label": "<string>",
  "currency": "<string>",
  "network": "<string>",
  "status": "<string>",
  "account_name": "<string>",
  "account_number_last4": "<string>",
  "account_type": "<string>",
  "routing_number": "<string>",
  "swift_code": "<string>",
  "iban_masked": "<string>",
  "clabe_last4": "<string>",
  "wallet_address_masked": "<string>",
  "is_default": true,
  "created": "<string>",
  "updated": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.hopnow.io/llms.txt

Use this file to discover all available pages before exploring further.

​
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 bene_)
​
destination_id
string
required
The payout destination’s external ID (starts with dest_)

​
Response

​
id
string
Payout destination identifier (starts with dest_)
​
object
string
Always returns "payout_destination"
​
beneficiary_id
string
Parent beneficiary ID
​
country
string
Country code
​
payout_method
string
Payment method: ach, wire, spei, etc.
​
type
string
Destination type: bank_account or wallet
​
label
string
User-friendly label
​
currency
string
Currency code
​
network
string
Blockchain network (for crypto destinations)
​
status
string
Status: active, disabled, or inactive
​
account_name
string
Bank account holder name
​
account_number_last4
string
Masked account number (e.g., ****6789)
​
account_type
string
Account type: checking or savings
​
routing_number
string
Bank routing number
​
swift_code
string
SWIFT/BIC code
​
iban_masked
string
Masked IBAN (for international accounts)
​
clabe_last4
string
Masked CLABE number (for Mexican accounts)
​
wallet_address_masked
string
Masked wallet address (for crypto destinations)
​
is_default
boolean
Whether this is the default destination for the beneficiary
​
created
string
ISO 8601 timestamp when created
​
updated
string
ISO 8601 timestamp when last updated

​
Response Example

{
  "id": "dest_1234567890abcdef",
  "object": "payout_destination",
  "beneficiary_id": "bene_1234567890abcdef",
  "country": "US",
  "payout_method": "ach",
  "type": "bank_account",
  "label": "Main Account",
  "currency": "USD",
  "network": null,
  "status": "active",
  "account_name": "John Doe",
  "account_number_last4": "****6789",
  "account_type": "checking",
  "routing_number": "021000021",
  "swift_code": null,
  "iban_masked": null,
  "clabe_last4": null,
  "wallet_address_masked": null,
  "is_default": true,
  "created": "2024-01-15T10:00:00Z",
  "updated": "2024-01-15T10:00:00Z"
}