ออบเจ็กต์: ErrorResponse

เนื้อหาการตอบกลับ

ส่วนเนื้อหาของ HTTP สำหรับการตอบกลับ HTTP ทั้งหมดที่ไม่ใช่ 200

ตัวอย่างการตอบกลับจะมีลักษณะดังนี้


  {
    "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

ใช้หากตัวระบุที่ส่งในคำขอไม่ถูกต้องหรือไม่รู้จัก ซึ่งอาจรวมถึง 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 ควรมีข้อมูลในช่องนี้ด้วยว่าตัวระบุประเภทใดไม่ถูกต้อง)