List Payments
curl --request GET \
--url https://api.hopnow.io/ads/v1/accounts/{account_id}/payments \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hopnow.io/ads/v1/accounts/{account_id}/payments"
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/ads/v1/accounts/{account_id}/payments', 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/ads/v1/accounts/{account_id}/payments",
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/ads/v1/accounts/{account_id}/payments"
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/ads/v1/accounts/{account_id}/payments")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/ads/v1/accounts/{account_id}/payments")
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": [
{
"object": "payment",
"id": "apo_5tg9m9p4q1w8e5r3t6y0u2i4",
"type": "payment",
"note": null,
"reference": "Invoice 42",
"payment_purpose": "supplier_or_vendor_payment",
"beneficiary_id": "bene_2aq7c1e6a2b4f3c9b8d2e5a1",
"beneficiary_name": "Globex Ltd",
"source_account": "USD Ops ....7821",
"destination_account": "USD ....7823",
"currency": "USD",
"amount": "1000.00",
"platform_fee_amount": "25.00",
"total_debit_amount": "1025.00",
"receipt": {
"recipient_amount": "1000.00",
"platform_fee": "25.00",
"total_debit": "1025.00"
},
"status": "pending_review",
"submitted_at": "2026-05-30T09:00:00Z",
"reviewed_at": null,
"settled_at": null,
"failed_at": null,
"transfer_at": null,
"scheduled_dispatched_at": null,
"created": "2026-05-30T09:00:00Z",
"updated": null,
"created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
"updated_by": null
}
],
"page": 1,
"size": 10,
"total": 1,
"pages": 1
}
Payments
List Payments
Retrieve a paginated list of payments for an account
GET
/
ads
/
v1
/
accounts
/
{account_id}
/
payments
List Payments
curl --request GET \
--url https://api.hopnow.io/ads/v1/accounts/{account_id}/payments \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hopnow.io/ads/v1/accounts/{account_id}/payments"
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/ads/v1/accounts/{account_id}/payments', 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/ads/v1/accounts/{account_id}/payments",
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/ads/v1/accounts/{account_id}/payments"
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/ads/v1/accounts/{account_id}/payments")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/ads/v1/accounts/{account_id}/payments")
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": [
{
"object": "payment",
"id": "apo_5tg9m9p4q1w8e5r3t6y0u2i4",
"type": "payment",
"note": null,
"reference": "Invoice 42",
"payment_purpose": "supplier_or_vendor_payment",
"beneficiary_id": "bene_2aq7c1e6a2b4f3c9b8d2e5a1",
"beneficiary_name": "Globex Ltd",
"source_account": "USD Ops ....7821",
"destination_account": "USD ....7823",
"currency": "USD",
"amount": "1000.00",
"platform_fee_amount": "25.00",
"total_debit_amount": "1025.00",
"receipt": {
"recipient_amount": "1000.00",
"platform_fee": "25.00",
"total_debit": "1025.00"
},
"status": "pending_review",
"submitted_at": "2026-05-30T09:00:00Z",
"reviewed_at": null,
"settled_at": null,
"failed_at": null,
"transfer_at": null,
"scheduled_dispatched_at": null,
"created": "2026-05-30T09:00:00Z",
"updated": null,
"created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
"updated_by": null
}
],
"page": 1,
"size": 10,
"total": 1,
"pages": 1
}
Returns a paginated list of payments for the account, ordered newest first.
Path Parameters
string
required
Id of the account (
acct_…).Query Parameters
int
default:"1"
Page number, ≥ 1. Default 1.
int
default:"10"
Items per page, 1–100. Default 10.
string | null
Filter by source virtual account id (
va_…).string | null
Filter by payment id (
apo_…).string | null
Filter by beneficiary id (
bene_…).string | null
Filter by payment destination id (
dest_…).enum | null
Filter by payment status:
pending_review, pending, processing, settled, failed, rejected, returned.enum | null
Filter by payment currency.
datetime | null
Include payments created at or after this timestamp (inclusive).
datetime | null
Include payments created before this timestamp (exclusive).
Response
Returns a paginated list of payment summaries — a flatter shape than the detail object, without the nestedpayment and beneficiary blocks.
object[]
The payments on this page.
Show payment attributes
Show payment attributes
string
Always
payment.string
Payment id (
apo_…).string
Always
payment.string | null
Private note for your platform, from create.
string | null
Bank-visible memo (SWIFT MT103 Field 70).
enum | null
PaymentPurpose value from create.string
Beneficiary id (
bene_…).string
Beneficiary display name.
string
Masked source virtual-account label.
string
Masked destination account label.
enum
Payment currency.
decimal
Recipient amount in the destination currency.
decimal
Add-on platform fee (default 0).
decimal
amount + platform_fee_amount — the total debited from the source virtual account.object | null
enum
PaymentStatus: pending_review, pending, processing, settled, failed, rejected, returned.datetime
When the payment order was created.
datetime | null
When the payment was reviewed, if applicable.
datetime | null
When the payment settled, if applicable.
datetime | null
When the payment failed, if applicable.
datetime | null
Requested dispatch time, if scheduled.
datetime | null
When the scheduled payment was actually dispatched.
datetime
When the payment was created.
datetime | null
When the payment was last updated.
string
Actor that created the payment.
string | null
Actor that last updated the payment.
integer
Current page number.
integer
Items per page.
integer
Total number of items.
integer
Total number of pages.
{
"items": [
{
"object": "payment",
"id": "apo_5tg9m9p4q1w8e5r3t6y0u2i4",
"type": "payment",
"note": null,
"reference": "Invoice 42",
"payment_purpose": "supplier_or_vendor_payment",
"beneficiary_id": "bene_2aq7c1e6a2b4f3c9b8d2e5a1",
"beneficiary_name": "Globex Ltd",
"source_account": "USD Ops ....7821",
"destination_account": "USD ....7823",
"currency": "USD",
"amount": "1000.00",
"platform_fee_amount": "25.00",
"total_debit_amount": "1025.00",
"receipt": {
"recipient_amount": "1000.00",
"platform_fee": "25.00",
"total_debit": "1025.00"
},
"status": "pending_review",
"submitted_at": "2026-05-30T09:00:00Z",
"reviewed_at": null,
"settled_at": null,
"failed_at": null,
"transfer_at": null,
"scheduled_dispatched_at": null,
"created": "2026-05-30T09:00:00Z",
"updated": null,
"created_by": "ak_x7k2m9p4q1w8e5r3t6y0u2i4",
"updated_by": null
}
],
"page": 1,
"size": 10,
"total": 1,
"pages": 1
}
⌘I