Esta documentação cobre somente a API pública autenticada com chave de API:
X-API-Key: gp_live_SUA_CHAVE
Content-Type: application/json
Authorization: Bearer gp_live_... ainda é aceito por compatibilidade. Prefira X-API-Key em integrações novas.
Rotas por módulo
Base URL de produção: https://api.goatpay.com.br/v1 (todas as rotas abaixo são relativas a esse prefixo).
| Recurso | Prefixo /v1 | Uso |
|---|
| Receber PIX | payment-pix/* | QR Code dinâmico |
| Enviar PIX | transfer-pix/* | Saque para chave ou BR Code |
| Transferências programadas | transfer-scheduled/* | Agendar, repetir ou por saldo — guia |
| Saque (alias) | payouts/* | Mesmo que transfer-pix/* |
| Reembolso PIX | refunds/* | Estorno de depósito (trilho PADRAO) |
| Transferência interna | transfer-internal/* | Entre contas por e-mail GoatPay |
| Cripto | payment-crypto/*, transfer-crypto/*, transfer-crypto-auto/create | Depósito, saque, cotação |
| Conta | account/balance, account/transactions | Saldo e extrato |
| MED | meds/* | Disputas e evidências |
| Webhooks | webhooks/* | Cadastro de URL de eventos |
| Loja | — | Visão geral loja |
| Clientes | customers/* | CRM — guia |
| Produtos | products/* | Catálogo — guia |
| Cupons | coupons/* | Descontos — guia |
| Links de pagamento | payment-links/* | Checkout + cartão Stripe — guia |
| Cartão Connect | stripe/onboarding-link, card/checkout, card/get, payments/:id/refund | guia |
| Subcontas | subaccount/* | Carteiras lógicas — guia |
Cobranças avulsas (billings), assinaturas, PIX Pay, PIX automático, recarga e bureau seguem em expansão da documentação; links de pagamento e cartão Stripe Connect já estão na API v1.
Nomes para não confundir
| Nome na doc | Rota | O que é |
|---|
| Receber PIX | POST /v1/payment-pix/create | QR Code |
| Enviar PIX | POST /v1/transfer-pix/create | Saída PIX |
| Reembolso | POST /v1/refunds/create | Devolução de depósito recebido |
| Depósito cripto | POST /v1/payment-crypto/create | Endereço on-chain |
| PIX na subconta | POST /v1/payment-pix/create + subaccountId | Crédito na subconta |
| Link pago | Webhook payment_link.paid | Checkout de link confirmado |
Trilho PADRAO e LIVRE
O trilho é definido na chave de API ao criá-la. Não envie pixRail no body.
| Trilho | Uso |
|---|
PADRAO | Conta verificada; reembolso PIX e MED no SPI |
LIVRE | PIX simplificado; subset de permissões na chave |
Próximo passo
Criar chave e primeira requisição 