On this page
List
List invoices with strict status and date filters, navigate forward with cursor pagination, and reconcile results without duplicate pages.
API key: Payment
Returns only invoices owned by the authenticated merchant, in the key's environment and visible projects. Results are ordered by created_at DESC, then invoice_id DESC.
Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
limit |
integer | 20 |
Page size from 1 to 100. |
cursor |
string | — | Opaque next_cursor from the previous response. |
status |
string | — | Exact snake_case status. Repeat the parameter to match any supplied status; don't send a comma-separated value. |
external_order_id |
string | — | Exact external order ID, up to 128 characters. |
project_id |
string | — | A prefixed prj_… ID visible to this Payment key. |
created_from |
Unix seconds | — | Inclusive created_at lower bound. |
created_to |
Unix seconds | — | Exclusive created_at upper bound. Must be later than created_from. |
Unknown parameters, repeated scalar parameters, duplicate statuses and invalid enum casing are rejected instead of being silently ignored.
Example
GET /v1/invoices?limit=50&status=paid&status=paid_over&created_from=1767225600 HTTP/1.1
Host: api.paymos.io
Authorization: HMAC-SHA256 pk_live_…:…
X-Request-Timestamp: 1767225660
Code examples
Each tab uses the official SDK for that language. Signing, serialization, safe retries, and typed errors are handled by the SDK.
import { Paymos } from '@paymos/sdk';
const paymos = new Paymos({
apiKey: process.env.PAYMOS_API_KEY,
apiSecret: process.env.PAYMOS_API_SECRET,
});
const page = await paymos.invoices.list({ status: ['paid', 'paid_over'], limit: 50 });
for await (const invoice of paymos.invoices.iterate({ status: ['paid'] }, 10)) {
console.log(invoice.invoiceId);
}
import os
from paymos import Paymos
paymos = Paymos(
api_key=os.environ["PAYMOS_API_KEY"],
api_secret=os.environ["PAYMOS_API_SECRET"],
)
page = paymos.invoices.list(status=["paid", "paid_over"], limit=50)
for invoice in paymos.invoices.iterate(10, status=["paid"]):
print(invoice["invoice_id"])
<?php
use Paymos\Client;
use Paymos\ClientConfig;
$paymos = new Client(new ClientConfig(
getenv('PAYMOS_API_KEY'),
getenv('PAYMOS_API_SECRET')
));
$page = $paymos->invoices()->listPage(array(
'status' => array('paid', 'paid_over'),
'limit' => 50,
));
foreach ($paymos->invoices()->iterate(array('status' => array('paid')), 10) as $invoice) {
echo $invoice['invoice_id'] . PHP_EOL;
}
package main
import (
"context"
"fmt"
"os"
paymos "github.com/Paymos-labs/go-sdk/v2"
)
func main() {
client, err := paymos.NewClient(os.Getenv("PAYMOS_API_KEY"), os.Getenv("PAYMOS_API_SECRET"))
if err != nil {
panic(err)
}
page, err := client.Invoices.List(context.Background(), paymos.InvoiceListParams{
Status: []paymos.InvoiceStatus{paymos.InvoicePaid, paymos.InvoicePaidOver},
Limit: 50,
})
if err != nil {
panic(err)
}
fmt.Println(len(page.Items), page.NextCursor)
iter := paymos.NewInvoiceIterator(client.Invoices, paymos.InvoiceListParams{
Status: []paymos.InvoiceStatus{paymos.InvoicePaid},
}, 10)
for {
invoice, ok, err := iter.Next(context.Background())
if err != nil {
panic(err)
}
if !ok {
break
}
fmt.Println(invoice.InvoiceID)
}
}
using Paymos;
using var paymos = new PaymosClient(
Environment.GetEnvironmentVariable("PAYMOS_API_KEY")!,
Environment.GetEnvironmentVariable("PAYMOS_API_SECRET")!);
var page = await paymos.Invoices.ListAsync(new InvoiceListOptions(
Status: [InvoiceStatus.Paid, InvoiceStatus.PaidOver],
Limit: 50));
await foreach (var invoice in paymos.Invoices.IterateAsync(
new InvoiceListOptions(Status: [InvoiceStatus.Paid]), maxPages: 10))
{
Console.WriteLine(invoice.InvoiceId);
}
import io.paymos.InvoiceListItem;
import io.paymos.InvoiceListOptions;
import io.paymos.InvoiceStatus;
import io.paymos.Page;
import io.paymos.PaymosClient;
import java.util.List;
PaymosClient paymos = new PaymosClient(
System.getenv("PAYMOS_API_KEY"),
System.getenv("PAYMOS_API_SECRET"));
Page<InvoiceListItem> page = paymos.invoices.list(InvoiceListOptions.builder()
.status(List.of(InvoiceStatus.PAID, InvoiceStatus.PAID_OVER))
.limit(50)
.build());
for (InvoiceListItem invoice : paymos.invoices.iterate(
InvoiceListOptions.builder().status(List.of(InvoiceStatus.PAID)).build(), 10)) {
System.out.println(invoice.invoiceId());
}
require 'paymos'
paymos = Paymos::Client.new(
api_key: ENV.fetch('PAYMOS_API_KEY'),
api_secret: ENV.fetch('PAYMOS_API_SECRET')
)
page = paymos.invoices.list(status: ['paid', 'paid_over'], limit: 50)
paymos.invoices.each(max_pages: 10, status: ['paid']) do |invoice|
puts invoice.invoice_id
end
use paymos::{InvoiceListParams, InvoiceStatus, PaymosClient};
let paymos = PaymosClient::new(
std::env::var("PAYMOS_API_KEY")?,
std::env::var("PAYMOS_API_SECRET")?,
)?;
let page = paymos
.invoices()
.list(&InvoiceListParams {
status: Some(vec![InvoiceStatus::Paid, InvoiceStatus::PaidOver]),
limit: Some(50),
..Default::default()
})
.await?;
println!("{} items, next_cursor={:?}", page.items.len(), page.next_cursor);
let mut pager = paymos.invoices().pager(
InvoiceListParams { status: Some(vec![InvoiceStatus::Paid]), ..Default::default() },
Some(10),
)?;
while let Some(invoice) = pager.next().await? {
println!("{}", invoice.invoice_id);
}
Response (200 OK)
{
"items": [
{
"invoice_id": "inv_74BPZFhr9qy9Uz2fbRkdJX",
"project_id": "prj_7gK2mR9xQ4vN8cT1bY5dL3",
"external_order_id": "order-1042",
"client_id": "customer-42",
"status": "paid",
"is_final": true,
"is_test": false,
"amount": "49.95",
"currency": "USDT",
"network": "TRC20",
"created_at": 1767225600,
"expires_at": 1767227400,
"completed_at": 1767225908
}
],
"next_cursor": "CfDJ8JvN…"
}
The list item is intentionally compact. Use Get Invoice for payments, transfers, deposit address and checkout details. The response carries Cache-Control: private, no-store.
Pagination rules
- There is no page number or
total_count: follownext_cursoruntil it isnull. - The cursor is opaque, protected against tampering and expires after 24 hours.
- It is bound to the invoices resource and the exact filters. Keep the filters unchanged between pages;
limitmay change. - A missing or final cursor is represented by
next_cursor: null. - If the cursor is invalid, expired, used on another resource or combined with different filters, restart without a cursor.
Errors
A Payout (rk_) key is rejected with 403 payment_key_required. Invalid filters return a field-level 400; an invalid cursor returns 400 pagination_cursor_invalid. A project_id outside the key's scope returns 404 without revealing whether it exists. See Error Codes.