API Reference

Autenticação

Todas as chamadas autenticadas usam o header Authorization: Bearer <token>. O token pode ser um JWT (obtido via login) ou uma API Key (bp_...).

curl -H "Authorization: Bearer bp_sua_api_key" \
  https://a.bridgepay.site/api/v1/payments

Auth

Pagamentos

Transacções

Checkouts

Links de pagamento personalizados. Crie um checkout e partilhe o URL com o seu cliente.

Payouts

Planos & Subscrição

Configurações

Webhooks

O BridgePay envia notificações HTTP POST para o webhook_url configurado quando o estado de um pagamento muda.

// Payload enviado ao seu webhook:
{
  "event": "payment.completed",
  "data": {
    "transaction_id": "uuid",
    "bridgepay_ref": "BP-abc123",
    "amount": 500.00,
    "status": "completed",
    "method": "mpesa",
    "completed_at": "2026-01-01T00:05:00Z"
  },
  "timestamp": "2026-01-01T00:05:00Z"
}

// Headers:
// X-BridgePay-Signature: hmac_sha256_do_payload
// Content-Type: application/json

Valide a assinatura comparando o HMAC-SHA256 do body com o seu webhook_secret.

Códigos de Estado