curl 'https://api.goatpay.com.br/v1/coupons/get/clx_coupon' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Cupom encontrado",
"data": {
"id": "clx_coupon",
"code": "VERAO10",
"discountType": "PERCENT",
"discountValue": 10,
"uses": 5,
"maxUses": 100,
"status": "ACTIVE"
},
"requestId": "req_abc"
}
Cupons
Consultar cupom
Consulta um cupom pelo ID.
GET
/
coupons
/
get
/
{id}
curl 'https://api.goatpay.com.br/v1/coupons/get/clx_coupon' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Cupom encontrado",
"data": {
"id": "clx_coupon",
"code": "VERAO10",
"discountType": "PERCENT",
"discountValue": 10,
"uses": 5,
"maxUses": 100,
"status": "ACTIVE"
},
"requestId": "req_abc"
}
URL:
GET https://api.goatpay.com.br/v1/coupons/get/{id} · Permissão: coupons/getcurl 'https://api.goatpay.com.br/v1/coupons/get/clx_coupon' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Cupom encontrado",
"data": {
"id": "clx_coupon",
"code": "VERAO10",
"discountType": "PERCENT",
"discountValue": 10,
"uses": 5,
"maxUses": 100,
"status": "ACTIVE"
},
"requestId": "req_abc"
}
string
required
ID do cupom.
Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Path Parameters
ID do recurso (transação, cobrança, webhook, etc.)