Editar link

Muda qualquer campo do link. Pausar é mandar active: false.

PATCH /v1/payment-links/{id}

cURL

curl -X PATCH https://bukio-backend-production.up.railway.app/v1/payment-links/LNK-4H8W2PQ7ZM3K \
  -H "Authorization: Bearer bk_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "active": false }'

200

{
  "id": "LNK-4H8W2PQ7ZM3K",
  "title": "Ingresso Workshop",
  "active": false,
  "status": "paused",
  "statusTitle": "Pausado",
  "payments": 12,
  "received": 118800,
  "...": "..."
}

Escopo payments:write; para passar a aceitar cartão ou cripto (methods), também card:write ou crypto:write. Todos os campos são opcionais; só os enviados mudam. null limpa um campo que aceita null. Limite de 60 criações ou edições por hora.

id · string · required

LNK- + 12 caracteres.

title · string

Até 80 caracteres.

active · boolean

false pausa o link (status: "paused"); true reativa.

amount · integer | null

Valor fixo, ou null para valor livre.

description · string | null

Até 280 caracteres.

suggestedAmounts · integer[] | null

Até 6 valores.

allowCustomAmount · boolean

Aceita valor digitado.

minAmount · integer

Mínimo do valor livre.

maxAmount · integer | null

Máximo do valor livre.

customerFields · string[]

name, email, phone, document.

displayName · string | null

Nome na página.

accentColor · string | null

#RRGGBB.

pageTheme · string

auto, light ou dark.

buttonLabel · string | null

Texto do botão, da lista fechada.

thankYouMessage · string | null

Mensagem depois do pagamento.

successUrl · string | null

Só https://.

maxPayments · integer | null

Limite de pagamentos.

expiresAt · string | null

Vencimento (ISO 8601).

subaccountId · string | null

sacc_... ou externalId: os próximos pagamentos pelo link são creditados a essa subconta. null tira a subconta (os próximos ficam com você). Os já pagos não mudam.

​

Resposta

O link atualizado, no formato de Criar link.

cURL

curl -X PATCH https://bukio-backend-production.up.railway.app/v1/payment-links/LNK-4H8W2PQ7ZM3K \
  -H "Authorization: Bearer bk_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "active": false }'

200

{
  "id": "LNK-4H8W2PQ7ZM3K",
  "title": "Ingresso Workshop",
  "active": false,
  "status": "paused",
  "statusTitle": "Pausado",
  "payments": 12,
  "received": 118800,
  "...": "..."
}