Documentação API

Introdução

A API Houp Pay segue o padrão REST com respostas em JSON. Use HTTPS e autentique todas as requisições com sua API Key secreta.

Base URL
https://api.houppay.com/v1

Autenticação

Envie sua chave secreta no header Authorization.

curl https://api.houppay.com/v1/charges \
  -H "Authorization: Bearer hk_live_a1b2c3d4..." \
  -H "Content-Type: application/json"

Criar uma cobrança Pix

POST /v1/charges
{
  "amount": 18400,
  "currency": "BRL",
  "payment_method": "pix",
  "customer": {
    "name": "João Silva",
    "tax_id": "111.222.333-44",
    "email": "joao@email.com"
  },
  "description": "Curso Avançado"
}

A resposta inclui o QR code e o código copia-e-cola, com expiração em 30 minutos.

Webhooks

Receba eventos assinados via HMAC SHA-256. Verifique sempre o header X-Houp-Signature.

Eventos suportados:
• charge.created
• charge.paid
• charge.refunded
• subscription.renewed
• payout.completed

Split de pagamento

"splits": [
  { "recipient_id": "rcp_marketplace", "percentage": 85 },
  { "recipient_id": "rcp_afiliado_42", "percentage": 15 }
]

SDKs oficiais

Disponíveis em Node.js, Python, PHP, Go e Ruby. Instale via gerenciador de pacotes nativo.