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 dele precisará ser do tipo ErrorResponse.

Um exemplo de solicitação é semelhante a este:


{
  "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 essa chamada.
otp

string

OBRIGATÓRIO: é a OTP informada pelo usuário e que a chamada está verificando.

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: identificador que o integrador conhece essa solicitação de verificação de OTP. Isso é gerado pelo integrador.
result

enum (VerifyOtpResultCode)

OBRIGATÓRIO: resultado da solicitação

VerifyOtpResultCode

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

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