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 ที่ผู้ใช้ระบุ ซึ่งการโทรนี้กำลังยืนยัน

เนื้อหาการตอบกลับ

ออบเจ็กต์การตอบกลับสำหรับเมธอด VerifyOtp

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง 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 อยู่แล้ว