Skip to main content
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": "CARD",
    "payerEmail": "cliente@loja.com",
    "externalReference": "pedido-42",
    "successUrl": "https://loja.com/pago",
    "cancelUrl": "https://loja.com/cancelado"
  }'

{
  "success": true,
  "message": "Checkout do link iniciado",
  "data": {
    "sessionId": "clx_session",
    "sessionToken": "uuid-token",
    "stripeCheckoutUrl": "https://checkout.stripe.com/...",
    "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-Key
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": "CARD",
    "payerEmail": "cliente@loja.com",
    "externalReference": "pedido-42",
    "successUrl": "https://loja.com/pago",
    "cancelUrl": "https://loja.com/cancelado"
  }'

{
  "success": true,
  "message": "Checkout do link iniciado",
  "data": {
    "sessionId": "clx_session",
    "sessionToken": "uuid-token",
    "stripeCheckoutUrl": "https://checkout.stripe.com/...",
    "payCheckoutUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro/uuid-token",
    "paymentLinkId": "clx_link",
    "externalReference": "pedido-42"
  },
  "requestId": "req_abc"
}

​
Corpo

​
linkId
string
required
ID do link (criar).
​
couponCode
string
Cupom validado com POST /v1/coupons/validate.
​
method
string
required
PIX, BOLETO, CRYPTO ou CARD.
​
amount
number
Obrigatório se o link não tiver fixedAmount.
​
externalReference
string
Sua referência (webhook e consulta).
​
successUrl
string
Retorno Stripe após pagamento (cartão).
​
cancelUrl
string
Retorno Stripe se cancelar (cartão).
​
payerName
string
Nome do pagador.
​
payerDocument
string
CPF/CNPJ.
​
payerEmail
string
E-mail (recomendado para cartão).
Após pagamento: webhook payment_link.paid ou consultar sessão. Guia: Links de pagamento.

Authorizations

​
X-API-Key
string
header
required

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

Headers

​
Idempotency-Key
string

Body

application/json
​
linkId
string
required
​
method
enum<string>
required
Available options:
PIX,
BOLETO,
CRYPTO,
CARD
​
amount
number
​
payerName
string
​
payerDocument
string
​
payerEmail
string
​
payerPhone
string
​
couponCode
string
​
externalReference
string
​
successUrl
string<uri>
​
cancelUrl
string<uri>

Response

200 - application/json

Checkout iniciado.

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