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

必須: この呼び出しの前に行われた sendOtp リクエストの requestId。
otp

string

必須: ユーザーが入力した OTP のうち、この通話が確認しているもの

レスポンスの本文

VerifyOtp メソッドのレスポンス オブジェクト。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorVerifyOtpId": string,
  "result": enum (VerifyOtpResultCode)
}
フィールド
responseHeader

object (ResponseHeader)

必須: すべてのレスポンスに共通するヘッダーです。
paymentIntegratorVerifyOtpId

string

省略可: インテグレータが検証する OTP リクエストを認識している識別子。これはインテグレータが生成するものです。
result

enum (VerifyOtpResultCode)

必須: このリクエストの結果。

VerifyOtpResultCode

OTP の確認リクエストの結果コード

列挙型
UNKNOWN_RESULT このデフォルト値を設定しないでください。
SUCCESS OTP はインテグレーターが送信した値と一致しました
OTP_NOT_MATCHED OTP がインテグレーターが送信したものと一致しません。
OTP_ALREADY_USED OTP はすでに使用されています。