underwork/banco-do-brasil-api-v2

SDK PHP para a API v2 do Banco do Brasil

0.0.1 2025-02-03 15:13 UTC

Requires

• php: >=8.3.0
• guzzlehttp/guzzle: ^7.9
• kamermans/guzzle-oauth2-subscriber: ^1.1
• league/pipeline: ^1.0
• respect/validation: ^2.4

Requires (Dev)

• laravel/pint: ^1.18.1
• pestphp/pest: ^3.5.1
• pestphp/pest-plugin-type-coverage: ^3.1
• phpstan/phpstan: ^1.12.7
• rector/rector: ^1.2.8
• symfony/var-dumper: ^7.1.6

MIT

• Lucas Pinheiro
• Luiz Cristino

• package
• php
• api
• Banco do Brasil

README

Este pacote foi criado com o intuito de facilitar a conexão com a API v2 fornecida pelo Banco do Brasil.

Instalação

composer require underwork/banco-do-brasil-api-v2

Utilização

<?php

use UnderWork\BancoDoBrasilApiV2\ValueObjects\Configuration;
use UnderWork\BancoDoBrasilApiV2\ValueObjects\Pix\CobrancaImediata;

/**
 * Cria arquivo de configuração. Necessário para informar as credencias de acesso a API.
 */
$configuracao = new Configuration(
    developerApplicationKey: '<secret>',
    clientId: '<secret>',
    clientSecret: '<secret>',
);

/**
 * Cria a api pix utilizando as configurações informadas.
 */
$pix = new BBApiPix($configuracao);

/**
 * A classe CobrancaImediata já faz a validação inicial dos valores
 * antes do envio para o banco do brasil.
 *
 * As validações podem ser encontradas na documentação oficial do Banco do Brasil.
 * https://apoio.developers.bb.com.br/referency/post/6483836ddcefbe00128886ce
 */
$cobranca = new CobrancaImediata(
    valor: '0.00',
    chave: 'chave pix do recebedor',
);

$pix->criarCobrancaImediata('<Seu txId aqui>', $cobranca);

Notas

• O pacote está sob construção então ainda não possui muitos endpoints mapeados, conforme a nossa necessidade ou apoio da comunidade novos endpoints serão adicionados.

• Este pacote não realiza nenhuma configuração de mTLS, já que essa configuração deve ser realizada no servidor através do Apache, NGINX ou similares