Method: resendOtp

  • The resendOtp endpoint enables issuers to send an additional OTP to the cardholder upon request, using the same information from the initial authenticate request.

  • The request body includes the requestHeader and authenticateRequestId, which is the unique identifier from the original authenticate request.

  • Successful responses return a ResendOtpResponse object with a success result code, while errors are indicated by an ErrorResponse object.

  • Potential error scenarios include request expiration (requestExpired) or reaching the OTP request limit (otpRequestLimitReached).

  • The endpoint uses a POST request to https://www.integratorhost.example.com/integrator-base-path/v1/payment-integrator-authenticated-card-fop-api/resendOtp.

Requests that the issuer send the cardholder an additional OTP if the user requests one. It is sent using the same information provided in the authenticate request.

If the endpoint encounters an error while processing the request, the response body from this endpoint should be of type ErrorResponse.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1
    },
    "requestId": "cmVxdWVzdDE",
    "requestTimestamp": {
      "epochMillis": "1481899949606"
    },
    "paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR"
  },
  "authenticateRequestId": "G112YZH4XPDV88J"
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1481899949611"
    }
  },
  "result": {
    "success": {}
  }
}

HTTP request

POST https://www.integratorhost.example.com/integrator-base-path/v1/payment-integrator-authenticated-card-fop-api/resendOtp

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "authenticateRequestId": string
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.
authenticateRequestId

string

REQUIRED: A unique identifier representing the request to send an OTP. This is the requestId generated by Google during an authenticate request. An OTP is sent to the same user using the same information that was in the authenticate request.

Response body

This method supports multiple return types. For additional information about what 4XX or 5XX HTTP status code to return with an ErrorResponse, consult the ErrorResponse object and HTTP status codes documentation.

Possible response messages
HTTP 200 Status

object (ResendOtpResponse)
HTTP 4XX / 5XX Status

object (ErrorResponse)

ResendOtpResponse

Response object for the payment integrator hosted resendOtp method.

JSON representation 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": {
    object (ResendOtpResultCode)
  }
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.
result

object (ResendOtpResultCode)

REQUIRED: The result of the resendOtp request.

ResendOtpResultCode

Result codes for resendOtp.

JSON representation 
{

  // Union field resend_otp_result_code can be only one of the following:
  "success": {
    object (Empty)
  },
  "requestExpired": {
    object (Empty)
  },
  "otpRequestLimitReached": {
    object (Empty)
  }
  // End of list of possible types for union field resend_otp_result_code.
}
Fields
Union field resend_otp_result_code. REQUIRED: The result of the resendOtp request. resend_otp_result_code can be only one of the following:
success

object (Empty)

The request to send an OTP to the user was successful.
requestExpired

object (Empty)

The request to authenticate the user has expired. A new authenticate request is required in order to authenticate this user.
otpRequestLimitReached

object (Empty)

The number of requests to send an OTP has reached its limit and no more OTPs can be requested for this authenticate request.