Skip to main content
DELETE
Arquivar checkout link
DELETE /checkout/links/{id} Faz parte do recurso Links — o conceito e os estados estão lá. O status passa a archived, a URL pública deixa de vender e nenhuma Session nova é materializada. A resposta é 200 com o Link inteiro, já com o estado novo.
Quem estava com a página aberta também para de poder pagar. O comprador que clicar em “Pagar” recebe 409 com key: "errors.checkout.link_not_active" — a confirmação revalida o Link a cada tentativa, de propósito, para que ninguém pague contra algo que você já tirou do ar.Se a intenção é só parar de divulgar e deixar quem está no meio da compra terminar, não arquive agora: espere as Sessions abertas expirarem (24h por padrão) ou cancele-as explicitamente.
Não há como desarquivar pela API. Não existe rota de restauração, e o PATCH não aceita status no corpo — pelo painel dá, pela integração não. Se precisar do mesmo checkout de volta, o caminho é criar um Link novo, com outro chk_, e o mesmo slug só se você tiver liberado o antigo.
Não é remoção, é mudança de estado — não há deletedAt. O Link continua existindo e sendo devolvido pelo GET com status: "archived", o que permite reler a configuração depois.
Endpoint idempotente. Veja Convenções.

Exemplo

Resposta 200

Authorizations

x-api-key
string
header
required

API key unificada (z2_{live|test}{sk|pk}...) — secret (sk) para integração backend, publishable (pk) para uso no frontend público

Path Parameters

id
string
required

ID do CheckoutLink

Response

Link arquivado

id
string

Identificador único do registro.

slug
string | null

Slug único global usado na URL pública /c/{slug}.

status
string

Estado atual do registro.

mode
string

Modo do checkout: 'payment' (pagamento único) ou 'subscription' (assinatura).

currency
string

Moeda no padrão ISO 4217 (ex.: BRL).

locale
string

Idioma do checkout (ex.: pt-BR, en-US, es-ES).

name
string | null

Nome de exibição do registro.

description
string | null

Descrição exibida no checkout.

sellable
boolean

Se o Link pode vender agora. É false quando um recebedor do splits, ou o dono da conta, não está ativo no PSP — o comprador vê uma página de indisponível. Independente do status.

config
object

Snapshot da configuração do checkout (formas de pagamento, itens e personalização visual).

requiredFields
string[] | null

Campos do comprador exigidos no checkout (ex.: email, document, phone, address).

customFields
object[] | null

Definições dos campos personalizados solicitados no checkout.

successUrl
string | null

URL de redirecionamento após o pagamento ser concluído com sucesso.

cancelUrl
string | null

URL de redirecionamento quando o comprador cancela o checkout.

metadata
object | null

Metadados livres (pares chave-valor) para uso do integrador; não afeta o processamento.

expirationMinutes
integer | null

Tempo de validade da sessão de checkout, em minutos.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).