Method: verifyOtp

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

Wenn am Endpunkt bei der Verarbeitung der Anfrage ein Fehler auftritt, sollte der Antworttext von diesem Endpunkt den Typ ErrorResponse haben.

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)

ERFORDERLICH: Gemeinsamer Header für alle Anfragen.
sendOtpRequestId

string

ERFORDERLICH: requestId aus der sendOtp-Anfrage vor diesem Aufruf.
otp

string

ERFORDERLICH: Das vom Nutzer angegebene OTP, das durch diesen Anruf verifiziert wird

Antworttext

Antwortobjekt für die verifyOtp-Methode.

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)

ERFORDERLICH: Gemeinsamer Header für alle Antworten.
paymentIntegratorVerifyOtpId

string

OPTIONAL: Kennung, unter der der Integrator diese OTP-Überprüfungsanfrage kennt. Dies wird von einem Integrator generiert.
result

enum (VerifyOtpResultCode)

REQUIRED: Ergebnis dieser Anfrage

VerifyOtpResultCode

Ergebniscodes für die OTP-Überprüfungsanfrage

Enums
UNKNOWN_RESULT Legen Sie diesen Standardwert niemals fest.
SUCCESS OTP stimmte mit der vom Integrator gesendeten Nachricht überein
OTP_NOT_MATCHED Das OTP stimmte nicht mit den vom Integrator gesendeten Informationen überein.
OTP_ALREADY_USED OTP wurde bereits verwendet.