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 שהמשתמש סיפק, והשיחה הזו מאמתת

גוף התשובה

אובייקט תגובה ל-method verificationOtp.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorVerifyOtpId": string,
  "result": enum (VerifyOtpResultCode)
}
שדות
responseHeader

object (ResponseHeader)

חובה: כותרת משותפת לכל התשובות.
paymentIntegratorVerifyOtpId

string

אופציונלי: המזהה של מבצע השילוב יודע שאפשר לאמת את בקשת ה-OTP הזו. זהו כלי השילוב שנוצר.
result

enum (VerifyOtpResultCode)

חובה: התוצאה של הבקשה

VerifyOtpResultCode

קודי תוצאות לאימות בקשת OTP

טיפוסים בני מנייה (enum)
UNKNOWN_RESULT אל תגדירו את ערך ברירת המחדל הזה אף פעם!
SUCCESS הסיסמה החד-פעמית (OTP) תואמת למה שנשלח על ידי מבצע השילוב
OTP_NOT_MATCHED הסיסמה החד-פעמית (OTP) לא תואמת למה שנשלח על ידי מבצע השילוב.
OTP_ALREADY_USED כבר נעשה שימוש ב-OTP.