Method: verifyOtp

Memverifikasi bahwa nilai OTP telah dikirim oleh integrator untuk akun.

Jika endpoint mengalami error saat memproses permintaan, isi respons dari endpoint ini harus berjenis ErrorResponse.

Contoh permintaan terlihat seperti ini:


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

Contoh respons terlihat seperti ini:


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

Permintaan HTTP

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

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "sendOtpRequestId": string,
  "otp": string
}
Kolom
requestHeader

object (RequestHeader)

DIPERLUKAN: Header umum untuk semua permintaan.
sendOtpRequestId

string

DIPERLUKAN: requestId dari permintaan sendOtp yang mendahului panggilan ini.
otp

string

DIPERLUKAN: Ini adalah OTP yang diberikan pengguna, yang sedang diverifikasi panggilan ini

Isi respons

Objek respons untuk metode VerifyOtp.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

object (ResponseHeader)

DIPERLUKAN: Header umum untuk semua respons.
paymentIntegratorVerifyOtpId

string

OPSIONAL: Pengidentifikasi integrator mengetahui bahwa ini memverifikasi permintaan OTP. Ini adalah integrator yang dihasilkan.
result

enum (VerifyOtpResultCode)

REQUIRED: Hasil dari permintaan ini

VerifyOtpResultCode

Kode hasil untuk memverifikasi permintaan OTP

Enumerasi
UNKNOWN_RESULT Jangan pernah menetapkan nilai default ini.
SUCCESS OTP cocok dengan yang dikirim oleh integrator
OTP_NOT_MATCHED OTP tidak sesuai dengan yang dikirim oleh integrator.
OTP_ALREADY_USED OTP sudah digunakan.