Lista as sessões de checkout

GET/v1/checkouts/sessions

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros de consulta

limitinteger
Tamanho da página (itens por página).
offsetinteger
Posição do primeiro item (a partir de 0).
sortstring
Expressão de ordenação: createdAt | intentScore | abandonRiskScore | abandonedAt, prefixo "-" = decrescente (ex.: "-intentScore"). Pontuações e abandonedAt ordenam com nulos por último, desempate por createdAt decrescente. Os antigos "ascending"/"descending" ordenam por createdAt.
daterangeum de
Criados neste dia (YYYY-MM-DD) ou neste instante.
daterangegtstring (date-time)
Criados depois deste instante (exclusivo).
daterangegtestring (date-time)
Criados a partir deste instante (inclusivo).
daterangeltstring (date-time)
Criados antes deste instante (exclusivo).
daterangeltestring (date-time)
Criados até este instante (inclusivo).
abandonedrangegtestring (date-time)
Limite inferior (inclusivo, instante ISO) de abandonedAt
abandonedrangeltestring (date-time)
Limite superior (inclusivo, instante ISO) de abandonedAt
idstring
Só esta sessão.
statusstring
Só sessões com este status.
Valores:activecompletedcancelledabandonedexpired
sourcestring
Só sessões desta origem.

Respostas

200Sucesso

dataobject[]obrigatório
Os itens desta página.
+14 campos de data
- idstringobrigatório
  Identificador público (sess_/ckts_/ses_…)
- objectstringobrigatório
  Sempre checkout.session.
  Valores:checkout.session
- onlinebooleanobrigatório
  Se o comprador está no checkout agora.
- sourcestringobrigatóriopode ser nulo
  De onde a sessão veio; null quando desconhecido.
- statusstringobrigatório
  active (o comprador está no checkout), completed (pago), cancelled, abandoned ou expired.
  Valores:activecompletedcancelledabandonedexpired
- createdAtstringobrigatório
  Quando o recurso foi criado (ISO 8601, UTC).
- updatedAtstringobrigatório
  Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).
- abandonedAtstringobrigatóriopode ser nulo
  Quando o carrinho foi abandonado; null quando não foi.
- completedAtstringobrigatóriopode ser nulo
  Quando a sessão foi paga; null até lá.
- intentScoreintegerobrigatóriopode ser nulo
  Quão perto o comprador está de pagar (0–100), pelo último sinal; null sem sinais.
- totalAmountintegerobrigatóriopode ser nulo
  Total do carrinho, em centavos; null quando nunca foi precificado.
- transactionIdstringobrigatóriopode ser nulo
  A cobrança que concluiu a sessão; null até lá.
- automationScoreintegerobrigatóriopode ser nulo
  Indício de robô/automação (0–100), pelo último sinal; null sem sinais.
- abandonRiskScoreintegerobrigatóriopode ser nulo
  Quão provável é a sessão se perder (0–100), pelo último sinal; null sem sinais.
pageobjectobrigatório
Cursores de paginação da lista.
+3 campos de page
- totalintegerobrigatório
  Número total de páginas.
- offsetobjectobrigatório
  O offset para pedir a primeira, a anterior, a próxima e a última página.
  +4 campos de offset
  - lastintegerobrigatório
    Posição da última página.
  - nextintegerobrigatório
    Posição da próxima página (fica nesta quando ela é a última).
  - previntegerobrigatório
    Posição da página anterior (0 na primeira).
  - firstintegerobrigatório
    Posição da primeira página.
- currentintegerobrigatório
  Número da página atual (a primeira é 1).
limitintegerobrigatório
Tamanho da página, como pedido.
totalintegerobrigatório
Número total de itens que atendem aos filtros.
offsetintegerobrigatório
Posição do primeiro item desta página, como pedido.
hasMorebooleanobrigatório
true quando há mais itens depois desta página.

400Requisição inválida (validação)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorArquiva uma carteira de recebimento PróximaCria uma sessão de checkout

{ "data": [ { "id": "sess_0a1b2c3d4e5f60718293", "object": "checkout.session", "online": true, "source": "string", "status": "active", "createdAt": "string", "updatedAt": "string", "abandonedAt": "string", "completedAt": "string", "intentScore": 0, "totalAmount": 5000, "transactionId": "string", "automationScore": 0, "abandonRiskScore": 0 } ], "page": { "total": 5000, "offset": { "last": 0, "next": 0, "prev": 0, "first": 0 }, "current": 0 }, "limit": 0, "total": 5000, "offset": 0, "hasMore": true }