AbacatePay HTTP

Coleção oficial de requisições HTTP da AbacatePay para testar, integrar e entender a API de forma simples, transparente e sem abstrações.

Este repositório fornece exemplos reais da API da AbacatePay nos formatos .http, compatíveis com VS Code, JetBrains IDEs, Insomnia e qualquer ferramenta que suporte HTTP bruto.

Você pode encontrar a documentação completa da API aqui.

Requisitos

Você pode usar qualquer uma das opções abaixo:

• VS Code + extensão REST Client
• JetBrains IDEs (WebStorm, GoLand, IntelliJ, etc.)
• Insomnia
• Qualquer cliente HTTP compatível com variáveis

Configuração

Crie (ou edite) um arquivo de environment dentro da versão desejada.

Exemplo, v1/environments/prod.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 da sua IDE.

Por 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 para simular webhooks localmente.

### 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"
}

Quando usar este repositório?

Use este repo se você:

• Prefere HTTP cru ao invés de SDK
• Quer entender a API sem abstrações
• Precisa debugar requests/responses reais
• Quer exemplos executáveis versionáveis

Se preferir um wrapper de alto nível, veja também: @abacatepay/sdk

Estrutura do repositório

As requisições são organizadas por versão da API, respeitando os limites e diferenças entre cada uma.

├─ v1/
│  ├─ billing.http
│  ├─ pix.http
│  ├─ payout.http
│  ├─ webhook.http
│  └─ ...
│
├─ v2/
│  ├─ checkout.http
│  ├─ pix.http
│  ├─ payout.http
│  ├─ webhook.http
│  └─ ...
│
└─ .env
└─ README.md

Cada pasta representa uma versão isolada da API. Sem misturar v1 com v2.

Feito com 🥑 pela equipe AbacatePay
Open source, de verdade.