> ## 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.

# Transações

> Consulte pagamentos, filtre resultados e solicite um estorno total.

## Consulte uma transação

```ts TypeScript theme={null}
const transaction = await sinnu.transactions.get(transactionId);

const formatted = new Intl.NumberFormat("pt-BR", {
  style: "currency",
  currency: "BRL",
}).format(transaction.amount / 100);
```

Nessa resposta, `amount` está em centavos e uma aprovação aparece como `status: "approved"`.

## Filtre a listagem

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

| Parâmetro | Uso |
| - | - |
| `status` | Filtrar pelo status público da transação. |
| `search` | Buscar por nome, e-mail do cliente ou descrição. |
| `customer` | Filtrar pelo identificador do cliente. |
| `page` / `pageSize` | Controlar a página. |

Para percorrer todos os resultados, use `sinnu.transactions.listAll` e [processe uma página de cada vez](https://docs.sinnu.com.br/sdk/paginacao-e-erros.md).

## Solicite estorno total

Estorne apenas após conferir a transação, a empresa e a decisão de devolução. O método solicita uma alteração financeira real e não recebe um valor parcial. A chave precisa do escopo `transactions:refund`; sem ele, a API responde `403`.

```ts TypeScript theme={null}
const updated = await sinnu.transactions.refund(transactionId, {
  reason: "Solicitado pelo comprador",
  note: "Devolução aprovada no atendimento",
});

console.log(updated.status);
```

Se a requisição falhar por timeout, consulte o estado antes de reenviar. Acompanhe o resultado também por `transaction.refunded`.


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