Method: verifyOtp

계정의 통합자가 OTP 값을 보냈는지 확인합니다.

요청을 처리하는 중에 엔드포인트에서 오류가 발생하면 이 엔드포인트의 응답 본문은 ErrorResponse 유형이어야 합니다.

요청의 예는 다음과 같습니다.


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

응답 예시는 다음과 같습니다.


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

HTTP 요청

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

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현
{
  "requestHeader": {
    object (RequestHeader)
  },
  "sendOtpRequestId": string,
  "otp": string
}
필드
requestHeader

object (RequestHeader)

필수: 모든 요청의 공통 헤더입니다.

sendOtpRequestId

string

필수: 이 호출 이전의 sendOtp 요청에서 requestId입니다.

otp

string

필수: 사용자가 제공한 OTP로, 이 통화를 통해 인증 중입니다.

응답 본문

verifyOtp 메서드의 응답 객체입니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "paymentIntegratorVerifyOtpId": string,
  "result": enum (VerifyOtpResultCode)
}
필드
responseHeader

object (ResponseHeader)

필수: 모든 응답의 공통 헤더입니다.

paymentIntegratorVerifyOtpId

string

선택사항: 통합업체가 이 인증 OTP 요청을 알고 있는 식별자입니다. 통합업체가 생성됩니다.

result

enum (VerifyOtpResultCode)

필수: 이 요청의 결과

VerifyOtpResultCode

OTP 요청 결과 코드

열거형
UNKNOWN_RESULT 이 기본값을 설정하면 안 됩니다.
SUCCESS 통합업체에서 보낸 OTP와 일치함
OTP_NOT_MATCHED OTP가 통합업체에서 보낸 정보와 일치하지 않습니다.
OTP_ALREADY_USED OTP가 이미 사용되었습니다.