Method: verifyOtp

Verifica se um valor de OTP foi enviado pelo integrador da conta.

Se o endpoint encontrar um erro ao processar a solicitação, o corpo da resposta desse endpoint precisará ser do tipo ErrorResponse.

Veja abaixo um exemplo de solicitação:


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

Veja um exemplo de resposta:


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

Solicitação HTTP

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

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "sendOtpRequestId": string,
  "otp": string
}
Campos
requestHeader

object (RequestHeader)

OBRIGATÓRIO: cabeçalho comum para todas as solicitações.
sendOtpRequestId

string

OBRIGATÓRIO: requestId da solicitação sendOtp que precedeu esta chamada.
otp

string

OBRIGATÓRIO: esta é a OTP que o usuário forneceu, que está sendo verificada por esta chamada.

Corpo da resposta

Objeto de resposta para o método verifyOtp.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorVerifyOtpId": string,
  "result": enum (VerifyOtpResultCode)
}
Campos
responseHeader

object (ResponseHeader)

OBRIGATÓRIO: cabeçalho comum para todas as respostas.
paymentIntegratorVerifyOtpId

string

OPCIONAL: o identificador que o integrador conhece como a solicitação de verificação de OTP. Este é o integrador gerado.
result

enum (VerifyOtpResultCode)

OBRIGATÓRIO: resultado desta solicitação

VerificarOCódigodeResultado

Códigos de resultado para verificar a solicitação de OTP

Enums
UNKNOWN_RESULT Nunca defina esse valor padrão.
SUCCESS A OTP corresponde ao que o integrador enviou
OTP_NOT_MATCHED A OTP não corresponde ao que o integrador enviou.
OTP_ALREADY_USED A OTP já foi usada.