Campos disponíveis para consulta
Abaixo temos uma lista de todos os campos disponíveis para a rotina de consulta.
Campo situação
| Nome | Descrição | Exemplo |
| situacao | Campo onde define a situação atual do boleto, que são SALVO, FALHA, EMITIDO, REJEITADO, REGISTRADO, LIQUIDADO e BAIXADO. *Para saber mais sobre as situações clique aqui. |
REGISTRADO |
Campos para validação de FALHA na inclusão
| Nome | Descrição | Exemplo |
| motivo | Campo onde é definido o motivo da falha de inclusão do boleto | Para informar o campo TituloCodDesconto, é necessário informar também o campo TituloValorDescontoTaxa |
Campos referentes a pagamentos
| Nome | Descrição | Exemplo |
| PagamentoData | Campo onde será retornado a data que houve o pagamento. | 26/12/2018 00:00:00 |
| PagamentoDataCredito | Campo onde será retornado a data em que o dinheiro estará disponível na conta do beneficiário. | 28/12/2018 00:00:00 |
| PagamentoRealizado | Campo Booleano, que define se boleto foi pago ou não. | true |
| PagamentoValorCredito | Campo onde será retornado o valor liquido da cobrança. | 9,00 |
| PagamentoValorPago | Campo onde será retornado valor pago pelo sacado. Ex: Valor + juros e multas, ou valor - descontos. |
10,50 |
| PagamentoValorTaxaCobranca | Campo onde será retornado a taxa de cobrança. | 1,50 |
| PagamentoValorAcrescimos | Campo onde será retornado o valor somado de juros e multa. | 1,00 |
| PagamentoValorDesconto | Campo onde será retornado o valor total de desconto. | 1,00 |
| PagamentoValorAbatimento | Campo que será retornado o valor de abatimento. | 1,00 |
| PagamentoDataTaxaBancaria | Campo onde será retornado a data em que o valor da taxa será debitado da conta do beneficiário. | 28/12/2018 00:00:00 |
| PagamentoValorOutrasDespesas | Campo onde será adicionado outros valores cobrado pelo banco, se houver. | 1,00 |
| PagamentoValorOutrosCreditos | Campo onde será adicionado outros valores creditados, se houver. | 1,00 |
Campos referentes ao sacado
| Nome | Descrição | Exemplo |
| SacadoCPFCNPJ | Neste campo será retornado o cpf ou cnpj do Sacado (responsável pelo pagamento do boleto), informado na inclusão. | 01001001000113 |
| SacadoEmail | Neste campo será retornado o email do Sacado (Quem irá pagar o boleto), informado na inclusão. | email@email.com.br |
| SacadoEnderecoLogradouro | Neste campo será retornado o logadouro do Sacado (Quem irá pagar o boleto), informado na inclusão. | Avenida Brasil |
| SacadoEnderecoNumero | Neste campo será retornado o numero da residencia do Sacado (Quem irá pagar o boleto), informado na inclusão. | 54 |
| SacadoEnderecoBairro | Neste campo será retornado o bairro do Sacado (Quem irá pagar o boleto), informado na inclusão. | Centro |
| SacadoEnderecoCep | Neste campo será retornado o CEP do Sacado (Quem irá pagar o boleto), informado na inclusão. | 86890000 |
| SacadoEnderecoCidade | Neste campo será retornado a cidade do Sacado (Quem irá pagar o boleto), informado na inclusão. | Maringá |
| SacadoEnderecoComplemento | Neste campo será retornado o complemento do Sacado (Quem irá pagar o boleto), informado na inclusão. | Ato. 704 |
| SacadoEnderecoPais | Neste campo será retornado o país do Sacado (Quem irá pagar o boleto), informado na inclusão. | Brasil |
| SacadoEnderecoUf | Neste campo será retornado a sigla do estado onde reside o Sacado (Quem irá pagar o boleto), informado na inclusão. | PR |
| SacadoNome | Neste campo será retornado o nome do Sacado (Quem irá pagar o boleto), informado na inclusão. | João da Silva |
| SacadoTelefone | Neste campo será retornado o telefone Sacado (Quem irá pagar o boleto), informado na inclusão. | 4430379500 |
| SacadoCelular | Neste campo será retornado o celular Sacado (Quem irá pagar o boleto), informado na inclusão. | 44998214397 |
Campos para referenciar conta/convenio do cedente
| Nome | Descrição | Exemplo |
| CedenteContaCodigoBanco | Neste campo será retornado o código (de acordo com a FEBRABAN) do banco responsável pela cobrança, informado na inclusão. | 341 |
| CedenteContaNumero | Neste campo será retornado o numero da conta do Cedente (Quem irá receber o boleto), informado na inclusão. | 1324 |
| CedenteContaNumeroDV | Neste campo será retornado o DV da conta do Cedente (Quem irá receber o boleto), informado na inclusão. | 2 |
| CedenteConvenioNumero | Neste campo será retornado o número do convenio da Conta do Cedente (Quem irá receber o boleto), informado na inclusão. | 221324 |
Campos básicos de consulta
| Nome | Descrição | Exemplo |
| TituloNossoNumero | Campo onde será retornado o sequencial informado na inclusão. | 1234 |
| TituloNossoNumeroImpressao | Campo onde será retornado o nosso número calculado de acordo com as regras de cada banco. | 109000012340 |
| TituloValor | Campo onde será retornado o valor to título informado na inclusão. | 10,00 |
| TituloNumeroDocumento | Campo onde será retornado o numero de controle informado na inclusão do boleto. | NFe 12345 |
| TituloDataEmissao | Campo onde será retornado a data da emissão do boleto. | 01/01/2019 |
| TituloDataVencimento | Campo onde será retornado a data de vencimento do boleto. | 01/02/2019 |
| TituloAceite | Indica se o pagador (quem recebeu o boleto) aceitou o boleto, ou seja, se ele autorizou, assinou o documento de cobrança que originou o boleto. Será retornado mesmo valor informado na inclusão. |
N |
| TituloDocEspecie | Tipo do boleto emitido, por exemplo: DM - Duplicata Mercantil, NP - Nota Promissória. Será retornado mesmo valor informado na inclusão. |
01 |
| TituloLocalPagamento | Será retornado o local do pagamento, informado na inclusão. | Pagavel em qualquer banco até o vencimento. |
Campos de boleto híbrido
Documentação de referência: Como emitir um boleto híbrido
| Nome | Descrição | Exemplo |
| hibrido | Campo retornado como true quando utilizado boleto híbrido | true |
| UrlPix | Url do PIX onde pode ser consultada a impressão com o QrCode | http://plugboleto.com.br/api/v1/boletos/impressao/HRKCVJXVV/pix |
Campos de Desconto
| Nome | Descrição | Exemplo |
| TituloCodDesconto | Neste campo será retornado o código para aplicar um determinado desconto, códigos disponíveis: 0 - Sem instrução de desconto. 1 - Valor Fixo Até a Data Informada. 2 - Percentual Até a Data Informada. 3 - Valor por Antecipação Dia Corrido. 4 - Valor por Antecipação Dia Útil. 5 - Percentual Sobre o Valor Nominal Dia Corrido. 6 - Percentual Sobre o Valor Nominal Dia Útil. 7 - Cancelamento de Desconto. |
1 |
| TituloDataDesconto | Neste campo será retornado a data limite para conceder um determinado descontonto, informado na inclusão. | 15/01/2019 |
| TituloValorDescontoTaxa | Neste campo será retornado o valor de um determinado desconto, informado na inclusão. | 2,00 |
| TituloCodDesconto2 | Neste campo será retornado o código para aplicar no segundo desconto, informado na inclusão. | 1 |
| TituloDataDesconto2 | Neste campo será retornado a data limite para conceder o segundo desconto, informado na inclusão. | 20/01/2019 |
| TituloValorDescontoTaxa2 | Neste campo será retornado o valor do segundo desconto, informado na inclusão. | 2,00 |
Campos de Juros
| Nome | Descrição | Exemplo |
| TituloCodigoJuros | Neste campo será retornado o código para aplicar um determinado juros, informado na inclusão. | 1 |
| TituloDataJuros | Neste campo será retornado a data de inicio para cobrar um determinado valor de juros/mora, informado na inclusão. | 02/02/2019 |
| TituloValorJuros | Neste campo será retornado o valor/taxa de um determinado juros/mora, informado na inclusão. | 2,00 |
Campos de Multa
| Nome | Descrição | Exemplo |
| TituloCodigoMulta | Neste campo será retornado o código para aplicar uma determinada Multa, informado na inclusão. | 1 |
| TituloDataMulta | Neste campo será retornado a data que deve ser cobrada uma determinada Multa, informado na inclusão. | 02/02/2019 |
| TituloValorMultaTaxa | Neste campo será retornado o valor/taxa de uma determinada multa, informado na inclusão. | 2,00 |
Campos de protesto automático
| Nome | Descrição | Exemplo |
| TituloCodProtesto | Neste campo será retornado o código para aplicar um determinado protesto, informado na inclusão. | 2 |
| TituloPrazoProtesto | Neste campo será retornado a quantidade de dias após o vencimento para realizar o protesto automático, informado na inclusão. | 30 |
Campos de baixa automática
| Nome | Descrição | Exemplo |
| TituloCodBaixaDevolucao | Neste campo será retornado o código para aplicar uma determinada baixa, informado na inclusão. | 2 |
| TituloPrazoBaixa | Neste campo será retornado a quantidade de dias após o vencimento para realizar a baixa automática, informado na inclusão. | 30 |
Campos de mensagens
| Nome | Descrição | Exemplo |
| TituloMensagem01 | Neste campo será retornado uma mensagem para ser adicionada ao boleto, informado na inclusão. | Conceder desconto de R$2,00 até 15/01/2019 |
| TituloMensagem02 | Neste campo será retornado uma mensagem para ser adicionada ao boleto, informado na inclusão. | Cobrar R$2,00 ao dia após o vencimento |
Os campos de mensagem podem ser consultados até TituloMensagem09.
Campos para Sacador/Avalista
| Nome | Descrição | Exemplo |
| TituloSacadorAvalista | Neste campo será retornado o nome do Sacador/Avalista para o boleto, informado na inclusão. | Joao Silva |
| TituloSacadorAvalistaEndereco | Neste campo será retornado o endereço do Sacador/Avalista para o boleto, informado na inclusão. | Avenida Brasil |
| TituloSacadorAvalistaCidade | Neste campo será retornado a cidade do Sacador/Avalista para o boleto, informado na inclusão. | Maringa |
| TituloSacadorAvalistaCEP | Neste campo será retornado o CEP do Sacador/Avalista para o boleto, informado na inclusão. | 86890000 |
| TituloSacadorAvalistaUF | Neste campo será retornado a sigla do estado onde reside o Sacador/Avalista do boleto, informado na inclusão. | PR |
| TituloInscricaoSacadorAvalista | Neste campo será retornado o CPF ou CNPJ do Sacador/Avalista do boleto, informado na inclusão. | 01001001000113 |
Outros Campos
| Nome | Descrição | Exemplo |
| TituloLinhaDigitavel | Linha digitável gerada a partir dos dados informados na emissão do título | 34191.00000 00000.000000 00000.000000 0 00000000000101 |
| TituloCodigoBarras | Descrição numérica do código de barras gerado na emissão do título | 3410000000000000000000000000000000000001000 |
| TituloEmissaoBoleto | Campo destinado para definir se a impressão do boleto será feita pelo beneficiário ou pelo banco, informado na inclusão. | A |
| TituloCategoria | Retorna a categoria do boleto que está sendo emitido, informada na inclusão. | 2 |
| TituloPostagemBoleto | Valor destinado para informar se a impressão do boleto será postada pelo beneficiário ou pelo banco, informado na inclusão. | N |
| TituloCodEmissaoBloqueto | Código adotado pela FEBRABAN para identificar o responsável e a forma de emissão do bloqueto, informado na inclusão. | 2 |
| TituloOutrosAcrescimos | Campo para informar acréscimo que deve ser somado ao valor do boleto, informado na inclusão. | 2,00 |
| TituloInformacoesAdicionais | Campo livre para informações adicionais do boleto, informado na inclusão. | Entregar para setor financeiro. |
| TituloInstrucoes | Retorna o conteúdo que será exibido ao lado do texto "Instruções", informado na inclusão. | Não receber após 30 dias do vencimento. |
| TituloParcela | Retorna o número da parcela para os modelos carnê, informado na inclusão. | 03/10 |
| TituloVariacaoCarteira | Variação da modalidade de cobrança no banco, informado na inclusão. Apenas o Banco do Brasil possui essa variação. |
017 |
| TituloCodigoReferencia | Campo livre para informar um valor de identificação secundária. | 321321321 |
| TituloCarteira | Campo com o código da carteira retornado pelo banco (Esse campo é atualizado após a conciliação do retorno do banco). | 5 |
| TipoMovimentoCarteira | Campo com o Tipo da carteira retornado pelo banco SIMPLES ou DESCONTADA (Esse campo é atualizado após a conciliação do retorno do banco). | |
| TituloContaCobranca | Campo com o número da conta, que o boleto foi conciliado (Esse campo é atualizado após a conciliação do retorno do banco). | 21332 |
|
TituloInstrucao1
|
instrução, conforme tabela do banco (2 caracteres alfanuméricos). Somente para CNAB 400 |
1 |
|
TituloInstrucao2
|
instrução, conforme tabela do banco (2 caracteres alfanuméricos). Somente para CNAB 400 |
1 |
| TituloInstrucao3 | 3a. instrução, conforme tabela do banco (2 caracteres alfanuméricos). Opcional para BRB e somente para CNAB 400 |
1 |
|
TituloInstrucaoPrazo1
|
Define a quantidade de dias para cumprimento da 1a. instrução. Opcional para BRB e somente para CNAB 400 |
1 |
|
TituloInstrucaoPrazo2
|
Define a quantidade de dias para cumprimento da 2a. instrução. Opcional para BRB e somente para CNAB 400 |
1 |
|
TituloInstrucaoPrazo3
|
Define a quantidade de dias para cumprimento da 3a. instrução. Opcional para BRB e somente para CNAB 400 |
1 |
|
ConvenioRegistroAutomatico
|
Campo booleano que irá retornar como true, caso o boleto tenha sido emitido com WS ativo no convênio, e false, caso tenha sido emitido com o WS desativado no convênio. | True |
|
TituloMovimentos
|
Campo onde será retornado as movimentações bancárias que o banco disponibilizou para o boleto via arquivo retorno. Por não envolver CNAB, campo pode não ser preenchido em transmissões de WS. |
Clique aqui para acessar um diretório com arquivos no formato TX2 ou JSON, com todos os campos acima preenchidos.
Comentários
0 comentário
Por favor, entre para comentar.