Skip to main content
A API pública GoatPay cobre receber e enviar PIX, cripto, transferência interna, saldo e extrato, disputas MED, webhooks e subcontas (quando habilitadas).

​
Base URL

https://api.goatpay.com.br/v1

​
Autenticação (API key)

Crie a chave no dashboard: Integrações → Chaves de API. Envie em todas as requisições: 
X-API-Key: gp_live_SUA_CHAVE
Content-Type: application/json
Authorization: Bearer gp_live_... ainda é aceito, mas use X-API-Key em integrações novas.
Sem chave válida: 401. Sem permissão na rota: 403.

​
Envelope de resposta

Sucesso: 
{
  "success": true,
  "message": "Pagamento PIX criado com sucesso",
  "data": {},
  "requestId": "req_..."
}
Erro (rotas /v1/*): 
{
  "success": false,
  "message": "Mensagem para integração",
  "error": {
    "code": "Bad Request",
    "statusCode": 400
  },
  "requestId": "req_..."
}
Valores monetários são em reais (100 = R$ 100,00). Use externalReference no body quando precisar correlacionar cobranças com o ID do seu sistema.

​
Campos na resposta

A API pública retorna apenas dados úteis para integração. Não são expostos: identificadores internos de conta, nome de processador de pagamento, status bruto do PSP, trilho da chave, metadados técnicos nem histórico operacional de webhooks na listagem. Em transações PIX, referenceId (quando existir) substitui o ID técnico do processador.

​
Rate limiting

100 requisições por minuto por API key. Veja Rate limiting. Erros HTTP e requestId: Erros e códigos.

​
Mapa rápido

Rotas da API

Todos os prefixos /v1

Loja (vendas)

Clientes, produtos, cupons e links

Criar cobrança PIX

Primeiro QR Code

Chave de API

Tutorial passo a passo

Webhooks

Eventos e assinatura HMAC