Skip to main content
GET
Get Beneficiary
Returns one beneficiary belonging to the account, together with its payout destinations. Requires an API key with read access on the payments scope.

Path Parameters

string
required
The account’s external ID (starts with acct_)
string
required
The beneficiary’s external ID (starts with bene_)

Response

string
Beneficiary identifier (starts with bene_)
string
Always returns "beneficiary"
string
Parent account external ID
string
Beneficiary type: individual or business
string
Title, or null
string
First name, or null
string
Middle name, or null
string
Last name, or null
string
Display name
string
Company name, or null
string
Email address, or null
string
Phone number, or null
object
Beneficiary address
string
Payout country code
string
Beneficiary status: active or disabled
boolean
Whether Hop has verified the beneficiary’s details. Verification is a Hop operation with no client step, and it does not gate payouts today.
boolean
Whether the beneficiary is the account holder’s own bank account at another institution. Only a self-owned beneficiary can be paid from the trading account (a withdrawal); third-party beneficiaries are paid from a virtual account (a payout). See Create Payout.
array
The beneficiary’s payout destinations, each with the same shape as the payout-destination object. disabled and pending destinations are included; deleted ones are not.
string
ISO 8601 timestamp when created
string
ISO 8601 timestamp when last updated
string
ID of the API key that created the beneficiary (starts with ak_)
string
Actor that last updated the beneficiary, or null

Errors

Response Example