Skip to main content
Recursos da loja no dashboard GoatPay, expostos na API pública v1 com chave gp_live_....

​
Base URL e autenticação

Todas as rotas abaixo usam o prefixo: 
https://api.goatpay.com.br/v1

curl 'https://api.goatpay.com.br/v1/products/list' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'
O trilho (PADRÃO / LIVRE) vem da API key, não do body. Respostas seguem o envelope padrão.

​
Módulos

RecursoPrefixo /v1Guia
Clientes/customers/*Clientes
Produtos/products/*Produtos
Cupons/coupons/*Cupons
Links/payment-links/*Links de pagamento

​
Permissões na API key

Ative na criação da chave (dashboard → Integrações):
GrupoPermissões
Clientescustomers/create, get, list, update, delete
Produtosproducts/create, get, list, update, delete
Cuponscoupons/create, get, list, update, delete, validate
Linkspayment-links/create, get, list, update, delete, checkout, sessions/get
Lista completa: Permissões · Mapa geral: Rotas da API.

​
Fluxo típico de venda

  1. Cadastre produto (opcional) e link com allowedMethods (PIX, BOLETO, CRYPTO, CARD).
  2. Opcional: POST /v1/coupons/validate e depois couponCode no checkout.
  3. POST /v1/payment-links/checkout → redirecione o cliente (stripeCheckoutUrl ou payCheckoutUrl).
  4. Confirme com webhook payment_link.paid ou GET /v1/payment-links/sessions/get/:sessionId.

​
Endpoints por recurso

​
Clientes

MétodoRota completa
POSThttps://api.goatpay.com.br/v1/customers/create
GET.../customers/get/:id
GET.../customers/list
PATCH.../customers/update/:id
DELETE.../customers/delete/:id

​
Produtos

MétodoRota completa
POST.../products/create
GET.../products/get/:id
GET.../products/list
PATCH.../products/update/:id
DELETE.../products/delete/:id

​
Cupons

MétodoRota completa
POST.../coupons/create
GET.../coupons/get/:id
GET.../coupons/list
PATCH.../coupons/update/:id
DELETE.../coupons/delete/:id
POST.../coupons/validate
MétodoRota completa
POST.../payment-links/create
GET.../payment-links/get/:id
GET.../payment-links/list
PATCH.../payment-links/update/:id
PATCH.../payment-links/status/:id
DELETE.../payment-links/delete/:id
POST.../payment-links/checkout
GET.../payment-links/sessions/get/:sessionId

Criar cliente

POST /v1/customers/create

Criar link

POST /v1/payment-links/create