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)

ต้องระบุ: ผลลัพธ์ของคําขอนี้

ยืนยันรหัสผลลัพธ์

รหัสผลลัพธ์สําหรับคําขอ OTP

Enum
UNKNOWN_RESULT อย่าตั้งค่าเริ่มต้นนี้!
SUCCESS OTP ตรงกับสิ่งที่ผู้รวมบริการส่ง
OTP_NOT_MATCHED OTP ไม่ตรงกับข้อมูลของผู้รวมที่ส่ง
OTP_ALREADY_USED มีการใช้ OTP อยู่แล้ว