Rotas da API pública

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

O header Authorization: Bearer gp_live_... ainda é aceito por compatibilidade. Prefira X-API-Key em integrações novas. Integrações OAuth de terceiros usam o protocolo na raiz da API (/oauth/*) e acessam /v1/* com bearer gp_oat_.... Veja o guia OAuth e GET /v1/me. Gestão de apps: /v1/oauth-apps/* com API key — guia. OAuth não cobre cripto, loja (customers, products, payment-links), cobranças recorrentes (billings, subscriptions) nem subcontas — use API key da própria conta para esses módulos.

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
Apps OAuth	`oauth-apps/*`	CRUD de apps, credenciais e autorizações — guia
Loja	—	Visão geral loja
Clientes	`customers/*`	Pagadores — loja · cobranças
Produtos	`products/*`	Catálogo — guia
Cupons	`coupons/*`	Descontos — guia
Links de pagamento	`payment-links/*`	Checkout PIX e cripto — guia
Cobranças avulsas	`billings/*`	Pagamento único (boleto, cartão, PIX) — guia
Assinaturas	`subscriptions/*`	Recorrência com ciclo fixo — guia
PIX automático	`pix-automatic/*`	Débito recorrente com consentimento — guia
Recarga móvel	`mobile-recharge/*`	Recarga pré-paga — guia
Bureau de crédito	`serasa/*`	Negativação e relatórios — guia
Subcontas	`subaccount/*`	Carteiras lógicas — guia

Cobrança avulsa × assinatura

	Cobrança avulsa	Assinatura
Prefixo	`billings/*`	`subscriptions/*`
Uso	Um pagamento	Cobrança automática a cada ciclo
Criar	`POST /billings/create`	`POST /subscriptions/create`

Receber PIX direto continua em payment-pix/*, independente de billings.

Nomes para não confundir

Nome na doc	Rota	O que é
Receber PIX	`POST /v1/payment-pix/create`	QR Code dinâmico
Enviar PIX	`POST /v1/transfer-pix/create`	Saída PIX
Pagar contas	`POST /v1/transfer-pix/create` + `pixCopyPaste`	Guia
Cobrança avulsa	`POST /v1/billings/create`	Boleto, cartão ou PIX (pagamento único)
Assinatura	`POST /v1/subscriptions/create`	Plano recorrente (mensal, etc.)
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

O trilho PADRAO é o único trilho da API pública. Não envie pixRail no body.

Trilho	Uso
`PADRAO`	Conta verificada (CPF ou CNPJ); PIX regulado; cobranças; reembolso PIX e MED no SPI

Próximo passo

Criar chave e primeira requisição

Começar

Integração

Tutoriais

Ajuda

Rotas da API pública

Rotas por módulo

Cobrança avulsa × assinatura

Nomes para não confundir

Trilho PADRAO

Próximo passo

​Rotas por módulo

​Cobrança avulsa × assinatura

​Nomes para não confundir

​Trilho PADRAO

​Próximo passo

Rotas por módulo

Cobrança avulsa × assinatura

Nomes para não confundir

Trilho PADRAO

Próximo passo