Skip to main content
GET
Get Payout
Returns one payout belonging to the account, in the same flat shape Create Payout returns: the beneficiary and the destination appear as plain id strings, not nested objects. Use List Payouts when you need the expanded beneficiary and destination details, or fetch them from Get Beneficiary and Get Destination. Voided payouts are retrievable by id even though the list hides them by default. 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 payout’s external ID (starts with po_)

Response

string
Payout identifier (starts with po_)
string
Always returns "payout"
string
Account ID (starts with acct_)
string
Beneficiary ID (starts with bene_). null only on payouts Hop booked manually on your behalf.
string
Payout destination ID (starts with dest_). null only on payouts Hop booked manually on your behalf.
string
Blockchain network for a crypto payout, otherwise null
string
Blockchain transaction hash for a crypto payout, otherwise null. It appears once the payout is on chain, so it is null on a payout that has not been submitted yet.
string
Payout amount (decimal)
string
Currency code
string | null
Selected payout rail, using the lowercase values listed in Create Payout. Returned from creation onward when a rail was selected. null means no explicit selection, including on historical payouts. This field records the selection, not confirmation of the rail actually used by the provider.
string
Amount converted to USD, or null when no rate was available
object
Balance funding the payout, always present: {"type": "trading_account"} for a withdrawal, {"type": "virtual_account", "virtual_account_id": "va_…"} for a payout
object
Platform fee charged on top of amount (currency, amount), or null when none
string
Payout status, one of eight values:
  • pending: funded and queued, either awaiting Hop’s review or approved and awaiting submission
  • pending_approval: waiting for approval in your portal under an approval policy
  • processing: submitted to the provider
  • completed: the provider confirmed the payment left
  • failed: the payout could not be funded or the provider rejected it; the hold is released
  • cancelled: cancelled before submission; the hold is released
  • returned: the payment left but the receiving bank returned it
  • voided: a completed payout reversed by Hop
Transitions: pending → pending_approval | processing | completed | failed | cancelled; pending_approval → pending | cancelled; processing → completed | failed; completed → returned | voided. failed, cancelled, returned and voided are terminal.
string
SWIFT UETR (unique end-to-end transaction reference) for a wire, or null. Also available as tracking_details.uetr; this top-level field remains for compatibility.
object
Payment-network tracking identifiers, populated as they become available. The object is always present; unavailable or inapplicable identifiers are null. The same object is included in payout webhooks.
string
ISO 8601 timestamp when the payout was initiated
string
ISO 8601 timestamp when Hop sent the payment command to the provider, or null
string
ISO 8601 timestamp when the payout completed, or null
string
ISO 8601 timestamp when the payout failed, or null
string
Reason for failure, or null
string
ISO 8601 timestamp when the payout was voided, or null
string
Reason the payout was voided, or null
string
Note carried on the payout, or null
string
ISO 8601 timestamp when created
string
ISO 8601 timestamp when last updated
string
Actor that created the payout: the API key id (starts with ak_), or hop_admin for a manual payout
string
Actor that last updated the payout, or null

Errors

Request Example

Response Example