Skip to main content
POST
URL: POST https://api.goatpay.com.br/v1/coupons/validate · Permissão: coupons/validate

Corpo

string
required
Código do cupom.
number
required
Valor base em BRL antes do desconto.
ID do link usado no checkout.
string
Obrigatório se o cupom estiver restrito a produtos.
Depois use couponCode em checkout do link. Guia: Cupons.

Authorizations

X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Body

application/json
code
string
required
amount
number
required
Required range: x >= 0.01
productId
string

Response

200 - application/json

Resultado da validação do cupom.

success
boolean
required
message
string
required
data
object
required
requestId
string