curl -X POST 'https://api.goatpay.com.br/v1/payment-links/create' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{
"name": "Plano Pro",
"slug": "plano-pro",
"description": "Assinatura mensal",
"fixedAmount": 99.90,
"allowedMethods": ["PIX", "CRYPTO"],
"requireEmail": true
}'
{
"success": true,
"message": "Link de pagamento criado",
"data": {
"id": "clx_link",
"name": "Plano Pro",
"publicCode": "abc12",
"slug": "plano-pro",
"fixedAmount": 99.9,
"allowedMethods": ["PIX", "CRYPTO"],
"status": "ACTIVE",
"payPageUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro",
"checkoutPath": "/pay/abc12/plano-pro"
},
"requestId": "req_abc"
}
Links de pagamento
Criar link de pagamento
Cria um link reutilizável com checkout hospedado GoatPay.
POST
/
payment-links
/
create
curl -X POST 'https://api.goatpay.com.br/v1/payment-links/create' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{
"name": "Plano Pro",
"slug": "plano-pro",
"description": "Assinatura mensal",
"fixedAmount": 99.90,
"allowedMethods": ["PIX", "CRYPTO"],
"requireEmail": true
}'
{
"success": true,
"message": "Link de pagamento criado",
"data": {
"id": "clx_link",
"name": "Plano Pro",
"publicCode": "abc12",
"slug": "plano-pro",
"fixedAmount": 99.9,
"allowedMethods": ["PIX", "CRYPTO"],
"status": "ACTIVE",
"payPageUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro",
"checkoutPath": "/pay/abc12/plano-pro"
},
"requestId": "req_abc"
}
URL:
POST https://api.goatpay.com.br/v1/payment-links/create · Permissão: payment-links/createcurl -X POST 'https://api.goatpay.com.br/v1/payment-links/create' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{
"name": "Plano Pro",
"slug": "plano-pro",
"description": "Assinatura mensal",
"fixedAmount": 99.90,
"allowedMethods": ["PIX", "CRYPTO"],
"requireEmail": true
}'
{
"success": true,
"message": "Link de pagamento criado",
"data": {
"id": "clx_link",
"name": "Plano Pro",
"publicCode": "abc12",
"slug": "plano-pro",
"fixedAmount": 99.9,
"allowedMethods": ["PIX", "CRYPTO"],
"status": "ACTIVE",
"payPageUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro",
"checkoutPath": "/pay/abc12/plano-pro"
},
"requestId": "req_abc"
}
Corpo
string
required
Nome interno do link.
string
required
Identificador na URL (único na plataforma).
string[]
required
PIX ou CRYPTO (um ou ambos).number
Valor fixo em BRL. Omita para valor aberto no checkout.
boolean
Cliente absorve taxas GoatPay.
Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Body
application/json
Minimum array length:
1Available options:
PIX, CRYPTO Required range:
x >= 0.01Available options:
NONE, OPTIONAL, REQUIRED 
