回應主體
所有非 200 HTTP 回應的 HTTP 主體。
回應範例如下所示：
{
"responseHeader": {
"responseTimestamp": "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 目前不是 ±60s 時使用，請使用這個值。
|
INVALID_IDENTIFIER
|
404
要求中傳送的 ID 無效或不明時使用。這可能包含 paymentIntegratorAccountId、googlePaymentToken、captureRequestId 等。必須在 errorDescription 中指定無效 ID 的類型。
|
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 應隨附這個欄位中的資訊，判斷該類型無效)。
|
