Download the PHP package basementdevs/abacatepay-php-sdk without Composer
On this page you can find all versions of the php package basementdevs/abacatepay-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download basementdevs/abacatepay-php-sdk
More information about basementdevs/abacatepay-php-sdk
Files in basementdevs/abacatepay-php-sdk
Download basementdevs/abacatepay-php-sdk
More information about basementdevs/abacatepay-php-sdk
Files in basementdevs/abacatepay-php-sdk
Vendor basementdevs
Package abacatepay-php-sdk
Short Description AbacatePay PHP SDK Client
License MIT
Package abacatepay-php-sdk
Short Description AbacatePay PHP SDK Client
License MIT
Please rate this library. Is it a good library?
Informations about the package 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
- PHP 8.3 ou maior
- Composer
- Conta na AbacatePay
- API Token válido
Instalação
Features
| Categoria | Funcionalidade | Status |
|---|---|---|
| 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
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
- 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
Sem builder:
Com builder:
Exemplos de Uso
Criar Produto e Cobrança
Criar Cliente
Criar QR Code Pix
Criar Saque Pix
Por que usar Builders?
| Benefício | Descriçã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
| Builder | Classe gerada | Descriçã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
| Comando | Descriçã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
| Código | Exceção | Descrição |
|---|---|---|
| 401 | AbacatePayException::unauthorized() |
Token inválido ou ausente. |
Contribuição
- Faça fork do repositório
- Crie um branch:
git checkout -b feature/nova-funcionalidade -
Rode os testes com Pest:
- Envie um Pull Request.
Suporte
- Abra uma issue no repositório para dúvidas ou bugs
- Suporte técnico: [email protected]
- Casos urgentes: entre em contato com o time AbacatePay
All versions of abacatepay-php-sdk with dependencies
PHP Build Version
Package Version
The package basementdevs/abacatepay-php-sdk contains the following files
Loading the files please wait ...