الكائن: 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

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

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 مصحوبةً بمعلومات في هذا الحقل عن نوع المعرّف غير الصالح).