Skip to main content
GET
https://apis.hopnow.io
/
v1
/
accounts
/
{account_id}
/
payouts
/
{payout_id}
Get Payout
curl --request GET \
  --url https://apis.hopnow.io/v1/accounts/{account_id}/payouts/{payout_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "<string>",
  "beneficiary": {},
  "payout_destination": {},
  "amount": "<string>",
  "currency": "<string>",
  "amount_in_usd": "<string>",
  "status": "<string>",
  "provider_reference_id": "<string>",
  "initiated_at": "<string>",
  "completed_at": "<string>",
  "failed_at": "<string>",
  "failed_reason": "<string>",
  "note": "<string>",
  "created": "<string>",
  "updated": "<string>"
}

​
Path Parameters

​
account_id
string
required
The account’s external ID (starts with acc_)
​
payout_id
string
required
The payout’s external ID (starts with pout_)

​
Response

Returns payout with nested beneficiary and destination details.
​
id
string
Payout identifier (starts with pout_)
​
object
string
Always returns "payout"
​
beneficiary
object
Beneficiary summary details
​
payout_destination
object
Payout destination summary details
​
amount
string
Payout amount (decimal)
​
currency
string
Currency code
​
amount_in_usd
string
Amount converted to USD
​
status
string
Payout status: pending, processing, completed, or failed
​
provider_reference_id
string
Provider reference ID
​
initiated_at
string
ISO 8601 timestamp when payout was initiated
​
completed_at
string
ISO 8601 timestamp when payout completed
​
failed_at
string
ISO 8601 timestamp when payout failed
​
failed_reason
string
Reason for failure
​
note
string
Optional note
​
created
string
ISO 8601 timestamp when created
​
updated
string
ISO 8601 timestamp when last updated

​
Response Example

{
  "id": "pout_1234567890abcdef",
  "object": "payout",
  "beneficiary": {
    "id": "ben_1234567890abcdef",
    "object": "beneficiary",
    "beneficiary_type": "individual",
    "first_name": "John",
    "last_name": "Doe",
    "display_name": "John Doe",
    "status": "active",
    "verified": true,
    "created": "2024-01-10T00:00:00Z"
  },
  "payout_destination": {
    "id": "dest_1234567890abcdef",
    "object": "payout_destination",
    "country": "US",
    "payout_method": "ach",
    "type": "bank_account",
    "currency": "USD",
    "status": "active",
    "account_number_last4": "7890",
    "is_default": true,
    "created": "2024-01-10T00:00:00Z"
  },
  "amount": "100.00",
  "currency": "USD",
  "amount_in_usd": "100.00",
  "status": "completed",
  "provider_reference_id": "ref_123",
  "initiated_at": "2024-01-15T10:00:00Z",
  "completed_at": "2024-01-15T10:05:00Z",
  "failed_at": null,
  "failed_reason": null,
  "note": "Monthly payment",
  "created": "2024-01-15T10:00:00Z",
  "updated": "2024-01-15T10:05:00Z"
}