Skip to main content
PATCH
/
payment-links
/
update
/
{id}
curl -X PATCH 'https://api.goatpay.com.br/v1/payment-links/update/clx_link' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "fixedAmount": 79.90,
    "allowedMethods": ["PIX", "CARD"],
    "productIds": ["clx_product"]
  }'

{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "publicCode": "<string>",
    "fixedAmount": 123,
    "allowedMethods": [
      "<string>"
    ],
    "status": "<string>",
    "payPageUrl": "<string>",
    "checkoutPath": "<string>"
  },
  "requestId": "<string>"
}
URL: PATCH https://api.goatpay.com.br/v1/payment-links/update/{id} · Permissão: payment-links/update
curl -X PATCH 'https://api.goatpay.com.br/v1/payment-links/update/clx_link' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "fixedAmount": 79.90,
    "allowedMethods": ["PIX", "CARD"],
    "productIds": ["clx_product"]
  }'

​
Corpo (parcial)

Mesmos campos de criar link. Para só ativar/desativar, use status. Guia: Links de pagamento.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string
required

ID do recurso (transação, cobrança, webhook, etc.)

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