Method: verifyOtp
Stay organized with collections
Save and categorize content based on your preferences.
Verifies an OTP value was sent by the integrator for the account.
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,
"minor": 0,
"revision": 0
},
"requestId": "0123434-otp-abc",
"requestTimestamp": "1502545413098"
},
"sendOtpRequestId": "0123434-otp-abc",
"otp": "7754321"
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": "1502545413132"
},
"paymentIntegratorVerifyOtpId": "5539163",
"result": "SUCCESS"
}
HTTP request
POST https://www.integratorhost.example.com/v1/verifyOtp
Request body
The request body contains data with the following structure:
| JSON representation |
{
"requestHeader": {
object (RequestHeader)
},
"sendOtpRequestId": string,
"otp": string
} |
| Fields |
requestHeader |
object (RequestHeader)
REQUIRED: Common header for all requests.
|
sendOtpRequestId |
string
REQUIRED: requestId from the sendOtp request that preceded this call.
|
otp |
string
REQUIRED: This is the OTP the user provided, which this call is verifying
|
Response body
Response object for the verifyOtp method.
If successful, the response body contains data with the following structure:
| Fields |
responseHeader |
object (ResponseHeader)
REQUIRED: Common header for all responses.
|
paymentIntegratorVerifyOtpId |
string
OPTIONAL: Identifier the integrator knows this verify OTP request as. This is integrator generated.
|
result |
enum (VerifyOtpResultCode)
REQUIRED: Result of this request
|
VerifyOtpResultCode
Result codes for verify OTP request
| Enums |
UNKNOWN_RESULT |
Do not ever set this default value! |
SUCCESS |
OTP matched what the integrator sent |
OTP_NOT_MATCHED |
OTP did not match what the integrator sent. |
OTP_ALREADY_USED |
OTP was already used. |
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-03 UTC."],[[["\u003cp\u003eThis endpoint verifies an OTP value sent by the integrator for the account using a POST request.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must include the \u003ccode\u003erequestHeader\u003c/code\u003e, \u003ccode\u003esendOtpRequestId\u003c/code\u003e, and the user-provided \u003ccode\u003eotp\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe response body contains a \u003ccode\u003eresponseHeader\u003c/code\u003e, an optional \u003ccode\u003epaymentIntegratorVerifyOtpId\u003c/code\u003e, and the \u003ccode\u003eresult\u003c/code\u003e indicating the verification outcome.\u003c/p\u003e\n"],["\u003cp\u003ePossible result codes include \u003ccode\u003eSUCCESS\u003c/code\u003e, \u003ccode\u003eOTP_NOT_MATCHED\u003c/code\u003e, and \u003ccode\u003eOTP_ALREADY_USED\u003c/code\u003e, providing the verification status.\u003c/p\u003e\n"],["\u003cp\u003eIn case of errors during processing, the response body will be of type \u003ccode\u003eErrorResponse\u003c/code\u003e.\u003c/p\u003e\n"]]],["This content details how to verify an OTP (One-Time Password). A `POST` request is sent to `https://www.integratorhost.example.com/v1/verifyOtp` with a JSON body. The request body requires a `requestHeader`, `sendOtpRequestId`, and the `otp` to verify. A successful response includes a `responseHeader`, an optional `paymentIntegratorVerifyOtpId`, and a `result` enum which can be `SUCCESS`, `OTP_NOT_MATCHED`, or `OTP_ALREADY_USED`. Error responses follow an `ErrorResponse` type.\n"],null,["# Method: verifyOtp\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.VerifyOtpResponse.SCHEMA_REPRESENTATION)\n- [VerifyOtpResultCode](#VerifyOtpResultCode)\n\nVerifies an OTP value was sent by the integrator for the account.\n\nIf the endpoint encounters an error while processing the request, the response body from this endpoint should be of type [`ErrorResponse`](/standard-payments/payment-processor-service-api/v1/ErrorResponse).\n\nAn example request looks like: \n\n\n {\n \"requestHeader\": {\n \"protocolVersion\": {\n \"major\": 1,\n \"minor\": 0,\n \"revision\": 0\n },\n \"requestId\": \"0123434-otp-abc\",\n \"requestTimestamp\": \"1502545413098\"\n },\n \"sendOtpRequestId\": \"0123434-otp-abc\",\n \"otp\": \"7754321\"\n }\n\nAn example response looks like: \n\n\n {\n \"responseHeader\": {\n \"responseTimestamp\": \"1502545413132\"\n },\n \"paymentIntegratorVerifyOtpId\": \"5539163\",\n \"result\": \"SUCCESS\"\n }\n\n### HTTP request\n\n`POST https://www.integratorhost.example.com/v1/verifyOtp`\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestHeader\": { object (/standard-payments/payment-processor-service-api/v1/RequestHeader) }, \"sendOtpRequestId\": string, \"otp\": string } ``` |\n\n| Fields ||\n|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestHeader` | `object (`[RequestHeader](/standard-payments/payment-processor-service-api/v1/RequestHeader)`)` **REQUIRED**: Common header for all requests. |\n| `sendOtpRequestId` | `string` **REQUIRED** : `requestId` from the `sendOtp` request that preceded this call. |\n| `otp` | `string` **REQUIRED**: This is the OTP the user provided, which this call is verifying |\n\n### Response body\n\nResponse object for the verifyOtp method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"responseHeader\": { object (/standard-payments/payment-processor-service-api/v1/ResponseHeader) }, \"paymentIntegratorVerifyOtpId\": string, \"result\": enum (/standard-payments/payment-processor-service-api/v1/TopLevel/verifyOtp#VerifyOtpResultCode) } ``` |\n\n| Fields ||\n|--------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `responseHeader` | `object (`[ResponseHeader](/standard-payments/payment-processor-service-api/v1/ResponseHeader)`)` **REQUIRED**: Common header for all responses. |\n| `paymentIntegratorVerifyOtpId` | `string` **OPTIONAL**: Identifier the integrator knows this verify OTP request as. This is integrator generated. |\n| `result` | `enum (`[VerifyOtpResultCode](/standard-payments/payment-processor-service-api/v1/TopLevel/verifyOtp#VerifyOtpResultCode)`)` **REQUIRED**: Result of this request |\n\nVerifyOtpResultCode\n-------------------\n\nResult codes for verify OTP request\n\n| Enums ||\n|--------------------|---------------------------------------------|\n| `UNKNOWN_RESULT` | Do not ever set this default value! |\n| `SUCCESS` | OTP matched what the integrator sent |\n| `OTP_NOT_MATCHED` | OTP did not match what the integrator sent. |\n| `OTP_ALREADY_USED` | OTP was already used. |"]]