Modelos de Erro

Estruturas de resposta e cenários mais comuns de falha

View as Markdown

Visão geral

Os erros do ecossistema GoMoney aparecem em dois formatos principais:

  • respostas da plataforma, usadas em customers e validações correlatas;
  • respostas da camada PIX, usadas em autenticação PIX e cobranças.

Erro de autenticação da API PIX

Usado em cenários como credenciais inválidas no login da API PIX.

1{
2 "statusCode": 401,
3 "timestamp": 1783188000000,
4 "path": "/auth/login",
5 "message": "Invalid user or password."
6}
CampoTipoDescrição
statusCodeintegerCódigo HTTP retornado.
timestampintegerMomento da falha.
pathstringCaminho chamado.
messagestringMensagem de erro.

Erro genérico de autenticação

Usado quando a sessão ou a credencial de integração não são aceitas.

1{
2 "statusCode": 401,
3 "message": "Invalid API access key"
4}
CampoTipoDescrição
statusCodeintegerCódigo HTTP retornado.
messagestringMotivo resumido da rejeição.

Erro de validação

Usado quando o corpo enviado não respeita o contrato da operação.

1{
2 "statusCode": 400,
3 "message": [
4 "email must be an email"
5 ],
6 "error": "Bad Request"
7}
CampoTipoDescrição
statusCodeintegerCódigo HTTP retornado.
messagestring ou string[]Detalhes das validações que falharam.
errorstringCategoria geral do erro.

Erro de negócio da plataforma

Usado quando o recurso existe, mas o usuário não pode operá-lo, ou quando o recurso não foi encontrado.

1{
2 "statusCode": 403,
3 "message": "You do not have access to this customer"
4}
1{
2 "statusCode": 404,
3 "message": "Customer not found"
4}

Erro da camada PIX

Usado quando a camada PIX retorna um código interno específico do fluxo.

1{
2 "statusCode": 400,
3 "path": "/pix/create/brl",
4 "code": "ERR13",
5 "message": "Payer > Document Number is not a valid CNPJ or CPF"
6}
CampoTipoDescrição
statusCodeintegerCódigo HTTP retornado.
pathstringCaminho chamado.
codestringCódigo interno do fluxo PIX.
messagestringDescrição da falha.

Mapeamento prático por cenário

CenárioCódigo mais comumInterpretação
Login da API PIX com credenciais inválidas401Usuário ou senha incorretos.
Login PIX bloqueado por excesso de tentativas429Conta temporariamente bloqueada.
Customer criado com corpo inválido400Falha de validação de dados.
Customer acessado por outra conta403Recurso sem vínculo com o usuário autenticado.
Customer inexistente404Identificador não encontrado.
Cobrança PIX com documento inválido400Dado do pagador fora do formato esperado.
Cobrança PIX fora da janela permitida para GMC503Restrição operacional temporária.
Cobrança PIX inexistente ou sem vínculo417Cobrança não localizada para a conta autenticada.

Como tratar no integrador

  • registrar o código HTTP e, quando existir, o código interno do fluxo PIX;
  • armazenar o caminho chamado e o identificador operacional da transação;
  • evitar retentativas automáticas para erros de autenticação e validação;
  • usar retentativa controlada apenas em indisponibilidades transitórias.