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

# SwytchPay API

> Gateway de pagamentos multi-provedor (PIX) para corretoras

> ⚠️ **Confidencial** — codinome stealth, provisório. Não divulgar.

A API do **SwytchPay** integra **depósito e saque via PIX** num único gateway que orquestra
múltiplos provedores. Uma corretora pluga uma vez e ganha redundância, roteamento e
conciliação — sem amarrar a um provedor só.

## Conceitos

* **Depósito** (`deposit`) — cobrança PIX in. A corretora cria, o player paga, o webhook confirma.
* **Saque** (`payout`) — PIX out para qualquer chave (saque de player ou settlement).
* **Saldo** (`balance`) — disponível / pendente / bloqueado, em centavos.
* **Webhook** — notificação assinada quando um depósito/saque muda de status.
* **Modo test** — universo paralelo (chaves `pk_test_…`) para integrar sem dinheiro real.

## Princípios

* **Dinheiro em centavos** (inteiro) — `amount_cents`, nunca decimal. Sem ambiguidade de vírgula.
* **Idempotência** por `external_id` — repetir um POST com o mesmo `external_id` devolve o
  recurso existente (nunca duplica).
* **Webhook-first** — o status muda de forma assíncrona; reaja ao webhook, não faça polling.

## Comece por aqui

<Card title="Quickstart" href="/reference/quickstart">Crie seu primeiro depósito em modo test.</Card>