ℹ️ Conteúdo em atualização
Estamos revisando estes procedimentos. Pessoas técnicas podem encontrar ajustes em códigos de erro ou mapeamentos de payload; valide com os logs e o OpenAPI mais recente. Pessoas não técnicas podem continuar usando o passo a passo e acionar o time de suporte caso algo pareça diferente do descrito.
🔧 Troubleshooting - Arrecadação Lojista
Este guia ajuda você a identificar e resolver problemas comuns ao integrar com a API de Arrecadação Lojista.
🎯 Início Rápido: Checklist de Debug
Antes de abrir um chamado de suporte, verifique:
- Token válido: Seu JWT está dentro da validade?
- Headers corretos: Header
Authorization: Bearer <token>está presente? - URL correta: Está usando HML ou PRD apropriadamente?
- Formato JSON: Body está em JSON válido?
- Campos obrigatórios: Todos os campos required foram enviados?
- TraceId salvo: Guardou o
traceIdda requisição com erro?
📚 Erros Comuns por Endpoint
1️⃣ Consulta de Títulos (GET /consulta-titulo)
⚠️ 400 Bad Request
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization é obrigatório | Informe o token de autorização válido. | Adicione header: Authorization: Bearer <seu_token> |
Campo(s) obrigatório(s) | cpfCliente é obrigatório. | Adicione parâmetro: ?cpfCliente=12345678901 |
Campo(s) obrigatório(s) | codigoEstabelecimento é obrigatório. | Adicione parâmetro: &codigoEstabelecimento=12345 |
Campo(s) com formato(s) inválido(s). | codigoEstabelecimento inválido, só aceitamos números | Verifique se o codigoEstabelecimento é apenas números. |
Exemplo de requisição correta:
curl -X GET "https://apihml.credsystem.com.br/arrecadacao-lojista/api/v2/consulta-titulo?cpfCliente=12345678901&codigoEstabelecimento=12345" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."
⚠️ 401 Unauthorized
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization inválido | Informe o token de autorização válido. | Obtenha um novo token via endpoint de autenticação |
Não Autorizado | Token expirado | Tokens JWT têm validade limitada. Renove seu token |
Como renovar o token:
- Faça nova requisição ao endpoint de autenticação
- Guarde o novo token
- Implemente lógica de renovação automática (antes de expirar)
⚠️ 403 Forbidden
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Acesso negado. | Você não tem permissão para acessar esse recurso. | Verifique se você deveria ter acesso às informações solicitadas. |
⚠️ 404 Not Found
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Dados não encontrados | Estabelecimento não encontrado ou não pertence a sua rede. | O estabelecimento informado precisa ser maior que zero e pertencer a sua rede. |
Cliente informado inválido ou inexistente | CPF não encontrado na base | Confirme o CPF do cliente (apenas números, 11 dígitos) |
⚠️ 422 Unprocessable Entity
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Validação de campos | cpfCliente não é válido. | Valide o CPF antes de enviar (dígitos verificadores) |
⚠️ 500 Internal Server Error
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Error | Erros não tratados | Entre em contato com o suporte e informe o erro. |
2️⃣ Pré-Autorização (POST /pre-autorizacao)
⚠️ 400 Bad Request
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Dados de entrada inválidos ou não existentes. | Corpo da requisição vazio ou dados inexistentes. | Verifique o payload enviado. |
Campo(s) obrigatório(s) | cpfCliente é obrigatório | Verifique se informou o CPF do cliente. |
Campo(s) obrigatório(s) | codigoEstabelecimento é obrigatório | Verifique se foi informado o código do estabelecimento. |
Campo(s) obrigatório(s) | codigoEstabelecimento ausente | Adicione no body: "codigoEstabelecimento": "12345" |
Campo(s) com formato(s) inválido(s) | Formato de número incorreto | CodigoEstabelecimento deve ser string numérica |
Campo(s) com formato(s) inválido(s). | codigoEstabelecimento inválido, só aceitamos números | Verifique se o codigoEstabelecimento é apenas números. |
Authorization é obrigatório. | Informe o token de autorização válido. | Valide se o Bearer token foi enviado corretamente. |
⚠️ 401 Unauthorized
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization inválido. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Não Autorizado | Authorization expirado. | Gere um novo Bearer token. |
⚠️ 403 Forbidden
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Acesso negado. | Você não tem permissão para acessar esse recurso. | Verifique se você deveria ter acesso às informações solicitadas. |
⚠️ 404 Not Found
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Dados não encontrados | Estabelecimento não encontrado ou não pertence à sua rede. | O codigoEstabelecimento deve ser informado, ser maior que 0 e pertencer à rede. |
Cliente informado inválido ou inexistente. | O cliente não foi encontrado e/ou não pertence à rede. | Verifique o cliente informado. |
⚠️ 412 Precondition Failed
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Extrato informado inválido ou não localizado | Se o extrato informado é válido, tente novamente mais tarde. | Se a mensagem persistir, tente novamente mais tarde. |
Divergencia de dados para pagamento de titulo promocional. | A parcela nº 1, vinculada ao contrato nº 12344431 não pode ser validada. O contrato informado não foi localizado | Verifique os dados informados. |
Divergencia de dados para pagamento de titulo promocional. | A parcela nº 10, vinculada ao contrato nº 12345512 não pode ser validada. Ordem de pagamento incorreta | Verifique o carnê e a parcela do pagamento. |
Divergencia de dados para pagamento de titulo promocional. | Não foi informado o codigo do estabelecimento da parcela | Verifique se foram passadas todas as informações necessárias. |
Dica: Sempre use os dados retornados pelo endpoint de consulta de títulos.
⚠️ 422 Unprocessable Entity
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Validação de campos | cpfCliente não é válido. | Verifique o CPF do cliente informado. |
Valores divergentes | O valor total do pagamento informado está incorreto. | Some exatamente os valores informados. |
Consulta título não localizada. | Para fazer uma pré-autorização é obrigatório fazer a consulta título primeiro. | Realize a consulta título antes de realizar a pré-autorização. |
⚠️ 500 Internal Server Error
Poss íveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Erros genéricos | Erros genéricos | Caso o erro retornado não seja inteligível, entre em contato com o suporte. |
⚠️ 503 Service Unavailable
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Serviço indisponível | Infelizmente estamos passando por uma instabilidade no momento. Tente novamente mais tarde. | Caso o serviço demore a ficar estável, por favor, contate o suporte. |
⚠️ 504 Gateway Timeout
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Tempo excedido | O servidor não respondeu a tempo. Por favor, tente novamente. | Tente novamente em alguns instantes, podemos estar com instabilidade. |
3️⃣ Pré-Autorização PIX (POST /pre-autorizacao/pix)
⚠️ 400 Bad Request
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Dados de entrada inválidos ou não existentes. | Corpo da requisição vazio ou dados inexistentes. | Verifique o payload enviado. |
Authorization é obrigatório. | Informe o token de autorização válido. | Verifique se o Bearer token foi informado. |
Divergência de valor | O valor total do pagamento informado está incorreto. | Verifique o valor informado. |
Campo(s) obrigatório(s) | cpfCliente é obrigatório | Verifique se enviou o campo cpfCliente. |
Campo(s) obrigatório(s) | cpfCliente não é válido | Verifique se enviou o cpfCliente com CPF válido. |
Campo(s) obrigatório(s) | codigoEstabelecimento é obrigatório. | Verifique se enviou o campo codigoEstabelecimento. |
Campo(s) com formato(s) inválido(s). | codigoEstabelecimento inválido, só aceitamos números | Verifique se o codigoEstabelecimento contém apenas números. |
Campo(s) obrigatório(s) | codigoEstabelecimento ausente | Adicione no body: "codigoEstabelecimento": "12345" |
Campo(s) com formato(s) inválido(s) | Formato de número incorreto | CodigoEstabelecimento deve ser string numérica |
⚠️ 401 Unauthorized
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization inválido. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Não Autorizado | Authorization expirado. | Gere um novo Bearer token. |
⚠️ 403 Forbidden
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Acesso negado. | Você não tem permissão para acessar esse recurso. | Verifique se você deveria ter acesso às informações solicitadas. |
⚠️ 404 Not Found
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Dados não encontrados | Estabelecimento não encontrado ou não pertence à sua rede. | O codigoEstabelecimento deve ser informado, ser maior que 0 e pertencer à rede. |
Cliente informado inválido ou inexistente. | O cliente não foi encontrado e/ou não pertence à rede. | Verifique o cpfCliente informado. |
⚠️ 412 Precondition Failed
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Extrato informado inválido ou não localizado | Se o extrato informado é válido, tente novamente mais tarde. | Se a mensagem persistir, tente novamente mais tarde. |
Divergencia de dados para pagamento de titulo promocional. | A parcela nº 1, vinculada ao contrato nº 12344431 não pode ser validada. O contrato informado não foi localizado | Verifique os dados informados. |
Divergencia de dados para pagamento de titulo promocional. | A parcela nº 10, vinculada ao contrato nº 12345512 não pode ser validada. Ordem de pagamento incorreta | Verifique o carnê e a parcela do pagamento. |
Divergencia de dados para pagamento de titulo promocional. | Não foi informado o codigo do estabelecimento da parcela | Verifique se foram passadas todas as informações necessárias. |
Dica: Sempre use os dados retornados pelo endpoint de consulta de títulos.
⚠️ 422 Unprocessable Entity
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Validação de campos | cpfCliente não é válido. | Verifique o CPF do cliente. |
Valores divergentes | O valor total do pagamento informado está incorreto. | Verifique o valor informado. |
⚠️ 500 Internal Server Error
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Erros genéricos | Erros genéricos | Caso o erro retornado não seja inteligível, entre em contato com o suporte. |
⚠️ 503 Service Unavailable
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Serviço indisponível | Infelizmente estamos passando por uma instabilidade no momento. Tente novamente mais tarde. | Caso o serviço demore a ficar estável, por favor, contate o suporte. |
⚠️ 504 Gateway Timeout
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Tempo excedido | O servidor não respondeu a tempo. Por favor, tente novamente. | Tente novamente em alguns instantes, podemos estar com instabilidade. |
4️⃣ Pré-autorização sonda status PIX (GET /pre-autorizacao/sonda/status-pix)
⚠️ 400 Bad Request
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization é obrigatório | Informe o token de autorização válido. | Verifique se o Bearer token foi informado. |
Campo(s) obrigatório(s). | codigoPreAutorizacao é obrigatório. | Verifique se informou o codigoPreAutorizacao |
Campo(s) obrigatório(s). | codigoEstabelecimento é obrigatório. | Verifique se informou o codigoEstabelecimento |
⚠️ 401 Unauthorized
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization inválido | Informe o token de autorização válido. | Obtenha um novo token via endpoint de autenticação |
Não Autorizado | Token expirado | Tokens JWT têm validade limitada. Renove seu token |
⚠️ 403 Forbidden
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Acesso negado. | Você não tem permissão para acessar esse recurso. | Verifique se você deveria ter acesso às informações solicitadas. |
⚠️ 404 Not Found
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Dados não encontrados | Estabelecimento não encontrado ou não pertence à sua rede. | O estabelecimento informado precisa ser maior que zero e pertencer à sua rede. |
⚠️ 422 Unprocessable Entity
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Validação de campos | codigoPreAutorizacao é obrigatório | Verifique se informou o codigoPreAutorizacao e se é maior que zero |
Campo(s) inválido(s) e/ou inexistente(s). | Código de pré-autorização e/ou loja estão inválidos | Verifique se informou os campos. |
⚠️ 500 Internal Server Error
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Erros genéricos | Erros genéricos | Caso o erro retornado não seja inteligível, entre em contato com o suporte. |
⚠️ 503 Service Unavailable
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Serviço indisponível | Infelizmente estamos passando por uma instabilidade no momento. Tente novamente mais tarde. | Caso o serviço demore a ficar estável, por favor, contate o suporte. |
⚠️ 504 Gateway Timeout
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Tempo excedido | O servidor não respondeu a tempo. Por favor, tente novamente. | Tente novamente em alguns instantes, podemos estar com instabilidade. |
5️⃣ Pré-autorização sonda status (GET /pre-autorizacao/sonda/status)
⚠️ 400 Bad Request
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization é obrigatório | Informe o token de autorização válido. | Verifique se o Bearer token foi informado. |
Campo(s) obrigatório(s). | codigoPreAutorizacao é obrigatório. | Verifique se informou o codigoPreAutorizacao |
Campo(s) obrigatório(s). | codigoEstabelecimento é obrigatório. | Verifique se informou o codigoEstabelecimento |
⚠️ 401 Unauthorized
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization inválido | Informe o token de autorização válido. | Obtenha um novo token via endpoint de autenticação |
Não Autorizado | Token expirado | Tokens JWT têm validade limitada. Renove seu token |
⚠️ 403 Forbidden
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Acesso negado. | Você não tem permissão para acessar esse recurso. | Verifique se você deveria ter acesso às informações solicitadas. |
⚠️ 404 Not Found
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Dados não encontrados | Estabelecimento não encontrado ou não pertence à sua rede. | O estabelecimento informado precisa ser maior que zero e pertencer à sua rede. |
⚠️ 422 Unprocessable Entity
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Validação de campos | codigoPreAutorizacao é obrigatório | Verifique se informou o codigoPreAutorizacao e se é maior que zero |
Campo(s) inválido(s) e/ou inexistente(s). | Código de pré-autorização e/ou loja estão inválidos | Verifique se informou os campos. |
⚠️ 500 Internal Server Error
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Erros genéricos | Erros genéricos | Caso o erro retornado não seja inteligível, entre em contato com o suporte. |
⚠️ 503 Service Unavailable
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Serviço indisponível | Infelizmente estamos passando por uma instabilidade no momento. Tente novamente mais tarde. | Caso o serviço demore a ficar estável, por favor, contate o suporte. |
⚠️ 504 Gateway Timeout
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Tempo excedido | O servidor não respondeu a tempo. Por favor, tente novamente. | Tente novamente em alguns instantes, podemos estar com instabilidade. |
6️⃣ Efetivação (POST /efetivacao)
⚠️ 400 Bad Request
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization é obrigatório. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Campo(s) obrigatório(s). | codigoPreAutorizacao é obrigatório. | Verifique o codigoPreAutorizacao informado. |
Campo(s) obrigatório(s). | codigoEstabelecimento é obrigatório. | Verifique o codigoEstabelecimento informado. |
Campo(s) com formato(s) inválido(s). | codigoEstabelecimento é obrigatório. | Verifique se o codigoEstabelecimento contém apenas números. |
Campo(s) obrigatório(s). | Codigo Estabelecimento, Valor Pagamento e Codigo Pré-Autorização são obrigatórios. | Verifique as informações enviadas. |
Divergência de Valor | O valor total do pagamento informado está incorreto. | Verifique se o valor passado é o mesmo que foi pré-autorizado. |
⚠️ 401 Unauthorized
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization inválido. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Não autorizado. | Authorization expirado. | Gere um novo Bearer token. |
⚠️ 403 Forbidden
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Acesso negado. | Você não tem permissão para acessar esse recurso. | Verifique se você realmente tem acesso a esse recurso. |
⚠️ 404 Not Found
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Dados não encontrados | Estabelecimento não encontrado ou não pertence à sua rede. | Verifique se o estabelecimento informado é válido e se é de sua rede. |
Código pré-autorização não localizado. | O código de pré-autorização informado é inválido e/ou inexistente. | Verifique o código de pré-autorização. |
Importante: Pré-autorizações são válidas apenas no mesmo dia da criação.
⚠️ 409 Conflict
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Não é possível efetivar o pagamento. | A pré-autorização informada já foi arrecadada. | Verifique se já ocorreu a efetivação da pré-autorização informada. |
⚠️ 422 Unprocessable Entity
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Validação de campos | codigoPreAutorizacao é obrigatório. | Verifique se o codigoPreAutorizacao foi informado e se é maior que zero. |
Divergência de estabelecimento. | O codigoEstabelecimento informado é divergente do estabelecimento da pré-autorização. | Verifique o codigoEstabelecimento informado. |
Divergência de dia de Efetivação. | Efetivação só pode ser feita no mesmo dia da geração da pré-autorização. | Verifique se a pré-autorização informada é do mesmo dia da efetivação. |
⚠️ 500 Internal Server Error
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Erros genéricos | Erros genéricos | Caso o erro retornado não seja inteligível, entre em contato com o suporte. |
⚠️ 503 Service Unavailable
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Serviço indisponível | Infelizmente estamos passando por uma instabilidade no momento. Tente novamente mais tarde. | Caso o serviço demore a ficar estável, por favor, contate o suporte. |
⚠️ 504 Gateway Timeout
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Tempo excedido | O servidor não respondeu a tempo. Por favor, tente novamente. | Tente novamente em alguns instantes, podemos estar com instabilidade. |
7️⃣ Efetivação Sonda (GET /efetivacao/sonda)
⚠️ 400 Bad Request
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization é obrigatório. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Campo(s) obrigatório(s). | codigoPreAutorizacao é obrigatório. | Verifique o codigoPreAutorizacao informado. |
Campo(s) obrigatório(s). | codigoEstabelecimento é obrigatório. | Verifique o codigoEstabelecimento informado. |
Campo(s) com formato(s) inválido(s). | codigoEstabelecimento é obrigatório. | Verifique se o codigoEstabelecimento contém apenas números. |
⚠️ 401 Unauthorized
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization inválido. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Não autorizado. | Authorization expirado. | Gere um novo Bearer token. |
⚠️ 403 Forbidden
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Acesso negado. | Você não tem permissão para acessar esse recurso. | Verifique se você realmente tem acesso a esse recurso. |
⚠️ 404 Not Found
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Dados não encontrados | Estabelecimento não encontrado ou não pertence à sua rede. | Verifique se o estabelecimento informado é válido e se é de sua rede. |
⚠️ 409 Conflict
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Mapeamento em atualização | Estamos revisando os retornos de conflito para este endpoint. | Consulte os logs da aplicação ou acione o suporte para orientação. |
⚠️ 422 Unprocessable Entity
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Validação de campos | codigoPreAutorizacao é obrigatório. | Verifique se o codigoPreAutorizacao foi informado e se é maior que zero. |
⚠️ 500 Internal Server Error
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Erros genéricos | Erros genéricos | Caso o erro retornado não seja inteligível, entre em contato com o suporte. |
⚠️ 503 Service Unavailable
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Serviço indisponível | Infelizmente estamos passando por uma instabilidade no momento. Tente novamente mais tarde. | Caso o serviço demore a ficar estável, por favor, contate o suporte. |
⚠️ 504 Gateway Timeout
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Tempo excedido | O servidor não respondeu a tempo. Por favor, tente novamente. | Tente novamente em alguns instantes, podemos estar com instabilidade. |
8️⃣ Desfazimento (POST /desfazimento)
⚠️ 400 Bad Request
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization é obrigatório. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Campo(s) obrigatório(s). | codigoEstabelecimento é obrigatório. | Verifique o codigoEstabelecimento informado. |
Campo(s) com formato(s) inválido(s). | codigoEstabelecimento é obrigatório. | Verifique se o codigoEstabelecimento contém apenas números. |
Campo(s) obrigatório(s). | codigoAutorizacao é uma informação obrigatória | Verifique se o campo foi informado e se é diferente de zero. |
Campo(s) obrigatório(s). | Identificador e Valor são campos obrigatórios. | Verifique se informou os campos. |
⚠️ 401 Unauthorized
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization inválido. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Não autorizado. | Authorization expirado. | Gere um novo Bearer token. |
⚠️ 403 Forbidden
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Acesso negado. | Você não tem permissão para acessar esse recurso. | Verifique se você realmente tem acesso a esse recurso. |
⚠️ 404 Not Found
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Dados não encontrados | Estabelecimento não encontrado ou não pertence à sua rede. | Verifique se o estabelecimento informado é válido e se é de sua rede. |
⚠️ 409 Conflict
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Mapeamento em atualização | Estamos revisando os retornos de conflito para este endpoint. | Consulte os logs da aplicação ou acione o suporte para orientação. |
⚠️ 422 Unprocessable Entity
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Mapeamento em atualização | Estamos revisando os retornos deste endpoint. | Valide com os logs ou contate o suporte. |
⚠️ 500 Internal Server Error
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Erros genéricos | Erros genéricos | Caso o erro retornado não seja inteligível, entre em contato com o suporte. |
⚠️ 503 Service Unavailable
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Serviço indisponível | Infelizmente estamos passando por uma instabilidade no momento. Tente novamente mais tarde. | Caso o serviço demore a ficar estável, por favor, contate o suporte. |
⚠️ 504 Gateway Timeout
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Tempo excedido | O servidor não respondeu a tempo. Por favor, tente novamente. | Tente novamente em alguns instantes, podemos estar com instabilidade. |
⚠️ ATENÇÃO: Desfazimentos só podem ser realizados no mesmo dia do pagamento!
9️⃣ Desfazimento (GET /desfazimento)
⚠️ 400 Bad Request
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization é obrigatório. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Campo(s) obrigatório(s). | codigoEstabelecimento é obrigatório. | Verifique o codigoEstabelecimento informado. |
Campo(s) com formato(s) inválido(s). | codigoEstabelecimento inválido, só aceitamos números | Verifique se o codigoEstabelecimento contém apenas números. |
⚠️ 401 Unauthorized
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization inválido. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Não autorizado. | Authorization expirado. | Gere um novo Bearer token. |
⚠️ 403 Forbidden
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Acesso negado. | Você não tem permissão para acessar esse recurso. | Verifique se você realmente tem acesso a esse recurso. |
⚠️ 404 Not Found
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Dados não encontrados | Estabelecimento não encontrado ou não pertence à sua rede. | Verifique se o estabelecimento informado é válido e se é de sua rede. |
⚠️ 409 Conflict
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Mapeamento em atualização | Estamos revisando os retornos de conflito para este endpoint. | Consulte os logs da aplicação ou acione o suporte para orientação. |
⚠️ 422 Unprocessable Entity
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Mapeamento em atualização | Estamos revisando os retornos deste endpoint. | Valide com os logs ou contate o suporte. |
⚠️ 500 Internal Server Error
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Erros genéricos | Erros genéricos | Caso o erro retornado não seja inteligível, entre em contato com o suporte. |
⚠️ 503 Service Unavailable
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Serviço indisponível | Infelizmente estamos passando por uma instabilidade no momento. Tente novamente mais tarde. | Caso o serviço demore a ficar estável, por favor, contate o suporte. |
⚠️ 504 Gateway Timeout
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Tempo excedido | O servidor não respondeu a tempo. Por favor, tente novamente. | Tente novamente em alguns instantes, podemos estar com instabilidade. |
1️⃣0️⃣ Faturas (GET /faturas)
⚠️ 400 Bad Request
| Título | Detalhe | Solução |
|---|---|---|
Authorization é obrigatório. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Campo(s) obrigatorio(s) não enviado(s). | Favor informar um CPF ou número de cartão válido. | Informe o CPF ou cartão válido. |
Validação de campos | Número do cartão inválido | Remova caracteres especiais e envie somente números (12 a 19 dígitos). |
Campo(s) obrigatório(s). | codigoEstabelecimento é obrigatório | Verifique o código do estabelecimento informado. |
⚠️ 401 Unauthorized
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization inválido. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Não autorizado. | Authorization expirado. | Gere um novo Bearer token. |
⚠️ 403 Forbidden
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Acesso negado. | Você não tem permissão para acessar esse recurso. | Verifique se você realmente tem acesso a esse recurso. |
⚠️ 404 Not Found
| Título | Detalhe | Solução |
|---|---|---|
Dados não encontrados | Estabelecimento não encontrado ou não pertence à sua rede. | Verifique se o estabelecimento informado é válido e se é de sua rede. |
Dados não encontrados | Cliente não encontrado ou não pertence à sua rede. | Verifique o cliente informado. |
Dados não encontrados | Cartão cliente não encontrado ou não pertence à sua rede. | Verifique o cartão do cliente. |
⚠️ 422 Unprocessable Entity
| Título | Detalhe | Solução |
|---|---|---|
Validação de campos | cpfCliente não é válido | Verifique o CPF informado. |
Validação de campos | Número do cartão inválido, insira um número válido com 12 a 19 dígitos. | Verifique o número do cartão informado. |
⚠️ 500 Internal Server Error
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Erros genéricos | Erros genéricos | Caso o erro retornado não seja inteligível, entre em contato com o suporte. |
⚠️ 503 Service Unavailable
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Serviço indisponível | Infelizmente estamos passando por uma instabilidade no momento. Tente novamente mais tarde. | Caso o serviço demore a ficar estável, por favor, contate o suporte. |
⚠️ 504 Gateway Timeout
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Tempo excedido | O servidor não respondeu a tempo. Por favor, tente novamente. | Tente novamente em alguns instantes, podemos estar com instabilidade. |
1️⃣1️⃣ Fatura Detalhada (GET /faturas/extrato/{numeroExtrato}/vencimento/{dataVencimento})
⚠️ 400 Bad Request
| Título | Detalhe | Solução |
|---|---|---|
Authorization é obrigatório. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Campo(s) obrigatório(s) | cpfCliente é obrigatório | Verifique se informou o CPF do cliente. |
Campo(s) obrigatório(s) | codigoEstabelecimento é obrigatório | Verifique se informou o código do estabelecimento. |
Campo(s) com formato(s) inválido(s). | codigoEstabelecimento inválido, só aceitamos números | Verifique se o codigoEstabelecimento contém apenas números. |
Campo(s) obrigatorio(s) não enviado(s). | Favor informar um vencimento do extrato válido. | Verifique se informou o vencimento correto (YYYY-MM-DD). |
Campo(s) obrigatorio(s) não enviado(s). | Favor informar um número Extrato válido. | Verifique se informou o extrato correto. |
⚠️ 401 Unauthorized
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization inválido. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Não autorizado. | Authorization expirado. | Gere um novo Bearer token. |
⚠️ 403 Forbidden
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Acesso negado. | Você não tem permissão para acessar esse recurso. | Verifique se você realmente tem acesso a esse recurso. |
⚠️ 404 Not Found
| Título | Detalhe | Solução |
|---|---|---|
Dados não encontrados | Estabelecimento não encontrado ou não pertence à sua rede. | Verifique se o estabelecimento informado é válido e se é de sua rede. |
Dados não encontrados | Cliente não encontrado ou não pertence à sua rede. | Verifique o cliente informado. |
Extrato nao localizado | O extrato informado não foi encontrado ou é inválido. | Verifique o extrato informado. |
⚠️ 412 Unprocessable Entity
| Título | Detalhe | Solução |
|---|---|---|
Validação de campos | cpfCliente não é válido | Verifique o CPF informado. |
⚠️ 422 Unprocessable Entity
| Título | Detalhe | Solução |
|---|---|---|
Validação de campos | cpfCliente não é válido | Verifique o CPF informado. |
⚠️ 500 Internal Server Error
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Erros genéricos | Erros genéricos | Caso o erro retornado não seja inteligível, entre em contato com o suporte. |
⚠️ 503 Service Unavailable
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Serviço indisponível | Infelizmente estamos passando por uma instabilidade no momento. Tente novamente mais tarde. | Caso o serviço demore a ficar estável, por favor, contate o suporte. |
⚠️ 504 Gateway Timeout
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Tempo excedido | O servidor não respondeu a tempo. Por favor, tente novamente. | Tente novamente em alguns instantes, podemos estar com instabilidade. |
1️⃣2️⃣ Transações da Fatura (GET /faturas/extrato/{numeroExtrato}/vencimento/{dataVencimento}/transacoes)
⚠️ 400 Bad Request
| Título | Detalhe | Solução |
|---|---|---|
Authorization é obrigatório. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Campo(s) obrigatorio(s) não enviado(s). | Favor informar um CPF ou número de cartão válido. | Informe o CPF ou cartão válido. |
Campo(s) obrigatório(s) | cpfCliente é obrigatório. | Verifique o CPF do cliente informado. |
Campo(s) obrigatório(s). | codigoEstabelecimento é obrigatório | Verifique o código do estabelecimento informado. |
Campo(s) com formato(s) inválido(s). | codigoEstabelecimento inválido, só aceitamos números | Verifique se o codigoEstabelecimento contém apenas números. |
Campo(s) obrigatorio(s) não enviado(s). | Favor informar um vencimento do extrato válido. | Verifique se informou o vencimento correto (YYYY-MM-DD). |
Campo(s) obrigatorio(s) não enviado(s). | Favor informar um número Extrato válido. | Verifique se informou o extrato correto. |
⚠️ 401 Unauthorized
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Authorization inválido. | Informe o token de autorização válido. | Verifique o Bearer token informado. |
Não autorizado. | Authorization expirado. | Gere um novo Bearer token. |
⚠️ 403 Forbidden
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Acesso negado. | Você não tem permissão para acessar esse recurso. | Verifique se você realmente tem acesso a esse recurso. |
⚠️ 404 Not Found
| Título | Detalhe | Solução |
|---|---|---|
Dados não encontrados | Estabelecimento não encontrado ou não pertence à sua rede. | Verifique se o estabelecimento informado é válido e se é de sua rede. |
Dados não encontrados | Cliente não encontrado ou não pertence à sua rede. | Verifique o cliente informado. |
⚠️ 422 Unprocessable Entity
| Título | Detalhe | Solução |
|---|---|---|
Validação de campos | cpfCliente não é válido | Verifique o CPF informado. |
⚠️ 500 Internal Server Error
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Erros genéricos | Erros genéricos | Caso o erro retornado não seja inteligível, entre em contato com o suporte. |
⚠️ 503 Service Unavailable
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Serviço indisponível | Infelizmente estamos passando por uma instabilidade no momento. Tente novamente mais tarde. | Caso o serviço demore a ficar estável, por favor, contate o suporte. |
⚠️ 504 Gateway Timeout
Possíveis Causas:
| Título | Detalhe | Solução |
|---|---|---|
Tempo excedido | O servidor não respondeu a tempo. Por favor, tente novamente. | Tente novamente em alguns instantes, podemos estar com instabilidade. |
📞 Contato com Suporte
Se o problema persistir após seguir este guia:
Informações para incluir no chamado:
- TraceId da requisição com erro
- Timestamp de quando ocorreu
- Endpoint que estava sendo acessado
- Dados enviados (remova informações sensíveis)
- Resposta recebida (completa)
- Ambiente (HML ou PRD)
- Passos para reproduzir o problema
Canais de Contato:
Tempo de Resposta:
- 🔴 Crítico (produção parada): 2 horas
- 🟡 Alto (funcionalidade impactada): 8 horas
- 🟢 Normal (dúvidas, melhorias): 24 horas
🔄 Ambientes
Homologação (HML)
- URL Base:
https://apihml.credsystem.com.br/arrecadacao-lojista/api/v2 - Propósito: Testes e desenvolvimento
- Dados: Fictícios, podem ser deletados
- SLA: Sem garantia de disponibilidade 24/7
Produção (PRD)
- URL Base:
https://api.credsystem.com.br/arrecadacao-lojista/api/v2 - Propósito: Operação real
- Dados: Reais, não podem ser deletados
- SLA: 99.9% de disponibilidade
📊 Status da API
Para verificar o status em tempo real da API:
🔗 Status Page (se disponível)