Pular para o conteúdo principal
Um link reúne preço, métodos de pagamento e opções do checkout. Ele pode receber mais de um pagamento: link e transação são recursos diferentes.

Defina a oferta

Corpo de criação
Envie o corpo para POST /api/payment-links. Guarde o id e o slug retornados. O SDK também tipa applepay e googlepay. A presença no contrato não garante disponibilidade para toda empresa, navegador ou dispositivo.

Dados do comprador no checkout

Se o seu sistema já coleta nome, CPF/CNPJ e e-mail no cadastro do usuário, envie customer diretamente em POST /api/payment-links ou PATCH /api/payment-links/{id}, sem precisar criar o cliente em uma chamada separada:
Link com comprador e uso único
Como o vínculo se comporta:
  • Deduplicação por empresa: quando customer.document (CPF ou CNPJ válido, com ou sem pontuação) já pertence a um cliente da sua empresa, a sinnu reaproveita o cadastro existente e atualiza nome, e-mail e telefone informados. Caso contrário, cria o cliente e retorna o identificador em linkedCustomerId.
  • Privacidade do documento: ao abrir https://pay.sinnu.com.br/{slug} ou o elemento checkout, nome, e-mail e telefone aparecem preenchidos e o CPF/CNPJ é exibido mascarado (***.456.789-** ou **.345.678/0001-**), com o botão Alterar. O documento completo nunca é exposto na consulta pública do link; a cobrança usa o documento vinculado no servidor, exceto se o comprador clicar em Alterar e informar outro.
  • Telefone opcional na API: se você enviar apenas name, email e document, esses três campos já abrem preenchidos e o comprador informa somente o celular e o meio de pagamento no checkout. Se enviar phone, ele segue direto para Pix ou cartão.
  • Cliente já salvo: quando você já mantém o id retornado por POST /api/customers/ ou sinnu.customers, envie linkedCustomer no lugar de customer. Não envie os dois campos na mesma requisição.
  • Escopos da chave: enviar customer inline exige links:write e customers:write; enviar linkedCustomer exige links:write e leitura de clientes (read ou customers:read).
Escolha o modelo conforme a relação entre link e pedido no seu sistema: Para reativar via PATCH um link arquivado ao atingir maxPayments, aumente maxPayments acima do total já aprovado ou limpe o limite com maxPayments: null junto de status: "active".

Gerencie o ciclo de vida

Use atualização parcial para alterar campos e arquivamento para retirar a oferta. Arquivar um link não estorna os pagamentos que já ocorreram.

Acompanhe os pagamentos

Consulte as transações do link. Esse endpoint retorna valores em reais. Para padronizar sua conciliação em centavos, consulte cada pagamento na API de transações. O SDK de links oferece métodos para essas operações.