> ## Documentation Index
> Fetch the complete documentation index at: https://docs.z2pay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Buscar checkout link
> Retorna a configuração completa de um template, com itens, métodos, splits e branding.
`GET /checkout/links/{id}`
Faz parte do recurso [Links](/pt-BR/checkout/links) — o conceito e os estados estão lá.
Devolve o Link inteiro, no mesmo formato da resposta da
[criação](/pt-BR/checkout/links/create): `items`, `paymentMethods`, `splits` e `branding` vêm
aninhados dentro de `config`, e os demais campos no topo. É por aqui que se relê a configuração para
[espelhá-la numa venda rápida](/pt-BR/checkout/charges#espelhar-a-config-de-um-link-numa-venda-rápida).
**Aqui só o `chk_` funciona — o `slug` não.** O slug vale na URL pública (`/c/{slug}`), que é onde
o comprador entra; nesta rota, buscar pelo slug responde `404`. Guarde o `chk_` ao criar o Link.
**Link arquivado continua sendo devolvido**, com `status: "archived"`. Arquivar muda o estado, não
apaga — é o que permite reler a configuração de um Link que saiu do ar.
## Exemplo
```bash theme={null}
curl https://api.sandbox.z2pay.com/v1/checkout/links/chk_byd8p3p79re859jpkmr0j65n3 \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX"
```
```json Resposta 200 theme={null}
{
"id": "chk_byd8p3p79re859jpkmr0j65n3",
"name": "Curso de Backend",
"slug": null,
"status": "active",
"sellable": true,
"mode": "payment",
"currency": "BRL",
"locale": "pt-BR",
"config": {
"items": [
{ "name": "Curso de Backend — vitalício", "quantity": 1, "unitAmount": 49900 }
],
"paymentMethods": {
"card": { "enabled": true, "installments": { "maxInstallments": 12, "freeInstallments": 3 } },
"pix": { "enabled": true, "expiresIn": 3600 }
},
"splits": null,
"branding": { "primaryColor": "#1e3b79", "merchantName": "Henrique Cursos" }
},
"requiredFields": ["email", "document", "phone"],
"customFields": null,
"successUrl": null,
"cancelUrl": null,
"metadata": { "campaign": "instagram-bio-2026-05" },
"expirationMinutes": 1440,
"createdAt": "2026-06-24T12:00:00.000Z",
"updatedAt": "2026-06-24T12:00:00.000Z",
"url": "https://pay.sandbox.z2pay.com/c/chk_byd8p3p79re859jpkmr0j65n3"
}
```
## OpenAPI
````yaml openapi/checkout.json GET /checkout/links/{id}
openapi: 3.0.3
info:
title: Z2Pay Checkout API
version: 1.0.0
description: >-
API pública dedicada do Checkout. Autenticação via header x-api-key com a
API key unificada da conta (z2_{live|test}_{sk|pk}_...). Endpoints privados
exigem uma key secret (sk); endpoints públicos aceitam a key publishable
(pk) consumida pelo frontend do comprador.
servers:
- url: https://api.sandbox.z2pay.com/v1
description: Sandbox
- url: https://api.z2pay.com/v1
description: Produção
security: []
tags:
- name: Checkout Links
description: Checkout Links (integração API via sk_)
- name: Checkout Sessions
description: Checkout Sessions (integração API via sk_)
- name: Vendas rápidas
description: Cobrança individual sem Link — Sessions ad-hoc criadas com a chave secreta
paths:
/checkout/links/{id}:
get:
tags:
- Checkout Links
summary: Buscar checkout link
description: Retorna dados completos do Link.
operationId: CheckoutLinkApiController_getById
parameters:
- name: id
in: path
required: true
description: ID do CheckoutLink
schema:
type: string
responses:
'200':
description: Link encontrado
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Identificador único do registro.
slug:
type: string
nullable: true
description: Slug único global usado na URL pública /c/{slug}.
status:
type: string
description: Estado atual do registro.
mode:
type: string
description: >-
Modo do checkout: 'payment' (pagamento único) ou
'subscription' (assinatura).
currency:
type: string
description: 'Moeda no padrão ISO 4217 (ex.: BRL).'
locale:
type: string
description: 'Idioma do checkout (ex.: pt-BR, en-US, es-ES).'
name:
type: string
nullable: true
description: Nome de exibição do registro.
description:
type: string
nullable: true
description: Descrição exibida no checkout.
sellable:
type: boolean
description: >-
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:
type: object
description: >-
Snapshot da configuração do checkout (formas de pagamento,
itens e personalização visual).
requiredFields:
type: array
items:
type: string
nullable: true
description: >-
Campos do comprador exigidos no checkout (ex.: email,
document, phone, address).
customFields:
type: array
items:
type: object
nullable: true
description: >-
Definições dos campos personalizados solicitados no
checkout.
successUrl:
type: string
nullable: true
description: >-
URL de redirecionamento após o pagamento ser concluído com
sucesso.
cancelUrl:
type: string
nullable: true
description: >-
URL de redirecionamento quando o comprador cancela o
checkout.
metadata:
type: object
nullable: true
description: >-
Metadados livres (pares chave-valor) para uso do
integrador; não afeta o processamento.
expirationMinutes:
type: integer
nullable: true
description: Tempo de validade da sessão de checkout, em minutos.
createdAt:
type: string
format: date-time
description: Data e hora de criação do registro (ISO 8601).
updatedAt:
type: string
format: date-time
description: Data e hora da última atualização do registro (ISO 8601).
url:
type: string
description: >-
URL pública do checkout para o comprador finalizar o
pagamento.
example:
id: chk_byd8p3p79re859jpkmr0j65n3
slug: plano-pro-mensal
status: active
mode: subscription
currency: BRL
locale: pt-BR
name: Plano Pro Mensal
description: Assinatura mensal do plano Pro
sellable: true
config:
items:
- name: Plano Pro
quantity: 1
unitAmount: 9900
chargeType: recurring
paymentMethods:
card:
enabled: true
pix:
enabled: true
subscription:
planId: plan_edz8m3vbxbvobrom0qlxbq68h
recurrence:
interval: 1
unit: month
currency: BRL
trialDays: 7
collectionTiming: prepaid
requiredFields:
- email
- document
- phone
customFields: null
successUrl: https://app.com/welcome
cancelUrl: null
metadata: null
expirationMinutes: 1440
createdAt: '2025-06-20T09:00:00.000Z'
updatedAt: '2025-06-29T13:45:30.000Z'
url: https://pay.z2pay.com/c/plano-pro-mensal
'401':
description: Chave de API ausente, malformada ou inválida
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: UNAUTHORIZED
message: Invalid API key
'403':
description: >-
A chave é válida, mas não tem permissão para esta operação — é o
caso de usar uma publishable key (pk) onde a rota exige uma secret
key (sk)
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: FORBIDDEN
message: Forbidden — insufficient permissions
'404':
description: Link não encontrado
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: NOT_FOUND
message: Checkout link not found
security:
- apiKey: []
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
description: >-
API key unificada (z2_{live|test}_{sk|pk}_...) — secret (sk) para
integração backend, publishable (pk) para uso no frontend público
````