GET
List checkout sessions

Authorizations

Authorization
string
header
default:sk_test_docs_246e232c64ccc7a001bf61ec0f2e6ab0
required

Authorization: Bearer <secret key>. Secret keys belong to your organisation, are shown once when created in the dashboard, and are scoped (see x-required-scope on each operation). Keep them on your server. Live keys are issued after your business is verified. Publishable keys (pk_) are only for @ketapay/checkout and don't work here.

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
cursor
string

The next_cursor from the previous page

external_reference
string

Only items with this external_reference

status
enum<string>

open: waiting for payment. complete: paid, escrow_id is set. expired: not paid by expires_at. cancelled: you cancelled it.

Available options:
open,
complete,
expired,
cancelled

Response

A page of checkout sessions, newest first

object
string
required
Allowed value: "list"
has_more
boolean
required
next_cursor
string | null
required

Pass as cursor to get the next page; null on the last page

data
object[]
required