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

# Visão geral da API

> Base URL, formato de valores e o que a API pública permite fazer

A API pública da ZynPay permite gerar cobranças Pix, consultar saldo e receber notificações de pagamento por webhook — sem precisar abrir o painel.

<CardGroup cols={2}>
  <Card title="Base URL" icon="server">
    ```
    https://api.zynpay.com.br
    ```
  </Card>

  <Card title="Valores monetários" icon="coins">
    Todo valor é um **inteiro em centavos**. R\$ 10,00 é `1000`.
  </Card>
</CardGroup>

## O que dá para fazer com uma chave de API

| Escopo         | Permite                                             |
| -------------- | --------------------------------------------------- |
| `pix:write`    | Criar cobranças Pix (`POST /v1/public/pix/charges`) |
| `pix:read`     | Listar e consultar cobranças                        |
| `balance:read` | Consultar o saldo da conta                          |

Saques, chaves de API e webhooks só podem ser gerenciados com a sua sessão do painel (login), nunca com uma chave de API — isso evita que uma chave vazada consiga sacar fundos.

## Antes de integrar

1. Crie sua conta e aguarde a [verificação](/primeiros-passos/verificacao-de-conta) — a API bloqueia contas não verificadas com `403 ACCOUNT_NOT_VERIFIED`.
2. Gere uma chave de API em [Autenticação](/api/autenticacao).
3. Configure um endpoint de [webhook](/api/webhooks) para saber na hora quando um Pix é pago.

<Tip>
  Prefere não integrar por API? Todo o fluxo também funciona 100% pelo painel — veja [Gerar uma cobrança Pix](/cobrancas/gerar-cobranca) e [Como sacar](/saques/como-sacar).
</Tip>