Object: ErrorResponse

بدن پاسخگو

متن HTTP برای همه پاسخ‌های غیر 200 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

اگر شناسه ارسال شده در درخواست نامعتبر یا ناشناخته باشد استفاده می شود. این ممکن است شامل 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 باید با اطلاعاتی در این قسمت همراه شود که نوع شناسه نامعتبر است).