Skip to main content
Base: https://api.goatpay.com.br/v1/coupons/*

​
Rotas

MétodoRotaPermissãoDocumentação
POST/v1/coupons/createcoupons/createCriar
GET/v1/coupons/get/:idcoupons/getConsultar
GET/v1/coupons/listcoupons/listListar
PATCH/v1/coupons/update/:idcoupons/updateAtualizar
DELETE/v1/coupons/delete/:idcoupons/deleteExcluir
POST/v1/coupons/validatecoupons/validateValidar

​
Tipos de desconto

discountTypeEfeito
PERCENTPercentual sobre o valor
FIXEDValor fixo em BRL (limitado ao total)

​
Restrições

  • productIds — cupom só vale para produtos listados
  • paymentLinkIds — cupom só vale para links listados
  • maxUses, expiresAt — limite de uso e validade

​
Fluxo no checkout

1

Validar

POST /v1/coupons/validate com code, amount, paymentLinkId (e productId se restrito).
2

Checkout

POST /v1/payment-links/checkout com couponCode igual ao código validado.
3

Confirmar

Webhook payment_link.paid ou sessão.
Visão geral: Loja.