Skip to main content

brbank

Biblioteca Python assincrona para emitir e acompanhar boletos e cobrancas Pix em bancos brasileiros por uma interface unica. Nao importa nada do Odoo: o modulo l10n_br_payment_boleto e uma das faces possiveis.

Licenca MIT. Python 3.10+ (o 3.10 e o do Odoo 16.0; brbank._compat cobre o que so existe no 3.11) e cryptography>=38, para conviver com o pyOpenSSL da imagem do Odoo. Alfa: nenhum adapter foi validado em sandbox de banco (validado_sandbox = False); o contrato de cada banco vem da documentacao publica e de fontes de terceiros, com as duvidas em docs/<banco>-duvidas.md. Estado: primeira fatia (modelo canonico, contrato de adapter, transporte, autenticacao, orquestrador e os adapters da tabela abaixo).

Bancos suportados

Todos os adapters passam pela mesma suite de contrato (registrar, consultar, baixar) contra um servidor falso. "Fonte do contrato" diz de onde veio o comportamento implementado: Odoo = portado de um modulo que ja roda em producao; oficial = especificacao publicada pelo banco (OpenAPI, WSDL ou portal); publica e terceiros = documentacao publica, integracoes e SDKs de terceiros, porque o portal do banco exige login. O detalhe e as duvidas de cada banco estao em docs/<banco>-duvidas.md.

Banco Adapter (entry point) Produto Capacidades declaradas Fonte do contrato
Inter (077) inter Cobranca v3, boleto hibrido hibrido, so hibrido, baixa, PDF, webhook Odoo
PinBank pinbank Boleto, envelope AES-CBC baixa Odoo
Banco do Brasil (001) bb Cobranca v2 alteracao, baixa publica e terceiros
Banrisul (041) banrisul Cobranca v1, boleto hibrido hibrido, alteracao, baixa, PDF oficial
Bradesco (237) bradesco Cobranca convencional (sem QR Code) baixa publica e terceiros
BTG Pactual (208) btg Banking Collections, bolepix hibrido, alteracao, baixa, PDF, webhook, emissao assincrona oficial
C6 Bank (336) c6 Bolepix v2, boleto hibrido hibrido, alteracao, baixa, PDF, webhook oficial
Caixa (104) caixa SIGCB, webservice SOAP hibrido, alteracao, baixa oficial (WSDL)
Itau (341) itau Cobranca v2 (CASH) e Bolecode hibrido (com bolecode), alteracao, baixa publica e terceiros
Safra (422) safra Cobranca v1 so registro e consulta publica e terceiros
Santander (033) santander Gestao de Boletos v2 (workspace) hibrido (com chave Pix), alteracao, baixa, emissao assincrona publica e terceiros
Sicoob (756) sicoob Cobranca v3, boleto hibrido hibrido, alteracao, baixa publica e terceiros
Sicredi (748) sicredi Cobranca v2 hibrido, alteracao, baixa, webhook publica e terceiros
Unicred (136) unicred Cobranca, API key + usuario baixa, PDF, webhook cifrado, emissao assincrona oficial

Pix (BACEN /cob, /cobv, /webhook) por um adapter generico, pix_bacen, com um perfil por PSP (host, escopos, headers e quirks): Inter, Banco do Brasil, Sicoob, Sicredi, Itau, Bradesco, Santander e Efi. Capacidades: Pix cob e cobv, webhook, baixa.

Fora desta lista por enquanto: BNB, gateways como Mercado Pago, PagBank e Stone (sob demanda), o boleto hibrido do Bradesco e a variante ECOMM do Sicredi. Banco novo = um adapter com BankAdapter e um entry point em brbank.adapters.

Nenhum adapter foi validado em sandbox. Todos trazem validado_sandbox = False (os perfis Pix tambem) e so passam a True depois de rodar contra o ambiente real do banco. Inter e PinBank herdam a logica de modulos Odoo em producao, mas o adapter da biblioteca tambem ainda nao rodou contra o banco.

Uso

from brbank import Orquestrador
from brbank.adapters.inter import InterAdapter, InterConfig

config = InterConfig(
    conta="matriz",
    client_id="...",
    client_secret="...",
    conta_corrente="123456",
    ambiente="sandbox",
    certificado_pem=cert_bytes,
    chave_pem=chave_bytes,  # vindos do cofre
)
adapter = InterAdapter(config)
orquestrador = Orquestrador(adapter, concorrencia=10)

registrado = await orquestrador.emitir(titulo)  # idempotente por chave
resultados = await orquestrador.emitir_em_varios(lote)  # falha isolada por titulo

Um banco novo e um pacote que registra o adapter no entry point brbank.adapters:

[project.entry-points."brbank.adapters"]
inter = "brbank.adapters.inter:InterAdapter"
pinbank = "brbank.adapters.pinbank:PinbankAdapter"
sicoob = "brbank.adapters.sicoob:SicoobAdapter"

sicredi = "brbank.adapters.sicredi:SicrediAdapter"

pix_bacen = "brbank.adapters.pix_bacen:PixBacenAdapter"

O PinbankAdapter usa OAuth2 password e payload cifrado AES-CBC (EnvelopeAesCbc), registra, consulta e baixa por NossoNumero, e nao tem webhook nem PDF. Contrato em aberto: docs/pinbank-duvidas.md.

O SicoobAdapter (Cobranca Bancaria v3, boleto hibrido) usa OAuth2 client_credentials sem client_secret (a identidade e o mTLS), header client_id, id do titulo = nosso numero, registra, consulta, baixa e envia instrucao (prorrogacao, abatimento, protesto). Sem PDF e sem webhook declarados. validado_sandbox = False: contrato montado de documentacao de terceiros, nunca executado contra o Sicoob. Duvidas: docs/sicoob-duvidas.md.

O BancoDoBrasilAdapter (bb, API Cobranca v2, convenio de 6 ou 7 digitos) usa OAuth2 client_credentials e a chave gw-dev-app-key em query param; registra, consulta, baixa, prorroga e abate, sem webhook nem PDF. Nasce com validado_sandbox = False: ver docs/bb-duvidas.md.

O BradescoAdapter (bradesco, API Cobranca convencional do portal Bradesco Developers) usa OAuth2 client_credentials sobre mTLS (o fluxo legado com JWT nao e coberto); registra, consulta e baixa pelo nosso numero gerado pelo banco. Sem alteracao, PDF nem webhook declarados; desconto e abatimento no registro sao recusados ate haver contrato. Nasce com validado_sandbox = False: ver docs/bradesco-duvidas.md.

O SicrediAdapter (API de Cobranca v2, OAuth2 password) registra, consulta, baixa e altera (prorrogacao e abatimento); webhook sem assinatura exige reconsulta. Nasce com validado_sandbox = False; contrato em aberto: docs/sicredi-duvidas.md.

O PixBacenAdapter fala a API Pix do BACEN (/cob, /cobv, /webhook, devolucao) e muda de banco por PerfilPsp: inter, bb, sicoob, sicredi, itau, bradesco, santander e efi (BNB sem perfil). Todos com validado_sandbox = False ate rodar no sandbox. O txid vem da chave de idempotencia, o copia-e-cola e o txid chegam em TituloRegistrado, e CONCLUIDA sem Pix na consulta nao liquida. Duvidas e quirks: docs/pix-duvidas.md.

config = PixBacenConfig(
    perfil="sicoob",
    conta="matriz",
    chave_pix="...",
    client_id="...",
    ambiente="producao",
    certificado_pem=cert,
    chave_pem=chave,
)
adapter = PixBacenAdapter(config)

brbank.criar_adapter("inter", config) resolve pelo nome e adapter.suporta(Capacidade.PDF) consulta as capacidades em runtime.

Regras

  • Valores em Decimal (float e recusado). Percentuais em unidade de percentual.
  • Nome, documento e endereco ficam fora do repr; log, erro e resposta bruta passam por brbank.mascara.mascarar.
  • Retry so para 429, 5xx e erro de transporte. Status desconhecido no banco levanta erro, nunca vira "pago".
  • Webhook gera EventoCanonico e nao confirma nada: reconsulte antes de liquidar.

Metadata

Release files for brbank 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for brbank 0.0.3
File Size Uploaded Provenance
brbank-0.0.3.tar.gz 245.7 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for brbank 0.0.3
File Interpreter ABI Platform
brbank-0.0.3-py3-none-any.whl Python 3 none any Details

Total release size: 363.9 kB

Release files / brbank-0.0.3.tar.gz

Download URL brbank-0.0.3.tar.gz
Size 245.7 kB
Tags Source
SHA-256 checksum
How to use checksums
086e3173214088bc0f3cc554a9b5b9f76c2befa9a58febca2bc0d74b98936c1a
BLAKE2b-256 checksum
How to use checksums
148a6b0ea2879f13c7651d99bc3f0d23f962ac619dfa8e6f535489fb28cec5c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / brbank-0.0.3-py3-none-any.whl

Download URL brbank-0.0.3-py3-none-any.whl
Size 118.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7b24b76dfee2b7d7a046ba0fd9f5dde15458946069723f489ebe09acfc657bca
BLAKE2b-256 checksum
How to use checksums
7c8acb7f679f21550ed5c5a719bf6504e7b2d67c6a9355c7a249b1e4ce62ce4c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Security for brbank 0.0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for brbank-0.0.3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page