Pular para o conteúdo principal

Consultar status da cobrança Pix

Resposta rápida: Faça GET /cob/{txid} com Bearer e mTLS; quando status for CONCLUIDA a cobrança foi liquidada — combine com webhook (recipe 06) para menos polling.

Pré-requisitos

Passo a passo

  1. Chame GET {{MODOBANK_API_BASE_HML}}/cob/{{TXID}}.
  2. Leia status (ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, etc. — confira OpenAPI).
  3. Se CONCLUIDA, leia array pix / endToEndId para conciliação.
  4. Em polling, use backoff (ex.: 2s → 5s → 15s) e pare na expiração da cob.
  5. Prefira webhook para produção (recipe 06).

Código

Fontes canônicas em snippets/:

  • snippets/curl/get-cob.sh
  • snippets/node/get-cob.mjs
  • snippets/python/get_cob.py
  • snippets/php/get-cob.php

curl

# source: snippets/curl/get-cob.sh

Node.js

// source: snippets/node/get-cob.mjs

Python

# source: snippets/python/get_cob.py

PHP

// source: snippets/php/get-cob.php

Execute o arquivo da sua stack em snippets/ após preencher placeholders.

Se der errado

SintomaCausaAção
404txid erradoConferir txid gravado na criação
Sempre ATIVAPagamento não liquidouTestar app HML / suporte

Checklist

  • GET retorna a cob criada
  • Fluxo de negócio trata CONCLUIDA
  • Não depende só de polling se webhook estiver disponível

Próximo passo

06 — Webhook de pagamento

FAQ

P: Posso confiar só no frontend dizendo que pagou?

R: Não. Sempre confirme via GET cob, webhook ou extrato Pix no PSP.