Method: verifyOtp

Verifica che un valore OTP sia stato inviato dall'integratore per l'account.

Se l'endpoint rileva un errore durante l'elaborazione della richiesta, il corpo della risposta da questo endpoint deve essere di tipo ErrorResponse.

Ecco un esempio di richiesta:


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

Ecco un esempio di risposta:


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

Richiesta HTTP

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

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "sendOtpRequestId": string,
  "otp": string
}
Campi
requestHeader

object (RequestHeader)

REQUIRED: intestazione comune per tutte le richieste.
sendOtpRequestId

string

REQUIRED: requestId dalla richiesta sendOtp che ha preceduto la chiamata.
otp

string

REQUIRED: si tratta della OTP fornita dall'utente e che viene verificata da questa chiamata.

Corpo della risposta

Oggetto di risposta per il metodo verifyOtp.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

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

object (ResponseHeader)

REQUIRED: intestazione comune per tutte le risposte.
paymentIntegratorVerifyOtpId

string

FACOLTATIVO: identificatore utilizzato dall'integratore per la verifica della richiesta OTP. Questo è stato generato dall'integratore.
result

enum (VerifyOtpResultCode)

REQUIRED: il risultato della richiesta

VerifyOtpResultCode

Codici risultato per la verifica della richiesta OTP

Enum
UNKNOWN_RESULT Non impostare mai questo valore predefinito.
SUCCESS OTP corrispondente a quanto inviato dall'integratore
OTP_NOT_MATCHED L'OTP non corrispondeva a quanto inviato dall'integratore.
OTP_ALREADY_USED OTP già usata.