Download the PHP package nkpay/pix-sdk without Composer

On this page you can find all versions of the php package nkpay/pix-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?

Example code of nkpay/pix-sdk

Informations about the package pix-sdk

nkpay/pix-sdk

SDK PHP não-oficial para a API Pix (especificação OpenAPI 3.0 do Banco Central — bacen/pix-api, v2.9.0). Cobre o fluxo de recebimento via Pix: cobranças imediatas (cob), cobranças com vencimento (cobv), consulta de Pix recebidos, devoluções, webhooks e locations.

A spec do BCB define apenas a API exposta pelo PSP recebedor. Cada banco/instituição (Banrisul, Asaas, etc.) implementa essa API com pequenas variações próprias — confira sempre a documentação do seu PSP para confirmar URLs, escopos e formato exato dos campos.

Instalação

(Se for usar localmente sem publicar no Packagist, copie a pasta src/ para o seu projeto e ajuste o autoload no composer.json.)

Dependência: guzzlehttp/guzzle ^7.8, PHP >= 8.1, extensão ext-openssl (necessária para o suporte a certificado .pfx/.p12 — veja abaixo).

Pré-requisitos (junto ao seu PSP)

Para autenticar você vai precisar, normalmente:

  1. Certificado mTLS cadastrado no PSP, em um dos formatos abaixo:
    • PEM + KEY (.pem/.crt + .key); ou
    • PFX/P12 (.pfx/.p12) — formato em que o Banrisul e outros bancos costumam entregar o certificado ICP-Brasil (e-CNPJ/e-CPF). O SDK converte o .pfx para PEM automaticamente em tempo de execução, não é necessário rodar openssl manualmente.
  2. client_id / client_secret para o fluxo OAuth2 client_credentials.
  3. URL base da API Pix do PSP (ex.: sandbox/produção do Banrisul) e URL do endpoint de token.

Dica: antes de configurar o cliente, use php examples/verificar_certificado.php caminho/certificado.pfx "senha" para confirmar o titular (CNPJ), validade e cadeia do certificado — sem expor a chave privada.

Configuração

Escolha uma das duas formas de certificado mTLS:

Opção A — PFX/P12 (formato comum do Banrisul)

Internamente o SDK lê o .pfx, separa certificado e chave privada e grava arquivos .pem temporários (permissão 0600) que o cURL exige — eles são apagados automaticamente ao final da requisição/script. Em hospedagem compartilhada, considere passar pfxTempDir apontando para um diretório privado fora do webroot.

Opção B — PEM + KEY

Em ambas as opções, caBundlePath é opcional e serve apenas para validar o certificado TLS do servidor do PSP com uma CA customizada (ICP-Brasil), caso o bundle padrão do sistema não seja suficiente — não tem relação com o certificado mTLS do cliente configurado acima.

Uso

Criar uma cobrança imediata (gerar QR Code para recebimento)

Consultar se um Pix foi recebido

Configurar webhook (notificação automática de recebimento)

No endpoint https://nkpay.com.br/webhooks/pix, processe o payload recebido e use $client->pix()->consultar($e2eid) para confirmar os detalhes — veja examples/webhook_listener.php.

Solicitar devolução (reembolso)

Cobrança com vencimento (boleto-Pix)

Tratamento de erros

Todos os métodos lançam NkPay\Pix\Exception\PixException em caso de erro HTTP ou de comunicação. O código de status fica em $e->statusCode, o corpo decodificado em $e->responseBody, e eventuais violações de validação (HTTP 400) em $e->violacoes().

Exemplos

Veja a pasta examples/:

Estrutura

O que NÃO está coberto (v1)

A spec completa também define recursos de Pix Automático / recorrência (/rec, /solicrec, /cobr, /lotecobv). Não foram incluídos nesta primeira versão por não serem usados no fluxo atual do NkPay — avise se precisar que eu adicione.

Esta SDK também não cobre envio de Pix (Pix saída/pagamento) — isso não faz parte da spec bacen/pix-api, que cobre apenas o lado do PSP recebedor. Para envio, continue usando AbacatePay/Asaas como já está fazendo no NkPay.

Licença

MIT.

All versions of pix-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
ext-openssl Version *
guzzlehttp/guzzle Version ^7.8
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 nkpay/pix-sdk contains the following files

Loading the files please wait ...