Object: ErrorResponse

Response body

HTTP Body for all non-200 HTTP responses.

An example response looks like:


  {
    "responseHeader": {
      "responseTimestamp": "1481899949611"
    },
    "errorResponseCode": "INVALID_IDENTIFIER",
    "errorDescription": "Unknown paymentIntegratorAccountId: PIAID1",
  }
JSON representation 
{
  "responseHeader": {
    object(ResponseHeader)
  },
  "errorResponseCode": string,
  "errorDescription": string,
}
Fields
responseHeader

object(ResponseHeader)

REQUIRED: Common header for all responses.

errorResponseCode

string

OPTIONAL: Provide one of the codes listed in the table below.

Error Response Codes and Advised HTTP Codes
INVALID_API_VERSION 400

Used if the integrator does not support the request's API version.

INVALID_PAYLOAD_SIGNATURE 401

Used if the signature of the payload is to an unknown or inactive key.

INVALID_PAYLOAD_ENCRYPTION 400

Used if the encryption of the payload is to an unknown or inactive key.

REQUEST_TIMESTAMP_OUT_OF_RANGE 400

Used if the request_timestamp is not ± 60s of now.

INVALID_IDENTIFIER 404

Used if an identifier sent in the request was invalid or unknown. This may include paymentIntegratorAccountId, googlePaymentToken, captureRequestId etc. The type of the invalid identifier should be specified in the errorDescription.

IDEMPOTENCY_VIOLATION 412

Used if the request violates the idempotency requirements for the request.

INVALID_FIELD_VALUE 400

Used if the request contains a value for a field that isn't in the set of supported values.

MISSING_REQUIRED_FIELD 400

Used if a field that is required is unset in the request.

PRECONDITION_VIOLATION 400

Used if a constraint on the operation is violated (e.g. when a request for a refund amount exceeds the amount remaining on the transaction).

USER_ACTION_IN_PROGRESS 400

Used if the request cannot be processed at this time because it would interrupt an in-process user action which effectively acts as a system lock. This code must not be used to indicate failures due to implementation-specific internal concurrency errors.

INVALID_DECRYPTED_REQUEST 400

Used if the request payload could be decrypted, but the resulting message could not be parsed.

errorDescription

string

OPTIONAL: Provide a description of this status for support reps to debug errors. Note that this is never shown to users. It can contain descriptive, non-sensitive text used for debugging. Note that some values for errorResponseCode should be accompanied by additional detail in this field (e.g. INVALID_IDENTIFIER should be accompanied by information in this field as to which type of identifier was invalid).