Method: verifyOtp

इस बात की पुष्टि करता है कि खाते के लिए इंटिग्रेटर ने ओटीपी भेजा है.

अगर अनुरोध को प्रोसेस करते समय एंडपॉइंट को कोई गड़बड़ी मिलती है, तो इस एंडपॉइंट से मिलने वाले रिस्पॉन्स का मुख्य हिस्सा ErrorResponse का होना चाहिए.

अनुरोध का एक उदाहरण यह दिखता है:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "0123434-otp-abc",
    "requestTimestamp": "1502545413098"
  },
  "sendOtpRequestId": "0123434-otp-abc",
  "otp": "7754321"
}

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


{
  "responseHeader": {
    "responseTimestamp": "1502545413132"
  },
  "paymentIntegratorVerifyOtpId": "5539163",
  "result": "SUCCESS"
}

एचटीटीपी अनुरोध

POST https://www.integratorhost.example.com/v1/verifyOtp

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "sendOtpRequestId": string,
  "otp": string
}
फ़ील्ड
requestHeader

object (RequestHeader)

ज़रूरी: सभी अनुरोधों के लिए सामान्य हेडर.
sendOtpRequestId

string

ज़रूरी है: इस कॉल से पहले वाले sendOtp अनुरोध से requestId.
otp

string

ज़रूरी: यह ओटीपी है, जो उपयोगकर्ता ने दिया है. इस ओटीपी की पुष्टि इस कॉल में की जा रही है

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

VerifyOtp तरीके के लिए रिस्पॉन्स ऑब्जेक्ट.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorVerifyOtpId": string,
  "result": enum (VerifyOtpResultCode)
}
फ़ील्ड
responseHeader

object (ResponseHeader)

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

string

ज़रूरी नहीं: इंटिग्रेटर के आइडेंटिफ़ायर के पास ओटीपी की पुष्टि करने के अनुरोध की जानकारी होती है. यह इंटिग्रेटर जनरेट किया गया है.
result

enum (VerifyOtpResultCode)

ज़रूरी: इस अनुरोध का नतीजा

VerifyOtpResultCode

ओटीपी के अनुरोध की पुष्टि के लिए नतीजों के कोड

Enums
UNKNOWN_RESULT कभी भी इस डिफ़ॉल्ट वैल्यू को सेट न करें!
SUCCESS इंटिग्रेटर ने जो ओटीपी भेजा है उससे ओटीपी मैच हुआ
OTP_NOT_MATCHED ओटीपी मेल नहीं खाता. यह इंटिग्रेटर ने भेजा है.
OTP_ALREADY_USED ओटीपी पहले ही इस्तेमाल कर लिया गया है.