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

חובה: זוהי הסיסמה החד-פעמית שהמשתמש סיפק, שהשיחה הזו מאמתת

גוף התשובה

אובייקט התשובה של שיטת verifyOtp.

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

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

object (ResponseHeader)

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

string

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

enum (VerifyOtpResultCode)

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

קוד אימות

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

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