> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sinnu.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Documentação oficial da sinnu, gateway de pagamento brasileiro: Pix e cartão de crédito. O índice de todas as páginas está em https://docs.sinnu.com.br/llms.txt.
> A API (https://api.sinnu.com.br) e o checkout (https://pay.sinnu.com.br) documentados são de produção. Não há ambiente público de testes: cada chamada cria ou altera dados reais.
> A chave secreta sk_live_ fica só no servidor. O navegador recebe apenas o slug do link ou a URL do checkout.
> Unidades: amountCents do link e os valores de /api/transactions/ estão em centavos (inteiro). data.amount do webhook e amount das transações de um link estão em reais. Compare na mesma unidade.
> Status: a API de transações usa approved; o corpo do webhook usa paid; o evento é transaction.approved.
> Libere o pedido só pelo webhook assinado (X-Sinnu-Signature, validado sobre o corpo cru com constructEvent({ payload, signature, secret })) e confirme com transactions.get. Nunca pelo evento completed do Sinnu Elements nem pelos parâmetros da URL de retorno.
> Estorno é sempre do valor total. Não invente métodos, campos ou eventos: confira na referência do SDK e da API.

# Links

> Crie, consulte, atualize e arquive links de pagamento com o SDK.

Os exemplos pressupõem um cliente `sinnu` [configurado no servidor](https://docs.sinnu.com.br/sdk/configuracao.md).

## Crie um link

```ts TypeScript theme={null}
const link = await sinnu.links.create({
  title: "Consultoria inicial",
  priceMode: "fixed",
  amountCents: 9900,
  methods: ["pix", "credit_card"],
  maxInstallments: 1,
  interestMode: "pass_to_customer",
});

const url = sinnu.checkout.url(link.slug);
```

`amountCents` é um inteiro em centavos. Use o `id` para gerenciar o link e o `slug` para abrir o checkout. A resposta tipada não possui uma propriedade `url`: monte-a com `checkout.url`.

## Crie um link com comprador e limite de pagamentos

Quando o seu sistema já coleta os dados do comprador no cadastro, envie `customer` e `maxPayments` na própria criação do link (disponível a partir da `0.3.0`):

```ts TypeScript theme={null}
const link = await sinnu.links.create({
  title: "Pedido #1042",
  priceMode: "fixed",
  amountCents: 14900,
  methods: ["pix", "credit_card"],
  maxInstallments: 3,
  interestMode: "pass_to_customer",
  maxPayments: 1,
  customer: {
    name: "Maria Oliveira",
    email: "maria@exemplo.com.br",
    document: "12345678909",
    phone: "11999998888",
  },
});

const url = sinnu.checkout.url(link.slug, { reference: "pedido-1042" });
```

`customer.phone` é opcional na API: sem ele, nome, e-mail e CPF/CNPJ mascarado já chegam preenchidos e o comprador informa apenas o celular no checkout. Com `maxPayments: 1`, o link passa automaticamente para `archived` assim que o primeiro pagamento é aprovado. Veja os detalhes em [Links de pagamento](https://docs.sinnu.com.br/guias/links-de-pagamento.md#dados-do-comprador-no-checkout) ou gerencie cadastros em [`sinnu.customers`](https://docs.sinnu.com.br/sdk/clientes).

## Consulte e atualize

```ts TypeScript theme={null}
const current = await sinnu.links.get(link.id);
const paused = await sinnu.links.update(link.id, { status: "paused" });
```

`update` envia apenas os campos informados via `PATCH`.

## Liste e percorra

```ts TypeScript theme={null}
const page = await sinnu.links.list({ page: 1, pageSize: 20 });

for await (const item of sinnu.links.listAll({ pageSize: 20 })) {
  console.log(item.id, item.status);
}
```

## Consulte as transações do link

```ts TypeScript theme={null}
const payments = await sinnu.links.transactions(link.id, {
  page: 1,
  pageSize: 20,
});
```

O `amount` dessa resposta está em reais. Não use o formatador em centavos da API de transações sem converter a unidade.

## Arquive

```ts TypeScript theme={null}
await sinnu.links.archive(link.id);
```

O método retorna `void`. Arquivar não estorna transações existentes.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.