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"
}
Links de pagamento
Consultar sessão de checkout
Consulta status da sessão de checkout.
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/getcurl '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
| status | Significado |
|---|---|
PENDING | Aguardando pagamento |
PAID | Pagamento confirmado |
EXPIRED | Sessão expirada |
FAILED | Falha / cancelado |
payment-links/sessions/get.
Para notificação em tempo real, use o webhook payment_link.paid.Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.