​
Formato do Objeto de Erro

Quando um erro ocorre durante o processamento de uma requisição na API do GatewayFy, a resposta é um objeto JSON que segue o formato abaixo:

{
	"statusCode": 500,
	"errorCode": "GATEWAY_INTERNAL_SERVER_ERROR",
	"message": "Mensagem detalhada sobre o erro",
	"details": {
		"campo1": "Detalhes sobre o campo 1",
		"campo2": "Detalhes sobre o campo 2"
	}
}

​
Campos do Objeto de Erro

  • statusCode (number): O código de status HTTP da resposta.
  • errorCode (string): O código de erro da API. Este código segue o padrão dos códigos de erro que estão listados abaixo.
  • message (string): Uma mensagem de erro detalhada.
  • details (any): Detalhes adicionais sobre o erro (opcional). Este campo pode conter qualquer tipo de dado.

​
Códigos de Erro

A tabela abaixo lista os códigos de erro que podem ser retornados pela API do GatewayFy.

Código de ErroDescrição
GATEWAY_INTERNAL_SERVER_ERRORErro genérico do servidor; algo deu errado no lado do servidor que não foi especificado mais detalhadamente.
GATEWAY_NOT_FOUNDO recurso solicitado não foi encontrado.
GATEWAY_UNAUTHORIZEDFalha na autenticação com as credenciais fornecidas.
GATEWAY_INVALID_ARGUMENTUm ou mais argumentos fornecidos na requisição são inválidos.
GATEWAY_PERMISSION_DENIEDO cliente não tem permissão para executar a operação solicitada.
GATEWAY_RESOURCE_EXHAUSTEDA requisição atingiu o limite de recursos, como tempo de CPU ou memória.
GATEWAY_FAILED_PRECONDITIONA operação foi rejeitada porque o sistema não está no estado necessário para a execução da operação.
GATEWAY_ABORTEDA operação foi abortada, geralmente devido a uma questão de concorrência.
GATEWAY_OUT_OF_RANGEA operação foi tentada fora dos limites válidos.
GATEWAY_UNIMPLEMENTEDA operação não é suportada ou ainda não foi implementada.
GATEWAY_INTERNALUm erro interno ocorreu enquanto tentava executar esta operação.
GATEWAY_UNAVAILABLEO serviço não está disponível no momento.
GATEWAY_DATA_LOSSDados críticos foram perdidos devido a um erro.
GATEWAY_UNAUTHENTICATEDA requisição requer autenticação, mas ela não foi fornecida.
GATEWAY_INVALID_DATAOs dados fornecidos são inválidos ou corrompidos.
AutenticaçãoWebhooks