Erros da API de Pagamentos
Formatos de erro da API de Pagamentos da My Gateway: validação, autenticação, acesso negado e erros internos, com as categorias de errorType.
Nesta página
| HTTP | Quando ocorre |
|---|---|
400 Bad Request | Payload inválido ou regra de negócio não atendida. |
401 Unauthorized | Authorization ausente, inválido ou expirado. |
403 Forbidden | Credencial reconhecida, mas sem acesso ao recurso. |
500 Internal Server Error | Erro inesperado. |
Validação ou negócio (400)#
Formato padrão
{
"notificationErrors": {
"error": {
"erros": [
{
"propertyName": "items.value",
"propertyErrors": [
"O valor informado é inválido."
]
}
]
}
},
"errorTypeDescription": "ValidationError",
"errorType": 1
}Atributos do erro
notificationErrorsobjectobrigatórioEnvelope das mensagens de erro.
Atributos de notificationErrors
error.errosarrayobrigatórioLista de propriedades inválidas. A grafia
errosé a retornada pela API.Atributos de error.erros
propertyNamestringobrigatórioCampo ou recurso relacionado ao erro.
propertyErrorsarray de stringobrigatórioUma ou mais mensagens para o campo.
errorTypeDescriptionstringobrigatórioCategoria textual do erro.
errorTypeintegerobrigatórioCódigo da categoria.
Categorias de erro#
| errorType | errorTypeDescription | Significado |
|---|---|---|
1 | ValidationError | Payload ou atributo inválido. |
2 | DataBaseError | Falha temporária de persistência. |
3 | CacheError | Falha temporária de cache ou processamento. |
4 | BusinessError | Regra de negócio não atendida. |
5 | InternalError | Erro interno identificado. |
6 | UndefinedError | Categoria não especificada. |
7 | ExceptionError | Exceção durante o processamento. |
8 | ProviderError | Falha ou recusa no processamento externo do pagamento. |
O significado de cada código MYG que aparece nas mensagens está em Códigos de erro.
Não autorizado (401)#
Resposta
{
"message": "Não autorizado",
"timestamp": "2026-10-29T21:30:00Z"
}Verifique se Authorization foi enviado exatamente como retornado na autenticação, se ainda não expirou e se a x-api-key é do mesmo ambiente.
Acesso negado (403)#
Resposta
{
"message": "Acesso negado",
"timestamp": "2026-10-29T21:30:00Z"
}A credencial foi reconhecida, mas não tem acesso ao recurso.
Erro interno (500)#
O corpo pode seguir o envelope de erro padrão. Guarde o horário, o endpoint, o clientChargeId ou paymentId e os identificadores de erro retornados para o suporte.
Última atualização em
