astrotechlabs/bancobrasil-sdk

Biblioteca para facilitar integração com serviços e API's do Banco do Brasil

1.1.0 2024-03-13 22:02 UTC

This package is auto-updated.

Last update: 2024-04-13 22:09:59 UTC


README

Este é um repositório que possui uma abstração a API do Banco do Brasil, facilitando a criação de PIX Copia e Cola como também outros serviços oferecidos

Installation

A forma mais recomendada de instalar este pacote é através do composer.

Para instalar, basta executar o comando abaixo

$ php composer.phar require vaironaegos/bancobrasil-sdk

ou adicionar esse linha

"astrotechlabs/bancobrasil-sdk": "^1.0"

na seção require do seu arquivo composer.json.

Como Usar?

Mínimo para usar

$bbService = new BancoBrasilPix(new BancoBrasilPixParams(
    clientId: 'xxxxxxxxx',
    clientSecret: 'yyyyyyyyyy',
    devAppId: 'ccccccccc',
    // isSandBox: true (opicional)
));

$pixChargeResponse = $bbService->createCharge(new PixData(
    senderName: 'João Silva',
    senderCpf: 'xxxxxxxxxxx',
    amount: 100.00,
    destinationKey: '0000000000', // Chave pix
    // description: 'Compra XPTO' (Opcional)
));

print_r($pixChargeResponse);

Saída

[
    'txId' => '809d734b0d487097ad0c358d6ca78dd6',
    'copyPasteKey' => 'pix.example.com/qr/v2/9d36b84fc70b478fb95c12729b90ca25',
    'responsePayload' => [
        'txid' => '7978c0c97ea847e78e8849634473c1f1',
        'calendario' => [
            'criacao' => '2020-09-09T20:15:00.358Z'
            'expiracao' => 3600
        ],
        'revisao' => 0,
        ...........
    ],
    'qrCode' => 'imagem qrcode...'
]

Contributing

Pull Request são bem-vindos. Para mudanças importantes, abra primeiro uma issue para discutir o que você gostaria de mudar.

Certifique-se de atualizar os testes conforme apropriado.

Licence

Este pacote é lançado sob a licença MIT. Consulte o pacote LICENSE para obter detalhes.