PHPackages gerencianet/gerencianet-sdk-php - 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. [Payment Processing](/categories/payments) 4. / 5. gerencianet/gerencianet-sdk-php Abandoned → [efipay/sdk-php-apis-efi](/?search=efipay%2Fsdk-php-apis-efi)Library[Payment Processing](/categories/payments) gerencianet/gerencianet-sdk-php =============================== GN APIs SDK PHP 5.1.4(2y ago)86280.1k—8.7%45[1 issues](https://github.com/gerencianet/gn-api-sdk-php/issues)5MITPHPPHP ^7.2 || ^8.0 Since May 28Pushed 2y ago15 watchersCompare [ Source](https://github.com/gerencianet/gn-api-sdk-php)[ Packagist](https://packagist.org/packages/gerencianet/gerencianet-sdk-php)[ Docs](https://github.com/gerencianet/gn-api-sdk-php)[ RSS](/packages/gerencianet-gerencianet-sdk-php/feed)WikiDiscussions master Synced 4d ago READMEChangelog (10)Dependencies (1)Versions (53)Used By (5) Aviso - SDK obsoleta ==================== [](#aviso---sdk-obsoleta) [![Gerencianet agora é Efí](https://camo.githubusercontent.com/7b29540fc56c3c0324da856c422e241f8a8a5f485229d0ca4c29aefba1278137/68747470733a2f2f73656a616566692e6c696e6b2f72796c75635343585433)](https://camo.githubusercontent.com/7b29540fc56c3c0324da856c422e241f8a8a5f485229d0ca4c29aefba1278137/68747470733a2f2f73656a616566692e6c696e6b2f72796c75635343585433) A SDK de PHP da Gerencianet continua em funcionamento, porém não receberá mais atualizações. Recomendamos que migre para a nova [SDK da Efí](https://github.com/efipay/sdk-php-apis-efi) para continuar desfrutando de nossos serviços e novidades. Para facilitar esse processo desenvolvemos o **Validador de Migração**, [veja mais detalhes](https://github.com/efipay/sdk-php-apis-efi#validador-de-migra%C3%A7%C3%A3o). SDK Efí by Gerencianet para PHP =============================== [](#sdk-efí-by-gerencianet-para-php) **Português** | [Inglês](https://github.com/gerencianet/gn-api-sdk-php/blob/master/README-en.md) --- [![Última versão estável](https://camo.githubusercontent.com/bc8185b3a7b16a501de5ca801a5ade9be3a080ef14e7646a49b3df4a29a80162/687474703a2f2f706f7365722e707567782e6f72672f676572656e6369616e65742f676572656e6369616e65742d73646b2d7068702f76)](https://packagist.org/packages/gerencianet/gerencianet-sdk-php)[![Licença](https://camo.githubusercontent.com/e6fb121d0deccc41f5afce9ebee4cea5f9b8ec8c3e22acdb3d5cee8312e053bc/687474703a2f2f706f7365722e707567782e6f72672f676572656e6369616e65742f676572656e6369616e65742d73646b2d7068702f6c6963656e7365)](https://packagist.org/packages/gerencianet/gerencianet-sdk-php)[![Total de downloads](https://camo.githubusercontent.com/e8356fb818dfe8580ca3a151798557e51699e9535473ed8fc884864ba19594e7/687474703a2f2f706f7365722e707567782e6f72672f676572656e6369616e65742f676572656e6369616e65742d73646b2d7068702f646f776e6c6f616473)](https://packagist.org/packages/gerencianet/gerencianet-sdk-php)[![Code Climate](https://camo.githubusercontent.com/76601754d3e0d0e7d86c5dc71fa4f915d0b7118367353c1e1c05262625d47afd/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f676572656e6369616e65742f676e2d6170692d73646b2d7068702f6261646765732f6770612e737667)](https://codeclimate.com/github/gerencianet/gn-api-sdk-php) SDK em PHP para integração com as APIs da Gerencianet para emissão de Pix, boletos, carnês, cartão de crédito, assinatura, link de pagamento, marketplance, Pix via Open Finance, pagamento de boletos, dentre outras funcionalidades. Para mais informações sobre [parâmetros](http://dev.gerencianet.com.br) e [valores/tarifas](http://gerencianet.com.br/tarifas) consulte nosso site. Ir para: - [**Requisitos**](#requisitos) - [**Testado com**](#testado-com) - [**Instalação**](#instala%C3%A7%C3%A3o) - [**Começando**](#come%C3%A7ando) - [**Para ambiente de homologação**](#para-ambiente-de-homologa%C3%A7%C3%A3o) - [**Para ambiente de produção**](#para-ambiente-de-produ%C3%A7%C3%A3o) - [**Como obter as credenciais Client-Id e Client-Secret**](#como-obter-as-credenciais-client-id-e-client-secret) - [**Crie uma nova aplicação para usar a API Gerencianet:**](#crie-uma-nova-aplica%C3%A7%C3%A3o-para-usar-a-api-gerencianet) - [**Como gerar um certificado Pix**](#como-gerar-um-certificado-pix) - [**Como cadastrar as chaves Pix**](#como-cadastrar-as-chaves-pix) - [**Cadastrar chave Pix pelo aplicativo mobile:**](#cadastrar-chave-pix-pelo-aplicativo-mobile) - [**Cadastrar chave Pix através da API:**](#cadastrar-chave-pix-atrav%C3%A9s-da-api) - [**Executar exemplos**](#executar-exemplos) - [**Guia de versão**](#guia-de-vers%C3%A3o) - [**Documentação Adicional**](#documenta%C3%A7%C3%A3o-adicional) - [**Validador de Migração**](#validador-de-migra%C3%A7%C3%A3o) - [Como usar o Validador:](#como-usar-o-validador) - [**Licença**](#licen%C3%A7a) --- **Requisitos** -------------- [](#requisitos) - PHP >= 7.2 - Guzzle >= 7.0 **Testado com** --------------- [](#testado-com) ``` PHP 7.2, 7.3, 7.4, 8.0 e 8.1 ``` **Instalação** -------------- [](#instalação) Clone este repositório e execute o seguinte comando para instalar as dependências ``` composer install ``` Ou se você já tem um projeto gerenciado com [Composer](https://getcomposer.org/), inclua a dependência em seu arquivo `composer.json`: ``` ... "require": { "gerencianet/gerencianet-sdk-php": "^5" }, ... ``` Ou baixe este pacote direto com [Composer](https://getcomposer.org/): ``` composer require gerencianet/gerencianet-sdk-php ``` **Começando** ------------- [](#começando) Para começar, você deve configurar as credenciais no arquivo `/examples/credentials/options.php`. Instancie as informações `client_id`, `client_secret` para autenticação e `sandbox` igual a *true*, se seu ambiente for Homologação, ou *false*, se for Produção. Se você usa cobrança Pix, informe no atributo `certificate` o diretório **absoluto** e o nome do seu certificado no formato `.p12` ou `.pem`. Veja exemplos de configuração a seguir: ### **Para ambiente de homologação** [](#para-ambiente-de-homologação) Instancie os parâmetros do módulo usando `client_id`, `client_secret`, `sandbox` igual a **true** e `certificate` com o nome do certificado de homologação: ``` $options = [ "client_id" => "Client_Id...", "client_secret" => "Client_Secret...", "certificate" => realpath(__DIR__ . "/homologacao.p12"), // Caminho absoluto para o certificado no formato .p12 ou .pem "sandbox" => true, "debug" => false, "timeout" => 30 ]; ``` ### **Para ambiente de produção** [](#para-ambiente-de-produção) Instancie os parâmetros do módulo usando `client_id`, `client_secret`, `sandbox` igual a *false* e `certificate` com o nome do certificado de produção: ``` $options = [ "client_id" => "Client_Id...", "client_secret" => "Client_Secret...", "certificate" => realpath(__DIR__ . "/producao.p12"), // Caminho absoluto para o certificado no formato .p12 ou .pem "sandbox" => false, "debug" => false, "timeout" => 30 ]; ``` Para iniciar a SDK, requer o módulo e os namespaces: ``` require __DIR__ . '/vendor/autoload.php'; use Gerencianet\Exception\GerencianetException; use Gerencianet\Gerencianet; ``` Embora as respostas dos serviços da web estejam no formato json, a SDK converterá qualquer resposta do servidor em array. O código deve estar dentro de um try-catch, e podem ser tratadas da seguinte forma: ``` try { /* chamada da função desejada */ } catch(GerencianetException $e) { /* Os erros da API do Gerencianet virão aqui */ } catch(Exception $e) { /* Outros erros virão aqui */ } ``` **Como obter as credenciais Client-Id e Client-Secret** ------------------------------------------------------- [](#como-obter-as-credenciais-client-id-e-client-secret) ### **Crie uma nova aplicação para usar a API Gerencianet:** [](#crie-uma-nova-aplicação-para-usar-a-api-gerencianet) 1. Acesse o painel da Gerencianet no menu **API**. 2. No menu lateral, clique em **Aplicações** depois em **Criar aplicação**. 3. Insira um nome para a aplicação, e selecione qual API quer ativar: **API de emissões** (boletos e carnês) e/ou **API Pix** e/ou Pagamentos. Neste caso, API Pix;que estes podem ser alterados posteriormente). 4. selecione os Escopos de Produção e Escopos de Homologação (Desenvolvimento) que deseja liberar; 5. Clique em **Criar aplicação**. 6. Informe a sua Assinatura Eletrônica para confirmar as alterações e atualizar a aplicação. **Como gerar um certificado Pix** --------------------------------- [](#como-gerar-um-certificado-pix) Todas as requisições do Pix devem conter um certificado de segurança que será fornecido pela Gerencianet dentro da sua conta, no formato PFX(.p12). Essa exigência está descrita na íntegra no [manual de segurança do PIX](https://www.bcb.gov.br/estabilidadefinanceira/comunicacaodados). **Para gerar seu certificado:** 1. Acesse o painel da Gerencianet no menu **API**. 2. No menu lateral, clique em **Meus Certificados** e escolha o ambiente em que deseja o certificado: **Produção** ou **Homologação**. 3. Clique em **Criar Certificado**. 4. Insira sua Assinatura Eletrônica para confirmar a alteração. **Como cadastrar as chaves Pix** -------------------------------- [](#como-cadastrar-as-chaves-pix) O cadastro das chaves Pix pode ser feito através do aplicativo da Gerencianet ou por um endpoint da API. A seguir você encontra os passos de como registrá-las. ### **Cadastrar chave Pix pelo aplicativo mobile:** [](#cadastrar-chave-pix-pelo-aplicativo-mobile) Caso ainda não tenha nosso aplicativo instalado, clique em [Android](https://play.google.com/store/apps/details?id=br.com.gerencianet.app) ou [iOS](https://apps.apple.com/br/app/gerencianet/id1443363326), de acordo com o sistema operacional do seu smartphone, para fazer o download. Para registrar suas chaves Pix por meio do aplicativo: 1. Acesse sua conta através do **app Gerencianet**. 2. No menu lateral, toque em **Pix** para iniciar seu registro. 3. Toque em **Minhas Chaves** e depois em **Cadastrar Chave**. 4. Você deve escolher pelo menos 1 das 4 opções de chaves disponíveis (CPF/CNPJ, celular, e-mail ou chave aleatória). 5. Após cadastrar as chaves do Pix desejadas, clique em **Continuar**. 6. Insira sua Assinatura Eletrônica para confirmar o cadastro. ### **Cadastrar chave Pix através da API:** [](#cadastrar-chave-pix-através-da-api) O endpoint utilizado para criar uma chave Pix aleatória (evp), é o `POST /v2/gn/evp` ([Criar chave evp](https://dev.efipay.com.br/docs/api-pix/endpoints-exclusivos-efi#criar-chave-evp)). Um detalhe é que, através deste endpoint é realizado o registro somente de chaves Pix do tipo aleatória. Para consumí-lo, basta executar o exemplo `/examples/exclusive/key/pixCreateEvp.php` da nossa SDK. A requisição enviada para esse endpoint não precisa de um body. A resposta de exemplo abaixo representa Sucesso (201), apresentando a chave Pix registrada. ``` { "chave": "345e4568-e89b-12d3-a456-006655440001" } ``` **Executar exemplos** --------------------- [](#executar-exemplos) Você pode executar usando qualquer servidor web, como Apache ou nginx e abrir qualquer exemplo em seu navegador. ⚠️ Alguns exemplos requerem que você altere alguns parâmetros para funcionar, como `/examples/charges/billet/createOneStepBillet.php` ou `/examples/pix/cob/pixCreateCharge.php`. **Guia de versão** ------------------ [](#guia-de-versão) VersãoStatusPackagistRepoVersão PHP1.xDescontinuado[/gerencianet/gerencianet-sdk-php#1.0.17](https://packagist.org/packages/gerencianet/gerencianet-sdk-php#1.0.17)[v1](https://github.com/gerencianet/gn-api-sdk-php/tree/1.x)>= 5.42.xDescontinuado[/gerencianet/gerencianet-sdk-php#2.4.1](https://packagist.org/packages/gerencianet/gerencianet-sdk-php#2.4.1)[v2](https://github.com/gerencianet/gn-api-sdk-php/tree/2.x)>= 5.53.xDescontinuado[/gerencianet/gerencianet-sdk-php#3.2.0](https://packagist.org/packages/gerencianet/gerencianet-sdk-php#3.2.0)[v3](https://github.com/gerencianet/gn-api-sdk-php/tree/3.x)>= 5.64.xDescontinuado[/gerencianet/gerencianet-sdk-php#4.1.1](https://packagist.org/packages/gerencianet/gerencianet-sdk-php#4.1.1)[v4](https://github.com/gerencianet/gn-api-sdk-php/tree/4.x)>= 7.25.xDescontinuado[/gerencianet/gerencianet-sdk-php](https://packagist.org/packages/gerencianet/gerencianet-sdk-php)[v5](https://github.com/gerencianet/gn-api-sdk-php)>= 7.2**Documentação Adicional** -------------------------- [](#documentação-adicional) A documentação completa com todos os endpoints e detalhes das APIs está disponível em . Se você ainda não tem uma conta digital da Gerencianet, [abra a sua agora](https://app.sejaefi.com.br/)! **Validador de Migração** ------------------------- [](#validador-de-migração) O Validador de Migração da SDK Efí Pay torna o processo de migração mais suave e eficiente. **Essa ferramenta não modifica o seu código**, somente analisa o código existente em busca de padrões específicos relacionados a classes e métodos que foram modificados na nova versão da SDK. Antes de realizar qualquer modificação no código de sua aplicação, é altamente aconselhável fazer um backup completo de todo o seu projeto. ### Como usar o Validador: [](#como-usar-o-validador) 1. Faça o download do [Validador de Migração](https://raw.githubusercontent.com/gerencianet/gn-api-sdk-php/master/migrationChecker.php). 2. Certifique-se de inserir este arquivo `migrationChecker.php` no diretório raiz do seu projeto. 3. Altere o arquivo `migrationChecker.php` e certifique-se de inserir corretamente na linha *55* e *56* o caminho para os arquivos `composer.json` e `installed.json`. 4. Execute o *Verificador de Migração*, que analisará seus arquivos em busca de problemas. 5. Revise os resultados apresentados, identificando os trechos de código que precisam ser atualizados. 6. Realize as correções recomendadas, seguindo as instruções exibidas. O verificador ajuda a identificar potenciais problemas de migração e oferece sugestões de correção, mas é essencial lembrar que cada aplicação é única e pode ter peculiaridades que não podem ser abordadas automaticamente. Após realizar as correções sugeridas, é altamente recomendado realizar testes extensivos em sua aplicação para validar o funcionamento adequado da SDK. [![Validador de Migração](https://camo.githubusercontent.com/b64c25e6e86151ec43698744161b79d54cfe38be207a6fb019da1ac2253cc21a/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f676572656e6369616e65742d7075622d70726f642d312f7072696e7473637265656e2f323032332f30382f32332f6775696c6865726d652e636f74612f3065323961642d253235677569632e706e67)](https://camo.githubusercontent.com/b64c25e6e86151ec43698744161b79d54cfe38be207a6fb019da1ac2253cc21a/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f676572656e6369616e65742d7075622d70726f642d312f7072696e7473637265656e2f323032332f30382f32332f6775696c6865726d652e636f74612f3065323961642d253235677569632e706e67) **Licença** ----------- [](#licença) [MIT](LICENSE) ### Health Score 50 — FairBetter than 95% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity51 Moderate usage in the ecosystem Community37 Small or concentrated contributor base Maturity81 Battle-tested with a long release history Bus Factor1 Top contributor holds 54.1% 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 ~60 days Recently: every ~30 days Total 52 Last Release 982d ago Major Versions 3.1.0 → 4.0.02021-03-23 3.1.1 → 4.0.32021-07-07 3.2.0 → 4.1.02021-11-12 4.1.1 → 5.0.02022-11-29 4.1.2 → 5.1.32023-08-23 PHP version history (6 changes)0.1.0PHP >=5.3.0 0.2.1PHP >=5.5.0 1.0.6PHP >=5.4.0 3.0.0PHP >=5.6.0 4.0.0PHP >=7.2 5.0.0PHP ^7.2 || ^8.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/744875933e79816c86c35740d8de5845c5003ea7e0d144ee5aacf107aab2b688?d=identicon)[gerencianet](/maintainers/gerencianet) ![](https://www.gravatar.com/avatar/a192f76887cb0498b01bab834d1fedd21c6df3bfb1212a61756d91534ed6a875?d=identicon)[WhinterGoncalves](/maintainers/WhinterGoncalves) ![](https://www.gravatar.com/avatar/b3cff02a13cb03b8a97f7030322cef00bcd1e744be887fc28c65b98d32ed6136?d=identicon)[diego.alberto](/maintainers/diego.alberto) ![](https://www.gravatar.com/avatar/37ef7f872f3964085974bb2deee7a63102087d4110aaeae074637588196a9649?d=identicon)[Sady](/maintainers/Sady) ![](https://www.gravatar.com/avatar/4639b825236e5e73e8a54e713f7f7f69d24129d184db1144962d75c27ed8212c?d=identicon)[guilhermecotaGn](/maintainers/guilhermecotaGn) ![](https://www.gravatar.com/avatar/d6b2c2209d4718bf84549c8774638d496d3b90490fd88555cc61f41985e31ae4?d=identicon)[jvoliveiraGN](/maintainers/jvoliveiraGN) --- Top Contributors [![guilhermecotaGn](https://avatars.githubusercontent.com/u/75252715?v=4)](https://github.com/guilhermecotaGn "guilhermecotaGn (119 commits)")[![ceciliadeveza](https://avatars.githubusercontent.com/u/2746797?v=4)](https://github.com/ceciliadeveza "ceciliadeveza (46 commits)")[![dannielhugo](https://avatars.githubusercontent.com/u/4249245?v=4)](https://github.com/dannielhugo "dannielhugo (22 commits)")[![FilipeMata](https://avatars.githubusercontent.com/u/10949632?v=4)](https://github.com/FilipeMata "FilipeMata (9 commits)")[![talitacampos](https://avatars.githubusercontent.com/u/2728950?v=4)](https://github.com/talitacampos "talitacampos (8 commits)")[![SadyCoimbraEfi](https://avatars.githubusercontent.com/u/55587938?v=4)](https://github.com/SadyCoimbraEfi "SadyCoimbraEfi (5 commits)")[![WhinterGoncalves](https://avatars.githubusercontent.com/u/22505756?v=4)](https://github.com/WhinterGoncalves "WhinterGoncalves (4 commits)")[![franciscotfmc](https://avatars.githubusercontent.com/u/1483404?v=4)](https://github.com/franciscotfmc "franciscotfmc (2 commits)")[![mariopacio](https://avatars.githubusercontent.com/u/5333657?v=4)](https://github.com/mariopacio "mariopacio (1 commits)")[![mpmnicolau](https://avatars.githubusercontent.com/u/1793450?v=4)](https://github.com/mpmnicolau "mpmnicolau (1 commits)")[![claudsonm](https://avatars.githubusercontent.com/u/4139808?v=4)](https://github.com/claudsonm "claudsonm (1 commits)")[![giovani-felipe](https://avatars.githubusercontent.com/u/37030674?v=4)](https://github.com/giovani-felipe "giovani-felipe (1 commits)")[![Thiagogresende](https://avatars.githubusercontent.com/u/36145611?v=4)](https://github.com/Thiagogresende "Thiagogresende (1 commits)") --- Tags api-pixassinaturabilletboletobolixcardcarnecarnetcartao-de-creditolink-de-pagamentomarketplaceopen-financephppixpix-copia-e-colaqrcodesdksdk-phpsplitsubscription ### Embed Badge ![Health badge](/badges/gerencianet-gerencianet-sdk-php/health.svg) ``` [![Health](https://phpackages.com/badges/gerencianet-gerencianet-sdk-php/health.svg)](https://phpackages.com/packages/gerencianet-gerencianet-sdk-php) ``` ### Alternatives [aws/aws-sdk-php AWS SDK for PHP - Use Amazon Web Services in your PHP project 6.3k543.5M2.6k](/packages/aws-aws-sdk-php)[neuron-core/neuron-ai The PHP Agentic Framework. 2.0k656.1k38](/packages/neuron-core-neuron-ai)[tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3741.3M46](/packages/tencentcloud-tencentcloud-sdk-php)[chargebee/chargebee-php ChargeBee API client implementation for PHP 758.5M9](/packages/chargebee-chargebee-php)[tempest/framework The PHP framework that gets out of your way. 2.2k34.4k15](/packages/tempest-framework)[imdhemy/google-play-billing Google Play Billing 491.5M5](/packages/imdhemy-google-play-billing) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)