Infopago API Docs
Primeiros PassosQRCodes API - Cash-In
API Contas - Cash-Out
Primeiros PassosQRCodes API - Cash-In
API Contas - Cash-Out
  1. QRCodes API - Cash-In
  • Evolução da API
  • Tratamento de erros
  • Pix Automático
  • Manual API QR Codes
    • Autenticação
      • Obter token de acesso
    • Gerenciamento de cobranças para pagamento imediato
      • Criar cobrança imediata.
      • Consultar lista de cobranças imediatas.
      • Criar cobrança imediata.
      • Revisar cobrança imediata.
      • Consultar cobrança imediata.
    • Gerenciamento de cobranças com vencimento
      • Consultar lista de cobranças com vencimento.
      • Criar cobrança com vencimento.
      • Revisar cobrança com vencimento.
      • Consultar cobrança com vencimento.
    • Gerenciamento de Lotes de Cobrança com Vencimentos
      • Consultar lotes de cobranças com vencimento.
      • Criar/Alterar lote de cobranças com vencimento.
      • Utilizado para revisar cobranças específicas dentro de um lote de cobranças com vencimento.
      • Consultar um lote específico de cobranças com vencimento.
    • Configuração de locations para payloads de recorrências
      • Criar location do payload.
      • Consultar locations cadastradas.
      • Recuperar location do payload.
      • Desvincular uma recorrência de uma location.
    • Configuração de locations para payloads
      • Criar location do payload.
      • Consultar locations cadastradas.
      • Recuperar location do payload.
      • Desvincular uma cobrança de uma location.
    • Gerenciamento de Pix recebidos
      • Consultar Pix.
      • Solicitar devolução.
      • Consultar devolução.
      • Consultar Pix recebidos.
    • Gerenciamento de notificações - Webhook
      • Consultar webhooks cadastrados.
      • Cancelar o webhook Pix.
      • Exibir informações acerca do Webhook Pix.
      • Configurar o Webhook Pix.
    • Gerenciamento de recorrências
      • Consultar lista de recorrências.
      • Criar recorrência.
      • Consultar recorrência.
      • Revisar recorrência.
    • Gerenciamento de solicitações de recorrências
      • Criar solicitação de confirmação de recorrência.
      • Consultar solicitação de confirmação de recorrência.
      • Revisar solicitação de confirmação de recorrência.
    • Gerenciamento de cobranças associadas a uma recorrência
      • Criar cobrança recorrente.
      • Consultar lista de cobranças recorrentes.
      • Criar cobrança recorrente.
      • Revisar cobrança recorrente.
      • Consultar cobrança recorrente.
      • Solicitar retentativa de cobrança.
    • Gerenciamento de notificações de recorrências - Webhook
      • Cancelar o Webhook.
      • Exibir informações acerca do Webhook.
      • Configurar Webhook.
    • Gerenciamento de notificações de cobranças recorrentes - Webhook
      • Cancelar o Webhook.
      • Exibir informações acerca do Webhook.
      • Configurar Webhook.
  • Esquemas
    • WebhookPayload
      • WebhookPixBody
    • RequestBodies
      • WebhookRecBody
      • WebhookCobRBody
      • LoteCobVBody
      • LoteCobVBodyRevisado
    • Id da Transação
    • Id fim a fim da transação
    • Id da Devolução
    • Id da location
    • Id da location
    • Revisão
    • ID Recorrência
    • Data de início
    • Data de fim
    • Natureza da Devolução Solicitada
    • Natureza da Devolução
    • Natureza da Devolução
    • Webhook Solicitado
    • Solicitação de Recorrência
    • Cobrança Recorrente Revisada
    • Status do registro da cobrança.
    • Location do Payload
    • Pessoa Física
    • Pessoa Jurídica
    • Pessoa Física
    • Pessoa Jurídica
    • Pessoa Física
    • Pessoa Jurídica
    • Webhook
    • Webhook Base
    • Webhook Base
    • Webhook Base
    • Informações de Agência e Conta
    • Webhook Base
    • Expiração
    • Data de Vencimento
    • Apresentação
    • Criação
    • Id da Solicitação de recorrência
    • Location do Payload Completa
    • Parâmetros de consulta de lotes de cobrança com vencimento.
    • DevolucaoSolicitada
    • Parâmetros de Consulta de Webhooks
    • DadosComplementaresPessoa
    • DadosBancarios
    • Webhook
    • Lote de cobranças com vencimento gerado
    • Paginação
    • Violações
    • Generated schema for Root
    • Valor da cobrança com vencimento calculada retornada pelo payload
    • Recorrência Notificada
    • Status da Recorrência
    • Configuração da Recorrência
    • Status da Solicitação de Recorrência
    • Solicitação de Recorrência
    • Solicitação de Recorrência Completa
    • Cobrança Recorrente Solicitada
    • Configuração da Cobrança Recorrente
    • Status da Cobrança Recorrente
    • Status da Cobrança Recorrente
    • Location do Payload Solicitada
    • Location do Payload Solicitada
    • Location do Payload Completa
    • Parâmetros de Consulta de Cobrança
    • Parâmetros de consulta de locations
    • Problema
    • DadosBancariosRecebedor
    • Location do Payload
    • Location do Payload Completa
    • Solicitação de Recorrência Base
    • Cobrança Base com Copia e Cola
    • Lotes de solicitações de cobranças com vencimento
    • Parâmetros de Consulta de Recorrências
    • Parâmetros de Consulta de Cobrança
    • Cobranças recorrentes consultadas
    • Recorrencias consultadas
    • PixValorOriginal
    • PixValorJuros
    • PixValorMulta
    • PixValorDesconto
    • PixValorAbatimento
    • Parâmetros de consulta de locations
    • Locations Consultadas
    • Locations Consultadas
    • Pix Consultados
    • Webhooks Consultados
    • Webhooks de Recorrências Consultados
    • Devolução
    • Devolução
    • Cobrança Recorrente Base
    • Cobrança Base
    • Pix
    • Pix
    • Parâmetros de Consulta Pix
    • Pessoa Física
    • Pessoa Jurídica
    • Cobrança com vencimento revisada
    • Cobrança com vencimento gerada
    • Payload JSON da cobrança imediata
    • PixValorSaque
    • PixValorTroco
    • DadosDevedor
    • DadosDevedorRecorrencia
    • Dados do Pagador
    • Recorrência Solicitada
    • Histórico de atualização da recorrência.
    • Recorrência Base
    • Histórico de Status da Solicitação de Recorrência
    • Cobrança Recorrente Gerada
    • Cobrança imediata revisada
    • Cobrança imediata gerada
    • Lote de solicitações de alteração ou criação de cobranças com vencimento
    • Payload JSON da cobrança com vencimento
    • Cobranças com vencimento consultadas
    • Cobranças imediatas consultadas
    • Dados relacionados à confirmação da ativação da recorrência.
    • Dados relacionados à confirmação da ativação da recorrência.
    • Cobrança imediata solicitada
    • Cobrança com vencimento solicitada
    • DadosRecebedor
    • Payload da Recorrência
    • Recorrência Completa Pesquisada
    • Recorrência Gerada
    • Valor da cobrança imediata
    • Valor da cobrança imediata retornada pelo payload
    • Recorrência Completa
    • Detalhamento do encerramento da recorrência.
    • Histórico de Atualização da Cobrança Recorrente
    • Histórico de Tentativas da Cobrança Recorrente
    • Recorrência Revisada
    • Valor da cobrança com vencimento
    • Cobrança Recorrente Completa
    • Cobrança Recorrente Notificada
    • Cobrança com vencimento completa
    • Cobrança imediata completa
  1. QRCodes API - Cash-In

Tratamento de erros

A API Pix utiliza códigos de status HTTP para indicar o resultado das requisições.
2xx → sucesso
4xx → erro do cliente (requisição inválida ou estado inconsistente)
5xx → erro no servidor
As respostas de erro seguem o padrão da RFC 7807 (Problem Details).

Estrutura do erro#

O campo type identifica o tipo de erro e segue o padrão:
https://pix.bcb.gov.br/api/v2/error/<TipoErro>
Esse campo não necessariamente representa uma URL navegável.
Ele é utilizado apenas como identificador do tipo de erro.

Erros gerais#

TipoDescriçãoHTTP
RequisicaoInvalidaRequisição inválida400
AcessoNegadoViolação de regras de autorização403
NaoEncontradoEntidade não encontrada404
PermanentementeRemovidoEntidade removida permanentemente410
ErroInternoDoServidorErro inesperado no servidor500
ServicoIndisponivelServiço indisponível503
IndisponibilidadePorTempoEsgotadoTimeout na requisição504

Erros por domínio#

CobR — Cobrança recorrente#

Erros principais#

CobRNaoEncontrado (404)
CobROperacaoInvalida (400)
CobRConsultaInvalida (400)

Exemplos de violações#

txid já utilizado
schema inválido
data de vencimento inválida
tentativa de alteração inválida
retentativa fora das regras

RecPayload — Payload de recorrência#

RecPayloadNaoEncontrado (404 / 410)
RecPayloadOperacaoInvalida (400)
Casos comuns:
recorrência encerrada
recorrência cancelada
token de acesso inválido

CobPayload — Payload de cobrança#

CobPayloadNaoEncontrado (404 / 410)
CobPayloadOperacaoInvalida (400)
Casos comuns:
cobrança inexistente
cobrança expirada
parâmetros inválidos (codMun, DPP, etc.)

SolicRec — Solicitação de recorrência#

SolicRecNaoEncontrada (404)
SolicRecOperacaoInvalida (400)
Casos comuns:
schema inválido
duplicidade de solicitação
tentativa de cancelamento inválida

Cob — Cobrança imediata#

CobNaoEncontrado (404)
CobOperacaoInvalida (400)
CobConsultaInvalida (400)
Exemplos de erro:
valor inválido ou zero
chave Pix inválida
alteração de cobrança fora do status permitido

CobV — Cobrança com vencimento#

CobVNaoEncontrada (404)
CobVOperacaoInvalida (400)
CobVConsultaInvalida (400)
Exemplos de erro:
data de vencimento inválida
desconto fora da regra
juros/multa inválidos
alteração fora do status permitido

PayloadLocation — Locations#

PayloadLocationNaoEncontrado (404)
PayloadLocationOperacaoInvalida (400)
PayloadLocationConsultaInvalida (400)

Pix — Transações Pix#

PixNaoEncontrado (404)
PixConsultaInvalida (400)
PixDevolucaoInvalida (400)
Casos comuns:
devolução acima do valor original
devolução fora da janela (90 dias)
e2eid inválido

Webhook#

WebhookOperacaoInvalida (400)
WebhookNaoEncontrado (404)
WebhookConsultaInvalida (400)
Casos comuns:
chave DICT inválida
webhookUrl fora do padrão

WebhookRec — Webhook de recorrência#

WebhookRecOperacaoInvalida (400)
WebhookRecConsultaInvalida (400)

WebhookCobR — Webhook de cobrança recorrente#

WebhookCobROperacaoInvalida (400)
WebhookCobRConsultaInvalida (400)

Boas práticas#

Sempre validar txid, e2eid e parâmetros obrigatórios
Tratar códigos HTTP corretamente
Implementar retry para erros 5xx
Logar erros com contexto (sem expor dados sensíveis)
Validar schema antes de enviar requisição

Resumo rápido#

API segue padrão HTTP + RFC 7807
Erros são organizados por domínio (Cob, Pix, Webhook, etc.)
Maioria dos erros 400 = problema de payload ou regra de negócio
Erros 500+ = problemas temporários (retry recomendado)
Página anterior
Evolução da API
Próxima página
Pix Automático
Built with