Acompanhando pagamentos (polling)
A API Aberta não possui webhooks — para acompanhar vencimentos e baixas, sua aplicação consulta a API periodicamente (polling).
Detectando novas baixas
Consulte os pagamentos do período recente em intervalos regulares:
GET /pagamentos?estornado=false&dataPagamento[min]=2026-07-15
Guarde os IDs já processados e trate apenas os novos.
Detectando contas vencidas
Não existe situação "vencida" — uma conta vencida e não paga continua em_aberto ou parcial. Combine situação com vencimento:
GET /contas?situacao[]=em_aberto&situacao[]=parcial&dataVencimento[max]=2026-07-15
Use a data de ontem em dataVencimento[max] para pegar tudo que já venceu.
Detectando estornos
Pagamentos estornados permanecem na listagem com dataEstorno preenchido. Para conciliação, periodicamente reconsulte os pagamentos recentes sem o filtro estornado=false e compare com sua base.
Boas práticas de polling
- Use janelas de data (
dataPagamento[min]) para trazer só o período relevante, não a base inteira. - Percorra a paginação até
last_pageantes de considerar a sincronização completa. - Prefira intervalos razoáveis (ex.: a cada 15–60 min) em vez de consultas contínuas.
- Trate a sincronização como idempotente: processar o mesmo registro duas vezes não deve duplicar dados no seu sistema.
Está montando a primeira sincronização? Veja antes o fluxo completo de integração para entender como os recursos se conectam.
Updated about 2 hours ago
