Skip to main content
POST
/
card
/
checkout
curl -X POST 'https://api.goatpay.com.br/v1/card/checkout' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 150.00,
    "description": "Pedido 42",
    "coverFee": false,
    "customerEmail": "cliente@loja.com",
    "successUrl": "https://loja.com/obrigado",
    "cancelUrl": "https://loja.com/cancelado"
  }'

{
  "success": true,
  "message": "Checkout de cartão criado",
  "data": {
    "transactionId": "clx_tx_card",
    "checkoutUrl": "https://checkout.stripe.com/c/pay/cs_test_...",
    "sessionId": "cs_test_...",
    "amount": 150,
    "status": "PENDING"
  },
  "requestId": "req_abc"
}

curl -X POST 'https://api.goatpay.com.br/v1/card/checkout' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 150.00,
    "description": "Pedido 42",
    "coverFee": false,
    "customerEmail": "cliente@loja.com",
    "successUrl": "https://loja.com/obrigado",
    "cancelUrl": "https://loja.com/cancelado"
  }'

{
  "success": true,
  "message": "Checkout de cartão criado",
  "data": {
    "transactionId": "clx_tx_card",
    "checkoutUrl": "https://checkout.stripe.com/c/pay/cs_test_...",
    "sessionId": "cs_test_...",
    "amount": 150,
    "status": "PENDING"
  },
  "requestId": "req_abc"
}

​
Corpo da requisição

​
amount
number
required
Valor em BRL. Mínimo R$ 5,00. Com coverFee: true, é o líquido desejado.
​
description
string
Descrição na fatura/checkout (padrão: Pagamento via API).
​
coverFee
boolean
Se true, a taxa GoatPay é acrescentada ao valor cobrado no cartão.
​
customerEmail
string
E-mail pré-preenchido no Stripe Checkout (recomendado).
​
successUrl
string
URL após pagamento aprovado. Padrão: página GoatPay se omitido.
​
cancelUrl
string
URL se o cliente cancelar no Stripe Checkout.

​
Resposta

CampoDescrição
checkoutUrlRedirecione o cliente para esta URL
transactionIdID da transação GoatPay — use em GET /card/get e estorno
sessionIdID da sessão Stripe Checkout
statusInicia como PENDING
Exige onboarding Stripe concluído (onboarding-link). Conta PJ verificada.
Confirme pagamento com webhook payment.paid ou polling em GET /card/get/:id. Para checkout com página GoatPay e vários métodos, use links de pagamento. Permissão: card/checkout. Guia: Cartão Stripe Connect.

Authorizations

​
X-API-Key
string
header
required

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

Body

application/json
​
amount
number
required

Valor em BRL (bruto ou líquido se coverFee true).

Required range: 5 <= x <= 1000000
​
description
string
Maximum string length: 180
​
coverFee
boolean
default:false
​
customerEmail
string
Maximum string length: 180
​
successUrl
string
Maximum string length: 500
​
cancelUrl
string
Maximum string length: 500

Response

Sessão Stripe Checkout criada.

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