Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abacatepay.com/llms.txt

Use this file to discover all available pages before exploring further.

AbacatePay PHP SDK

Repositório oficial — issues, changelog e contribuições.

​
Pré-requisitos

  • PHP 7.2.5+ e Composer
  • SSL habilitado em produção
  • Uma chave de API (criar no dashboard)

​
Instalação

composer require abacatepay/php-sdk

​
Configuração

Armazene sua chave de API em uma variável de ambiente e nunca no código: 
use AbacatePay\Clients\Client;

Client::setToken($_ENV['ABACATEPAY_API_KEY']);

​
Primeira cobrança

use AbacatePay\Clients\BillingClient;
use AbacatePay\Resources\Billing;
use AbacatePay\Resources\Billing\Product;
use AbacatePay\Resources\Billing\Metadata as BillingMetadata;
use AbacatePay\Enums\Billing\Methods;
use AbacatePay\Enums\Billing\Frequencies;

$billingClient = new BillingClient();

$billing = $billingClient->create(new Billing([
    'frequency' => Frequencies::ONE_TIME,
    'methods'   => [Methods::PIX],
    'products'  => [
        new Product([
            'external_id' => 'PRO-PLAN',
            'name'        => 'Pro plan',
            'quantity'    => 1,
            'price'       => 1000, // em centavos
        ])
    ],
    'metadata' => new BillingMetadata([
        'return_url'     => 'https://meusite.com/app',
        'completion_url' => 'https://meusite.com/pagamento/sucesso',
    ]),
]));

echo $billing->url; // URL de pagamento para o cliente
Resposta: 
{
  "success": true,
  "error": null,
  "data": {
    "id": "bill_12345667",
    "url": "https://app.abacatepay.com/pay/bill_12345667",
    "amount": 1000,
    "status": "PENDING",
    "devMode": true,
    "createdAt": "2024-11-04T18:38:28.573Z"
  }
}

​
Próximos passos

Configurar webhooks

Receba notificações em tempo real sobre pagamentos confirmados.

Checkout Transparente

Aceite PIX e cartão diretamente na sua interface.

Criar clientes

Gerencie clientes vinculados às cobranças.

Referência completa

Todos os endpoints, status codes e formato de resposta.