Skip to main content

Envelope de erro

Estrutura devolvida no corpo de qualquer resposta de erro (400, 401). Veja quando cada status ocorre em Tratamento de erros.

{
"messages": [
{ "code": "4051004", "text": "Termo de autorização não está ativo ou expirou" }
]
}
CampoTipoAceita nuloDescrição
messagesarrayNão (lista vazia por padrão)Uma ou mais mensagens de erro/validação. Vários erros de validação podem vir juntos.
messages[].codestringSimCódigo do erro. "401"/"403" correspondem aos status HTTP de mesmo número; "9999999" é o genérico para falha não classificada. Demais códigos são específicos de cada módulo — lista completa em Códigos de erro por módulo.
messages[].textstringSimMensagem legível, em português. Pode mudar entre versões; trate o erro pelo code.

403 e 404 são os únicos casos em que o corpo vem vazio — e 404 é raro, porque um id inexistente devolve 400 com o código "não encontrado" do módulo. Ver Tratamento de erros.