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

Attribute	Description
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

Attribute	Description
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

Attribute	Description
responseTimestamp string	EPOCH timestamp of the time at which response is being sent.

Body

Attribute

Description

resultInfo

object

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

resultInfo

Attribute	Description
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

resultCode	resultStatus	resultMsg
0000	S	Success
501	F	System error
1012	F	param missing
1007	F	Missing mandatory element
1001	F	Request parameters are not valid
1006	F	Your Session has expired
2013	F	Mid in the query param doesn't match with the Mid send in the request
2014	F	OrderId in the query param doesn't match with the OrderId send in the request
403	F	Invalid OTP entered
442	F	Invalid OTP, already used OTP entered.
432	F	Login Failed
401	F	Authorization Failed
434	F	Bad Request
531	F	Oops ! You have reached OTP limit, please raise a query at paytm.com/care.
2222	F	Invalid 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"}}'