Method: verifyOtp

التحقّق من قيمة كلمة المرور لمرة واحدة (OTP) التي أرسلتها جهة الدمج للحساب

إذا واجهت نقطة النهاية خطأً أثناء معالجة الطلب، يجب أن يكون نص الاستجابة من نقطة النهاية هذه من النوع 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"
}

طلب HTTP

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

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "sendOtpRequestId": string,
  "otp": string
}
الحقول
requestHeader

object (RequestHeader)

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

string

مطلوب: requestId من طلب sendOtp الذي سبق هذه المكالمة.
otp

string

مطلوب: هذه هي كلمة المرور لمرة واحدة التي قدَّمها المستخدم، والتي يتم التحقّق منها في هذه المكالمة.

نص الاستجابة

كائن الاستجابة لطريقة التحقق من Otp.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorVerifyOtpId": string,
  "result": enum (VerifyOtpResultCode)
}
الحقول
responseHeader

object (ResponseHeader)

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

string

اختياري: المعرّف الذي يعرف مسؤول عملية الدمج هذا طلب التحقّق من كلمة المرور لمرة واحدة (OTP) تم إنشاء عملية الدمج هذه.
result

enum (VerifyOtpResultCode)

REQUIRED: نتيجة هذا الطلب

VerifyOtpResultCode

رموز النتائج لطلب التحقق من كلمة المرور لمرة واحدة

عمليات التعداد
UNKNOWN_RESULT لا تضبط هذه القيمة التلقائية على الإطلاق.
SUCCESS تطابقت كلمة المرور لمرة واحدة مع ما أرسله مسؤول الدمج
OTP_NOT_MATCHED لم تتطابق كلمة المرور لمرة واحدة مع ما أرسله مسؤول الدمج.
OTP_ALREADY_USED سبق أن تم استخدام كلمة المرور لمرة واحدة (OTP).