Skip to main content

List Checkouts

Merchant route confirmed. Check applicability.

Object and complete fields · Authentication, amounts and errors · Integration guide

GET /v1/checkouts

Lists the current merchant's sessions in descending creation-time order, then descending ID for equal creation times. Multiple filters apply together.

Attributes​

AttributeLocationTypeRequiredDescription
order_idquerystringNoExact merchant order reference; may return multiple Checkouts
statusquerystringNoopen, processing, succeeded, failed
has_exceptionquerybooleanNotrue selects sessions with funds exceptions, false those without; omitted means either
created_fromquerystringNoInclusive creation-time lower bound
created_toquerystringNoExclusive creation-time upper bound
page_sizequeryintegerNoItems per page; default 20, range 1–100
page_tokenquerystringNoPrevious page's next_page_token; omit on the first page

Request example​

GET /v1/checkouts?order_id=ORDER_001&status=succeeded&page_size=20
Authorization: Bearer inv_test_...

Response example​

200 OK. Each item in data is a complete Checkout without payment details.

{
"data": [
{
"id": "checkout_example",
"amount": "10",
"currency": "usdc",
"transaction_speed": "low",
"status": "succeeded",
"failure_reason": null,
"exception_status": null,
"order_id": "ORDER_001",
"description": "Order payment",
"metadata": {},
"url": "https://pay.example.com/c/checkout_example",
"return_url": "https://merchant.example.com/orders/ORDER_001",
"expires_at": "2026-10-28T08:30:00Z",
"created_at": "2026-10-28T08:00:00Z",
"updated_at": "2026-10-28T08:02:00Z"
}
],
"next_page_token": ""
}

Business error codes