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

{
  "success": true,
  "message": "Sessão de checkout",
  "data": {
    "sessionId": "clx_session",
    "status": "PAID",
    "method": "CARD",
    "amount": 99.9,
    "paidAt": "2026-06-02T15:00:00.000Z",
    "externalReference": "pedido-42",
    "transactionId": "clx_tx",
    "paymentLink": {
      "id": "clx_link",
      "slug": "plano-pro",
      "publicCode": "abc12"
    }
  },
  "requestId": "req_abc"
}
URL: GET https://api.goatpay.com.br/v1/payment-links/sessions/get/{sessionId} · Permissão: payment-links/sessions/get
curl 'https://api.goatpay.com.br/v1/payment-links/sessions/get/clx_session' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Sessão de checkout",
  "data": {
    "sessionId": "clx_session",
    "status": "PAID",
    "method": "CARD",
    "amount": 99.9,
    "paidAt": "2026-06-02T15:00:00.000Z",
    "externalReference": "pedido-42",
    "transactionId": "clx_tx",
    "paymentLink": {
      "id": "clx_link",
      "slug": "plano-pro",
      "publicCode": "abc12"
    }
  },
  "requestId": "req_abc"
}

​
Status da sessão

statusSignificado
PENDINGAguardando pagamento
PAIDPagamento confirmado
EXPIREDSessão expirada
FAILEDFalha / cancelado
Permissão: payment-links/sessions/get. Para notificação em tempo real, use o webhook payment_link.paid.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
sessionId
string
required

Response

200 - application/json

Sessão de checkout (status do pagamento).

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