Criar a chave
Crie a chave no painel da conta em Integrações → Chaves de API (app.goatpay.com.br). A integração server-to-server usa apenas o header abaixo, não sessão de usuário.
Defina descrição, escopo (read, write, full), permissões por rota e trilho PADRAO ou LIVRE.
O secret gp_live_... aparece uma vez. Guarde em variável de ambiente.
Não existe chave sandbox separada. Todas as chaves são de produção; teste com valores baixos.
Usar na requisição
curl https://api.goatpay.com.br/v1/account/balance \
-H "X-API-Key: gp_live_SUA_CHAVE"
Permissões
Lista completa com todas as rotas: Permissões da API key.
Resumo dos grupos principais: PIX (payment-pix/*, transfer-pix/*, payouts/*), cripto, transferência interna, reembolsos, conta, MED, webhooks, subcontas, Conta Padrão PJ (clientes, cobranças, assinaturas, boleto, PIX Pay, PIX automático, recarga, bureau).
Trilho PADRAO e LIVRE
Cada chave de API é criada para um trilho (PADRAO ou LIVRE). Operações de PIX, transferência interna e cripto usam automaticamente o saldo desse trilho — não envie pixRail no body.
Documentação das rotas
API Reference com exemplos de request e response em cada endpoint.