Method: verifyOtp

Hesap için entegrasyon uzmanı tarafından gönderilen bir OTP değerini doğrular.

Uç nokta, isteği işlerken bir hatayla karşılaşırsa bu uç noktadaki yanıt gövdesi ErrorResponse türünde olmalıdır.

Örnek istek:


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

Örnek bir yanıt aşağıdaki gibidir:


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

HTTP isteği

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

İstek içeriği

İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:

JSON gösterimi 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "sendOtpRequestId": string,
  "otp": string
}
Alanlar
requestHeader

object (RequestHeader)

ZORUNLU: Tüm istekler için ortak başlık.
sendOtpRequestId

string

ZORUNLU: Bu çağrıdan önce gelen sendOtp isteğinden requestId.
otp

string

ZORUNLU: Bu, kullanıcının sağladığı ve bu çağrının doğrulamakta olduğu OTP'dir.

Yanıt gövdesi

VerifyOtp yönteminin yanıt nesnesi.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorVerifyOtpId": string,
  "result": enum (VerifyOtpResultCode)
}
Alanlar
responseHeader

object (ResponseHeader)

ZORUNLU: Tüm yanıtlar için ortak başlık.
paymentIntegratorVerifyOtpId

string

İSTEĞE BAĞLI: Entegratörün bu OTP isteğini doğrulama isteğini bildiği tanımlayıcı. Bu, entegratör tarafından oluşturulmuştur.
result

enum (VerifyOtpResultCode)

ZORUNLU: Bu isteğin sonucu

VerifyOtpResultCode

OTP doğrulama isteği için sonuç kodları

Sıralamalar
UNKNOWN_RESULT Bu varsayılan değeri asla ayarlamayın.
SUCCESS OTP, entegratörün gönderdiği değerle eşleşti
OTP_NOT_MATCHED OTP, entegrasyon uzmanının gönderdiği değerle eşleşmedi.
OTP_ALREADY_USED OTP zaten kullanıldı.