Method: verifyOtp

Xác minh giá trị OTP đã được nhà tích hợp gửi cho tài khoản.

Nếu điểm cuối gặp lỗi trong khi xử lý yêu cầu, thì nội dung phản hồi từ điểm cuối này phải thuộc loại ErrorResponse.

Một yêu cầu mẫu có dạng như sau:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "0123434-otp-abc",
    "requestTimestamp": "1502545413098"
  },
  "sendOtpRequestId": "0123434-otp-abc",
  "otp": "7754321"
}

Một phản hồi mẫu sẽ có dạng như sau:


{
  "responseHeader": {
    "responseTimestamp": "1502545413132"
  },
  "paymentIntegratorVerifyOtpId": "5539163",
  "result": "SUCCESS"
}

Yêu cầu HTTP

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

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc như sau:

Biểu diễn dưới dạng JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "sendOtpRequestId": string,
  "otp": string
}
Các trường
requestHeader

object (RequestHeader)

BẮT BUỘC: Tiêu đề chung cho tất cả các yêu cầu.
sendOtpRequestId

string

BẮT BUỘC: requestId từ yêu cầu sendOtp trước cuộc gọi này.
otp

string

BẮT BUỘC: Đây là OTP mà người dùng đã cung cấp mà cuộc gọi này đang xác minh

Nội dung phản hồi

Đối tượng phản hồi cho phương thức verifyOtp.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorVerifyOtpId": string,
  "result": enum (VerifyOtpResultCode)
}
Các trường
responseHeader

object (ResponseHeader)

BẮT BUỘC: Tiêu đề chung cho tất cả các phản hồi.
paymentIntegratorVerifyOtpId

string

KHÔNG BẮT BUỘC: Giá trị nhận dạng mà nhà tích hợp xác định yêu cầu xác minh bằng OTP này dưới dạng. Đây là công cụ tích hợp được tạo.
result

enum (VerifyOtpResultCode)

BẮT BUỘC: Kết quả của yêu cầu này

Mã kết quả xác minh

Mã kết quả để xác minh yêu cầu OTP

Enum
UNKNOWN_RESULT Không bao giờ đặt giá trị mặc định này!
SUCCESS OTP khớp với thông tin mà nhà tích hợp gửi đi
OTP_NOT_MATCHED OTP không khớp với thông tin mà nhà tích hợp gửi đi.
OTP_ALREADY_USED OTP đã được sử dụng.