Erros da API de Link de Pagamento
Códigos HTTP e formatos de erro da API de Link de Pagamento da My Gateway: validação, autenticação e erros inesperados.
Nesta página
Códigos HTTP#
| HTTP | Quando pode ocorrer |
|---|---|
200 OK | Operação concluída com sucesso. |
400 Bad Request | Payload inválido, regra de negócio não atendida, UUID vazio ou inválido, status inválido ou registro não localizado. |
401 Unauthorized | Token ausente, inválido, expirado ou sem autorização. |
403 Forbidden | x-api-key ausente, inválida ou sem acesso ao recurso no API Gateway. |
500 Internal Server Error | Erro inesperado. Use o identificador retornado para acionar o suporte. |
Validação e regra de negócio#
Formato padrão
{
"notificationErrors": {
"error": {
"errors": [
{
"propertyName": "Value",
"propertyErrors": [
"O valor informado não pode ser igual ou menor que zero"
]
}
]
}
},
"errorTypeDescription": "ValidationError",
"errorType": 1
}Atributos do erro
notificationErrors.error.errorsarrayobrigatórioLista de propriedades que falharam.
Atributos de notificationErrors.error.errors
propertyNamestringobrigatórioNome lógico da propriedade validada. Pode vir no padrão C# (
Value,AcceptedPaymentsType) em vez do nome JSON.propertyErrorsarray de stringobrigatórioUma ou mais mensagens para a propriedade.
errorTypeDescriptionstringobrigatórioCategoria textual do erro.
errorTypeintegerobrigatórioCódigo numérico 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. |
9 | EntityNotFound | Registro não encontrado. |
O significado de cada código MYG que aparece nas mensagens está em Códigos de erro.
Autenticação ou erro inesperado#
Formato
{
"errorId": "identificador-para-suporte",
"message": "Não autorizado",
"encryptdetail": "detalhe-tecnico",
"timestamp": "2026-10-29T17:40:00Z",
"ip": "203.0.113.10"
}Em erros internos, message pode ser Ocorreu um erro interno no servidor..
Última atualização em
