Referência
Erros e status
Códigos HTTP, corpo de erro e enumeradores usados nas respostas.
HTTP
| Código | Quando |
|---|---|
| 200 | Sucesso em leitura ou ação sem criação. |
| 201 | Recurso criado (cobrança, link, lote, transferência, chave, QR, parceiro). |
| 400 | Payload inválido ou regra de negócio da requisição. |
| 401 | Ausência de sessão, JWT inválido ou expirado. |
| 403 | Papel insuficiente (ex.: criar parceiro sem ser MASTER). |
| 404 | Recurso inexistente na conta autenticada. |
| 409 | Conflito — slug de parceiro já existe. |
| 500 | Erro interno. Mensagem genérica; detalhes no servidor. |
Status de cobrança (receivable)
| status | Significado |
|---|---|
| created | Criada, aguardando pagamento |
| processing | Em processamento |
| paid | Paga |
| refunded | Estornada |
| canceling | Cancelamento em andamento |
| canceled | Cancelada |
Status de lote
| status | Significado |
|---|---|
| draft | Rascunho — ainda aceita transferências |
| waiting_approval | Aguardando aprovação |
| processing | Em processamento |
| finished | Finalizado |
| canceled | Cancelado |
Status de transferência
| status | Significado |
|---|---|
| draft | Rascunho |
| created | Criada |
| processing | Em processamento |
| transferred | Transferida |
| failed | Falhou |
| returned | Devolvida |
Tipos de chave Pix
| key_type | Descrição |
|---|---|
| TELEFONE | Telefone (E.164, ex. +5551999999999) |
| CPF | CPF |
| CNPJ | CNPJ |
| CHAVE_ALEATORIA | Chave aleatória (EVP) |
Status de QR Code
| status | Significado |
|---|---|
| ATIVA | Pode receber pagamento |
| CONCLUIDA | Cobrança liquidada |
| REMOVIDA_PELO_USUARIO_RECEBEDOR | Revogada pela conta |
| REMOVIDA_PELO_PSP | Revogada pelo prestador |