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 はすでに使用されています。