Comece por aqui
Convenções
Valores, datas, papéis e o formato padrão de erro da API.
Valores
- Centavos (inteiro) em cobranças (`amount`), links (`amount`), saldo (`value`) e transferências (`value`). Ex.:
15035= R$ 150,35. - Reais (decimal) apenas em QR Codes (`value`, `original_value`). Ex.:
50.0= R$ 50,00.
Datas
Datas de vencimento usam YYYY-MM-DD. Instantes (criação, atualização, expiração de link) usam ISO 8601 em UTC.
Papéis
| role | Acesso |
|---|---|
| PARTNER | Opera a própria conta, nos módulos liberados pelo master. Não vê irmãos nem a conta pai. |
| MASTER | Conta raiz. Cria clientes, fornecedores e subcontas, liga módulos e vê a produção de toda a rede. |
A hierarquia tem três níveis no cadastro da conta: master (profundidade 0), cliente ou fornecedor (1) e subconta (2). O papel do usuário continua MASTER ou PARTNER. Quem está acima vê a produção de quem está abaixo. Listagens aceitam scope=network ou partnerId de uma conta da própria árvore. Escrita (criar cobrança, Pix, lote) vale só na própria conta. Módulo desligado responde 403.
Formato de erro
JSON
{
"error": "Dados inválidos.",
"details": {}
}Sempre JSON. `details` aparece em validação (Zod) ou quando a malha de pagamentos devolve contexto extra.