Consulta PIX (CNAB)
Visao Geral
API de consulta de transacoes PIX/CNAB com filtros avancados e paginacao
O servico epix-consulta-ordem-pix-cnab permite consultar transacoes PIX originadas do fluxo CNAB. A API oferece filtros avancados, paginacao e dois niveis de detalhe: listagem resumida e consulta detalhada por ID.
Como funciona
- Liste transacoes —
GET /api/v1/transacoescom filtros de data, status, valor e favorecido - Consulte o detalhe —
GET /api/v1/transacoes/{id}para obter todas as informacoes de uma transacao
Filtros disponiveis
| Filtro | Descricao |
|---|---|
| Periodo | Data inicio e fim (obrigatorio, maximo 180 dias) |
| Status | Status da transacao PIX |
| Valor | Valor exato ou faixa (minimo/maximo) |
| Favorecido | Nome do favorecido (minimo 3 caracteres) |
| Chave PIX | Chave PIX do favorecido |
| Arquivo | Nome do arquivo CNAB ou lote de servico |
Status das transacoes
| Status | Descricao |
|---|---|
PENDING | Transacao criada, aguardando processamento |
QUEUED | Na fila para envio |
SENT | Enviada ao banco |
ACCEPTED | Aceita pelo banco |
SETTLED | Liquidada com sucesso |
REJECTED | Rejeitada pelo banco (veja codigos de rejeicao) |
CANCEL_REQUESTED | Cancelamento solicitado |
CANCELLED | Cancelada |
Codigos de rejeicao
Quando uma transacao e rejeitada (REJECTED), o campo motivoFalha contem o motivo da rejeicao. Os codigos seguem a Tabela G059 do Pix:
| Codigo | Descricao |
|---|---|
BE08 | Saldo insuficiente |
PA | Servico Pix indisponivel |
PG | CPF/CNPJ invalido ou nao preenchido |
PH | Transacao nao finalizada pelo banco pagador — tentar novamente |
PX | Transacao nao autorizada pelo banco recebedor — usar outra chave |
PI | QR Code diferente de dinamico com vencimento |
PP | Valor do pagamento invalido (so QR Code) |
WA | Valor supera o limite permitido |
WC | Inclusao rejeitada — contingencia Pix |
WD | Ultrapassou horario permitido para pagamento |
WE | CPF/CNPJ do recebedor inconsistente com titular da conta |