search

POSTVerify OTP API

Use Case

Once the user enters the OTP,  Verify OTP API is called to validate the OTP entered by the user to complete authentication for login into the AI router ecosystem. 

Request Attributes

Content Type : JSON

Head

AttributeDescription
requestTimeStamp
string
optional

EPOCH timestamp of the time at which request is being sent.

tokenType
string
mandatory

Token Type 

Eg. TXN_TOKEN
 

token
string
mandatory

Transaction Token

channelId
EChannelId Enum
optional

The parameter value identifies the Channel for which the API call is initiated. Default value will be WEB.
 

Possible values: WEB, WAP, APP, SYSTEM

Body

AttributeDescription
otp
string
mandatory

One Time Password is a temporary, secure PIN-code sent to you via SMS or e-mail that is valid only for one session.

rememberMe
boolean
optional

Auto logs in the user next time if this field is checked.

Response Attributes

Content Type : JSON

Head

AttributeDescription
responseTimestamp
string

EPOCH timestamp of the time at which response is being sent.

Body

AttributeDescription
resultInfo
object

This parameter gives the information about the result of the API response

resultInfo
+
AttributeDescription
resultStatus
string

This parameter is the result specific to the phase of the transaction mentioned in the txnType field

resultCode
string

This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64.

resultMsg
string

This parameter is the result message which contains information about the result.

authenticated
boolean

This parameter gives the information if the user is successfully authenticated or not. 

payOptionsInfo
Map

AI router sends the response of payment options available for the user. 

Response Codes & Messages

resultCoderesultStatusresultMsg
0000SSuccess
501FSystem error
1012Fparam missing
1007FMissing mandatory element
1001FRequest parameters are not valid
1006FYour Session has expired
2013FMid in the query param doesn't match with the Mid send in the request
2014FOrderId in the query param doesn't match with the OrderId send in the request
403FInvalid OTP entered
442FInvalid OTP, already used OTP entered.
432FLogin Failed
401FAuthorization Failed
434FBad Request
531FOops ! You have reached OTP limit, please raise a query at paytm.com/care.
2222FInvalid request body
Staging
Production
https://stage-router.paytm.in/aoa-pay-option-service/v2/otp/verify?mid={mid}&orderId={orderID}copy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl --location --request POST 'https://stage-router.paytm.in/aoa-pay-option-service/v2/otp/verify?mid={mid}&orderId={orderID}' \
--header 'Authorization: Basic YW9hLWFjcXVpcmluZy1iaXo6WVdHNHh2MHN5WWhIZkM0MEVwckE5bGo0YlgyTFp0bE8=' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{"head": {"version": "v1","channelId":"WEB","token": "7f0e9307-bcfd-443e-9f70-0b09dec6821c","tokenType":"TXN_TOKEN"},"body": {"otp":"888888"}}'

 

copy icon