PHPackages michaeld555/sicoob-sdk - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. michaeld555/sicoob-sdk ActiveLibrary[API Development](/categories/api) michaeld555/sicoob-sdk ====================== SDK para integração com a API da Sicoob v1.0.3(1y ago)053MITPHPPHP >=8.0 Since Feb 17Pushed 1mo ago1 watchersCompare [ Source](https://github.com/michaeld555/sicoob-sdk)[ Packagist](https://packagist.org/packages/michaeld555/sicoob-sdk)[ Docs](https://github.com/michaeld555/sicoob-sdk)[ RSS](/packages/michaeld555-sicoob-sdk/feed)WikiDiscussions master Synced 1w ago READMEChangelog (4)Dependencies (4)Versions (5)Used By (0) Sicoob SDK ========== [](#sicoob-sdk) SDK PHP para integração com a **API do Sicoob**, oferecendo suporte completo a **boletos bancários**, **PIX (cobrança imediata e com vencimento)** e **webhooks**. Requisitos ---------- [](#requisitos) - PHP >= 8.0 - Extensão `json` - Extensão `openssl` (para autenticação SSL em produção) Instalação ---------- [](#instalação) ``` composer require michaeld555/sicoob-sdk ``` Configuração ------------ [](#configuração) ### Credenciais [](#credenciais) Acesse o **Portal do Desenvolvedor Sicoob** para obter: - **client\_id** e **client\_secret** (sandbox) - **Certificado SSL** (arquivos `.crt` e `.key`) para o ambiente de produção ### Modos de operação [](#modos-de-operação) ModoAutenticação**Sandbox**Client credentials simples (client\_id + client\_secret)**Produção**Client credentials via certificado SSLUso --- [](#uso) ### Boleto [](#boleto) ``` use Michaeld555\SicoobBoleto; $sicoob = new SicoobBoleto(); $sicoob->setClientId('seu-client-id') ->setClientSecret('seu-client-secret') // apenas sandbox ->setCertificateCrt('/caminho/certificado.crt') // apenas produção ->setCertificateKey('/caminho/chave.key') // apenas produção ->setSandbox(true); // true para sandbox $boleto = $sicoob->boleto(); // Incluir boleto $boleto->incluir([ 'numeroBoleto' => '123456', 'valor' => 150.00, // ... demais campos conforme documentação Sicoob ]); // Consultar $boleto->consultar('123456'); // Segunda via $boleto->segundaVia('123456'); // Atualizar $boleto->atualizar('123456', ['valor' => 200.00]); // Baixar (cancelar) $boleto->baixar('123456', [ 'motivoCancelamento' => 'ACERTOS' ]); ``` #### Webhook de Boleto [](#webhook-de-boleto) ``` $webhook = $sicoob->webhook(); $webhook->criar([ 'webhookUrl' => 'https://meusite.com/webhook', 'tipo' => 'BOLETO' ]); $webhook->consultar(); $webhook->atualizar(['webhookUrl' => 'https://meusite.com/novo-webhook']); $webhook->deletar(); $webhook->reativar(); $webhook->solicitacoes(['dataInicio' => '2024-01-01', 'dataFim' => '2024-12-31']); ``` ### PIX [](#pix) ``` use Michaeld555\SicoobPix; $sicoob = new SicoobPix(); $sicoob->setClientId('seu-client-id') ->setClientSecret('seu-client-secret') ->setCertificateCrt('/caminho/certificado.crt') ->setCertificateKey('/caminho/chave.key') ->setSandbox(true); // Cobrança Imediata (COB) $cob = $sicoob->cob(); $cob->criar([ 'calendario' => ['expiracao' => 3600], 'devedor' => ['cpf' => '12345678909', 'nome' => 'João Silva'], 'valor' => ['original' => '100.00'], 'chave' => 'chave-pix-aqui', 'solicitacaoPagador' => 'Pagamento referente ao pedido 123' ]); $cob->consultar('txid-gerado'); $cob->atualizar('txid-gerado', ['valor' => ['original' => '150.00']]); $cob->cancelar('txid-gerado'); // QR Code $qrCode = $cob->gerarQRCode('brcode-pix-aqui'); // Retorna QRCodeInterface do chillerlan/php-qrcode // Cobrança com Vencimento (COBV) $cobv = $sicoob->cobv(); $cobv->criar([ 'calendario' => [ 'dataDeVencimento' => '2025-12-31', 'validadeAposVencimento' => 30 ], 'devedor' => ['cpf' => '12345678909', 'nome' => 'João Silva'], 'valor' => ['original' => '500.00'], 'chave' => 'chave-pix-aqui' ]); $cobv->consultar('txid-ou-txid-gerado-automaticamente'); $cobv->atualizar('txid', [...]); $cobv->cancelar('txid'); $cobv->gerarQRCode('brcode-pix-aqui'); ``` #### Webhook de PIX [](#webhook-de-pix) ``` $webhook = $sicoob->webhook(); $webhook->criar('chave-pix', 'https://meusite.com/webhook-pix'); $webhook->consultar('chave-pix'); $webhook->atualizar('chave-pix', 'https://meusite.com/novo-webhook-pix'); $webhook->deletar('chave-pix'); ``` ### QR Code [](#qr-code) ``` use Michaeld555\Helpers\QRCodeGenerator; $qrCode = QRCodeGenerator::generate('brcode-pix-aqui'); // Retorna uma imagem QR Code (SVG/PNG) ``` Estrutura do Projeto -------------------- [](#estrutura-do-projeto) ``` src/ ├── Formater/ │ ├── RequestBoletoMaker.php # Construtor de requisições HTTP para boletos │ └── RequestPixMaker.php # Construtor de requisições HTTP para PIX ├── Helpers/ │ ├── QRCodeGenerator.php # Geração de QR Code a partir de brcode │ └── TxidGenerator.php # Geração de TXID (UUID v4) ├── Options/ │ └── EnvironmentUrls.php # URLs dos ambientes (produção/sandbox) ├── Services/ │ ├── Boleto.php # CRUD de boletos bancários │ ├── Cob.php # Cobrança PIX imediata │ ├── CobV.php # Cobrança PIX com vencimento │ ├── WebhookBoleto.php # Gerenciamento de webhooks de boleto │ └── WebhookPix.php # Gerenciamento de webhooks de PIX ├── Validators/ │ ├── CobValidator.php # Validação de payloads COB │ ├── CobVValidator.php # Validação de payloads COBV │ └── WebhookPixValidator.php # Validação de payloads de webhook PIX ├── SicoobBoleto.php # Fachada principal para boletos └── SicoobPix.php # Fachada principal para PIX ``` Tratamento de Erros ------------------- [](#tratamento-de-erros) Os métodos retornam um array com a estrutura abaixo em caso de erro na API: ``` [ 'message' => 'Descrição do erro', 'violacoes' => ['Campo X é obrigatório', ...] ] ``` Licença ------- [](#licença) MIT © Michael Douglas ### Health Score 35 — LowBetter than 77% of packages Maintenance68 Regular maintenance activity Popularity10 Limited adoption so far Community7 Small or concentrated contributor base Maturity47 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~10 days Total 4 Last Release 515d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/468ac93c5d3d72f0574d393b2582b56059fcc1cf48f564e63717a685f19d8b50?d=identicon)[michaeld555](/maintainers/michaeld555) --- Top Contributors [![michaeld555](https://avatars.githubusercontent.com/u/97418627?v=4)](https://github.com/michaeld555 "michaeld555 (6 commits)") --- Tags pixsicoobboletossicoob-sdkapi-sicoob ### Embed Badge ![Health badge](/badges/michaeld555-sicoob-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/michaeld555-sicoob-sdk/health.svg)](https://phpackages.com/packages/michaeld555-sicoob-sdk) ``` ### Alternatives [laravel/framework The Laravel Framework. 34.9k556.2M21.5k](/packages/laravel-framework)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.5k6.0M777](/packages/sylius-sylius)[leantime/leantime Open source project management system for non-project managers. Simple like Trello, powerful like Jira. Built with neurodiversity in mind. 11.3k4.0k](/packages/leantime-leantime)[google/cloud Google Cloud Client Library 1.2k16.9M57](/packages/google-cloud)[tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3661.3M49](/packages/tencentcloud-tencentcloud-sdk-php)[eslazarev/wildberries-sdk Wildberries OpenAPI clients (generated). 353.6k](/packages/eslazarev-wildberries-sdk) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)