Skip to main content
GET
/
payment-links
/
get
/
{id}
curl 'https://api.goatpay.com.br/v1/payment-links/get/clx_link' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Link de pagamento encontrado",
  "data": {
    "id": "clx_link",
    "name": "Plano Pro",
    "slug": "plano-pro",
    "publicCode": "abc12",
    "fixedAmount": 99.9,
    "allowedMethods": ["PIX", "CARD"],
    "status": "ACTIVE",
    "payPageUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro",
    "checkoutPath": "/pay/abc12/plano-pro"
  },
  "requestId": "req_abc"
}
URL: GET https://api.goatpay.com.br/v1/payment-links/get/{id} · Permissão: payment-links/get
curl 'https://api.goatpay.com.br/v1/payment-links/get/clx_link' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Link de pagamento encontrado",
  "data": {
    "id": "clx_link",
    "name": "Plano Pro",
    "slug": "plano-pro",
    "publicCode": "abc12",
    "fixedAmount": 99.9,
    "allowedMethods": ["PIX", "CARD"],
    "status": "ACTIVE",
    "payPageUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro",
    "checkoutPath": "/pay/abc12/plano-pro"
  },
  "requestId": "req_abc"
}
​
id
string
required
ID do link.
Compartilhe payPageUrl com o cliente ou inicie cobrança via checkout. Guia: Links de pagamento.

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

Link de pagamento.

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