Erros

Formato do erro

Todo erro da API tem o mesmo formato:

{
  "error": {
    "code": "conflict",
    "message": "Oferta inativa",
    "request_id": "3f6c1a52-8e1d-4c0b-9a7e-2d5b6c7e8f90"
  }
}

Códigos

Qualquer GET pode ser repetido igual.

O code é escolhido só pelo status HTTP, com uma exceção: o 502 sandbox_unavailable. Um status 422 vira unprocessable_entity, e qualquer outro status 4xx sem nome na tabela vira error.

Erros comuns a todas as rotas

Estes erros podem aparecer em qualquer rota que recebe os dados ou o header citados. Os erros próprios de cada fluxo ficam na página da jornada.

Erros de validação

Quando o corpo ou os parâmetros estão errados, a resposta é 400 invalid_request com uma mensagem. Exemplo, ao enviar offer_identifier e offer juntos:

{
  "error": {
    "code": "invalid_request",
    "message": "Envie offer_identifier ou offer, nunca os dois",
    "request_id": "9b2e7c14-3a5d-4f60-8e1b-7c9d0a2b3c4d"
  }
}

A mensagem mostra um problema por vez. Corrija, envie de novo e veja se aparece outro. As mensagens genéricas, inclusive as vazias, estão em Erros comuns a todas as rotas.

Rota inexistente

Quando o método e o caminho não correspondem a nenhuma rota da API, a resposta é 404 not_found:

{
  "error": {
    "code": "not_found",
    "message": "Rota não encontrada na API pública.",
    "request_id": "5d8e2a61-4b3c-4f7d-9e0a-1c2b3d4e5f60"
  }
}

Confira o método e o caminho, e se a URL começa com a URL base https://api.pagpolar.com/v1, sem repetir o /v1. As rotas existentes estão na Referência da API.

O token é conferido antes da rota. Sem token válido, a resposta é 401 unauthorized, mesmo numa rota que não existe. Com IP fora da lista autorizada, é 403 forbidden.

Ambiente de testes indisponível

Quando o ambiente de testes está fora do ar ou demora mais de 30 segundos para responder, as chamadas feitas com a chave de Homologação, ou com o token dela, recebem 502:

{
  "error": {
    "code": "sandbox_unavailable",
    "message": "Ambiente de testes indisponível no momento. Tente novamente em instantes.",
    "request_id": null
  }
}

• request_id chega null, e a resposta não traz o header X-Request-Id.
• As chaves de Produção não são afetadas.
• Quando o ambiente de testes responde, o status e o corpo da resposta dele chegam sem mudança. Os erros seguem o mesmo formato desta página.

Espere alguns segundos e repita. Se o erro veio depois de 30 segundos numa rota de cobrança, a venda de teste pode ter sido criada: procure a venda antes de repetir.

Onde encontrar o request_id

O mesmo valor aparece em dois lugares:

• no campo error.request_id do corpo do erro;
• no header X-Request-Id de toda resposta da API, inclusive as de sucesso. A única exceção é o 502 sandbox_unavailable.

Grave o X-Request-Id nos logs do seu sistema. No painel, o Histórico de requisições da credencial mostra o mesmo valor em ID da requisição. Veja Credenciais.

Próximos passos