PHPackages                             pstrennepohl/php-api-sicredi - 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. pstrennepohl/php-api-sicredi

ActiveLibrary[API Development](/categories/api)

pstrennepohl/php-api-sicredi
============================

Biblioteca para integração com a API Sicredi Geração de QR Code PIX + Geração de Boletos

v1.0.2(1y ago)021MITPHPPHP ^8.0

Since May 23Pushed 12mo ago1 watchersCompare

[ Source](https://github.com/PSTrennepohl/php-api-sicredi)[ Packagist](https://packagist.org/packages/pstrennepohl/php-api-sicredi)[ Docs](https://github.com/pstrennepohl/php-api-sicredi)[ RSS](/packages/pstrennepohl-php-api-sicredi/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (1)Versions (4)Used By (0)

PHP API Sicredi
===============

[](#php-api-sicredi)

Biblioteca para integração com a API Sicredi para a geração de QR Code PIX e Boletos.

Instalação
----------

[](#instalação)

```
composer require pstrennepohl/php-api-sicredi
```

Exemplo de uso:
---------------

[](#exemplo-de-uso)

#### 1. Gerando um PIX para pagamento

[](#1-gerando-um-pix-para-pagamento)

```
   0, // 0[Homologação], 1[Producao]
      "client_id" => "IdDoClienteGeradoNaApiDoSicredi",
      "client_secret" => "SecretDoClienteGeradoNaApiDoSicredi",
      "crt_file" => "/Caminho/do/certificado.cer",
      "key_file" => "/caminho/do/chave.key",
      "pass" => "senha se houver, não é obrigatória"
    ];

    // precisa do try{}catch pois efetua testes de validade do certificado
    try{
        $pix = new SicrediPIX($initPix);
    }catch(Exception $e){
        echo htmlentities($e->getMessage());
    }

    $cobranca  = [
        "calendario" => [
            "expiracao"=> 60 //nesse caso expira em 60 segundos
        ],

        "valor" => [
            "original" => 3.50 // valor a ser cobrado
        ],
        "chave" => "ChaveDoCliente",
        "solicitacaoPagador" => "Mensagem que aparece para quem vai pagar.",
        "infoAdicionais" => [
            [
                "nome" => "Conta/parcela",
                "valor" => "3/1"
            ]
        ]
    ];
    $ret = $pix->criarCobranca($cobranca);
    $qrcode = $pix->gerarQRCode($ret->pixCopiaECola);

    echo '';
  ?>
```

#### 2. Verificando os dados do PIX gerado

[](#2-verificando-os-dados-do-pix-gerado)

```
  dadosDeCobranca('txid');
    echo $ret->calendario->criacao; // data de criação
    echo $ret->calendario->expiracao; // tepo de validade
    echo $ret->status; // ATIVA (ainda é possivel pagar), CONCLUIDA (já foi paga)
    echo $ret->txid; // código ID da transação
    echo $ret->revisao;
    echo $ret->location;
    echo $ret->loc->id;
    echo $ret->loc->location;
    echo $ret->loc->tipoCob;
    echo $ret->loc->criacao;
    echo $ret->valor->original; // VALOR da cobrança
    echo $ret->valor->modalidadeAlteracao;
    echo $ret->valor->retirada;
    echo $ret->chave; // chave pix do recebedor
    echo $ret->solicitacaoPagador; // texto informativo para o pagador
    echo $ret->infoAdicionais[0]->nome; // dados para controle interno
    echo $ret->infoAdicionais[0]->valor; // valor do dado para controle interno
    echo $ret->pixCopiaECola; // código pix copia e cola
  ?>
```

#### 3. WEBHOOK Endereço utilizado para receber o status do PIX

[](#3-webhook-endereço-utilizado-para-receber-o-status-do-pix)

Obs.: O WebHook é setado apenas uma vez, não a cada transação, pois ele registra que TODOS os retornos dessa ChaveDoCliente devem ser para este endereço(URL).

#### 3.1 Verificando o endereço cadastrado

[](#31-verificando-o-endereço-cadastrado)

```
   0, // 0[Homologação], 1[Producao]
      "client_id" => "IdDoClienteGeradoNaApiDoSicredi",
      "client_secret" => "SecretDoClienteGeradoNaApiDoSicredi",
      "crt_file" => "/Caminho/do/certificado.cer",
      "key_file" => "/caminho/do/chave.key",
      "pass" => "senha se houver, não é obrigatória"
    ];

    // precisa do try{}catch pois efetua testes de validade do certificado
    try{
        $pix = new SicrediPIX($initPix);
    }catch(Exception $e){
        echo htmlentities($e->getMessage());
    }
    $WebHook = $pix->getUrlWebhook("ChaveDoCliente"); // Retorna um json
    foreach ($WebHook as $chave => $valor) {
        echo "[".$chave."]: ".$valor."";
    }
  ?>
```

#### 3.2 Cadastrando o endereço de retorno.

[](#32-cadastrando-o-endereço-de-retorno)

Quando o pix é pago é acionado um evento que envia as informações para o endereço configurado, dessa forma consegue-se saber quando o PIX foi pago e dar baixa automatica internamente.

```
   0, // 0[Homologação], 1[Producao]
      "client_id" => "IdDoClienteGeradoNaApiDoSicredi",
      "client_secret" => "SecretDoClienteGeradoNaApiDoSicredi",
      "crt_file" => "/Caminho/do/certificado.cer",
      "key_file" => "/caminho/do/chave.key",
      "pass" => "senha se houver, não é obrigatória"
    ];

    // precisa do try{}catch pois efetua testes de validade do certificado
    try{
        $pix = new SicrediPIX($initPix);
    }catch(Exception $e){
        echo htmlentities($e->getMessage());
    }

    $url = 'https://endereco.com.br/do/retornoDoPix.php';
    $chave = "ChaveDoCliente",
    $pix->updateWebhook($url, $chave);
  ?>
```

#### 4. Para uma lista completa de opções para a geração de boleto execute:

[](#4-para-uma-lista-completa-de-opções-para-a-geração-de-boleto-execute)

```
  DadosBoleto->getVariaveis();
  ?>
```

Qualquer dúvida consulte o manual do Sicredi!
---------------------------------------------

[](#qualquer-dúvida-consulte-o-manual-do-sicredi)

###  Health Score

28

—

LowBetter than 52% of packages

Maintenance49

Moderate activity, may be stable

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity44

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 ~20 days

Total

2

Last Release

387d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/201273253?v=4)[Paulo Frederico Trennepohl dos Santos](/maintainers/PSTrennepohl)[@PSTrennepohl](https://github.com/PSTrennepohl)

---

Top Contributors

[![PSTrennepohl](https://avatars.githubusercontent.com/u/201273253?v=4)](https://github.com/PSTrennepohl "PSTrennepohl (17 commits)")

### Embed Badge

![Health badge](/badges/pstrennepohl-php-api-sicredi/health.svg)

```
[![Health](https://phpackages.com/badges/pstrennepohl-php-api-sicredi/health.svg)](https://phpackages.com/packages/pstrennepohl-php-api-sicredi)
```

###  Alternatives

[appwrite/server-ce

End to end backend server for frontend and mobile apps.

56.4k108.1k](/packages/appwrite-server-ce)[filament/filament

A collection of full-stack components for accelerated Laravel app development.

3829.6M3.6k](/packages/filament-filament)[doppar/framework

The Doppar Framework

4012.4k14](/packages/doppar-framework)[abydahana/aksara

Aksara is a CodeIgniter based CRUD Toolkit you can use to build complex applications become shorter, secure and more reliable just in a few lines of code. Serving both CMS or Framework, produce both HEADLESS (RESTful API) or TRADITIONAL (Browser Based), just by writing single controller. Yet it's reusable, scalable and ready to use!

1111.2k](/packages/abydahana-aksara)[skeeks/cms-shop

Интернет магазин для SkeekS CMS

145.8k23](/packages/skeeks-cms-shop)[lunasoft/sw-sdk-php

PHP Library for SW Services

1628.8k](/packages/lunasoft-sw-sdk-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
