Method: verifyOtp

Sprawdza wartość hasła jednorazowego przesłanego przez integratora dla konta.

Jeśli podczas przetwarzania żądania punkt końcowy napotka błąd, treść odpowiedzi z tego punktu końcowego powinna być typu ErrorResponse.

Przykładowe żądanie wygląda tak:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "0123434-otp-abc",
    "requestTimestamp": "1502545413098"
  },
  "sendOtpRequestId": "0123434-otp-abc",
  "otp": "7754321"
}

Przykładowa odpowiedź wygląda tak:


{
  "responseHeader": {
    "responseTimestamp": "1502545413132"
  },
  "paymentIntegratorVerifyOtpId": "5539163",
  "result": "SUCCESS"
}

Żądanie HTTP

POST https://www.integratorhost.example.com/v1/verifyOtp

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "sendOtpRequestId": string,
  "otp": string
}
Pola
requestHeader

object (RequestHeader)

WYMAGANE: wspólny nagłówek dla wszystkich żądań.
sendOtpRequestId

string

WYMAGANE: requestId z żądania sendOtp poprzedzającego to wywołanie.
otp

string

WYMAGANE: to hasło jednorazowe podane przez użytkownika, które jest sprawdzane przez to połączenie.

Treść odpowiedzi

Obiekt odpowiedzi dla metody VerifyOtp.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorVerifyOtpId": string,
  "result": enum (VerifyOtpResultCode)
}
Pola
responseHeader

object (ResponseHeader)

WYMAGANE: wspólny nagłówek wszystkich odpowiedzi.
paymentIntegratorVerifyOtpId

string

OPCJONALNE: identyfikator, który integrator zna to żądanie weryfikacji z użyciem hasła jednorazowego. Wygenerowano go przez integratora.
result

enum (VerifyOtpResultCode)

WYMAGANE: wynik tego żądania.

VerifyOtpResultCode

Kody wyników weryfikacji żądania hasła jednorazowego

Wartości w polu enum
UNKNOWN_RESULT Nigdy nie ustawiaj tej wartości domyślnej.
SUCCESS Hasło jednorazowe zgodne z treścią wysłane przez integratora
OTP_NOT_MATCHED Hasło jednorazowe nie odpowiada temu, co wysłał integrator.
OTP_ALREADY_USED Hasło jednorazowe zostało już użyte.