{"id":20625357,"url":"https://github.com/insign/integracao-bb","last_synced_at":"2025-08-11T17:13:27.427Z","repository":{"id":253470051,"uuid":"843604475","full_name":"insign/integracao-bb","owner":"insign","description":"Biblioteca para facilitar a integração com a API de cobranças do Banco do Brasil","archived":false,"fork":false,"pushed_at":"2024-11-07T15:49:07.000Z","size":53,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-15T15:05:10.450Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/insign.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-16T22:30:53.000Z","updated_at":"2024-11-07T15:48:59.000Z","dependencies_parsed_at":"2024-11-07T16:42:12.333Z","dependency_job_id":null,"html_url":"https://github.com/insign/integracao-bb","commit_stats":null,"previous_names":["insign/integracao-bb"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insign%2Fintegracao-bb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insign%2Fintegracao-bb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insign%2Fintegracao-bb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insign%2Fintegracao-bb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/insign","download_url":"https://codeload.github.com/insign/integracao-bb/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249094932,"owners_count":21211837,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T13:09:23.907Z","updated_at":"2025-04-15T15:05:16.484Z","avatar_url":"https://github.com/insign.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Integração com a API de Cobranças do Banco do Brasil\n![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/insign/integracao-bb/test.yml?style=for-the-badge\u0026label=TEST)\n\n## Instalação\n\n```bash\ncomposer require insign/integracao-bb\n```\n\n## Instanciar a classe\n\n```php\nuse insign\\BB\\Cobranca;\n\n$cobranca = new Cobranca('clientId', 'clientSecret', 'developerKey', production: false);\n```\n\n## Gerar Token\n\n\u003e De forma geral, não é necessário gerar o token, pois o token é gerado automaticamente pela API.\n\n```php\n$token = $cobranca-\u003egetTokenAccess();\n```\n\n## Registrar Boleto\n\n```php\n// https://apoio.developers.bb.com.br/referency/post/5f4fb7f5b71fb5001268ca44\n$convenio = '3128557';\n$idBoleto = '000' . $convenio . random_int(1000000000, 9999999999);\n\n$registro = [\n  'numeroConvenio'                       =\u003e $convenio,\n  'numeroCarteira'                       =\u003e '17',\n  'numeroVariacaoCarteira'               =\u003e '35',\n  'codigoModalidade'                     =\u003e '1',\n  'dataEmissao'                          =\u003e date('d.m.Y'),\n  'dataVencimento'                       =\u003e '31.12.' . date('Y'),\n  'valorOriginal'                        =\u003e '128.40',\n  'indicadorAceiteTituloVencido'         =\u003e 'N',\n  'codigoAceite'                         =\u003e 'A',\n  'codigoTipoTitulo'                     =\u003e '2',\n  'descricaoTipoTitulo'                  =\u003e 'DUPLICATA MERCANTIL',\n  'indicadorPermissaoRecebimentoParcial' =\u003e 'N',\n  'numeroTituloBeneficiario'             =\u003e '1',\n  'campoUtilizacaoBeneficiario'          =\u003e 'UM TEXTO',\n  'numeroTituloCliente'                  =\u003e $idBoleto,\n  'mensagemBloquetoOcorrencia'           =\u003e '',\n  'pagador'                              =\u003e [\n    'tipoInscricao'   =\u003e '1',\n    'numeroInscricao' =\u003e '97965940132',\n    'nome'            =\u003e 'Teste Teste',\n    'endereco'        =\u003e 'R. Teste',\n    'cep'             =\u003e '10110000',\n    'cidade'          =\u003e 'São Paulo',\n    'bairro'          =\u003e 'Centro',\n    'uf'              =\u003e 'SP',\n    'telefone'        =\u003e '1112345678',\n  ],\n  //    'beneficiarioFinal' =\u003e [\n  //        'tipoInscricao' =\u003e '1',\n  //        'numeroInscricao' =\u003e '',\n  //        'nome' =\u003e '',\n  //    ],\n  'indicadorPix'                         =\u003e 'S',\n];\ntry {\n  $boletoRegistrado = $cobranca-\u003eregistrarBoleto($registro);\n}\ncatch (\\Exception $e) {\n  echo \"\\nErro ao registrar o boleto: {$e-\u003egetMessage()}\\n\";\n  echo json_encode($registro);\n  return;\n}\n\nif ($idBoleto == $boletoRegistrado-\u003enumero) {\n  echo \"\\nBoleto registrado com sucesso\\n\";\n  echo json_encode($boletoRegistrado);\n} else {\n  echo \"\\nErro ao registrar o boleto\";\n  echo json_encode($boletoRegistrado);\n  return;\n}\n```\n\n## Consultar Boleto\n\n```php\n$id_boleto = 'nossonumero';\n$numeroConvenio = '';\n$listar = $cobranca-\u003everBoleto($id_boleto, $numeroConvenio);\n```\n\n## Editar Boleto\n\n```php\n$id_boleto = 'nossonumero';\n$data = [\n    'numeroConvenio' =\u003e  '3128557',\n    'indicadorNovaDataVencimento' =\u003e 'S', \n    'alteracaoData' =\u003e [\n        'novaDataVencimento' =\u003e '01.04.2021',\n    ],\n    'indicadorAtribuirDesconto' =\u003e 'N',\n    'desconto' =\u003e [\n        'tipoPrimeiroDesconto' =\u003e '',\n        'valorPrimeiroDesconto' =\u003e '',\n        'percentualPrimeiroDesconto' =\u003e '',\n        'dataPrimeiroDesconto' =\u003e '',\n        'tipoSegundoDesconto' =\u003e '',\n        'valorSegundoDesconto' =\u003e '',\n        'percentualSegundoDesconto' =\u003e '',\n        'dataSegundoDesconto' =\u003e '',\n        'tipoTerceiroDesconto' =\u003e '',\n        'valorTerceiroDesconto' =\u003e '',\n        'percentualTerceiroDesconto' =\u003e '',\n        'dataTerceiroDesconto' =\u003e '',\n    ],\n    'indicadorAlterarDesconto' =\u003e 'N',\n    'alteracaoDesconto' =\u003e [\n        'tipoPrimeiroDesconto' =\u003e '',\n        'novoValorPrimeiroDesconto' =\u003e '',\n        'novoPercentualPrimeiroDesconto' =\u003e '',\n        'novaDataLimitePrimeiroDesconto' =\u003e '',\n        'tipoSegundoDesconto' =\u003e '',\n        'novoValorSegundoDesconto' =\u003e '',\n        'novoPercentualSegundoDesconto' =\u003e '',\n        'novaDataLimiteSegundoDesconto' =\u003e '',\n        'tipoTerceiroDesconto' =\u003e '',\n        'novoValorTerceiroDesconto' =\u003e '',\n        'novoPercentualTerceiroDesconto' =\u003e '',\n        'novaDataLimiteTerceiroDesconto' =\u003e '',\n    ],\n    'indicadorAlterarDataDesconto' =\u003e 'N',\n    'alteracaoDataDesconto' =\u003e [\n        'novaDataLimitePrimeiroDesconto' =\u003e '',\n        'novaDataLimiteSegundoDesconto' =\u003e '',\n        'novaDataLimiteTerceiroDesconto' =\u003e '',\n    ],\n    'indicadorProtestar' =\u003e 'N',\n    'protesto' =\u003e [\n        'quantidadeDiasProtesto' =\u003e '',\n    ],    \n    'indicadorSustacaoProtesto' =\u003e 'N',\n    'indicadorCancelarProtesto' =\u003e 'N',\n    'indicadorIncluirAbatimento' =\u003e 'N',\n    'abatimento' =\u003e [\n        'valorAbatimento' =\u003e '',\n    ],\n    'indicadorCancelarAbatimento' =\u003e 'N',\n    'alteracaoAbatimento' =\u003e [\n        'novoValorAbatimento' =\u003e '',\n    ],\n    'indicadorCobrarJuros' =\u003e 'N',\n    'juros' =\u003e [\n        'tipoJuros' =\u003e '',\n        'valorJuros' =\u003e '',\n        'taxaJuros' =\u003e '',\n    ],\n    'indicadorDispensarJuros' =\u003e 'N',\n    'indicadorCobrarMulta' =\u003e 'N',\n    'multa' =\u003e [\n        'tipoMulta' =\u003e '',\n        'valorMulta' =\u003e '',\n        'dataInicioMulta' =\u003e '',\n        'taxaMulta' =\u003e '',\n    ],\n    'indicadorDispensarMulta' =\u003e 'N',\n    'indicadorNegativar' =\u003e 'N',\n    'negativacao' =\u003e [\n        'quantidadeDiasNegativacao' =\u003e '',\n        'tipoNegativacao' =\u003e '',\n    ],\n    'indicadorAlterarSeuNumero' =\u003e 'N',\n    'alteracaoSeuNumero' =\u003e [\n        'codigoSeuNumero' =\u003e '',\n    ],\n    'indicadorAlterarEnderecoPagador' =\u003e 'N',\n    'alteracaoEndereco' =\u003e [\n        'enderecoPagador' =\u003e '',\n        'bairroPagador' =\u003e '',\n        'cidadePagador' =\u003e '',\n        'UFPagador' =\u003e '',\n        'CEPPagador' =\u003e '',\n    ],\n    'indicadorAlterarPrazoBoletoVencido' =\u003e 'N',\n    'alteracaoPrazo' =\u003e [\n        'quantidadeDiasAceite' =\u003e '',\n    ]\n];\n\n\n$alterar = $cobranca-\u003ealterarBoleto($id_boleto, $data);\n```\n\n## Baixar Boleto\n\n```php\n$id_boleto = 'nossonumero';\n$convenio 'convenio'\n\n$baixar = $cobranca-\u003ebaixarBoleto($id_boleto, $convenio);\n```\n## Informações\n\nInformações sobre a API utilizada nesta integração: https://apoio.developers.bb.com.br/referency/post/5f9c2149f39b8500120ab13c\n\n## Contribuições\n\nContribua com esta integração no [GitHub](https://github.com/insign/integracao-bb)\n\nPara enviar uma nova versão execute `make push` (nova tag patch com seus commits)\n\n## Testes\nExecute os testes com [Pest](https://pestphp.com/) executando: `make test`\n\n## Licença\n[GNU Affero General Public License v3.0](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsign%2Fintegracao-bb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finsign%2Fintegracao-bb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsign%2Fintegracao-bb/lists"}