Erros técnicos da API (Code e Message)

Erros retornados em Code e Message

Os parâmetros Code e Message aparecem no corpo da resposta quando ocorre um erro HTTP, geralmente o 4xx. Eles detalham a causa da falha na requisição ou no processamento, permitindo identificar rapidamente o problema.

• Code: código numérico que identifica o tipo de erro;
• Message: mensagem textual do erro.

Exemplo

Veja a seguir um exemplo de corpo da resposta para uma requisição ao VerifyCard quando existe erro no MerchantId

[
  {
    "Code": 114,
    "Message": "The provided MerchantId is not in correct format"
  }
]

Como tratar os erros de Code e Message?

• Corrija os dados enviados: verifique os campos obrigatórios, formatos e tamanhos;
• Verifique credenciais MerchantId e MerchantKey;
• Confirme os serviços habilitados no site Cielo, na aba E-commerce;
• Confirme IPs autorizados no site Cielo;
• Consulte API Status para erros 5xx persistentes.

Tabela de Code e Message

Code e Message apresentam os mesmos valores de ProviderReturnCode e ProviderReturnMessage, mas retornam em situações diferentes:

• Os valores ProviderReturnCode e ProviderReturnMessage são retornados em operações HTTP de sucesso (200 ou 201);
• Os valores Code e Message são retornados em operações HTTP de erro (ex.: 400).

Confira a tabela completa: