Pular para o conteúdo principal
cURL
Envie apenas os campos que deseja alterar, incluindo customer, linkedCustomer ou maxPayments. Os status do link são active, paused e archived.

Autorizações

Authorization
string
header
obrigatório

Chave secreta sk_live_ da empresa. Use somente no servidor.

Parâmetros de caminho

id
string<uuid>
obrigatório

Corpo

Body para atualizar parcialmente um link de pagamento.

title
string

Título exibido no checkout hospedado.

Maximum string length: 255
description
string

Descrição exibida no checkout.

imageUrl
string<uri> | null
Maximum string length: 200
priceMode
enum<string>

Modo de preço. No contrato público atual, use sempre fixed.

Opções disponíveis:
fixed
amountCents
integer | null

Valor fixo do link em centavos. Obrigatório para priceMode: fixed.

Intervalo obrigatório: 1000 <= x <= 20000000
minAmountCents
integer | null

Reservado para modos de preço futuros. Não use no contrato público atual.

Intervalo obrigatório: 0 <= x <= 2147483647
maxAmountCents
integer | null

Reservado para modos de preço futuros. Não use no contrato público atual.

Intervalo obrigatório: 0 <= x <= 2147483647
methods
enum<string>[]

Métodos aceitos no checkout. Envie pix, credit_card ou ambos.

Opções disponíveis:
pix,
credit_card
maxInstallments
integer

Número máximo de parcelas para cartão. Use 1 quando o link aceitar apenas Pix.

Intervalo obrigatório: 1 <= x <= 12
interestMode
enum<string>

Define quem absorve juros de parcelamento: absorb ou pass_to_customer.

Opções disponíveis:
absorb,
pass_to_customer
acceptsOneTime
boolean
status
enum<string>

Status do link: active, paused ou archived.

Opções disponíveis:
active,
paused,
archived
threeDsMode
enum<string>

Modo de 3DS para cartão: always ou contingency.

Opções disponíveis:
always,
contingency
tags
string[]

Tags livres para organização interna do link.

redirectUrl
string | null

Para onde o checkout leva o comprador depois do pagamento confirmado (cartão aprovado ou Pix pago), com transactionId, reference e status=approved na query. Aceita https:// ou o esquema do seu app (meuapp://pedido). O retorno é liberado por empresa: confirme com a Sinnu se já está ativo para a sua. Confirme o pagamento pela API ou pelo webhook: os parâmetros da URL podem ser alterados pelo comprador.

Maximum string length: 200
externalReference
string | null

Código do produto no seu sistema. Volta como externalRef do item em cada venda do link.

Maximum string length: 255
linkedCustomer
string<uuid> | null

ID (UUID) de um cliente já cadastrado nesta empresa para vincular ao link. Mutuamente exclusivo com customer.

customer
object | null

Dados do comprador (name, email, document?, phone?) para cadastrar ou reutilizar por CPF/CNPJ e vincular ao link em uma única requisição. Mutuamente exclusivo com linkedCustomer.

maxPayments
integer | null

Limite máximo de pagamentos aprovados aceitos pelo link (null = ilimitado; 1 = link de uso único que arquiva automaticamente após ser pago).

Intervalo obrigatório: 1 <= x <= 1000000
salespersonId
integer | null
trackingPixelIds
string<uuid>[]

Resposta

Link de pagamento público da empresa autenticada. Use o slug para montar a URL do checkout hospedado.

id
string<uuid>
obrigatório
read-only
slug
string
obrigatório
read-only
title
string
obrigatório
read-only

Título exibido no checkout hospedado.

description
string
obrigatório
read-only

Descrição exibida no checkout.

imageUrl
string<uri> | null
obrigatório
read-only
priceMode
enum<string>
obrigatório

Modo de preço. No contrato público atual, use sempre fixed.

Opções disponíveis:
fixed
amountCents
integer | null
obrigatório
read-only

Valor fixo do link em centavos. Obrigatório para priceMode: fixed.

Intervalo obrigatório: 1000 <= x <= 20000000
minAmountCents
integer | null
obrigatório
read-only

Reservado para modos de preço futuros. Não use no contrato público atual.

maxAmountCents
integer | null
obrigatório
read-only

Reservado para modos de preço futuros. Não use no contrato público atual.

methods
enum<string>[]
obrigatório
read-only

Métodos aceitos no checkout. Envie pix, credit_card ou ambos.

Opções disponíveis:
pix,
credit_card
maxInstallments
integer
obrigatório
read-only

Número máximo de parcelas para cartão. Use 1 quando o link aceitar apenas Pix.

Intervalo obrigatório: 1 <= x <= 12
interestMode
enum<string>
obrigatório

Define quem absorve juros de parcelamento: absorb ou pass_to_customer.

Opções disponíveis:
absorb,
pass_to_customer
acceptsOneTime
boolean
obrigatório
read-only
status
enum<string>
obrigatório

Status do link: active, paused ou archived.

Opções disponíveis:
active,
paused,
archived
threeDsMode
enum<string>
obrigatório

Modo de 3DS para cartão: always ou contingency.

Opções disponíveis:
always,
contingency
tags
string[]
obrigatório
read-only

Tags livres para organização interna do link.

redirectUrl
string | null
obrigatório
read-only

Para onde o checkout leva o comprador depois do pagamento confirmado (cartão aprovado ou Pix pago), com transactionId, reference e status=approved na query. Aceita https:// ou o esquema do seu app (meuapp://pedido). O retorno é liberado por empresa: confirme com a Sinnu se já está ativo para a sua. Confirme o pagamento pela API ou pelo webhook: os parâmetros da URL podem ser alterados pelo comprador.

externalReference
string | null
obrigatório
read-only

Código do produto no seu sistema. Volta como externalRef do item em cada venda do link.

linkedCustomerId
string | null
obrigatório
read-only

ID do cliente vinculado ao link, quando houver.

maxPayments
integer | null
obrigatório
read-only

Limite máximo de pagamentos aprovados aceitos pelo link (null = ilimitado; 1 = link de uso único que arquiva automaticamente após ser pago).

Intervalo obrigatório: 1 <= x <= 1000000
companyId
integer | null
obrigatório
read-only
companyName
string | null
obrigatório
read-only
sellerEmail
string | null
obrigatório
read-only
salesCount
integer
obrigatório
read-only

Nº de vendas pagas do link (Payment status='paid', alinhado a maxPayments).

views
integer
obrigatório
read-only

Visitas ao checkout público (LinkVisit, já deduplicadas na escrita).

conversionRate
number<double>
obrigatório
read-only

Fração 0..1 = salesCount/views, com guarda de divisão por zero e teto em 1.0.

activeSubscriptions
integer
obrigatório
read-only

Assinaturas deste link que CONTINUAM sendo cobradas.

A cláusula é a de checkout.services.still_charging_filter - fonte única, para esta contagem e a da mensagem de arquivamento nunca contarem coisas diferentes.

Serve à tela de EDIÇÃO: o aviso de que mudar o preço não repreça quem já assinou existia, bem escrito, na tela de CRIAÇÃO - onde ainda não há assinante e a frase não significa nada. Com o número, ele passa a significar.

salespersonId
integer | null
obrigatório
read-only
salesperson
object | null
obrigatório
trackingPixelIds
string[]
obrigatório
read-only
createdAt
string<date-time>
obrigatório
read-only
updatedAt
string<date-time>
obrigatório
read-only