Skip to main content
GET
Obter um link de pagamento
Retorna o objeto completo identificado pelo ID, quando ele pertence à conta da chave. amount e unit_amount refletem os preços atuais. Requer payment_links:read ou read. Veja campos, relacionamentos e eventos.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

ID público do link de pagamento na conta.

Pattern: ^chk_[a-z0-9]{16}$

Response

Operação concluída

id
string
required

Identificador público estável, com prefixo chk_. É o mesmo ID do checkout no painel. Use a URL retornada; não construa o endereço a partir do ID.

Pattern: ^chk_[a-z0-9]{16}$
allow_discount_codes
boolean
required

Permite informar códigos de desconto na página.

amount
integer
required

Subtotal em centavos, calculado com os preços atuais dos itens. Somente leitura.

Required range: x >= 0
cancel_url
string<uri> | null
required

Destino HTTPS ao cancelar a compra. null remove.

checkout_experience
object
required

Apresentação, banner, dados exigidos e mensagem final. Campos visuais null herdam o padrão.

created_at
string<date-time>
required

Data e hora da criação, em ISO 8601 com fuso horário. Somente leitura.

currency
enum<string>
required

Sempre BRL.

Available options:
BRL
discount
string | null
required

Desconto disponível na conta de pagamentos. null remove o desconto automático.

Pattern: ^disc_[A-Za-z0-9]+$
has_surcharge
boolean
required

Repassa tarifas ao comprador. Apenas compras avulsas.

interest_payer
enum<string>
required

Quem absorve os juros do parcelamento: comprador ou conta.

Available options:
buyer,
organization
line_items
object[]
required

Itens vendidos pelo link, na ordem de exibição.

Required array length: 1 - 20 elements
max_installments
integer
default:12
required

Máximo de parcelas no cartão. Assinaturas não parcelam.

Required range: 1 <= x <= 12
metadata
object
required

Objeto JSON livre para referências da integração, limitado a 16 KB.

object
string
required
Allowed value: "payment_link"
optional_items
object[]
required

Até três ofertas adicionais avulsas, de produtos diferentes dos itens principais.

Maximum array length: 3
payment_method_collection
enum<string>
required

Coleta do cartão nas assinaturas: sempre ou apenas quando houver pagamento imediato.

Available options:
always,
if_required
payment_methods
enum<string>[]
required

Meios de pagamento. Assinaturas recorrentes usam credit_card.

Required array length: 1 - 2 elements
Available options:
credit_card,
pix,
boleto
recurring
object | null
required

Período de renovação quando os itens são assinaturas; null em compras avulsas. Somente leitura.

status
enum<string>
required

draft não abre compras; active está publicado; inactive foi desativado.

Available options:
draft,
active,
inactive
subscription_data
object | null
required

Condições da assinatura. O link aceita período grátis em dias; data final absoluta de trial pertence a sessões individuais.

success_url
string | null
required

Destino HTTPS após concluir a página; não confirma pagamento. Aceita {CHECKOUT_SESSION_ID}.

template
enum<string> | null
required

Layout da página. null usa o padrão da conta.

Available options:
split,
sidebar,
stacked,
null
title
string
required

Título exibido na página.

Maximum string length: 120
total_orders
integer
required

Compras confirmadas por este link. Somente leitura.

Required range: x >= 0
updated_at
string<date-time>
required

Data e hora da última alteração, em ISO 8601 com fuso horário. Somente leitura.

url
string | null
required

URL confirmada do checkout hospedado. Pode usar o domínio configurado. Não construa a URL a partir do ID.