List Payouts
curl --request GET \
--url https://api.hopnow.io/v1/accounts/{account_id}/payouts \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hopnow.io/v1/accounts/{account_id}/payouts"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hopnow.io/v1/accounts/{account_id}/payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hopnow.io/v1/accounts/{account_id}/payouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hopnow.io/v1/accounts/{account_id}/payouts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hopnow.io/v1/accounts/{account_id}/payouts")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/v1/accounts/{account_id}/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
}Payouts
List Payouts
Retrieve a paginated list of outgoing payments
GET
/
v1
/
accounts
/
{account_id}
/
payouts
List Payouts
curl --request GET \
--url https://api.hopnow.io/v1/accounts/{account_id}/payouts \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hopnow.io/v1/accounts/{account_id}/payouts"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hopnow.io/v1/accounts/{account_id}/payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hopnow.io/v1/accounts/{account_id}/payouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hopnow.io/v1/accounts/{account_id}/payouts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hopnow.io/v1/accounts/{account_id}/payouts")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/v1/accounts/{account_id}/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
string
required
The account’s external ID (starts with
acc_)Query Parameters
string
Filter by payout status (e.g.,
pending, processing, completed, failed)string
Filter by ISO 4217 currency code (e.g., USD, EUR, GBP)
string
Filter payouts created on or after this date (ISO 8601 format)
string
Filter payouts created before this date (ISO 8601 format)
integer
default:"1"
Page number (minimum 1)
integer
default:"10"
Items per page (1-100)
Response
array
Array of payout objects with nested beneficiary and destination details
integer
Current page number
integer
Items per page
integer
Total number of items
integer
Total number of pages
Response Example
{
"items": [
{
"id": "po_r4ft5s7cuvimpoloqd8gwksw",
"object": "payout",
"beneficiary": {
"id": "bene_9gt1ummgx127biovlurm9mq2",
"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
}
⌘I