Ativar ou desativar link

curl -X PATCH 'https://api.goatpay.com.br/v1/payment-links/status/clx_link' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "status": "INACTIVE" }'

{
  "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>"
}

PATCH

payment-links

status

{id}

curl -X PATCH 'https://api.goatpay.com.br/v1/payment-links/status/clx_link' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "status": "INACTIVE" }'

{
  "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/status/{id} · Permissão: payment-links/update

curl -X PATCH 'https://api.goatpay.com.br/v1/payment-links/status/clx_link' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "status": "INACTIVE" }'

string

required

ID do link.

string

required

ACTIVE ou INACTIVE.

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

string

required

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

Body

application/json

status

enum<string>

required

Available options:

ACTIVE,

INACTIVE

Response

200 - application/json

Link de pagamento.

success

boolean

required

message

string

required

data

object

required

Show child attributes

requestId

string

Atualizar Excluir

Introdução

Webhooks

PIX

Conta

Loja

Subcontas

Ativar ou desativar link

Authorizations

Path Parameters

Body

Response