PHPackages levicosta201/gerencianet-pix-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. levicosta201/gerencianet-pix-sdk ActiveLibrary[API Development](/categories/api) levicosta201/gerencianet-pix-sdk ================================ Package to connect with PIX Api from Gerencianet 0.2.48(5y ago)947mitPHPPHP >=7.3 Since Dec 17Pushed 5y ago1 watchersCompare [ Source](https://github.com/levicosta201/gerencianet-pix-api)[ Packagist](https://packagist.org/packages/levicosta201/gerencianet-pix-sdk)[ RSS](/packages/levicosta201-gerencianet-pix-sdk/feed)WikiDiscussions master Synced today READMEChangelog (7)DependenciesVersions (8)Used By (0) Gerencianet PIX SDK =================== [](#gerencianet-pix-sdk) [![Latest Stable Version](https://camo.githubusercontent.com/1732f78091ffb0a9a21e8530ef2705fc9ba0e80e6ee2371ebcb597b3f6a109c7/68747470733a2f2f706f7365722e707567782e6f72672f6c657669636f7374613230312f676572656e6369616e65742d7069782d73646b2f76)](//packagist.org/packages/levicosta201/gerencianet-pix-sdk) [![Total Downloads](https://camo.githubusercontent.com/a0f347c7ddf68497c6c3f0a748c99a99c188025dfaedc3caf5ee1b521e62a2b5/68747470733a2f2f706f7365722e707567782e6f72672f6c657669636f7374613230312f676572656e6369616e65742d7069782d73646b2f646f776e6c6f616473)](//packagist.org/packages/levicosta201/gerencianet-pix-sdk) [![Latest Unstable Version](https://camo.githubusercontent.com/94a0cbc20de3ddff7dc12d757c72c84c0eb42c24b99a6e3e80def48f5af66162/68747470733a2f2f706f7365722e707567782e6f72672f6c657669636f7374613230312f676572656e6369616e65742d7069782d73646b2f762f756e737461626c65)](//packagist.org/packages/levicosta201/gerencianet-pix-sdk) [![License](https://camo.githubusercontent.com/e1111c1a2459ea3fd18c931fc862975bed5828a9ba0706726e03e8251a0bfe31/68747470733a2f2f706f7365722e707567782e6f72672f6c657669636f7374613230312f676572656e6369616e65742d7069782d73646b2f6c6963656e7365)](//packagist.org/packages/levicosta201/gerencianet-pix-sdk) Essa API foi desenvolvida para facilitar a integração com a API do PIX da [Gerencianet](https://gerencianet.com.br/pix/). Você pode isntalar em qualquer projeto via composer. New Features! ============= [](#new-features) - Autenticação - Geração de cobrança > A medida que forem desenvolvidas novas features iremos adicionando aqui neste documento, a API será atualizada constantemente até que seja realizado a comunicação com todas as partes da API. ### Requisítos Mínimos [](#requisítos-mínimos) Para utilizar este SDK você precisará de no mínimo: - \[PHP\] - php: >=7.3 - \[CURL\] - Latest Version - \[COMPOSER\] - Latest Version ### Instalação [](#instalação) A instalação deste SDK é ralmente muito simples e você poderá fazer isso apenas com o comando abaixo. ``` $ composer require levicosta201/gerencianet-pix-sdk ``` ### Utilização [](#utilização) Utilizar este SDK também foi facilitado. Sabemos que o SDK da GN é simples de utilizar, porém foi feita uma organização para melhor compreesão e facilidade da emissão do PIX. Veja o exemplo abaixo: ### Autenticação: [](#autenticação) Antes de efetuar qualquer transação na API PIX da GN é preciso que você receba um token de autenticação, este token pode ser obtido por meio de ticket da própria GN. ``` //Aqui são aceitos dois parâmetros em forma de string, homolog ou production $connect = new Gerencianet\Pix\Connect('production'); //Aqui você você precisa informar apenas o caminho do seu certificado .pem fornecido pela GN $connect = $connect->setCertFile('PATH_TO_CERT_FILE') ->setClientId(env('GERENCIA_NET_CLIENT_ID')) ->setClientSecret(env('GERENCIA_NET_CLIENT_SECRET')); return $connect->proccess(); ``` A solicitação acima irá retornar um array com os seguintes dados: ``` [▼ "data" => array:2 [▼ "accessToken" => "AQUI_IRA_VIR_SEU_TOKEN_DE_ACESSO ▶" "tokenType" => "Bearer" ] ] ``` ### Cobrança: [](#cobrança) Após a autenticação você já possui o necessário para realizar uma cobrança, que poderá ser realizada da seguinte maneira: ``` $pixCharge = new Gerencianet\Pix\Charge('production'); $pixCharge = $pixCharge->setCepDebtor('12300999') ->setCityDebtor('CIDADE_DE_QUEM_PAGA') ->setFreeValue(false) ->setNameDebtor('Nome de quem paga') ->setCpfCnpjDebtor('CPF_DEQUEM_PAGA') ->setValue(10.0) ->setType('estatico') ->setDescriptionService('Teste de descrição') ->setDimenQrCoode(256) ->setUniquePay(true) ->setExpiresTimeQrCode(3600) ->setAccessToken($authData['accessToken']) ->setTokenType('TIPO_TOKEN_RETORNO_API') ->setKeyPix('SUA_CHAVE_PIX_GN'); return $pixCharge->create(); ``` Parâmetros FunçãoTipoDescriçãosetNameDebtor()StringDeverá ser informado o nome de quem está REALIZANDO O PAGAMENTO do PixsetCpfCnpjDebtor()StringDeverá ser informado o CPF/CNPJ de quem está REALIZANDO O PAGAMENTO do Pix. Sem pontos e sem traçossetCepDebtor()StringDeverá ser informado o CEP de quem está REALIZANDO O PAGAMENTO do PixsetCityDebtor()StringDeverá ser informado a Cidade de quem está REALIZANDO O PAGAMENTO do PixsetFreeValue()BoolDeverá ser informado se o valor do pagamento é livre ou nãosetValue()FloatDeverá ser informado o valor da cobrança do PixsetType()BoolDeverá ser informado se o QR Code será dinâmico ou estáticosetDescriptionService()StringDeverá ser informado a descrição da cobrançasetDimenQrCoode()IntegerDeverá ser informado o tamanho da imagem do QR Code, o tamanho máximo é 256pxsetUniquePay()BoolDeverá ser informado se o QR Code poderá ser reutilizadosetExpiresTimeQrCode()IntegerDeverá ser informado o tempo de expiração do QR Code em MilisegundossetKeyPix()StringDeverá informar a sua chave PIX cadastrada no GN sem pontos e sem traçossetTokenType()StringDeverá informar o tipo de token que a API retornacreate()ClassExecuta a cobrança e retorna o array com os dados da cobrançaCaso tenha sucesso na execução acima você deverá receber o seguinte retorno em forma de array ``` array:4 [▼ "success" => "true" "barCode" => "CODIGO_DE_BARRAS" "qrCodeBase64" => "iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAABlB" "pixData" => array:7 [▼ "calendario" => array:1 [▼ "expiracao" => "3600" ] "devedor" => array:2 [▼ "cpf" => "CPF_PAGADOR" "nome" => "NOME_PAGADOR" ] "valor" => array:1 [▼ "original" => 0.01 ] "chave" => "28656307000164" "solicitacaoPagador" => "Teste de descrição" "txid" => "5m6KHjHtDP2a 5Yva30gWjMrA" ] ] ``` ### Listagem de Pix: [](#listagem-de-pix) Após realizar a sua cobrança, você poderá listar e visualizar as cobranças recebidas, para isso faça da seguinte forma: ``` $authData = PixService::auth(); $issuedPix = new Issued(); $issuedPix = $issuedPix->setInitDate("2020-12-09" . "T00:00:00Z") ->setEndDate("2021-12-12" . "T00:00:00Z") ->setCertFile(self::getCertFile()) ->setTokenType($authData['tokenType']) ->setAccessToken($authData['accessToken']); return $issuedPix->list(); ``` Parâmetros FunçãoTipoDescriçãosetInitDate()DateTimeDeverá ser informado para saber qual o início do período da buscasetEndDate()DateTimeDeverá ser informado para saber qual o fim do período da buscasetFilterCpf()StringDeverá ser informado para filtrar PIX por um CPF específicosetFilterCnpj()StringDeverá ser informado para filtrar PIX por um CNPJ específicosetPaginate()IntegerDeverá ser informado para filtrar a paginação da Lista do PIXsetItensPerPage()IntegerDeverá ser informado para o retorno de quantos PIX serão exibidos por páginaCaso tenha sucesso na requisição você receberá o seguinte array: ``` array:2 [▼ "parametros" => array:3 [▼ "inicio" => "2020-12-09T00:00:00Z" "fim" => "2021-12-12T00:00:00Z" "paginacao" => array:4 [▼ "paginaAtual" => 0 "itensPorPagina" => 100 "quantidadeDePaginas" => 1 "quantidadeTotalDeItens" => 1 ] ] "pix" => array:1 [▼ 0 => array:4 [▼ "endToEndId" => "ABCDEFGR020121414PVXK1" "valor" => "0.01" "horario" => "2020-12-14T14:24:19.000Z" "infoPagador" => "API" ] ] ] ``` ### Todos [](#todos) - Lis PIX - List PIX Cob - Pix Webhook - Cancel PIX License ------- [](#license) MIT **Free Software, Hell Yeah!** ### Health Score 23 — LowBetter than 26% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity14 Limited adoption so far Community7 Small or concentrated contributor base Maturity43 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 ~8 days Total 7 Last Release 1974d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/4788641?v=4)[Levi Costa](/maintainers/levicosta201)[@levicosta201](https://github.com/levicosta201) --- Top Contributors [![levicosta201](https://avatars.githubusercontent.com/u/4788641?v=4)](https://github.com/levicosta201 "levicosta201 (3 commits)") ### Embed Badge ![Health badge](/badges/levicosta201-gerencianet-pix-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/levicosta201-gerencianet-pix-sdk/health.svg)](https://phpackages.com/packages/levicosta201-gerencianet-pix-sdk) ``` ### Alternatives [exsyst/swagger A php library to manipulate Swagger specifications 35916.4M7](/packages/exsyst-swagger)[hubspot/api-client Hubspot API client 24016.2M20](/packages/hubspot-api-client)[pocketmine/bedrock-protocol An implementation of the Minecraft: Bedrock Edition protocol in PHP 172445.0k15](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram Telegram driver for BotMan 93459.5k6](/packages/botman-driver-telegram) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)