Skip to main content
GET
Get Payout Destination
Returns one payout destination of a beneficiary owned by the account. Account numbers, IBANs, PIX keys, CLABEs and wallet addresses are always returned masked. 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_)
string
required
The payout destination’s external ID (starts with dest_)

Response

string
Payout destination identifier (starts with dest_)
string
Always returns "payout_destination"
string
Parent beneficiary external ID
string
Payout country
array
Payout rails Hop derived from the destination details: crypto for a wallet, pix when a PIX key was sent, spei for a Mexican account, swift for any other bank account. Always carries at least one element.
string
Destination type: bank_account or wallet
string
Destination label, or null
string
Currency
string
Blockchain network for a wallet, null for a bank account
string
Destination status: active, pending, or disabled. A wallet stays pending until Hop reviews it, and the outcome (active or disabled) raises payout_destination.updated. Only an active destination can be paid.
string
Name on the receiving account, or null
string
Account number masked as four asterisks plus the last 4 characters, for example ****7890
string
Account type as supplied at creation. Free text, not a fixed set of values.
string
Bank routing number, or null
string
SWIFT/BIC code, or null
string
IBAN masked as the first 4 characters, four asterisks, and the last 4, for example GB29****6819
string
CLABE masked as **** plus the last 4 digits. For a Mexican destination this and account_number_last4 carry the same digits.
string
PIX key masked as **** plus the last 4 characters
string
Wallet address masked as the first 6 characters, four asterisks, and the last 4, for example 0x742d****0bEb
string
Receiving bank name, or null
object
Receiving bank address (address_line, city, region, postal_code, country), or null
string
Correspondent bank name, or null
object
Correspondent bank address, same shape as bank_address, or null
string
Correspondent bank SWIFT/BIC code, or null
string
Account holder, when it differs from account_name, or null
string
ISO 8601 timestamp when created
string
ISO 8601 timestamp when last updated
string
ID of the API key that created the destination (starts with ak_)
string
Actor that last updated the destination, or null

Errors

Response Example