PHPackages                             insign/integracao-bb - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. insign/integracao-bb

ActiveLibrary[API Development](/categories/api)

insign/integracao-bb
====================

Biblioteca para facilitar a integração com a API de cobranças do Banco do Brasil

v1.1.0(3mo ago)101.2k↓50%1AGPL-3.0-or-laterPHPPHP >=8.3CI failing

Since Aug 20Pushed 3mo ago1 watchersCompare

[ Source](https://github.com/insign/integracao-bb)[ Packagist](https://packagist.org/packages/insign/integracao-bb)[ RSS](/packages/insign-integracao-bb/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (3)Versions (11)Used By (0)

Integração com a API de Cobranças do Banco do Brasil
====================================================

[](#integração-com-a-api-de-cobranças-do-banco-do-brasil)

[![GitHub Actions Workflow Status](https://camo.githubusercontent.com/3003b0334c4774f3275ecb286ffb82ff19facab9b88e4627738410a5c998f7a4/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f696e7369676e2f696e746567726163616f2d62622f746573742e796d6c3f7374796c653d666f722d7468652d6261646765266c6162656c3d54455354)](https://camo.githubusercontent.com/3003b0334c4774f3275ecb286ffb82ff19facab9b88e4627738410a5c998f7a4/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f696e7369676e2f696e746567726163616f2d62622f746573742e796d6c3f7374796c653d666f722d7468652d6261646765266c6162656c3d54455354)

Instalação
----------

[](#instalação)

```
composer require insign/integracao-bb
```

Instanciar a classe
-------------------

[](#instanciar-a-classe)

```
use insign\BB\Cobranca;

$cobranca = new Cobranca('clientId', 'clientSecret', 'developerKey', production: false);
```

Gerar Token
-----------

[](#gerar-token)

> De forma geral, não é necessário gerar o token, pois o token é gerado automaticamente pela API.

```
$token = $cobranca->getTokenAccess();
```

Registrar Boleto
----------------

[](#registrar-boleto)

```
// https://apoio.developers.bb.com.br/referency/post/5f4fb7f5b71fb5001268ca44
$convenio = '3128557';
$idBoleto = '000' . $convenio . random_int(1000000000, 9999999999);

$registro = [
  'numeroConvenio'                       => $convenio,
  'numeroCarteira'                       => '17',
  'numeroVariacaoCarteira'               => '35',
  'codigoModalidade'                     => '1',
  'dataEmissao'                          => date('d.m.Y'),
  'dataVencimento'                       => '31.12.' . date('Y'),
  'valorOriginal'                        => '128.40',
  'indicadorAceiteTituloVencido'         => 'N',
  'codigoAceite'                         => 'A',
  'codigoTipoTitulo'                     => '2',
  'descricaoTipoTitulo'                  => 'DUPLICATA MERCANTIL',
  'indicadorPermissaoRecebimentoParcial' => 'N',
  'numeroTituloBeneficiario'             => '1',
  'campoUtilizacaoBeneficiario'          => 'UM TEXTO',
  'numeroTituloCliente'                  => $idBoleto,
  'mensagemBloquetoOcorrencia'           => '',
  'pagador'                              => [
    'tipoInscricao'   => '1',
    'numeroInscricao' => '97965940132',
    'nome'            => 'Teste Teste',
    'endereco'        => 'R. Teste',
    'cep'             => '10110000',
    'cidade'          => 'São Paulo',
    'bairro'          => 'Centro',
    'uf'              => 'SP',
    'telefone'        => '1112345678',
  ],
  //    'beneficiarioFinal' => [
  //        'tipoInscricao' => '1',
  //        'numeroInscricao' => '',
  //        'nome' => '',
  //    ],
  'indicadorPix'                         => 'S',
];
try {
  $boletoRegistrado = $cobranca->registrarBoleto($registro);
}
catch (\Exception $e) {
  echo "\nErro ao registrar o boleto: {$e->getMessage()}\n";
  echo json_encode($registro);
  return;
}

if ($idBoleto == $boletoRegistrado->numero) {
  echo "\nBoleto registrado com sucesso\n";
  echo json_encode($boletoRegistrado);
} else {
  echo "\nErro ao registrar o boleto";
  echo json_encode($boletoRegistrado);
  return;
}
```

Consultar Boleto
----------------

[](#consultar-boleto)

```
$id_boleto = 'nossonumero';
$numeroConvenio = '';
$listar = $cobranca->verBoleto($id_boleto, $numeroConvenio);
```

Editar Boleto
-------------

[](#editar-boleto)

```
$id_boleto = 'nossonumero';
$data = [
    'numeroConvenio' =>  '3128557',
    'indicadorNovaDataVencimento' => 'S',
    'alteracaoData' => [
        'novaDataVencimento' => '01.04.2021',
    ],
    'indicadorAtribuirDesconto' => 'N',
    'desconto' => [
        'tipoPrimeiroDesconto' => '',
        'valorPrimeiroDesconto' => '',
        'percentualPrimeiroDesconto' => '',
        'dataPrimeiroDesconto' => '',
        'tipoSegundoDesconto' => '',
        'valorSegundoDesconto' => '',
        'percentualSegundoDesconto' => '',
        'dataSegundoDesconto' => '',
        'tipoTerceiroDesconto' => '',
        'valorTerceiroDesconto' => '',
        'percentualTerceiroDesconto' => '',
        'dataTerceiroDesconto' => '',
    ],
    'indicadorAlterarDesconto' => 'N',
    'alteracaoDesconto' => [
        'tipoPrimeiroDesconto' => '',
        'novoValorPrimeiroDesconto' => '',
        'novoPercentualPrimeiroDesconto' => '',
        'novaDataLimitePrimeiroDesconto' => '',
        'tipoSegundoDesconto' => '',
        'novoValorSegundoDesconto' => '',
        'novoPercentualSegundoDesconto' => '',
        'novaDataLimiteSegundoDesconto' => '',
        'tipoTerceiroDesconto' => '',
        'novoValorTerceiroDesconto' => '',
        'novoPercentualTerceiroDesconto' => '',
        'novaDataLimiteTerceiroDesconto' => '',
    ],
    'indicadorAlterarDataDesconto' => 'N',
    'alteracaoDataDesconto' => [
        'novaDataLimitePrimeiroDesconto' => '',
        'novaDataLimiteSegundoDesconto' => '',
        'novaDataLimiteTerceiroDesconto' => '',
    ],
    'indicadorProtestar' => 'N',
    'protesto' => [
        'quantidadeDiasProtesto' => '',
    ],
    'indicadorSustacaoProtesto' => 'N',
    'indicadorCancelarProtesto' => 'N',
    'indicadorIncluirAbatimento' => 'N',
    'abatimento' => [
        'valorAbatimento' => '',
    ],
    'indicadorCancelarAbatimento' => 'N',
    'alteracaoAbatimento' => [
        'novoValorAbatimento' => '',
    ],
    'indicadorCobrarJuros' => 'N',
    'juros' => [
        'tipoJuros' => '',
        'valorJuros' => '',
        'taxaJuros' => '',
    ],
    'indicadorDispensarJuros' => 'N',
    'indicadorCobrarMulta' => 'N',
    'multa' => [
        'tipoMulta' => '',
        'valorMulta' => '',
        'dataInicioMulta' => '',
        'taxaMulta' => '',
    ],
    'indicadorDispensarMulta' => 'N',
    'indicadorNegativar' => 'N',
    'negativacao' => [
        'quantidadeDiasNegativacao' => '',
        'tipoNegativacao' => '',
    ],
    'indicadorAlterarSeuNumero' => 'N',
    'alteracaoSeuNumero' => [
        'codigoSeuNumero' => '',
    ],
    'indicadorAlterarEnderecoPagador' => 'N',
    'alteracaoEndereco' => [
        'enderecoPagador' => '',
        'bairroPagador' => '',
        'cidadePagador' => '',
        'UFPagador' => '',
        'CEPPagador' => '',
    ],
    'indicadorAlterarPrazoBoletoVencido' => 'N',
    'alteracaoPrazo' => [
        'quantidadeDiasAceite' => '',
    ]
];

$alterar = $cobranca->alterarBoleto($id_boleto, $data);
```

Baixar Boleto
-------------

[](#baixar-boleto)

```
$id_boleto = 'nossonumero';
$convenio 'convenio'

$baixar = $cobranca->baixarBoleto($id_boleto, $convenio);
```

Informações
-----------

[](#informações)

Informações sobre a API utilizada nesta integração:

Contribuições
-------------

[](#contribuições)

Contribua com esta integração no [GitHub](https://github.com/insign/integracao-bb)

Para enviar uma nova versão execute `make push` (nova tag patch com seus commits)

Testes
------

[](#testes)

Execute os testes com [Pest](https://pestphp.com/) executando: `make test`

Licença
-------

[](#licença)

[GNU Affero General Public License v3.0](LICENSE)

###  Health Score

47

—

FairBetter than 94% of packages

Maintenance82

Actively maintained with recent releases

Popularity24

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~78 days

Recently: every ~118 days

Total

8

Last Release

91d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/934b53b68624e78343e3f3367897cbaf5fb01475511a1650d2c99c972c810ec6?d=identicon)[insign](/maintainers/insign)

---

Top Contributors

[![insign](https://avatars.githubusercontent.com/u/1113045?v=4)](https://github.com/insign "insign (17 commits)")

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/insign-integracao-bb/health.svg)

```
[![Health](https://phpackages.com/badges/insign-integracao-bb/health.svg)](https://phpackages.com/packages/insign-integracao-bb)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)