curl "https://checkout.noxpay.io/v2/crossramp_checkouts?limit=20&offset=0" \
-H "api-key: <key>"
import requests
response = requests.get(
"https://checkout.noxpay.io/v2/crossramp_checkouts",
headers={"api-key": "<key>"},
params={"limit": 20, "offset": 0},
)
print(response.json())
const params = new URLSearchParams({ limit: 20, offset: 0 });
const response = await fetch(
`https://checkout.noxpay.io/v2/crossramp_checkouts?${params}`,
{ headers: { "api-key": "<key>" } }
);
const data = await response.json();
{
"version": "v2",
"total": 42,
"limit": 20,
"offset": 0,
"results": []
}
Crossramp Checkout
List Checkouts
GET /v2/crossramp_checkouts — list all Crossramp Checkout sessions with optional filters.
curl "https://checkout.noxpay.io/v2/crossramp_checkouts?limit=20&offset=0" \
-H "api-key: <key>"
import requests
response = requests.get(
"https://checkout.noxpay.io/v2/crossramp_checkouts",
headers={"api-key": "<key>"},
params={"limit": 20, "offset": 0},
)
print(response.json())
const params = new URLSearchParams({ limit: 20, offset: 0 });
const response = await fetch(
`https://checkout.noxpay.io/v2/crossramp_checkouts?${params}`,
{ headers: { "api-key": "<key>" } }
);
const data = await response.json();
{
"version": "v2",
"total": 42,
"limit": 20,
"offset": 0,
"results": []
}
Query parameters
| Parameter | Type | Description |
|---|---|---|
limit | integer | Max results per page (default: 20, max: 100) |
offset | integer | Pagination offset (default: 0) |
pix_e2e | string | Filter by PIX end-to-end transaction ID |
client_tax_id | string | Filter by customer CPF or CNPJ |
date_from | string | Start date filter — RFC 3339 or YYYY-MM-DD |
date_to | string | End date filter — RFC 3339 or YYYY-MM-DD |
2026-08-20T14:22:00Z) as well as YYYY-MM-DD.
A bare
YYYY-MM-DD in date_to resolves to midnight at the start of that day, so date_to=2026-08-20 excludes everything that happened during 20 August. To cover a whole day, pass the next day, or use an explicit RFC 3339 timestamp.limit falls back to 50, and unknown parameters are ignored. None of these return an error, so validate client-side if it matters.
Results are ordered by creation time, newest first. The ordering is not configurable.
Response 200 OK
Each item in results has the same shape as the Get Checkout response. total is the match count before pagination, so you can use it to page through the full set; results is [] when nothing matches, never null.
curl "https://checkout.noxpay.io/v2/crossramp_checkouts?limit=20&offset=0" \
-H "api-key: <key>"
import requests
response = requests.get(
"https://checkout.noxpay.io/v2/crossramp_checkouts",
headers={"api-key": "<key>"},
params={"limit": 20, "offset": 0},
)
print(response.json())
const params = new URLSearchParams({ limit: 20, offset: 0 });
const response = await fetch(
`https://checkout.noxpay.io/v2/crossramp_checkouts?${params}`,
{ headers: { "api-key": "<key>" } }
);
const data = await response.json();
{
"version": "v2",
"total": 42,
"limit": 20,
"offset": 0,
"results": []
}