Validação de Requisições
A MKP-Totem usa um motor de validação próprio (não o validador padrão do
framework). Cada endpoint define um conjunto de regras; quando uma regra falha,
a resposta vem com status 401 e a lista de mensagens no campo msg.
Formato do erro de validação
{
"data": null,
"msg": ["Campo amount é obrigatório", "bank_slip inválido"],
"statusCode": 401
}
Regras disponíveis
| Regra | Descrição |
|---|---|
Required | Campo obrigatório |
Min:n / Max:n | Tamanho mínimo / máximo (em caracteres) |
Numeric | Numérico, com até 2 casas decimais |
NumericNotRequired | Numérico, mas opcional |
ValidDate | Data no formato YYYY-MM-DD |
ValidBirth / ValidExpiry | Data no passado / futuro |
ValidEmail | E-mail válido |
ValidString | Apenas letras e espaços |
ValidCpf / ValidCnpj | CPF / CNPJ com dígito verificador |
CpfOrCnpj | CPF ou CNPJ (detecta pelo tamanho) |
Unique | Valor único no banco |
Exemplo
O endpoint POST /payment valida:
| Campo | Regras |
|---|---|
bank_slip | Required, Max:47, Numeric |
due_date | Required, ValidDate |
amount | Required, Numeric, Max:11 |
terminal_id | Required, Numeric |
company_id | Required, Numeric |
Consulte cada endpoint na API Reference para ver as regras específicas no corpo da requisição.