Download the PHP package sistem-atc/bank-sdk without Composer

On this page you can find all versions of the php package sistem-atc/bank-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package bank-sdk

sistem-atc/bank-sdk

SDK PHP unificado de integração bancária — Bradesco, Itaú e Inter PJ — e dos gateways de pagamento Asaas e PagBrasil. Segue o mesmo molde do sistem-atc/marketplace-sdk: enums de identificação, connectors por banco/gateway, grupos de métodos por domínio, DTOs tipados e credenciais fornecidas pelo host via contract.

Cobre Open Banking (OAuth2 client_credentials + mTLS), consulta de extrato, cobrança (boleto e Pix), recebimentos Pix (arranjo regulatório Bacen), pagamentos (SISPAG) e CNAB 240/400. Da PagBrasil, cobre a API inteira: pedidos (cartão, Débito Flash, boleto, Pix), Link de Pagamento, Pix Automático, Payout, assinaturas PagStream, IPN/webhooks e o relatório de liquidação. Do Asaas, cobra a API v3 inteira (32 grupos de métodos, vindos do sistem_atc/asaas-laravel).

Instalação

Laravel 10–13. O BanksServiceProvider é auto-descoberto e publica o config:

Uso

Cada banco é uma classe (Banks\{Banco}\{Banco}) que implementa o contrato comum BankConnector. A regra de cada domínio é da classe do banco:

Quando o banco vem de dado (a conexão guarda 'itau', 'bradesco'…), o enum Bank resolve o connector. O enum só identifica o banco: não tem regra.

Trocar de banco não muda o código do consumidor nos domínios comuns: cada método é tipado pela interface de domínio, não pelo banco.

Produtos específicos de cada banco

O contrato comum (auth, statement, pix, payments, dda, code) é o mínimo que todo banco tem. Produtos que só um banco oferece ficam só no connector daquele banco, tipados — o IDE/PHPStan só mostra o que o banco tem:

O enum é backed ('bradesco', 'inter', 'itau'): dá pra guardar o banco da conexão no banco de dados e resolver com Bank::from($valor). Gateways de pagamento ficam no enum Gateway (ver PagBrasil).

Migrando da 0.x para a 2.0

0.x 2.0
Bank::Itau->statement($i) (e auth, pix, payments, dda) Itau::make()->statement($i) ou Bank::Itau->connector()->statement($i)
Bank::Itau->boletos($i) e demais atalhos de produto Itau::make()->boletos($i)
Bank::PagBrasil, Bank::PagBrasil->pedidos($i) Gateway::PagBrasil, PagBrasil::make()->pedidos($i)
SistemAtc\Banks\Itau\…, \Bradesco\… SistemAtc\Banks\Banks\Itau\…, \Banks\Bradesco\…
SistemAtc\Banks\PagBrasil\… SistemAtc\Banks\Gateways\PagBrasil\…

Bank::X->code(), Bank::from() e Bank::X->connector() não mudaram.

Credenciais — o contract BankIntegration

O SDK não guarda credenciais. O host (ex.: o ERP) implementa SistemAtc\Banks\Contracts\BankIntegration, entregando por request:

Multiempresa é nativo: cada CNPJ tem seu app e seu certificado, e cada chamada carrega a integração da empresa dona da operação.

Autenticação

Domínios

Domínio Itaú Bradesco Inter
Auth (OAuth2 + mTLS) ✅ ✅ ✅
Extrato / Saldo ✅ ✅ ✅
Pagamentos / Pix saída ✅ ✅ ✅ (boleto, DARF, lote, Pix)
Boletos cobrança ✅ ✅ ✅ (Cobrança v3, boleto com Pix)
Recebimentos Pix (Bacen COB/COBV/PIX/LOC/WEBHOOK + resolver QR) ✅ ✅ ✅ (sem resolver QR)
Conciliação Pix (lançamentos conciliados) ✅ — —
Pix Automático (recorrência + cobrança + QR) ✅ — — (fora por ora)
Bolecode Pix ✅ — ✅ (a Cobrança v3 já emite com Pix)
Boletos Negociados / Ativos Financeiros (recebíveis) ✅ — —
Saque/Troco Pix ✅ — —
Cobrança QR Code (boleto híbrido) — ✅ —
Débito veicular (SP/MG/PR/BA) — ✅ —
Arrecadação (contas de consumo e tributos) — ✅ —
TED — ✅ —
Ágora Investimentos (somente leitura) — ✅ —
Gateway PagBrasil (ver seção própria) — — —
CNAB 240/400 (remessa/retorno) compartilhado compartilhado compartilhado

As APIs do Itaú vivem em hosts distintos por produto (api.itau.com.br, pix-pj.api.itau.com, account-statement.api.itau.com…); o SDK resolve o host por produto e ambiente.

O Inter usa um host só por ambiente (cdpj.partners.bancointer.com.br e cdpj-sandbox.partners.uatinter.co), com o produto no path (/banking/v2, /cobranca/v3, /pix/v2). Os DTOs do Inter (Banks/Inter/DTO/Response/*) foram gerados das specs OpenAPI oficiais do portal developers.inter.co.

O Inter não tem API de DDA: Inter::make()->dda() lança BadMethodCallException.

Inter PJ

Webhooks

O SDK publica sozinho a rota que recebe os avisos dos bancos e cadastra essa mesma URL no banco — como o marketplace-sdk faz com os marketplaces.

Cadastro (Inter): TipoWebhook reúne os avisos das três APIs.

Recebimento: o aviso chega ao host pelo evento SistemAtc\Banks\Webhooks\BankWebhookReceived (banco, integração, tipo, payload, cabeçalhos como x-conta-corrente, corpo bruto). O host registra um listener síncrono que grava o payload: se ele lançar exceção a rota responde 500 e o banco reenvia (o Inter tenta 4 vezes); sem listener a rota responde 503, nunca 200.

Autenticação do Inter: o Inter chama a URL com certificado de cliente assinado pela CA dele. Quem confere é o servidor web que termina o TLS, e ele repassa o resultado no cabeçalho X-SSL-Client-Verify. Sem SUCCESS a rota responde 401.

A CA não vem no pacote: baixe o ca.crt do "Certificado Webhook" no Internet Banking PJ e passe o caminho ao comando. Ela é a mesma para todo correntista: um servidor configurado atende todas as contas Inter, e integração nova não pede nada no nginx. O comando confere o arquivo (PEM legível, vencimento de cada certificado — recusa vencido, avisa a menos de 90 dias) e imprime o passo a passo de uma instalação do zero:

O trecho que ele gera, no server { listen 443 ssl; } do domínio:

Quando o Inter trocar a CA (a intermediária atual vence em 08/02/2029), baixe o arquivo novo, confira com o comando e reinstale no servidor (recarregando o nginx).

Config (banks.webhooks) Env Padrão
routes BANKS_WEBHOOK_ROUTES inter,asaas
prefix BANKS_WEBHOOK_PREFIX api/webhooks/banks
base_url BANKS_WEBHOOK_BASE_URL app.url
inter.client_verify_header BANKS_WEBHOOK_INTER_CLIENT_VERIFY_HEADER X-SSL-Client-Verify (vazio desliga)

Asaas: o webhook é cadastrado no painel do Asaas (Integrações → Webhooks) com a URL {prefix}/asaas/{integração}/eventos (WebhookUrl::for('asaas', $i, AsaasWebhookReceiver::TIPO)) e um token de autenticação. O Asaas manda todos os eventos nessa URL com o token no cabeçalho asaas-access-token; o SDK compara com o getWebhookToken() da integração. Para isso o host registra um WebhookIntegrationResolver, que devolve a integração pelo id da URL — sem ele a rota responde 503. O tipo do evento entregue ao host é o evento do payload (PAYMENT_RECEIVED…); o DTO tipado sai de AsaasWebhookPayload::map($evento->payload).

Itaú e Bradesco entram no mesmo mecanismo com um WebhookReceiver próprio (registrado em WebhookReceivers) quando o recebimento deles for implementado; banco que conferir origem por certificado implementa também RequiresClientCertificate e ganha o banks:webhooks-nginx de graça. A PagBrasil continua com o WebhookVerifier (a URL dela já está cadastrada no host).

Asaas

Gateway de cobrança (boleto, Pix, cartão, assinaturas, parcelamentos, split, subcontas, transferências, NFS-e, negativação). Veio do pacote sistem_atc/asaas-laravel 2.0.2 com os mesmos Methods e DTOs; mudou a entrada e a credencial:

asaas-laravel bank-sdk
Asaas::payment() (facade, config global) Asaas::make()->payment($integration)
SistemAtc\Asaas\… SistemAtc\Banks\Gateways\Asaas\… (Enum → Enums)
ASAAS_ACCESS_TOKEN / ASAAS_ENVIRONMENT AsaasIntegration::getApiKey() / isSandbox()
rota api/asaas-events + job + handlers + eventos por tipo rota do SDK + BankWebhookReceived + AsaasWebhookPayload::map()
idempotência em cache do host (INSERT-first com chave única no payload)

A integração implementa SistemAtc\Banks\Contracts\AsaasIntegration: getApiKey() (chave de API da conta, cabeçalho access_token) e getWebhookToken() (token do webhook cadastrado no painel). Hosts: banks.asaas.base_url.production (https://api.asaas.com/v3) e .sandbox (https://api-sandbox.asaas.com/v3). A assinatura de cada método está em docs/asaas/.

PagBrasil

A PagBrasil é gateway, não banco: implementa Contracts\GatewayConnector (só make() e auth()), não BankConnector, e não tem extrato, DDA, SISPAG nem código FEBRABAN. O enum Gateway resolve o connector a partir do valor persistido (Gateway::from('pagbrasil')->connector()). A integração implementa Contracts\PagBrasilIntegration, que soma ao BankIntegration o pbtoken, a secret phrase e a signature key (HMAC) do Dashboard.

Produto Rotas
Pedidos /api/order/add, get, refund, extend, cancel, creditcard/delete, /api/pix/1click
Link de Pagamento /api/checkout/add
Pix Automático /api/order/add (pix_rec), /api/pix/rec/add, rec/get, rec/retry, /mock/pix/automatic/chargeRecurrences (sandbox)
Payout /api/payout/ (addpayee, updatepayee, deletepayee, getpayee, addpayout)
PagStream v2 /api/v2/pagstream/subscriptions…, …/recurrences…, …/shippings, /products, /charges (24 operações)
PagStream v1 /api/pagstream/subscription/add, subscription/item/add\|update\|delete
OAuth (PagBrasil.JS) /api/oauth/token — via PagBrasil::make()->auth($i)

Pontos que não estão óbvios na doc da PagBrasil:

CNAB

Módulo compartilhado (FEBRABAN posicional): CnabType (240/400), LayoutInterface pluggável por banco, RetornoParser (extração posicional) e RemessaBuilder.

Testes

Arquitetura

Licença

MIT.


All versions of bank-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
illuminate/support Version ^10.0|^11.0|^12.0|^13.0
illuminate/http Version ^10.0|^11.0|^12.0|^13.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package sistem-atc/bank-sdk contains the following files

Loading the files please wait ...