Method: verifyOtp

Vérifie qu'une valeur de mot de passe à usage unique a été envoyée par l'intégrateur du compte.

Si le point de terminaison rencontre une erreur lors du traitement de la requête, le corps de la réponse de ce point de terminaison doit être de type ErrorResponse.

Voici un exemple de requête:


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

Voici un exemple de réponse:


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

Requête HTTP

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

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "sendOtpRequestId": string,
  "otp": string
}
Champs
requestHeader

object (RequestHeader)

OBLIGATOIRE: en-tête commun à toutes les requêtes.
sendOtpRequestId

string

OBLIGATOIRE: requestId de la requête sendOtp ayant précédé cet appel.
otp

string

OBLIGATOIRE: il s'agit du mot de passe à usage unique fourni par l'utilisateur et que cet appel valide

Corps de la réponse

Objet de réponse pour la méthode VerifyOtp.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorVerifyOtpId": string,
  "result": enum (VerifyOtpResultCode)
}
Champs
responseHeader

object (ResponseHeader)

OBLIGATOIRE: en-tête commun à toutes les réponses.
paymentIntegratorVerifyOtpId

string

FACULTATIF: Identifiant sous lequel l'intégrateur connaît cette demande de validation OTP. Il s'agit d'un code généré par un intégrateur.
result

enum (VerifyOtpResultCode)

OBLIGATOIRE: résultat de cette requête.

VerifyOtpResultCode

Codes de résultat de la demande de validation de mot de passe à usage unique

Enums
UNKNOWN_RESULT Ne définissez jamais cette valeur par défaut.
SUCCESS Mot de passe à usage unique correspond à celui envoyé par l'intégrateur
OTP_NOT_MATCHED Le mot de passe à usage unique ne correspond pas aux informations envoyées par l'intégrateur.
OTP_ALREADY_USED L'OTP a déjà été utilisé.