الكائن: errorResponse

نص الاستجابة

نص HTTP لجميع استجابات HTTP غير 200.

يبدو الرد كمثال:


  {
    "responseHeader": {
      "responseTimestamp": "1481899949611"
    },
    "errorResponseCode": "INVALID_IDENTIFIER",
    "errorDescription": "Unknown paymentIntegratorAccountId: PIAID1",
  }
تمثيل JSON
{
  "responseHeader": {
    object(ResponseHeader)
  },
  "errorResponseCode": string,
  "errorDescription": string,
}
الحقول
responseHeader

object(ResponseHeader)

مطلوب: عنوان مشترك لجميع الردود.

errorResponseCode

string

OPTIONAL: أدخِل أحد الرموز المدرَجة في الجدول أدناه.

رموز الاستجابة للأخطاء ورموز HTTP المقترَحة
INVALID_API_VERSION 400

تُستخدَم إذا كانت جهة الدمج لا تتيح استخدام واجهة برمجة التطبيقات للطلب. .

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

OPTIONAL: تقديم وصف لهذه الحالة لما يلي: دعم ممثلي تصحيح الأخطاء. يُرجى العِلم أنّ هذه المعلومات لن تظهر للمستخدمين أبدًا. يمكن أن تحتوي الرسالة على نص وصفي غير حسّاس يُستخدَم لتصحيح الأخطاء. لاحظ أن بعض قيم errorResponseCode يجب أن تكون مصحوبة بتفاصيل إضافية في هذا الحقل (على سبيل المثال، يجب أن تكون INVALID_IDENTIFIER مصحوبة بالمعلومات في هذا الحقل فيما يتعلق بنوع المعرِّف غير الصالح).