用於驗證帳戶整合商傳送的 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 |
必要項目:來自此呼叫前 |
otp |
必要項目:這是使用者提供的動態密碼,此通話正在驗證 |
回應主體
VerifyOtp 方法的回應物件。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{ "responseHeader": { object ( |
欄位 | |
---|---|
responseHeader |
必要項目:所有回應的通用標頭。 |
paymentIntegratorVerifyOtpId |
選用:整合商 ID 會將這項驗證 OTP 要求視為整合商。這是已產生的整合商。 |
result |
必要項目:此要求的結果 |
VerifyOtpResultCode
驗證動態密碼要求的結果代碼
列舉 | |
---|---|
UNKNOWN_RESULT |
切勿設定這個預設值! |
SUCCESS |
動態密碼與整合服務供應商傳送的資料相符 |
OTP_NOT_MATCHED |
動態密碼與整合服務供應商傳送的資料不符。 |
OTP_ALREADY_USED |
動態密碼已有人使用。 |