Documentação da API Prumo Pay

Crie cobranças Pix, consulte status e saldo direto da sua operação — checkout, oferta, bot ou sistema próprio. Base: https://api.prumopay.com

Autenticação

Gere uma chave em Painel → API & Integrações e envie no header de toda requisição. Use a chave de teste no sandbox e a de produção quando for pra valer.

Authorization: Bearer pp_live_sua_chave

Criar uma cobrança Pix

POST /v1/charges — valor em centavos. Retorna o Pix copia-e-cola e um link de pagamento pronto.

curl -X POST https://api.prumopay.com/v1/charges \
  -H "Authorization: Bearer pp_live_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 9990,
    "description": "Mentoria Tráfego Pago",
    "customer": { "name": "Maria Silva", "document": "12345678900" }
  }'

// resposta
{
  "id": "ch_9f2k7x",
  "status": "pending",
  "amount": 9990,
  "currency": "BRL",
  "pix": { "qr_code": "00020126…br.gov.bcb…" },
  "payment_link": "https://prumopay.com/pay/ch_9f2k7x"
}

Consultar o status

GET /v1/charges/:id — status: pending, paid, expired, refunded.

curl https://api.prumopay.com/v1/charges/ch_9f2k7x \
  -H "Authorization: Bearer pp_live_sua_chave"

{ "id": "ch_9f2k7x", "status": "paid", "amount": 9990, "paid_at": "…" }

Saldo

GET /v1/balance — saldo disponível, em centavos.

curl https://api.prumopay.com/v1/balance \
  -H "Authorization: Bearer pp_live_sua_chave"

{ "available": 152340, "currency": "BRL" }

Webhook

Configure a URL do seu sistema no painel. A cada mudança de status a gente chama seu endpoint (evento charge.paid etc.), com retentativa por 24h e assinatura HMAC. Responda 200 rápido.

Erros

Respostas de erro vêm com status HTTP adequado e um corpo { "error": "mensagem" }. 401 = chave inválida · 422 = dados inválidos · 429 = rate limit.