SelectwinSelectwin

Lê o rastro bruto de interação de uma sessão (evento a evento)

GET/v1/checkouts/sessions/{sessionId}/events

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

Parâmetros do caminho

  • sessionIdstringobrigatório

    Identificador público (sess_/ckts_/ses_…)

Parâmetros de consulta

  • limitinteger

    Número máximo de eventos devolvidos.

  • afterSeqinteger

Respostas

200Sucesso
  • idstringobrigatório

    Identificador público (sess_/ckts_/ses_…)

  • dataobject[]obrigatório

    Os eventos, em ordem de sequência.

    +6 campos de data
    • seqintegerobrigatório

      Número de sequência do evento na sessão (o cursor de paginação).

    • stepintegerobrigatóriopode ser nulo

      Passo do funil em que o evento aconteceu; null quando não está ligado a um passo.

    • typestringobrigatório

      Tipo do evento (ex.: step.enter, field.error, payment.submit).

    • payloadobjectobrigatóriopode ser nulo

      Detalhes do evento — só forma e tempo, nunca o que o comprador digitou.

    • occurredAtstringobrigatório

      Quando aconteceu (relógio do comprador).

    • receivedAtstringobrigatório

      Quando foi recebido (relógio do servidor).

  • totalintegerobrigatório

    Número total de eventos da sessão.

  • objectstringobrigatório

    Sempre list.

    Valores:list
  • hasMorebooleanobrigatório

    true quando há eventos depois do último devolvido (pagine com afterSeq).

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
404Não encontrado
  • 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

Preferências de cookies

Hoje o site usa só cookies essenciais: nenhuma ferramenta de medição ou de anúncios está ligada, e nada é compartilhado com terceiros. Se isso mudar, você decide aqui antes de qualquer coisa ser carregada.

  • Mantêm o site funcionando: segurança, a sua escolha sobre cookies e preferências como a versão da documentação. Não dependem de consentimento.

    Sempre ativos