PHPackages                             basementdevs/abacatepay-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. basementdevs/abacatepay-php-sdk

ActiveLibrary[Payment Processing](/categories/payments)

basementdevs/abacatepay-php-sdk
===============================

AbacatePay PHP SDK Client

1.1.0(8mo ago)8145↓92.9%[1 PRs](https://github.com/basementdevs/abacatepay-php-sdk/pulls)MITPHPPHP ^8.3

Since Oct 27Pushed 8mo agoCompare

[ Source](https://github.com/basementdevs/abacatepay-php-sdk)[ Packagist](https://packagist.org/packages/basementdevs/abacatepay-php-sdk)[ RSS](/packages/basementdevs-abacatepay-php-sdk/feed)WikiDiscussions 1.x Synced yesterday

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

AbacatePay PHP SDK
==================

[](#abacatepay-php-sdk)

SDK para integração com a **API AbacatePay**. Permite gerenciar clientes, cobranças, QR Codes Pix e saques de forma simples e fluente usando PHP moderno.

---

Requisitos
----------

[](#requisitos)

- PHP 8.3 ou maior
- Composer
- Conta na AbacatePay
- API Token válido

---

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

[](#instalação)

```
composer require basementdevs/abacatepay-php-sdk
```

---

Features
--------

[](#features)

CategoriaFuncionalidadeStatus**Clientes**Criar novo cliente✅Listar clientes✅**Cobranças**Criar nova cobrança✅Listar cobranças✅**Pix**Criar QR Code Pix✅Consultar status de pagamento do QR Code Pix✅**Cupons**Criar novo cupom✅Listar cupons✅**Saques**Criar novo saque✅Buscar saque por ID externo✅Listar saques✅---

Builders
--------

[](#builders)

O SDK utiliza o **padrão Builder** para tornar a criação de requisições mais fluente, segura e legível. Em vez de instanciar objetos manualmente com longas listas de parâmetros, o *builder* permite construir o objeto passo a passo e valida automaticamente campos obrigatórios antes do envio.

### Motivação

[](#motivação)

- **Legibilidade:** o código descreve claramente o que está sendo criado.
- **Segurança:** evita instâncias inválidas de requisições (campos obrigatórios ausentes).
- **Consistência:** todos os tipos de requisição seguem a mesma interface fluente (`::builder()` + `->build()`).
- **Extensibilidade:** fácil adicionar novos campos ou validações sem quebrar código existente.

### Exemplo comparativo

[](#exemplo-comparativo)

Sem builder:

```
$request = new CreatePixQrCodeRequest(
    10000, 3600, 'Pagamento de assinatura',
    new PixCustomerRequest('Maria', '+55...', 'maria@email.com', '123'),
    new PixMetadataRequest('order-abc-123')
);
```

Com builder:

```
$pixQr = CreatePixQrCodeRequest::builder()
    ->amount(10000)
    ->expiresIn(3600)
    ->description('Pagamento de assinatura')
    ->customer(
        PixCustomerRequest::builder()
            ->name('Maria Oliveira')
            ->cellphone('+5511988887777')
            ->email('maria@email.com')
            ->taxId('12345678900')
            ->build()
    )
    ->metadata(
        PixMetadataRequest::builder()
            ->externalId('order-abc-123')
            ->build()
    )
    ->build();
```

---

Exemplos de Uso
---------------

[](#exemplos-de-uso)

### Criar Produto e Cobrança

[](#criar-produto-e-cobrança)

```
$client = new AbacatePayClient('test_key');

$product = ProductRequest::builder()
    ->externalId('prod-123')
    ->name('Garrafa Térmica 500ml')
    ->description('Mantém bebidas quentes ou frias por até 8h')
    ->quantity(2)
    ->price(8900)
    ->build();

$response = $client->billing()
    ->create(
        CreateBillingRequest::multipleTimes()
            ->creditCard()
            ->completionUrl('https://exemplo.com/sucesso')
            ->returnUrl('https://exemplo.com/retorno')
            ->forCustomerId('cust_abc123')
            ->externalId('billing-001')
            ->addProduct($product)
            ->build()
    );
```

---

### Criar Cliente

[](#criar-cliente)

```
$createCustomer = CreateCustomerRequest::builder()
    ->name('João Silva')
    ->cellphone('+5511999999999')
    ->email('joao@email.com')
    ->taxId('12345678900')
    ->build();

$response = $client->customers()->create($createCustomer);
```

---

### Criar QR Code Pix

[](#criar-qr-code-pix)

```
$pixCustomer = PixCustomerRequest::builder()
    ->name('Maria Oliveira')
    ->cellphone('+5511988887777')
    ->email('maria@email.com')
    ->taxId('12345678900')
    ->build();

$metadata = PixMetadataRequest::builder()
    ->externalId('order-abc-123')
    ->build();

$pixQr = CreatePixQrCodeRequest::builder()
    ->amount(10000)
    ->expiresIn(3600)
    ->description('Pagamento de assinatura')
    ->customer($pixCustomer)
    ->metadata($metadata)
    ->build();

$response = $client->pix()->createQrCode($pixQr);
```

---

### Criar Saque Pix

[](#criar-saque-pix)

```
$pix = WithdrawPixRequest::builder()
    ->type(WithdrawPixTypeEnum::Email)
    ->key('user@email.com')
    ->build();

$request = CreateWithdrawRequest::builder()
    ->externalId('withdraw-001')
    ->method(WithdrawMethodsEnum::Pix)
    ->amount(15000)
    ->pix($pix)
    ->description('Saque de teste')
    ->build();

$response = $client->withdraw()->create($request);
```

---

Por que usar Builders?
----------------------

[](#por-que-usar-builders)

BenefícioDescrição**API fluente**A construção é expressiva e de fácil leitura.**Validação interna**Todos os campos obrigatórios são verificados antes da criação.**Extensão segura**Novos campos podem ser adicionados sem alterar código existente.**Coerência**Todos os recursos (`Billing`, `Pix`, `Withdraw`, `Customer`) seguem o mesmo padrão.### **Lista de Builders Disponíveis**

[](#lista-de-builders-disponíveis)

BuilderClasse geradaDescrição`ProductRequest::builder()``ProductRequest`Cria produtos utilizados em cobranças.`CreateBillingRequest::multipleTimes()` / `CreateBillingRequest::oneTime()``CreateBillingRequest`Cria cobranças únicas ou recorrentes.`CreateCustomerRequest::builder()``CreateCustomerRequest`Cria novos clientes.`CustomerRequest::builder()``CustomerRequest`Representa clientes existentes em cobranças.`PixCustomerRequest::builder()``PixCustomerRequest`Define dados do cliente para pagamentos via Pix.`PixMetadataRequest::builder()``PixMetadataRequest`Define informações adicionais (como `externalId`) para QR Codes Pix.`CreatePixQrCodeRequest::builder()``CreatePixQrCodeRequest`Cria requisições para gerar QR Codes Pix.`WithdrawPixRequest::builder()``WithdrawPixRequest`Define dados da chave Pix para saques.`CreateWithdrawRequest::builder()``CreateWithdrawRequest`Cria requisições para saques via Pix.---

Comandos de Desenvolvimento
---------------------------

[](#comandos-de-desenvolvimento)

ComandoDescrição`make all`Executa Pint, Rector e Pest.`make rector`Analisa e sugere refatorações.`make pint`Formata automaticamente o código.`make test`Executa testes automatizados.`make fix`Corrige código com Pint e Rector.---

Exceções
--------

[](#exceções)

CódigoExceçãoDescrição401`AbacatePayException::unauthorized()`Token inválido ou ausente.---

Contribuição
------------

[](#contribuição)

1. Faça fork do repositório
2. Crie um branch: `git checkout -b feature/nova-funcionalidade`
3. Rode os testes com Pest:

```
make test
```

4. Envie um Pull Request.

---

Suporte
-------

[](#suporte)

- Abra uma **issue** no repositório para dúvidas ou bugs
- Suporte técnico: ****
- Casos urgentes: entre em contato com o **time AbacatePay**

###  Health Score

38

—

LowBetter than 83% of packages

Maintenance61

Regular maintenance activity

Popularity16

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 52.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 ~0 days

Total

4

Last Release

247d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/02c87326bfe0283475a9bd73a12100d564617668fd9fd57eb703ea08f420898e?d=identicon)[DanielHe4rt](/maintainers/DanielHe4rt)

---

Top Contributors

[![Clintonrocha98](https://avatars.githubusercontent.com/u/50300876?v=4)](https://github.com/Clintonrocha98 "Clintonrocha98 (28 commits)")[![gvieira18](https://avatars.githubusercontent.com/u/48625433?v=4)](https://github.com/gvieira18 "gvieira18 (8 commits)")[![RichardGL11](https://avatars.githubusercontent.com/u/100035136?v=4)](https://github.com/RichardGL11 "RichardGL11 (8 commits)")[![danielhe4rt](https://avatars.githubusercontent.com/u/6912596?v=4)](https://github.com/danielhe4rt "danielhe4rt (7 commits)")[![PilsAraujo](https://avatars.githubusercontent.com/u/78178841?v=4)](https://github.com/PilsAraujo "PilsAraujo (2 commits)")

---

Tags

abacatepaypayment-providerphpsdkphpsdkpaymentabacatepay

###  Code Quality

TestsPest

Static AnalysisPHPStan, Rector

Code StyleLaravel Pint

Type Coverage Yes

### Embed Badge

![Health badge](/badges/basementdevs-abacatepay-php-sdk/health.svg)

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

###  Alternatives

[checkout/checkout-sdk-php

Checkout.com SDK for PHP

563.6M13](/packages/checkout-checkout-sdk-php)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

273.0k](/packages/eslazarev-wildberries-sdk)

PHPackages © 2026

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