--- title: "Consultar os dados detalhados de um boleto. (por Id do boleto)" method: GET path: "/pj/forintegration/cobranca/v1/boletos/{boletoId}" tags: ["Listar boleto(s)"] --- # Consultar os dados detalhados de um boleto. (por Id do boleto) `GET /pj/forintegration/cobranca/v1/boletos/{boletoId}` ## Request - The document declares no server URL. - Auth: none declared ## Path parameters - `boletoId` string, uuid, required: Código do boleto. Exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ## Response `200` Success - SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosBoletoBuscadoHateoas: Boleto. - `item` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosBoletoBuscado: Dados completos de um boleto retornado em consultas. - `id` string, uuid: Identificador único do boleto no formato GUID. Exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. - `nossoNumero` integer, nullable: Identificador do boleto gerado pelo banco. - `seuNumero` string, nullable: Identificador do boleto definido pelo próprio emissor, usado para reconhecimento no seu sistema (ex.: número da venda ou nota fiscal). - `valor` number, double, nullable: Valor monetário em reais. - `valorPago` number, double, nullable: Valor pago do boleto. Exemplo: 995.55 Este valor é preenchido no momento em que o boleto é pago na rede bancária. Caso o boleto seja pago no próprio BS2, esse valor só será preenchido juntamente com o campo ValorLiquidado. - `valorLiquidado` number, double, nullable: Valor liquidado do boleto. Exemplo: 995.55 Diferente do valor pago, valor liquidado é o valor exato que entra na conta, e ocorre em D+1. - `carteira` SwaggerCobrancaBs2PjCompartilhadosCarteiraCodigoDescricao: Código e descrição da carteira de cobrança. Exemplo: 21 - Simples, 41 - Vinculada. - `descricao` string, nullable: Descrição da carteira de cobrança (ex.: Simples, Vinculada). - `codigo` integer, nullable: Código da carteira de cobrança. Valores: 21 (Carteira simples) ou 41 (Carteira vinculada). - `movimento` string, date-time, nullable: Data de movimento do boleto. - `vencimento` string, date-time, nullable: Data de vencimento do boleto. - `emissao` string, date-time, nullable: Data de emissão do boleto. - `notificacaoPagamento` string, date-time, nullable: Data e hora em que o pagamento do boleto foi notificado ao sistema. - `pagamento` string, date-time, nullable: Data em que o boleto foi pago pelo pagador na rede bancária. - `cancelamento` string, date-time, nullable: Data de cancelamento do boleto. - `canal` string, nullable: Apelido para identificação do beneficiário. - `sacado` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosSacado: Pagador do boleto (sacado) — pessoa física ou jurídica responsável pela quitação. - `tipo` integer: Tipo de pessoa: física (identificada por CPF) ou jurídica (identificada por CNPJ). - `documento` string, nullable: CPF ou CNPJ da pessoa física ou jurídica. Exemplo: CNPJ: 24401281000152 ou CPF: 75956344075. - `nome` string, nullable: Nome da pessoa física ou razão social da pessoa jurídica. - `endereco` SwaggerCobrancaBs2PjCompartilhadosEndereco: Endereço completo do pagador, contendo logradouro, número, complemento, bairro, cidade, UF e CEP. - `cep` string, nullable: CEP do endereço do pagador, somente os 8 dígitos numéricos sem máscara. Exemplo: 04543011. - `estado` string, nullable: Sigla do estado do endereço. Apenas iniciais. Exemplo: SP, MG, RJ. - `cidade` string, nullable: Cidade do endereço do pagador. Exemplo: São Paulo. - `bairro` string, nullable: Bairro do endereço do pagador. Exemplo: Vila Olímpia. - `logradouro` string, nullable: Logradouro do endereço do pagador. Exemplo: Av. Pres. Juscelino Kubitschek. - `numero` string, nullable: Número do logradouro no endereço. Aceita apenas letras e números, sem caracteres especiais. Exemplo: KM 10. - `complemento` string, nullable: Complemento do endereço do pagador. Utilizado para informações adicionais ou quando o número contém caracteres especiais. - `email` string, nullable: E-mail do pagador. Exemplo: joao@bs2.com.br. - `telefone` string, nullable: Telefone do pagador. Informar apenas dígitos numéricos, sem máscara (máximo 13 dígitos). Exemplo: 11944440000. - `sacadorAvalista` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosSacadorAvalista: Sacador avalista do boleto. - `tipo` integer: Tipo de pessoa: física (identificada por CPF) ou jurídica (identificada por CNPJ). - `documento` string, nullable: CPF ou CNPJ da pessoa física ou jurídica. Exemplo: CNPJ: 24401281000152 ou CPF: 75956344075. - `nome` string, nullable: Nome da pessoa física ou razão social da pessoa jurídica. - `endereco` SwaggerCobrancaBs2PjCompartilhadosEndereco: Endereço completo do pagador, contendo logradouro, número, complemento, bairro, cidade, UF e CEP. - `cep` string, nullable: CEP do endereço do pagador, somente os 8 dígitos numéricos sem máscara. Exemplo: 04543011. - `estado` string, nullable: Sigla do estado do endereço. Apenas iniciais. Exemplo: SP, MG, RJ. - `cidade` string, nullable: Cidade do endereço do pagador. Exemplo: São Paulo. - `bairro` string, nullable: Bairro do endereço do pagador. Exemplo: Vila Olímpia. - `logradouro` string, nullable: Logradouro do endereço do pagador. Exemplo: Av. Pres. Juscelino Kubitschek. - `numero` string, nullable: Número do logradouro no endereço. Aceita apenas letras e números, sem caracteres especiais. Exemplo: KM 10. - `complemento` string, nullable: Complemento do endereço do pagador. Utilizado para informações adicionais ou quando o número contém caracteres especiais. - `codigoBarras` string, nullable: Código de barras do boleto. Exemplo: 21895787100000000000010000000000000000000000. - `linhaDigitavel` string, nullable: Linha digitável do boleto. Exemplo: 21090010070000000000000860000000000000000000000. - `registrado` boolean: Indica se o boleto foi registrado na Nuclea, o que o torna disponível para pagamento na rede bancária. Exemplo: true. - `mensagem` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosMensagem: Mensagem personalizada impressa no boleto, dividida em até 4 linhas de até 80 caracteres cada. Utilizada para orientar o caixa ou o pagador sobre a cobrança. - `linha1` string, nullable: Primeira linha da mensagem personalizada impressa no boleto (máximo 80 caracteres). - `linha2` string, nullable: Segunda linha da mensagem personalizada impressa no boleto (máximo 80 caracteres). - `linha3` string, nullable: Terceira linha da mensagem personalizada impressa no boleto (máximo 80 caracteres). - `linha4` string, nullable: Quarta linha da mensagem personalizada impressa no boleto (máximo 80 caracteres). - `desconto` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosDesconto: Configuração do desconto por pagamento antecipado. - `percentual` number, double, nullable: Valor percentual do desconto. - `valorFixo` number, double, nullable: Valor fixo a ser descontado quando o pagamento ocorrer dentro da data limite de desconto. - `valorDiario` number, double, nullable: Valor de desconto concedido por dia até a data limite de desconto. - `limite` string, date-time, nullable: Data limite para aplicação do desconto. - `multa` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosMulta: Configuração de multa e juros aplicados após o vencimento do boleto. Multa máxima: 20%. Juros máximos: 20% ao mês. - `valor` number, double, nullable: Valor percentual de multa aplicado a partir da data de multa/juros. - `data` string, date-time, nullable: Data a partir da qual a multa e os juros passam a ser cobrados sobre o boleto. - `juros` number, double, nullable: Taxa de juros aplicada a partir da data de multa/juros, em percentual ao mês. Máximo: 20% ao mês. Exemplo: 15. - `status` integer: Status atual do boleto no ciclo de vida. - `naturezaDaOperacaoDePagamento` integer: Natureza da operação de pagamento associada ao boleto. - `bancoPagamento` integer, nullable: Banco onde o pagamento do boleto foi realizado. - `agenciaPagamento` integer, nullable: Agência bancária onde o pagamento do boleto foi realizado. - `canalPagamento` integer, nullable: Canal pelo qual o pagamento do boleto foi realizado. - `dataLimitePagamento` string, date-time, nullable: Data limite até a qual o boleto pode ser pago após o vencimento. O prazo configurável é de 1 a 90 dias após o vencimento. - `beneficiarioFinal` SwaggerCobrancaBs2PJDomainCobrancaModelsBoletosAvulsoBoletoAggregateBeneficiarioFinal: Beneficiário final do boleto — quem de fato recebe o valor(quando difere do cedente). - `razaoSocial` string, nullable: Razão social do beneficiário final. - `nomeFantasia` string, nullable: Nome fantasia do beneficiário final. - `documento` string, nullable: CPF ou CNPJ da pessoa física ou jurídica. Exemplo: CNPJ: 24401281000152 ou CPF: 75956344075. - `solicitacoes` SwaggerCobrancaBs2PjCobrancaBoletosCompartilhadosSolicitacaoInstrucao[], nullable: Lista de solicitações de instrução associadas ao boleto. - `id` string, uuid: Identificador único da solicitação de instrução no formato GUID. Exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. - `tipo` integer: Tipo da instrução solicitada sobre o boleto. - `status` integer: Status da solicitação de instrução sobre o boleto. - `dados` string, nullable: Dados serializados em formato JSON referentes à instrução ou solicitação realizada. - `justificativa` string, nullable: Texto explicando o status da instrução. - `criadoEmUtc` string, date-time: Data e hora de criação do registro em UTC. ## Other responses - `400`: Bad Request - `404`: Not Found --- [API](https://skmtc.dev/bs2/apis/api-boletos.md) - [All operations](https://skmtc.dev/bs2/apis/api-boletos/llms.txt) - [OpenAPI document](https://skmtc.dev/bs2/apis/api-boletos/revisions/5d82dc00a3f9?raw)