Consultar sessão de checkout
Sessão de checkout para integração servidor a servidor. Com o checkout do comprador liberado, checkout_available é true e checkout_url é o link da página Mainum para onde você envia o comprador: ele informa só o e-mail e paga por Pix. Enquanto o checkout do comprador não estiver liberado, ou depois que a sessão expirar, checkout_available é false e checkout_url é null. OPEN indica apenas uma sessão ainda não expirada, nunca pagamento confirmado: confirme pelo evento charge.paid (metadata.checkout_session_id) ou consultando a cobrança, nunca pelo redirecionamento. Não envie sua chave de API ao navegador. A criação não reserva saldo/estoque nem congela tarifa financeira; preços e limites da conta são validados quando o comprador inicia o Pix. Operações de loja ainda não são aceitas.
Cabeçalhos
Bearer seguido da sua chave: gw_test_ em teste, gw_live_ em produção.
Parâmetros de caminho
Resposta 200
Sessão da própria conta, mesmo se expirada.
Identificador da sessão. Não é credencial de acesso do comprador.
Estado da validade da sessão; não é estado de pagamento.
4 campos
Pares chave-valor seus, até 20 chaves e 2 KB. Gravados uma vez na criação e devolvidos em toda consulta e webhook. Não guarde dados pessoais aqui.
Loja cuja identidade a página de pagamento mostra, ou null.
true quando checkout_url pode ser enviado ao comprador.
Link da página de pagamento Mainum desta sessão; null enquanto indisponível ou após expirar. Trate como segredo do pedido: envie só ao comprador.
Códigos de resposta
| HTTP | Quando acontece |
|---|---|
| 200 | Sessão da própria conta, mesmo se expirada. |
| 400 | Requisição ou cursor inválido |
| 401 | Chave ausente, inválida ou sem o escopo exigido |
| 404 | Recurso não encontrado para o estabelecimento autenticado |
| 429 | Limite de requisições excedido |
| 503 | Serviço temporariamente indisponível |
Cada código de erro está explicado em Erros.