Skip to main content
GET
https://apis.hopnow.io
/
v1
/
accounts
/
{account_id}
/
payouts
List Payouts
curl --request GET \
  --url https://apis.hopnow.io/v1/accounts/{account_id}/payouts \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "object": "<string>",
      "beneficiary": {},
      "payout_destination": {},
      "amount": "<string>",
      "currency": "<string>",
      "status": "<string>",
      "initiated_at": "<string>",
      "created": "<string>"
    }
  ],
  "page": 123,
  "size": 123,
  "total": 123,
  "pages": 123
}

​
Path Parameters

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

​
Query Parameters

​
status
string
Filter by payout status (e.g., pending, processing, completed, failed)
​
currency
string
Filter by ISO 4217 currency code (e.g., USD, EUR, GBP)
​
start_date
string
Filter payouts created on or after this date (ISO 8601 format)
​
end_date
string
Filter payouts created before this date (ISO 8601 format)
​
page
integer
default:"1"
Page number (minimum 1)
​
size
integer
default:"10"
Items per page (1-100)

​
Response

​
items
array
Array of payout objects with nested beneficiary and destination details
​
page
integer
Current page number
​
size
integer
Items per page
​
total
integer
Total number of items
​
pages
integer
Total number of pages

​
Response Example

{
  "items": [
    {
      "id": "pout_1234567890abcdef",
      "object": "payout",
      "beneficiary": {
        "id": "ben_1234567890abcdef",
        "object": "beneficiary",
        "first_name": "John",
        "last_name": "Doe",
        "display_name": "John Doe",
        "status": "active"
      },
      "payout_destination": {
        "id": "dest_1234567890abcdef",
        "object": "payout_destination",
        "country": "US",
        "type": "bank_account",
        "currency": "USD",
        "status": "active"
      },
      "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"
    }
  ],
  "page": 1,
  "size": 10,
  "total": 1,
  "pages": 1
}