Acompanhar uma cobrança

Devolve o estado atual de uma cobrança criada no checkout. É a rota que a página de pagamento consulta enquanto espera.

GEThttps://api.navenaut.com/checkout/charges/{chargeRef}

Autenticação

Rota pública: não exige credencial. A ausência é declarada, não omissão.

Esta rota não exige autenticação. Ela é chamada pelo comprador, que não tem sessão: a identidade do vendedor vem da referência do produto, nunca do chamador.

Parâmetros

Caminho

Nome	Tipo	Descrição
`chargeRef`obrigatório	texto	A referência da cobrança, devolvida na criação.

Respostas

200 · sucesso

{
  "currency": "BRL",
  "expiresAt": "exemplo",
  "installment": {
    "count": 2,
    "installmentCents": 129900
  },
  "method": "pix",
  "payable": {
    "emv": "exemplo",
    "kind": "pix",
    "qrImageUrl": "https://loja.exemplo.com.br/webhooks"
  },
  "priceCents": 129900,
  "ref": "referencia-de-exemplo"
}

404 · não encontrado

A referência não existe.

410 · recurso expirado

A cobrança expirou e não pode mais ser paga.

Erros desta rota

Status	Código	Quando	O que fazer
404	`CHECKOUT_CHARGE_NOT_FOUND`	A `chargeRef` não existe nesta instalação. Ou nunca foi cunhada, ou está transcrita com um caractere a mais.	Confira a referência que a criação da cobrança devolveu. Repetir não muda o resultado.
410	`CHECKOUT_CHARGE_GONE`	A cobrança existiu e o prazo de pagamento dela fechou. Ela não pode mais ser paga, e o 410 é o que separa isso de uma referência inexistente.	Crie uma cobrança nova para o mesmo produto. Repetir a consulta devolve sempre 410, e a cobrança expirada não volta.

Os códigos são estáveis e fazem parte do contrato. A lista completa, com todos os vocabulários, está na tabela de erros.