Consulta de Boletos
Permitimos consultar boletos gerados a partir de diversos filtros para facilitar a gestão da cobrança.
Obtém detalhe do boleto pelo campo nosso número
Funcionalidade permite recuperar um boleto por meio do Nosso Número.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| NossoNumero | Nosso número do boleto | integer | Sim |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| id | Identificador do boleto | string | Não |
| nossoNumero | Nosso número do boleto | integer | Sim |
| seuNumero | Seu número do boleto | string | Sim |
| valor | Valor do boleto | number | Sim |
| valorPago | Valor pago do boleto pelo sacado (usuário pagador) na rede bancária | number | Sim |
| valorLiquidado | Valor liquidado do boleto. Refere-se ao crédito em conta após compensação do boleto | number | Sim |
| carteira | Dados da carteira, informamos: descrição e código. Refere-se à carteira à qual o cliente pertence | object | Sim |
| movimento | Data da movimentação financeira do boleto, ou seja, quando houve compensação | date-time | Sim |
| vencimento | Data de vencimento definida para o boleto | date-time | Sim |
| emissao | Data de emissão do boleto | date-time | Sim |
| notificacaoPagamento | Data da notificação do pagamento do boleto via webhook | date-time | Sim |
| pagamento | Data do pagamento do boleto | date-time | Sim |
| cancelamento | Data do cancelamento do boleto | date-time | Sim |
| sacado | Sacado é aquele que paga o boleto (normalmente, o cliente). Informamos e-mail, telefone, CPF/CNPJ, nome e endereço | object | Sim |
| sacadorAvalista | Dados da pessoa física ou jurídica que receberá o valor pago por meio do boleto (CPF/CNPJ, nome, endereço) | object | Sim |
| codigoBarras | Código de barras do boleto | string | Sim |
| linhaDigitavel | Linha digitável do boleto | string | Sim |
| registrado | Sinaliza se o boleto está registrado na CIP. True ou False. | boolean | Não |
| mensagem | Mensagens referentes às linhas 1, 2 3 e 4 do boleto | objetc | Sim |
| desconto | Desconto definido para o boleto (percentual, valor fixo, valor diário ou por limite) | object | Sim |
| multa | Multa definida para o boleto (valor, data a partir da qual será cobrada e o percentual) | object | Sim |
| status | Código do status do boleto, ver tabela [Status do Boleto] | integer | Não |
| naturezaDaOperacaoDePagamento | Código da natureza do pagamento, ver tabela [Natureza de pagamento] | integer | Não |
| bancoPagamento | Banco onde o pagamento foi realizado pelo usuário pagador | integer | Sim |
| agenciaPagamento | Agência onde o pagamento foi realizado pelo usuário pagador | integer | Sim |
| canalPagamento | Canal (Internet banking, mobile banking, ATM ou agência) onde o pagamento foi realizado pelo usuário pagador | integer | Sim |
| dataLimitePagamento | Data limite definida para realizar o pagamento do boleto | date-time | Sim |
| beneficiarioFinal | Dono do produto e/ou serviço oferecido e que será creditado pelos valores das cobranças (razão social, nome fantasia e o CPF/CNPJ) | object | Sim |
Obter detalhe do boleto pelo campo nosso numero
Obtém detalhe do boleto pelo código de identificação
Funcionalidade para recuperar um boleto por meio do código de identificação.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| boletoId | Código de identificação do boleto | string | Sim |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| id | Identificador do boleto | string | Não |
| nossoNumero | Nosso número do boleto | integer | Sim |
| seuNumero | Seu número do boleto | string | Sim |
| valor | Valor do boleto | number | Sim |
| valorPago | Valor pago do boleto pelo sacado (usuário pagador) na rede bancária | number | Sim |
| valorLiquidado | Valor liquidado do boleto. Refere-se ao crédito em conta após compensação do boleto | number | Sim |
| carteira | Dados da carteira (descrição e código) | object | Sim |
| movimento | Data do movimento | date-time | Sim |
| vencimento | Data de vencimento definida para o boleto | date-time | Sim |
| emissao | Data de emissão do boleto | date-time | Sim |
| notificacaoPagamento | Data da notificação do pagamento do boleto via webhook | date-time | Sim |
| pagamento | Data do pagamento do boleto | date-time | Sim |
| cancelamento | Data do cancelamento do boleto | date-time | Sim |
| sacado | Sacado é aquele que paga o boleto (normalmente, o cliente). Informamos e-mail, telefone, CPF/CNPJ, nome e endereço | object | Sim |
| sacadorAvalista | Dados da pessoa física ou jurídica que receberá o valor pago por meio do boleto (CPF/CNPJ, nome, endereço) | object | Sim |
| codigoBarras | Código de barras do boleto | string | Sim |
| linhaDigitavel | Linha digitável do boleto | string | Sim |
| registrado | Sinaliza se o boleto está registrado na CIP. True ou false | boolean | Não |
| mensagem | Mensagens referentes às linhas 1, 2 3 e 4 do boleto | objetc | Sim |
| desconto | Desconto definido para o boleto (percentual, valor fixo, valor diário ou por limite) | object | Sim |
| multa | Multa definida para o boleto (valor, data a partir da qual será cobrada e o percentual) | object | Sim |
| status | Código do status do boleto, ver tabela [Status do Boleto] | integer | Não |
| naturezaDaOperacaoDePagamento | Código da natureza do pagamento, ver tabela [Natureza de pagamento] | integer | Não |
| bancoPagamento | Banco onde o pagamento foi realizado pelo usuário pagador | integer | Sim |
| agenciaPagamento | Agência onde o pagamento foi realizado pelo usuário pagador | integer | Sim |
| canalPagamento | Canal (Internet banking, mobile banking, ATM ou agência) onde o pagamento foi realizado pelo usuário pagador | integer | Sim |
| dataLimitePagamento | Data limite definida para realizar o pagamento do boleto | date-time | Sim |
| beneficiarioFinal | Dono do produto e/ou serviço oferecido e que será creditado pelos valores das cobranças (razão social, nome fantasia e o CPF/CNPJ) | object | Sim |
Obter detalhe do boleto pelo código de identificação
Realiza a busca de boletos gerados a partir de uma série de filtros
Funcionalidade possibilita a busca por um boleto a partir de filtros.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| emissaoInicial | Data inicial de emissão do boleto | date-time | Não |
| emissaoFinal | Data final de emissão do boleto | date-time | Não |
| vencimentoInicial | Data inicial de vencimento definida para o boleto | date-time | Não |
| vencimentoFinal | Data final de vencimento definida para o boleto | date-time | Não |
| status | Código do status do boleto, ver tabela [Status do Boleto] | integer | Sim |
| documentoSacado | CPF/CNPJ do sacado (ou seja, o usuário pagador) | string | Não |
| canal | Apelido para identificação do beneficiário | string | Não |
| nossoNumero | Nosso número do boleto | integer | Não |
| seuNumero | Seu número do boleto | string | Não |
Resposta:
| Campo | Descrição | Formato | Nullable |
|---|---|---|---|
| id | Identificador do boleto | string | Não |
| nossoNumero | Nosso número do boleto | integer | Sim |
| seuNumero | Seu número do boleto | string | Sim |
| valor | Valor do boleto | number | Sim |
| valorLiquidado | Valor liquidado do boleto. Refere-se ao crédito em conta após compensação do boleto | number | Sim |
| vencimento | Data de vencimento definida para o boleto | date-time | Sim |
| emissao | Data de emissão do boleto | date-time | Sim |
| notificacaoPagamento | Data da notificação do pagamento do boleto | date-time | Sim |
| pagamento | Data do pagamento do boleto | date-time | Sim |
| cancelamento | Data do cancelamento do boleto | date-time | Sim |
| nomeSacado | Nome do sacado, que é o pagador do boleto | string | Sim |
| codigoBarras | Código de barras do boleto | string | Sim |
| linhaDigitavel | Linha digitável do boleto | string | Sim |
| status | Código do status do boleto, ver tabela [Status do Boleto] | integer | Não |
| bancoPagamento | Banco onde o pagamento foi realizado pelo usuário pagador | integer | Sim |
| agenciaPagamento | Agência onde o pagamento foi realizado pelo usuário pagador | integer | Sim |
| canalPagamento | Canal (Internet banking, mobile banking, ATM ou agência) onde o pagamento foi realizado pelo usuário pagador | integer | Sim |
| dataLimitePagamento | Data limite definida para realizar o pagamento do boleto | date-time | Sim |
| sacadoAvalista | Dados da pessoa física ou jurídica que receberá o valor pago por meio do boleto (CPF/CNPJ, nome, endereço) | object | Sim |
| beneficiarioFinal | Dono do produto e/ou serviço oferecido e que será creditado pelos valores das cobranças (razão social, nome fantasia e o CPF/CNPJ) | object | Sim |
Realizar a busca de boletos gerados a partir de uma série de filtros
Status do boleto
O boleto poderá ter os seguintes status:
| Enumeração | Descrição |
|---|---|
| 1 | Aberto |
| 2 | Vencido |
| 3 | Cancelado |
| 4 | Pago |
Natureza de pagamento
O boleto poderá ter as seguintes naturezas:
| Enumeração | Descrição |
|---|---|
| 0 | Erro |
| 1 | Baixa Caixa |
| 2 | Baixa Normal |
| 3 | Transferência Carteira |
| 4 | Cartório |
| 5 | Baixa Tit Protestado |
| 6 | Correspondente |
| 7 | Compensação Eletrônica |
| 8 | Compensação Convencional |
| 9 | Transferência Crédito |
| 10 | Pagamento Antecipado |
| 11 | Baixa Doc |
| 12 | Baixa Ted |
| 99 | Em Aberto |
Updated 6 months ago