curl -X POST 'https://api.goatpay.com.br/v1/payment-links/checkout' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: pedido-42-v1' \
-d '{
"linkId": "clx_link",
"method": "PIX",
"payerEmail": "cliente@loja.com",
"externalReference": "pedido-42"
}'
{
"success": true,
"message": "Checkout do link iniciado",
"data": {
"sessionId": "clx_session",
"sessionToken": "uuid-token",
"payCheckoutUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro/uuid-token",
"paymentLinkId": "clx_link",
"externalReference": "pedido-42"
},
"requestId": "req_abc"
}
Iniciar checkout do link
Inicia checkout do link (PIX ou cripto).
POST
/
payment-links
/
checkout
curl -X POST 'https://api.goatpay.com.br/v1/payment-links/checkout' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: pedido-42-v1' \
-d '{
"linkId": "clx_link",
"method": "PIX",
"payerEmail": "cliente@loja.com",
"externalReference": "pedido-42"
}'
{
"success": true,
"message": "Checkout do link iniciado",
"data": {
"sessionId": "clx_session",
"sessionToken": "uuid-token",
"payCheckoutUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro/uuid-token",
"paymentLinkId": "clx_link",
"externalReference": "pedido-42"
},
"requestId": "req_abc"
}
URL:
POST https://api.goatpay.com.br/v1/payment-links/checkout · Permissão: payment-links/checkout · Header opcional Idempotency-Keycurl -X POST 'https://api.goatpay.com.br/v1/payment-links/checkout' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: pedido-42-v1' \
-d '{
"linkId": "clx_link",
"method": "PIX",
"payerEmail": "cliente@loja.com",
"externalReference": "pedido-42"
}'
{
"success": true,
"message": "Checkout do link iniciado",
"data": {
"sessionId": "clx_session",
"sessionToken": "uuid-token",
"payCheckoutUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro/uuid-token",
"paymentLinkId": "clx_link",
"externalReference": "pedido-42"
},
"requestId": "req_abc"
}
Corpo
string
Cupom validado com POST /v1/coupons/validate.
string
required
PIX ou CRYPTO.number
Obrigatório se o link não tiver
fixedAmount.string
Sua referência (webhook e consulta).
string
Nome do pagador.
string
CPF/CNPJ.
string
E-mail do pagador.
payment_link.paid ou consultar sessão.
Guia: Links de pagamento.Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Headers
Body
application/json