Skip to main content
POST
URL: POST https://api.goatpay.com.br/v1/payment-links/create · Permissão: payment-links/create

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.
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,
CRYPTO
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