Skip to main content
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", "CARD"],
    "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", "CARD"],
    "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/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", "CARD"],
    "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", "CARD"],
    "status": "ACTIVE",
    "payPageUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro",
    "checkoutPath": "/pay/abc12/plano-pro"
  },
  "requestId": "req_abc"
}

​
Corpo

​
name
string
required
Nome interno do link.
​
slug
string
required
Identificador na URL (único na plataforma).
​
allowedMethods
string[]
required
PIX, BOLETO, CRYPTO, CARD (cartão exige Stripe Connect).
​
fixedAmount
number
Valor fixo em BRL. Omita para valor aberto no checkout.
​
payerCoversFee
boolean
Cliente absorve taxas GoatPay.
Guia: Links de pagamento · Loja.

Authorizations

​
X-API-Key
string
header
required

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

Body

application/json
​
name
string
required
​
slug
string
required
​
allowedMethods
enum<string>[]
required
Minimum array length: 1
Available options:
PIX,
BOLETO,
CRYPTO,
CARD
​
description
string
​
fixedAmount
number
Required range: x >= 0.01
​
requireName
boolean
​
requireDocument
boolean
​
requireEmail
boolean
​
requirePhone
boolean
​
customerMode
enum<string>
Available options:
NONE,
OPTIONAL,
REQUIRED
​
payerCoversFee
boolean
​
productIds
string[]

Response

200 - application/json

Link de pagamento.

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