gustavohmelo/integracao-bb-cobranca

Integração com a API de cobrança do Banco do Brasil

v1.0.1 2022-10-11 22:14 UTC

Requires

• ext-json: *
• guzzlehttp/guzzle: ^7.5

MIT

• Gustavo Melo
• Marcelo de Melo Junior

README

Intanciar a classe

Valores disponiveis para "Enviroment" = "sandbox" ou "production"
$bancoBrasil = new BancoBrasil('clientId', 'clientSecret', 'developerKey', 'enviroment');

Gerar Token

$token = $bancoBrasil->getTokenAcess();

Registrar Boleto

$registro = [
    'numeroConvenio' => '',
    'numeroCarteira' => '17',
    'numeroVariacaoCarteira' => '35',
    'codigoModalidade' => '01', //Identifica a característica dos boletos dentro das modalidades de cobrança existentes no banco. Domínio: 01 - SIMPLES; 04 - VINCULADA
    'dataEmissao' => '30.03.2021', //Data de emissão do boleto (formato "dd.mm.aaaaa").
    'dataVencimento' => '31.03.2021', //Data de vencimento do boleto (formato "dd.mm.aaaaa").
    'valorOriginal' => '10', //Valor de cobrança > 0.00, emitido em Real (formato decimal separado por "."). Valor do boleto no registro. Deve ser maior que a soma dos campos “VALOR DO DESCONTO DO TÍTULO” e “VALOR DO ABATIMENTO DO TÍTULO”, se informados. Informação não passível de alteração após a criação. No caso de emissão com valor equivocado, sugerimos cancelar e emitir novo boleto.
    'valorAbatimento' => '0',
    'quantidadeDiasProtesto' => '',
    'quantidadeDiasNegativacao' => '',
    'orgaoNegativador' => '',
    'indicadorAceiteTituloVencido' => 'S',
    'numeroDiasLimiteRecebimento' => '90',
    'codigoAceite' => 'A',
    'codigoTipoTitulo' => '2',
    'descricaoTipoTitulo' => 'DUPLICATA MERCANTIL',
    'indicadorPermissaoRecebimentoParcial' => 'N',
    'numeroTituloBeneficiario' => '1',
    'campoUtilizacaoBeneficiario' => 'UM TEXTO',
    'numeroTituloCliente' => 'nossonumero',
    'mensagemBloquetoOcorrencia' => '',
    'desconto' => [
        'tipo' => '',
        'dataExpiracao' => '',
        'porcentagem' => '',
        'valor' => '',
    ],
    'segundoDesconto' => [
        'dataExpiracao' => '',
        'porcentagem' => '',
        'valor' => '',
    ],
    'terceiroDesconto' => [
        'dataExpiracao' => '',
        'porcentagem' => '',
        'valor' => '',
    ],
    'jurosMora' => [
        'tipo' => '',
        'porcentagem' => '',
        'valor' => '',
    ],
    'multa' => [
        'tipo' => '',
        'data' => '',
        'porcentagem' => '',
        'valor' => '',
    ],
    'pagador' => [
        'tipoInscricao' => '1',
        'numeroInscricao' => '',
        'nome' => '',
        'endereco' => '',
        'cep' => '',
        'cidade' => '',
        'bairro' => '',
        'uf' => '',
        'telefone' => '',
    ],
    'beneficiarioFinal' => [
        'tipoInscricao' => '1',
        'numeroInscricao' => '',
        'nome' => '',
    ],    
    'indicadorPix' => 'S'
]

$registrar = $bancoBrasil->register($registro);

Consultar Boleto

$id_boleto = 'nossonumero';
$numeroConvenio = '';
$listar = $bancoBrasil->read($id_boleto, $numeroConvenio);

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 = $bancoBrasil->alter($id_boleto, $data);

Baixar Boleto

$id_boleto = 'nossonumero';
$baixar[
    'numeroConvenio' => 'convenio'
];

$baixar = $bancoBrasil->baixar($id_boleto, $baixar);

Informações

Para mais informações sobre a API utilizada nesta integração, Acesse este link

Exemplo

Para ver a implementação dos métodos disponiveis, veja o arquivo example.php