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

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

نص الاستجابة

كائن الاستجابة لطريقة verificationOtp.

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

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

object (ResponseHeader)

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

string

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

enum (VerifyOtpResultCode)

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

رمز التحقق من نتيجة البحث

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

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