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"
}
Cupons
Validar cupom
Valida cupom e retorna valor com desconto antes do checkout.
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/validatecurl -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
string
required
Código do cupom.
number
required
Valor base em BRL antes do desconto.
string
required
ID do link usado no checkout.
string
Obrigatório se o cupom estiver restrito a produtos.
couponCode em checkout do link.
Guia: Cupons.Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Body
application/json