Method: verifyOtp

Überprüft, ob ein OTP-Wert vom Integrator für das Konto gesendet wurde.

Wenn der Endpunkt bei der Verarbeitung der Anfrage auf einen Fehler stößt, sollte der Antworttext dieses Endpunkts vom Typ ErrorResponse sein.

Eine Beispielanfrage sieht so aus:


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

Eine Beispielantwort sieht so aus:


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

HTTP-Anfrage

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

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "sendOtpRequestId": string,
  "otp": string
}
Felder
requestHeader

object (RequestHeader)

REQUIRED: Allgemeiner Header für alle Anfragen.
sendOtpRequestId

string

ERFORDERLICH: requestId aus der Anfrage sendOtp, die vor diesem Anruf stattgefunden hat.
otp

string

ERFORDERLICH: Das vom Nutzer bereitgestellte OTP, das der Anruf überprüft

Antworttext

Antwortobjekt für die Methode „verifyOtp“.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorVerifyOtpId": string,
  "result": enum (VerifyOtpResultCode)
}
Felder
responseHeader

object (ResponseHeader)

REQUIRED: Allgemeiner Header für alle Antworten.
paymentIntegratorVerifyOtpId

string

OPTIONAL: Kennt den Integrator, der diese OTP-Anfrage kennt. Dies wurde vom Integrationsintegrator generiert.
result

enum (VerifyOtpResultCode)

ERFORDERLICH: Ergebnis dieser Anfrage

Verifizierungs-/Ergebniscode

Ergebniscodes für die Bestätigung der OTP-Anfrage

Enums
UNKNOWN_RESULT Legen Sie diesen Standardwert nie fest.
SUCCESS OTP hat überein, was der Integrator gesendet hat
OTP_NOT_MATCHED Das OTP entsprach nicht dem, was der Integrator gesendet hat.
OTP_ALREADY_USED OTP wurde bereits verwendet.