オブジェクト: ErrorResponse

レスポンスの本文

200 以外のすべての HTTP レスポンスの HTTP 本文。

レスポンスの例を次に示します。


  {
    "responseHeader": {
      "requestTimestamp": "1481899949611"
    },
    "errorResponseCode": "INVALID_IDENTIFIER",
    "errorDescription": "Unknown paymentIntegratorAccountId: PIAID1",
  }
JSON 表現 
{
  "responseHeader": {
    object(ResponseHeader)
  },
  "errorResponseCode": string,
  "errorDescription": string,
}
フィールド
responseHeader

object(ResponseHeader)

必須: すべてのレスポンスに共通のヘッダー。

errorResponseCode

string

省略可: 下の表に記載されているコードのいずれかを指定します。

エラー レスポンス コードと推奨 HTTP コード
INVALID_API_VERSION 400

インテグレータがリクエストの API バージョンをサポートしていない場合に使用されます。
INVALID_PAYLOAD_SIGNATURE 401

不明なキーまたは無効なキーでペイロードが署名された場合に使用されます。
INVALID_PAYLOAD_ENCRYPTION 400

不明なキーまたは無効なキーでペイロードが暗号化された場合に使用されます。
REQUEST_TIMESTAMP_OUT_OF_RANGE 400

request_timestamp が現在 ± 60 秒でない場合に使用します。

INVALID_IDENTIFIER 404

リクエストで送信された ID が無効か、不明な場合に使用されます。これには、paymentIntegratorAccountId、googlePaymentToken、captureRequestId などが含まれます。無効な識別子のタイプは errorDescription で指定する必要があります。
IDEMPOTENCY_VIOLATION 412

リクエストがべき等性の要件に違反している場合に使用されます。
INVALID_FIELD_VALUE 400

サポートされている値のセットにない値がリクエストのフィールドに含まれている場合に使用されます。
MISSING_REQUIRED_FIELD 400

リクエストで必須フィールドが未設定の場合に使用されます。
PRECONDITION_VIOLATION 400

オペレーションの制約に違反した場合（払い戻し額のリクエストがトランザクションの残額を超えた場合など）に使用されます。
USER_ACTION_IN_PROGRESS 400

システムロックとして機能するプロセス中のユーザー アクションが中断されるため、現時点でリクエストを処理できない場合に使用されます。実装固有の内部同時実行エラーによる失敗を示すために、このコードを使用しないでください。

INVALID_DECRYPTED_REQUEST 400

リクエスト ペイロードは復号できたが、メッセージを解析できない場合に使用されます。
errorDescription

string

省略可: サポート担当者がエラーをデバッグできるように、このステータスの説明を入力します。ユーザーに表示されることはありません。 デバッグに役立ち、機密情報を含まないテキストを含めることができます。 errorResponseCode の一部の値では、このフィールドに追加の詳細を指定する必要があります（たとえば、 INVALID_IDENTIFIER の場合は、このフィールドで無効な識別子のタイプを示す情報を指定する必要があります）。