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

Перечисления
UNKNOWN_RESULT Никогда не устанавливайте это значение по умолчанию!
SUCCESS OTP соответствует тому, что отправил интегратор.
OTP_NOT_MATCHED OTP не соответствовал тому, что отправил интегратор.
OTP_ALREADY_USED OTP уже использовался.