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

REQUIRED : requestId از درخواست sendOtp که قبل از این تماس بود.

otp

string

مورد نیاز : این OTPی است که کاربر ارائه کرده است که این تماس در حال تأیید آن است

بدن پاسخگو

شی پاسخ برای متد verifyOtp.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorVerifyOtpId": string,
  "result": enum (VerifyOtpResultCode)
}
زمینه های
responseHeader

object ( ResponseHeader )

مورد نیاز : هدر مشترک برای همه پاسخ ها.

paymentIntegratorVerifyOtpId

string

اختیاری : شناسه یکپارچه‌کننده این درخواست OTP را تأیید می‌کند. این یکپارچه ساز تولید شده است.

result

enum ( VerifyOtpResultCode )

الزامی : نتیجه این درخواست

VerifyOtpResultCode

کدهای نتیجه برای تأیید درخواست OTP

Enums
UNKNOWN_RESULT هرگز این مقدار پیش فرض را تنظیم نکنید!
SUCCESS OTP با آنچه که ادغام کننده ارسال کرد مطابقت داشت
OTP_NOT_MATCHED OTP با آنچه که ادغام کننده ارسال کرد مطابقت نداشت.
OTP_ALREADY_USED OTP قبلاً استفاده شده بود.