Method: verifyOtp

Xác minh giá trị OTP do đối tác 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.

Yêu cầu mẫu sẽ 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"
}

Câu trả lờ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 có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "sendOtpRequestId": string,
  "otp": string
}
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 trong yêu cầu sendOtp trước lệnh gọi này.
otp

string

BẮT BUỘC: Đây là OTP người dùng đã cung cấp và 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)
}
Trường
responseHeader

object (ResponseHeader)

BẮT BUỘC: Tiêu đề chung cho tất cả câu trả lời.
paymentIntegratorVerifyOtpId

string

KHÔNG BẮT BUỘC: Giá trị nhận dạng mà đối tác tích hợp biết yêu cầu xác minh OTP này dưới dạng. Đây là dữ liệu tích hợp do trình tích hợp tạo.
result

enum (VerifyOtpResultCode)

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

VerifyOtpResultCode

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

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