Skip to main content
A AbacatePay HTTP é a coleção oficial de requisições HTTP cruas da AbacatePay, feita para quem quer entender exatamente o que acontece na API, sem camadas mágicas ou SDKs no meio. Ideal para debug, aprendizado, testes manuais e integrações customizadas, usando arquivos .http executáveis diretamente na sua IDE ou cliente favorito.

Principais Capacidades

HTTP puro

Requisições reais, sem abstrações ou helpers ocultos.

Versionado

Exemplos separados por versão da API (v1 e v2).

Executável

Rode requests direto do editor com um clique.

Webhooks

Simulação local de eventos reais da plataforma.

Ambientes

Variáveis via .env para alternar entre prod, sandbox e local.

Debug & Aprendizado

Veja headers, payloads e responses completos.

Requisitos

Você pode usar qualquer ferramenta que suporte HTTP bruto com variáveis:
  • Insomnia
  • VS Code + extensão REST Client
  • Qualquer cliente HTTP compatível com .env
  • JetBrains IDEs (WebStorm, GoLand, IntelliJ, etc.)

Configuração

Crie ou edite o arquivo de environment dentro da versão desejada. Exemplo, .env
API_VERSION=v1
WEBHOOK_SECRET=abc_my_secret
ABACATEPAY_API_KEY=abc_prod_xxx
BASE_URL=https://api.abacatepay.com
BASE_WEBHOOK_URL=http://localhost:3000

Uso Básico

Abra qualquer arquivo .http e execute a requisição diretamente pela sua IDE. Exemplo, criar um QRCode PIX na v1
### Create QRCode PIX
POST {{$dotenv .env BASE_URL}}/{{$dotenv .env API_VERSION}}/pixQrCode/create

Content-Type: application/json
Authorization: Bearer {{$dotenv .env ABACATEPAY_API_KEY}}

{
  "amount": 1000
}

Webhooks

Os arquivos .http também incluem exemplos completos para simular webhooks localmente, facilitando testes sem depender de eventos reais.
### Simular webhook billing.paid
POST {{$dotenv .env BASE_WEBHOOK_URL}}/webhooks/abacatepay?webhookSecret={{$dotenv .env WEBHOOK_SECRET}}

X-Webhook-Signature: ...

{
  "id": "log_12345abcdef",
  "data": {
    "payment": {
      "amount": 1000,
      "fee": 80,
      "method": "PIX"
    },
    "pixQrCode": {
      "amount": 1000,
      "id": "pix_char_mXTWdj6sABWnc4uL2Rh1r6tb",
      "kind": "PIX",
      "status": "PAID"
    }
  },
  "devMode": false,
  "event": "billing.paid"
}

Open source de verdade

Mantido pela equipe AbacatePay e pela comunidade. Simples, transparente e sem mágica.