Skip to main content
POST
/
coupons
/
validate
curl -X POST 'https://api.goatpay.com.br/v1/coupons/validate' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "VERAO10",
    "amount": 100,
    "paymentLinkId": "clx_link",
    "productId": "clx_product"
  }'

{
  "success": true,
  "message": "Cupom válido",
  "data": {
    "couponId": "clx_coupon",
    "code": "VERAO10",
    "discountType": "PERCENT",
    "discountValue": 10,
    "discountAmount": 10,
    "amountOriginal": 100,
    "amountFinal": 90
  },
  "requestId": "req_abc"
}
URL: POST https://api.goatpay.com.br/v1/coupons/validate · Permissão: coupons/validate
curl -X POST 'https://api.goatpay.com.br/v1/coupons/validate' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "VERAO10",
    "amount": 100,
    "paymentLinkId": "clx_link",
    "productId": "clx_product"
  }'

{
  "success": true,
  "message": "Cupom válido",
  "data": {
    "couponId": "clx_coupon",
    "code": "VERAO10",
    "discountType": "PERCENT",
    "discountValue": 10,
    "discountAmount": 10,
    "amountOriginal": 100,
    "amountFinal": 90
  },
  "requestId": "req_abc"
}

​
Corpo

​
code
string
required
Código do cupom.
​
amount
number
required
Valor base em BRL antes do desconto.
​
paymentLinkId
string
required
ID do link usado no checkout.
​
productId
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
​
paymentLinkId
string
required
​
productId
string

Response

200 - application/json

Resultado da validação do cupom.

​
success
boolean
required
​
message
string
required
​
data
object
required
​
requestId
string