Consultar Pix por lote ou identificador

Funcionalidade principal

Esta API é utilizada para realizar a busca e o acompanhamento de transações Pix (realizadas ou agendadas) dentro de um determinado período ou através de identificadores específicos. Ela permite que o integrador valide o status de liquidação diretamente com os dados registrados na rede do Banco Central, servindo como uma ferramenta de auditoria e conciliação para operações de Cash-out.

A consulta pode ser filtrada por:

Período temporal: Intervalo de até 24 horas entre a data inicial e final.

End2EndId: O identificador universal da transação gerado pelo Banco Central.

Identificador externo: O código de referência criado pelo cliente no momento da solicitação do pagamento.

Casos de uso comuns

Conciliação assíncrona: Verificar se pagamentos agendados foram efetivados com sucesso na data programada.

Auditoria de transferências: Validar os dados de uma transação específica (valor e data) utilizando o End2EndId retornado pelo BACEN.

Gestão de erros de envio: Identificar o status atual de uma ordem de pagamento quando o sistema do integrador não recebeu a confirmação em tempo real.

Relatórios diários: Extrair lotes de transações ocorridas em janelas de tempo específicas para alimentar sistemas de ERP ou BI.

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

curl --location '/api/Pix/ConsultarPixLoteId' \ --header 'UserName;' \ --header 'RequestOrigin;' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "Data": { "CodigoCanal": 0, "CodigoCliente": 0, "DataHoraInicial": "string", "DataHoraFinal": "string", "End2EndId": "string", "IdentificadorExterno": "string" } }'

{ "Data": { "Data": "string", "Valor": "string", "End2EndId": "string", "Status": "string", "IdentificadorExterno": "string" }, "ResultCode": 0, "Message": "string", "ValidationData": { "ResultCode": 0, "Message": "string", "Errors": [ { "ErrorMessage": "string", "FieldName": "string" } ] } }

Funcionalidade principal

Casos de uso comuns

Requisição

Respostas

Consultar Pix por lote ou identificador

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns