Objeto: ErrorResponse

Corpo da resposta

Corpo HTTP para todas as respostas HTTP que não são 200.

Um exemplo de resposta é semelhante a:


  {
    "responseHeader": {
      "requestTimestamp": "1481899949611"
    },
    "errorResponseCode": "INVALID_IDENTIFIER",
    "errorDescription": "Unknown paymentIntegratorAccountId: PIAID1",
  }
Representação JSON
{
  "responseHeader": {
    object(ResponseHeader)
  },
  "errorResponseCode": string,
  "errorDescription": string,
}
Campos
responseHeader

object(ResponseHeader)

OBRIGATÓRIO: cabeçalho comum para todas as respostas.

errorResponseCode

string

OPCIONAL: forneça um dos códigos listados na tabela abaixo.

Códigos de resposta de erro e códigos HTTP recomendados
INVALID_API_VERSION 400

Usado se o integrador não for compatível com a versão da API da solicitação.

INVALID_PAYLOAD_SIGNATURE 401

Usado se a assinatura do payload for para uma chave desconhecida ou inativa.

INVALID_PAYLOAD_ENCRYPTION 400

Usado se a criptografia do payload for para uma chave desconhecida ou inativa.

REQUEST_TIMESTAMP_OUT_OF_RANGE 400

Usado se o request_timestamp não tiver 60 segundos ou mais de agora.

INVALID_IDENTIFIER 404

Usado se um identificador enviado na solicitação for inválido ou desconhecido. Isso pode incluir paymentIntegratorAccountId, googlePaymentToken, captureRequestId etc. O tipo de identificador inválido precisa ser especificado no errorDescription.

IDEMPOTENCY_VIOLATION 412

Usado se a solicitação viola os requisitos de idempotência da solicitação.

INVALID_FIELD_VALUE 400

Usado se a solicitação contém um valor para um campo que não esteja no conjunto de valores compatíveis.

MISSING_REQUIRED_FIELD 400

Usado se um campo obrigatório não estiver definido na solicitação.

PRECONDITION_VIOLATION 400

Usado se uma restrição na operação for violada, por exemplo, quando uma solicitação de reembolso excede o valor restante na transação.

USER_ACTION_IN_PROGRESS 400

Usado se não for possível processar a solicitação no momento porque ela interromperia uma ação do usuário em andamento, que atua como um bloqueio do sistema. Esse código não pode ser usado para indicar falhas devido a erros de simultaneidade internos específicos da implementação.

INVALID_DECRYPTED_REQUEST 400

Usado se o payload da solicitação puder ser descriptografado, mas a mensagem resultante não puder ser analisada.

errorDescription

string

OPCIONAL: forneça uma descrição desse status para que os representantes de suporte depurem os erros. Isso nunca é mostrado aos usuários. Pode conter texto descritivo e não confidencial usado para depuração. Alguns valores de errorResponseCode precisam ser acompanhados por outros detalhes nesse campo (por exemplo, INVALID_IDENTIFIER precisa ser acompanhado por informações neste campo sobre o tipo de identificador inválido).