Documentation Index
Fetch the complete documentation index at: https://docs.paybridge.dev/llms.txt
Use this file to discover all available pages before exploring further.
Bem-vindo
A API Paybridge permite integrar pagamentos PIX em suas aplicações de forma simples e segura.
URL Base
https://api.paybridge.dev/v1
Autenticação
Todas as requisições devem incluir o header X-API-Key com uma API Key válida.
curl -X POST https://api.paybridge.dev/v1/payments \
-H "X-API-Key: pk_test_sua_api_key" \
-H "Content-Type: application/json"
Tipos de API Key
| Tipo | Prefixo | Descrição |
|---|
| Teste | pk_test_* | Pagamentos em sandbox, sem transações reais |
| Produção | pk_live_* | Pagamentos reais processados no PSP |
Rate Limiting
As requisições são limitadas a 100 por minuto por API Key.
Recursos Disponíveis
Criar Pagamento
Crie cobranças PIX com QR Code
Consultar Pagamento
Consulte o status de um pagamento
Webhooks
Receba notificações de eventos
Fluxo de Integração
Exemplo Rápido
curl -X POST https://api.paybridge.dev/v1/payments \
-H "X-API-Key: pk_test_sua_api_key" \
-H "Content-Type: application/json" \
-d '{
"amount": 10.00,
"description": "Pedido #123",
"externalId": "pedido-123",
"payer": {
"name": "João Silva",
"document": "12345678900",
"email": "joao@email.com"
}
}'
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"amount": 10.00,
"currency": "BRL",
"status": "pending",
"pixCopyPaste": "00020126580014br.gov.bcb.pix...",
"pixQrCodeBase64": "data:image/png;base64,...",
"expiresAt": "2026-01-28T15:30:00.000Z",
"createdAt": "2026-01-28T15:00:00.000Z",
"isTest": true
}
