Skip to main content
POST
URL: POST https://api.goatpay.com.br/v1/payment-links/checkout · Permissão: payment-links/checkout · Header opcional Idempotency-Key

Corpo

ID do link (criar).
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.
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
method
enum<string>
required
Available options:
PIX,
CRYPTO
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