ऑब्जेक्ट: ErrorResponse

जवाब का मुख्य भाग

सभी गैर-200 एचटीटीपी रिस्पॉन्स के लिए एचटीटीपी बॉडी.

जवाब का एक उदाहरण ऐसा दिखता है:


  {
    "responseHeader": {
      "requestTimestamp": "1481899949611"
    },
    "errorResponseCode": "INVALID_IDENTIFIER",
    "errorDescription": "Unknown paymentIntegratorAccountId: PIAID1",
  }
जेएसओएन के काेड में दिखाना 
{
  "responseHeader": {
    object(ResponseHeader)
  },
  "errorResponseCode": string,
  "errorDescription": string,
}
फ़ील्ड
responseHeader

object(ResponseHeader)

ज़रूरी: सभी जवाबों के लिए सामान्य हेडर.

errorResponseCode

string

ज़रूरी नहीं: यहां दी गई टेबल में दिए गए कोड में से कोई एक कोड दें.

गड़बड़ी रिस्पॉन्स कोड और सुझाए गए एचटीटीपी कोड
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 के साथ इस फ़ील्ड में जानकारी होनी चाहिए कि किस तरह का आइडेंटिफ़ायर अमान्य है).