Comprovantes

Disponibilizamos operações de consulta e exportação de comprovantes em PDF de pagamentos.

Consulta Comprovantes

A funcionalidade permite a consulta por um comprovante de pagamento.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
dataInicialData inicial da pesquisadate-timeSim
dataFinalData final da pesquisadate-timeSim
tipoFiltroCódigo do tipo de filtro, conforme tabela [Tipo de filtro]integerSim

Resposta:

CampoDescriçãoFormatoNullable
comprovanteIdIdentificador único do comprovantestringNão
empresaDados da empresaObjectSim
EfetuadoEmData em que o pagamento foi efetuadodate-timeSim
EfetuarEmData em que o pagamento será efetuado, e nesse caso o pagamento está agendadodate-timeSim
tipoCódigo do tipo de comprovante, conforme tabela [Tipo de comprovante]integerNão
protocoloNúmero do protocolo do pagamentostringSim
dadosTransferenciaApresenta valor, favorecido e dados bancários do favorecidoobjectSim
dadosPagamentoApresenta beneficiário, sacador avalista, pagador, cedente, banco emissor do pagamento, linha digitável, vencimento e valores (pago, desconto, mora, deduções, acréscimos, encargos etc.) do boletoobjectSim
dadosTributoApresenta dados do pagador, pagador final, vencimento, valores (pago, juros etc.) do tributoobjectSim
dadosPagamentoPixApresenta os dados de recebedor (nome, CPF/CNPJ e dados bancários), valor, valor de tarifa, chave e endToEndIdobjetcSim

Consultar comprovantes

Gera comprovante em PDF

A funcionalidade permite gerar o comprovante de pagamento no formato PDF.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
comprovanteIdIdentificador do comprovantestringSim
TipoComprovanteCódigo do tipo de comprovante, conforme tabela [Tipo de comprovante]integerSim

E como resultado é efetuado o download do PDF.

Gerar comprovante em PDF.

Tipo de filtro

Na tabela abaixo, listamos os tipos de filtros:

EnumeraçãoDescrição
1Transferência
2Pagamento
3Agendamento Transferência
4Agendamento Pagamento
5Efetuados
6Agendados

Tipo de comprovante

Na tabela a seguir, são listados os tipos de comprovantes:

EnumeraçãoDescrição
1Transferência
2Pagamento
3Pagamento Tributo
4Agendamento Transferência
5Agendamento Pagamento
6Agendamento Pagamento Tributo
7Pagamento Pix