Skip to main content
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/get
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"
}
​
id
string
required
ID do cupom.
Guia: Cupons.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string
required

ID do recurso (transação, cobrança, webhook, etc.)

Response

200 - application/json

Cupom criado, consultado ou atualizado.

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