PHPackages                             nwiry/bompix-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. [API Development](/categories/api)
4. /
5. nwiry/bompix-sdk-php

AbandonedArchivedLibrary[API Development](/categories/api)

nwiry/bompix-sdk-php
====================

PHP SDK para utilização dos métodos da API Rest BomPix.

1.1.2(1y ago)139MITPHP

Since Apr 12Pushed 1y ago2 watchersCompare

[ Source](https://github.com/diogosace/bompix-sdk-php)[ Packagist](https://packagist.org/packages/nwiry/bompix-sdk-php)[ RSS](/packages/nwiry-bompix-sdk-php/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (4)Dependencies (1)Versions (5)Used By (0)

🧰 BomPix PHP SDK - v1.1.2
=========================

[](#-bompix-php-sdk---v112)

PHP SDK para utilização dos métodos da API Rest BomPix de forma prática e fácil.

🛠 Dependências
--------------

[](#-dependências)

- PHP 8+
- Guzzle 7.8+

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

[](#-instalação)

Para instalar a última versão da SDK, execute o comando abaixo:

```
composer install nwiry/bompix-sdk-php
```

🔑 Autenticação
--------------

[](#-autenticação)

```
use Nwiry\BompixSDK\Request\AuthRequest;

// Inicialize a autenticação
$auth = new AuthRequest("{SUA_CHAVE_DE_API}", "{SUA_CHAVE_SECRETA}");

// Execute a autenticação e obtenha a resposta da API
$responseAuth = $auth->login()->getResponse();

// Armazene o token e o tempo de expiração
$token = $responseAuth->token;
$expiresIn = $responseAuth->expires_in;
```

🔗 Criando Links de Pagamento
----------------------------

[](#-criando-links-de-pagamento)

```
use Nwiry\BompixSDK\Link;
use Nwiry\BompixSDK\Request\LinkRequest;

// Inicialize a instância de link
$link = new Link("nomedomeulink");

// Crie o link de pagamento
$linkRequest = new LinkRequest($responseAuth, $link);
$result = $linkRequest->create()->getResponse();

// Armazene os detalhes do link
$linkId = $result->id;
$linkSlug = $result->slug;
```

📜 Obtendo Links
---------------

[](#-obtendo-links)

```
use Nwiry\BompixSDK\Link;
use Nwiry\BompixSDK\Request\LinkRequest;

// Obtenha um link específico via ID
$link = new Link("nomedomeulink");
$linkRequest = new LinkRequest($responseAuth, $link);
$linkDetails = $linkRequest->get(1);

// Obtenha os detalhes do link
$linkId = $linkDetails->id;
$linkSlug = $linkDetails->slug;
$linkUrl = $linkDetails->url;

// Obtenha uma lista de links
$links = $linkRequest->getAll();
foreach ($links as $link) {
    echo $link->id;
    echo $link->slug;
    echo $link->url;
}
```

💳 Gerando Pagamentos
--------------------

[](#-gerando-pagamentos)

```
use Nwiry\BompixSDK\Link;
use Nwiry\BompixSDK\Payment;
use Nwiry\BompixSDK\PaymentMessage;
use Nwiry\BompixSDK\Request\LinkRequest;
use Nwiry\BompixSDK\Request\PaymentRequest;

// Obtenha o link
$link = new Link("nomedomeulink");
$linkRequest = new LinkRequest($responseAuth, $link);
$linkDetails = $linkRequest->get(slug: $link->slug);

// Defina os dados do pagamento
$paymentData = new Payment(5.35, $linkDetails->id);
$payerMessage = new PaymentMessage("João", "Pagamento da fatura #1", "joao@example.com");
$paymentData->setMessage($payerMessage);

// Crie o pagamento
$paymentRequest = new PaymentRequest($responseAuth, $paymentData);
$payment = $paymentRequest->create()->getResponse();

// Armazene os detalhes do pagamento
$paymentUuid = $payment->uuid;
$paymentQrcode = $payment->qrcode;
$paymentQrcodePng = $payment->qrcode_png;
$paymentPixDuration = $payment->pix_duration;
```

📄 Obtendo Pagamentos
--------------------

[](#-obtendo-pagamentos)

```
use Nwiry\BompixSDK\Request\PaymentRequest;

// Obtenha um pagamento específico
$paymentRequest = new PaymentRequest($responseAuth);
$payment = $paymentRequest->get("{UUID}");

// Obtenha uma lista de pagamentos
$payments = $paymentRequest->getAll();
foreach ($payments as $payment) {
    echo $payment->uuid;
    echo $payment->qrcode;
    echo $payment->qrcode_png;
    echo $payment->pix_duration;
    echo $payment->paid ? "Pago" : "Não Pago";
}
```

🔔 Webhooks
----------

[](#-webhooks)

### Criando e Manuseando Webhooks

[](#criando-e-manuseando-webhooks)

```
use Nwiry\BompixSDK\Webhook;
use Nwiry\BompixSDK\Request\WebhookRequest;

// Crie um novo webhook
$linkDetails = $linkRequest->get(slug: $link->slug);
$webhookData = new Webhook($linkDetails->id, "{SUA_URL_PARA_NOTIFICACAO}");
$webhookRequest = new WebhookRequest($responseAuth, $webhookData);
$webhook = $webhookRequest->create()->getResponse();

// Obtenha um webhook específico
$webhookDetails = $webhookRequest->get($webhook->id);

// Obtenha uma lista de webhooks
$webhooks = $webhookRequest->getAll();

// Delete um webhook
$webhookRequest->delete($webhook->id);
```

### Processando Notificações de Pagamento (Webhooks)

[](#processando-notificações-de-pagamento-webhooks)

```
use Nwiry\BompixSDK\Notification;
use Nwiry\BompixSDK\Request\PaymentRequest;

// Inicialize a instância de notificação na rota do seu webhook
$notification = new Notification();
$event = $notification->processNotification();

// Verifique a veracidade da notificação
$payment = (new PaymentRequest($responseAuth))->get($event->uuid);
$isPaid = $payment->paid ? "Pagamento efetuado com sucesso" : "O pagamento ainda não foi efetuado";
```

🛠 Tratando Exceções
-------------------

[](#-tratando-exceções)

```
use Nwiry\BompixSDK\Exception\BomPixException;

try {
    $paymentRequest = new PaymentRequest($responseAuth, $paymentData);
    $payment = $paymentRequest->create()->getResponse();
} catch (BomPixException $e) {
    echo "Erro: " . $e->getMessage();
}
```

📚 Documentação Oficial da API
-----------------------------

[](#-documentação-oficial-da-api)

Para mais informações detalhadas sobre todos os endpoints e funcionalidades disponíveis na API BomPix, consulte a [Documentação Oficial da API](https://www.postman.com/angeloghiotto/workspace/bompix/collection/1972712-e8f7332a-c58f-49b0-9270-a820307775e5?action=share&creator=1972712&active-environment=1972712-4274a100-9718-4e99-9c72-37e458e0716f). Lá você encontrará exemplos de uso, descrições detalhadas dos parâmetros e respostas, além de guias para ajudar na integração com a API.

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance33

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community8

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

Total

4

Last Release

679d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/8c9faff0337695ebee7e13e76a0018020fc4ee1def13184e05937d97526a9194?d=identicon)[nwiry](/maintainers/nwiry)

---

Top Contributors

[![diogosace](https://avatars.githubusercontent.com/u/42446215?v=4)](https://github.com/diogosace "diogosace (24 commits)")

### Embed Badge

![Health badge](/badges/nwiry-bompix-sdk-php/health.svg)

```
[![Health](https://phpackages.com/badges/nwiry-bompix-sdk-php/health.svg)](https://phpackages.com/packages/nwiry-bompix-sdk-php)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

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