Consultar Sessão de Checkout
Retorna todos os dados para renderizar a tela de pagamento / adesão ao plano de recorrência. Endpoint público acessível pelo navegador do pagador sem autenticação.
Este endpoint é público ([AllowAnonymous]) e não exige token Bearer de autenticação.
Contexto de Integração
Utilize este endpoint na sua página web de checkout para recuperar as informações da oferta a partir do sessionId gerado em Criar Sessão de Checkout. Os dados retornados permitem exibir o resumo da compra (valor, nome do plano e ciclo) e verificar o status (canPay: true) antes de solicitar os dados do cartão.
Parâmetros
curl --request GET \
--url 'https://api.sopague.com.br/gateway/v2/recurrences/checkout-sessions/{sessionId}'Resposta (200 OK)
{
"id": "e30c4ef1-0d32-4752-bf1c-5d15a51a8dae",
"merchantName": "Loja Exemplo Ltda",
"merchantDocument": "12345678000199",
"planId": "9fa85f64-5717-4562-b3fc-2c963f66afa6",
"planName": "Plano Premium Mensal",
"description": "Acesso ilimitado aos serviços premium",
"amount": 99.9,
"currency": "BRL",
"billingPeriod": "MONTHLY",
"billingPeriodDescription": "Mensal",
"intervalCount": 1,
"intervalUnit": "MONTH",
"trialDays": 0,
"maxInstallments": 1,
"customer": {
"id": "1a46ad42-78f0-4aaa-9831-612c1359c315",
"name": "Carlos Eduardo",
"email": "[email protected]",
"document": "12345678909",
"phone": "11987654321"
},
"allowedPaymentMethods": [
"CREDIT_CARD"
],
"canPay": true,
"status": "Pending",
"expiresOn": "2026-09-18T14:30:00Z",
"returnUrl": "https://minhaloja.com.br/assinatura/obrigado"
}Próximos Passos
- Efetuar Pagamento: Quando o cliente submeter o formulário de pagamento com os dados do cartão, envie a requisição para Pagar Sessão de Checkout.
Erros
As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.
Ver validações observadas em homologação
Requisição com corpo JSON vazio ou identificador sintético. O retorno abaixo mostra a validação realizada em homologação.
[
{
"tag": "Id",
"description": "O ID da sessão de checkout é obrigatório."
}
]Campos da resposta de erro
A tabela reúne os campos presentes nos exemplos acima. Uma resposta HTTP sem corpo não inclui esses campos.
