Method: verifyOtp

Memverifikasi nilai OTP yang dikirim oleh integrator untuk akun tersebut.

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

Contoh permintaan terlihat seperti:


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

Contoh respons akan 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)

WAJIB: Header umum untuk semua permintaan.
sendOtpRequestId

string

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

string

WAJIB: Ini adalah OTP yang diberikan pengguna, yang diverifikasi oleh 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)

WAJIB: Header umum untuk semua respons.
paymentIntegratorVerifyOtpId

string

OPSIONAL: ID integrator mengetahui permintaan OTP verifikasi ini. Ini adalah integrator yang dihasilkan.
result

enum (VerifyOtpResultCode)

WAJIB: Hasil permintaan ini

VerifyOtpResultCode

Kode hasil untuk memverifikasi permintaan OTP

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