API reference
Pagination
Every list returns the same object. Follow nextCursor until hasMore is false.
Lists
Response
{
"object": "list",
"data": [ ... ],
"hasMore": true,
"nextCursor": "MjAyNi0wOS0yM1QxMDo0MjowMC4wMDBafGludl8xMDQ4"
}- Results are newest first.
- limit is 1–100 (default 50). Out-of-range values return 400 with field: limit.
- Pass nextCursor back unchanged as cursor. Cursors are opaque; a modified cursor returns 400.
- Invoices filter by status, chain, reference, createdAfter, createdBefore and metadata[key]=value. Events filter by type and dates.
- Clients pinned to 2026-09-16 receive some lists as bare arrays; see the changelog.
const response = await fetch(`${process.env.BOSPAY_API_BASE}/invoices?status=paid&metadata[orderId]=1048&limit=20`, {
method: "GET",
headers: {
"Content-Type": "application/json",
"BOSPay-Version": "2026-09-23",
"X-API-Key": process.env.BOSPAY_API_KEY,
}
});
if (!response.ok) {
throw new Error(`BOSPay request failed: ${response.status}`);
}
const data = await response.json();