PHPackages                             mountbit/pague-dev-php-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. [Payment Processing](/categories/payments)
4. /
5. mountbit/pague-dev-php-sdk

ActiveLibrary[Payment Processing](/categories/payments)

mountbit/pague-dev-php-sdk
==========================

SDK do pague.dev para PHP

v2.0.0(5mo ago)410[4 PRs](https://github.com/MountBit/pague-dev-php-sdk/pulls)MITPHPPHP ^8.4CI passing

Since Feb 5Pushed 3mo agoCompare

[ Source](https://github.com/MountBit/pague-dev-php-sdk)[ Packagist](https://packagist.org/packages/mountbit/pague-dev-php-sdk)[ Docs](https://github.com/mountbit/pague-dev-php-sdk)[ Fund](https://donate.mapos.com.br)[ RSS](/packages/mountbit-pague-dev-php-sdk/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (10)Dependencies (4)Versions (19)Used By (0)

MountBit Pague.dev PHP SDK
==========================

[](#mountbit-paguedev-php-sdk)

SDK em PHP para integrar facilmente com a **API pague.dev**, permitindo que aplicações PHP criem cobranças PIX, gerenciem clientes, projetos, cobranças (links de pagamento) e transações de forma simples e tipada.

A API do pague.dev oferece recursos como PIX, cobranças, clientes e transações por meio de uma interface REST limpa, com autenticação via API Key e respostas em JSON. ([docs.pague.dev](https://docs.pague.dev/?utm_source=chatgpt.com))

---

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

[](#-instalação)

Instale via **Composer**:

```
composer require mountbit/pague-dev-php-sdk
```

---

🚀 Começando
-----------

[](#-começando)

### 1. Configurar o Cliente

[](#1-configurar-o-cliente)

```
use MountBit\PagueDev\Api;

$apiKey = 'pd_test_xxx';
$connector = new Api($apiKey);
```

---

🧰 Recursos Disponíveis
----------------------

[](#-recursos-disponíveis)

### 🎯 PIX - Estático

[](#-pix---estático)

#### Criar cobrança PIX

[](#criar-cobrança-pix)

```
use MountBit\PagueDev\Requests\Pix\Static\Create as CreatePix;

$request = new CreatePix(
    amount: 25.00,
    description: 'Pix Estático',
);

$response = $connector->send($request);

print_r($response->json());
```

### 🎯 PIX - Dinâmico

[](#-pix---dinâmico)

#### Criar cobrança PIX com objeto Customer

[](#criar-cobrança-pix-com-objeto-customer)

```
use MountBit\PagueDev\Requests\Pix\Dynamic\Create as CreatePix;
use MountBit\PagueDev\Dtos\Pix\Customer;

$request = new CreatePix(
    amount: 100.50,
    description: 'Pagamento PIX',
    projectId: 'proj_123',
    customer: new Customer(
        name: 'John Doe',
        document: '12345678910',
        email: 'email@example.com',
        phone: '12345',
    ),
    expiresIn: 3600,
    externalReference: 'ref_001',
    metadata: ['orderId' => 'order_001'],
);

$response = $connector->send($request);

print_r($response->json());
```

---

#### Criar cobrança PIX com Customer Id

[](#criar-cobrança-pix-com-customer-id)

```
use MountBit\PagueDev\Requests\Pix\Dynamic\Create as CreatePix;
use MountBit\PagueDev\Dtos\Pix\Customer;

$request = new CreatePix(
    amount: 100.50,
    description: 'Pagamento PIX',
    projectId: 'proj_123',
    customerId: 'customer_123',
    expiresIn: 3600,
    externalReference: 'ref_001',
    metadata: ['orderId' => 'order_001'],
);

$response = $connector->send($request);

print_r($response->json());
```

---

#### Gerar QR Code a partir de cobrança PIX (Estático ou Dinâmico)

[](#gerar-qr-code-a-partir-de-cobrança-pix-estático-ou-dinâmico)

```
use MountBit\PagueDev\Requests\Pix\Dynamic\Create as CreatePixRequest;
use MountBit\PagueDev\Responses\Pix\Dynamic\Create as CreatePixResponse;
// ou
// use MountBit\PagueDev\Requests\Pix\Static\Create as CreatePixRequest;
// use MountBit\PagueDev\Responses\Pix\Static\Create as CreatePixResponse;

$request = new CreatePixRequest(
    ...dados
);

/** @var CreatePixResponse $response **/
$response = $connector->send($request);

echo '';
```

---

### 💳 Cobranças (Links de pagamento)

[](#-cobranças-links-de-pagamento)

#### Criar cobrança

[](#criar-cobrança)

```
use MountBit\PagueDev\Requests\Charges\Create as CreateCharge;

$request = new CreateCharge(
    projectId: 'proj_123',
    name: 'Cobrança teste',
    amount: 150.0,
    paymentMethods: ['pix'],
    customerId: null,
    allowCoupons: true
);

$response = $connector->send($request);

print_r($response->json());
```

#### Buscar cobrança por ID

[](#buscar-cobrança-por-id)

```
use MountBit\PagueDev\Requests\Charges\GetById;

$request = new GetById(id: 'charge_123');

$response = $connector->send($request);

print_r($response->json());
```

#### Listar cobranças

[](#listar-cobranças)

```
use MountBit\PagueDev\Requests\Charges\GetList;

$request = new GetList(page: 1, limit: 10, search: 'teste');

$response = $connector->send($request);

print_r($response->json());
```

---

### 👤 Clientes

[](#-clientes)

#### Criar cliente

[](#criar-cliente)

```
use MountBit\PagueDev\Requests\Customers\Create as CreateCustomer;

$request = new CreateCustomer(
    name: 'Maria Silva',
    document: '12345678900',
    email: 'maria@example.com',
    phone: '+551199999999'
);

$response = $connector->send($request);

print_r($response->json());
```

#### Listar clientes

[](#listar-clientes)

```
use MountBit\PagueDev\Requests\Customers\GetList as GetCustomersList;

$request = new GetCustomersList(page: 1, limit: 10, search: 'Maria');

$response = $connector->send($request);

print_r($response->json());
```

---

### 🗂️ Projetos

[](#️-projetos)

#### Criar projeto

[](#criar-projeto)

```
use MountBit\PagueDev\Requests\Projects\Create as CreateProject;

$request = new CreateProject(
    name: 'Projeto Teste',
    color: '#FF0000',
    description: 'Projeto de exemplo',
    logoUrl: 'https://example.com/logo.png'
);

$response = $connector->send($request);

print_r($response->json());
```

#### Listar projetos

[](#listar-projetos)

```
use MountBit\PagueDev\Requests\Projects\GetList as GetProjectsList;

$request = new GetProjectsList(page: 1, limit: 10, search: 'Teste');

$response = $connector->send($request);

print_r($response->json());
```

---

### 📊 Transações

[](#-transações)

#### Buscar transação por ID

[](#buscar-transação-por-id)

```
use MountBit\PagueDev\Requests\Transactions\GetById as GetTransactionById;

$request = new GetTransactionById(id: 'txn_123');

$response = $connector->send($request);

print_r($response->json());
```

---

### 📊 Métricas

[](#-métricas)

#### Buscar métricas da conta

[](#buscar-métricas-da-conta)

```
use MountBit\PagueDev\Requests\Metrics\GetList as GetMetricsList;

$request = new GetMetricsList();

$response = $connector->send($request);

print_r($response->json());
```

---

### ➕ Saques

[](#-saques)

#### Criar saque com campos inline

[](#criar-saque-com-campos-inline)

```
use MountBit\PagueDev\Requests\Withdrawals\Create as CreateWithdraw;

$request = new CreateWithdraw(
    amount: 5.0,
    pixKey: 'teste@teste.com.br',
    pixKeyType: 'email',
    holderName: 'Teste Silva',
    holderDocument: '12345678901',
    holderDocumentType: 'cpf',
);

$response = $connector->send($request);

print_r($response->json());
```

#### Criar saque com bankAccountId

[](#criar-saque-com-bankaccountid)

```
use MountBit\PagueDev\Requests\Withdrawals\Create as CreateWithdraw;

$request = new CreateWithdraw(
    amount: 5.0,
    bankAccountId: 'ID_DA_CONTA_BANCARIA',
);

$response = $connector->send($request);

print_r($response->json());
```

---

### 🔔 Webhooks

[](#-webhooks)

O SDK fornece utilitários para **verificar e parsear eventos de webhook** com segurança.

#### Estrutura de um WebhookEvent

[](#estrutura-de-um-webhookevent)

```
use MountBit\PagueDev\Dtos\WebhookEvent;

$event = new WebhookEvent(
    event: 'payment_completed',
    eventId: 'a0b78f10-c7f4-4f5d-98dd-3e36eafeb812',
    timestamp: '2026-01-11T19:03:28.280Z',
    data: [
        'amount' => 150.0,
        'customerId' => 'cust_123'
    ]
);
```

#### Parsear Webhook recebido

[](#parsear-webhook-recebido)

```
use MountBit\PagueDev\Utils;
use MountBit\PagueDev\Exceptions\InvalidSignature;
use MountBit\PagueDev\Exceptions\InvalidWebhook;

$rawBody = file_get_contents('php://input'); // corpo completo em formato puro
$signatureHeader = $_SERVER['HTTP_X_SIGNATURE'] ?? '';
$webhookSecret = 'sua_chave_secreta';

try {
    $webhookEvent = Utils::getInstance()->parseWebhook(
        $rawBody,
        $signatureHeader,
        $webhookSecret,
        shouldThrow: true,            // lança exceção se inválido
        shouldValidateEventType: true // valida tipos de evento
    );

    // Processar o evento
    if ($webhookEvent->event === 'payment_completed') {
        // lógica para pagamento concluído
    }

} catch (InvalidSignature $e) {
    echo 'Assinatura inválida';
} catch (InvalidWebhook $e) {
    echo 'Webhook inválido';
}
```

---

🧪 Testes
--------

[](#-testes)

Use **Saloon MockClient** e fixtures JSON para validar requisições e respostas:

```
composer test
```

---

📄 Documentação da API
---------------------

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

Detalhes completos dos endpoints, parâmetros e respostas estão disponíveis em:

---

🛡️ Autenticação
---------------

[](#️-autenticação)

Todas as chamadas exigem uma **API Key** no header:

```
X-API-Key: sua_api_key

```

---

📦 Requisitos
------------

[](#-requisitos)

- PHP 8.4+
- Composer

---

👥 Contribuições
---------------

[](#-contribuições)

Contribuições são bem-vindas! Para adicionar novas features ou corrigir bugs:

1. Faça um fork do repositório
2. Crie um branch para sua feature e/ou correção
3. Abra um Pull Request

---

📝 Licença
---------

[](#-licença)

Este projeto está licenciado sob a licença **MIT**.

###  Health Score

41

—

FairBetter than 87% of packages

Maintenance75

Regular maintenance activity

Popularity9

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 97.8% 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 ~2 days

Total

11

Last Release

175d ago

Major Versions

v1.7.0 → v2.0.02026-02-24

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/13210429?v=4)[Gianluca Bine](/maintainers/Pr3d4dor)[@Pr3d4dor](https://github.com/Pr3d4dor)

---

Top Contributors

[![Pr3d4dor](https://avatars.githubusercontent.com/u/13210429?v=4)](https://github.com/Pr3d4dor "Pr3d4dor (45 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")

---

Tags

MountBitpague-dev-php-sdk

###  Code Quality

TestsPHPUnit

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/mountbit-pague-dev-php-sdk/health.svg)

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

###  Alternatives

[filament/filament

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

3932.5M4.3k](/packages/filament-filament)[eduardokum/laravel-boleto

Biblioteca com boletos para o laravel

630386.5k2](/packages/eduardokum-laravel-boleto)[abydahana/aksara

Aksara is a modern, developer-friendly framework and CMS built on CodeIgniter 4, featuring rapid CRUD development, modular architecture, smart routing, flexible access control, API integration, and an AI assistant to make content management faster and smarter.

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

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

145.9k25](/packages/skeeks-cms-shop)[doppar/framework

The Doppar Framework

4112.6k14](/packages/doppar-framework)[whatsdiff/whatsdiff

See what's changed in your project's dependencies

761.4k](/packages/whatsdiff-whatsdiff)

PHPackages © 2026

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