Skip to main content
GET
Listar sessões

Authorizations

X-Client-Id
string
header
required
X-Api-Key
string
header
required

Query Parameters

page
integer
default:1

Número da página a ser listada (mínimo 1)

Required range: x >= 1
limit
integer
default:10

Quantidade de registros por página (padrão 10; máximo 100)

Required range: 1 <= x <= 100
order
enum<string>
default:desc

Aceito como asc ou desc (padrão desc; valores inválidos caem para desc). A listagem atual ordena sempre por createdAt decrescente.

Available options:
asc,
desc
id
string<uuid>

Filtra pelo identificador da sessão

status
enum<string>

Filtra por status da sessão. Aceita múltiplos valores separados por vírgula

Available options:
created,
paid,
canceled,
voided
isActive
enum<string>

Filtra sessões ativadas ou desativadas. Aceita múltiplos valores separados por vírgula (true e/ou false)

Available options:
true,
false
merchantId
string<uuid>

Filtra pelo identificador do merchant

orderId
string

Filtra pelo identificador do pedido. Se informado, deve ter no mínimo 2 caracteres Unicode após o trim

Minimum string length: 2
multiplePayments.status
enum<string>

Filtra pela disponibilidade agregada do link (multiplePayments.status). Aceita múltiplos valores separados por vírgula. disabled cobre links temporariamente indisponíveis, incluindo expiração por dueDate.

Available options:
active,
disabled,
canceled
created.gt
string<date-time>

Filtra sessões com createdAt estritamente maior que o instante informado (RFC 3339 ou RFC 3339 com fração de segundos)

created.lt
string<date-time>

Filtra sessões com createdAt estritamente menor que o instante informado (RFC 3339 ou RFC 3339 com fração de segundos)

Response

Success

items
object[]
meta
object