paytm developer docs logoDeveloperDocumentation
search

POSTCheck UPI Account Status API

Use Case

This API can be used by the merchants for checking whether a UPI account exists for a particular user mobile number or not. It can also be used by the merchants for adding a touch of smartness to the static UPI payment icon, and show Paytm as a payment option only to users who have their UPI profile enabled on the Paytm app.

Request Attributes

Content Type : JSON

Head

AttributeDescription
version
string
optional

Version of the API.

Example: v1

tokenType
string
mandatory

This parameter identifies whether the API works on checksum authentication.

Possible Values: CHECKSUM

token
string
mandatory
  • For tokenType JWT, use JWT token.
  • For tokenType CHECKSUM, It's value to be sent should be the checksum string created by using Paytm checksum library. Authorization string corresponding to the tokenType used.

Example: 16Xm7DXbvNqhaLw+HMj4XB6XTQKCoM=

requestTimestamp
string
optional

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

requestId
string
optional

Unique reference ID for a transaction which is generated by merchant and sent in the request

channelId
string
optional

The parameter value identifies the Channel for which API call is initiated.

Body

AttributeDescription
mid
string
mandatory

Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation.

Example: INTEGR7769XXXXXX9383

mobileNumber
string
mandatory

mobile number of user without country code

deviceId
string
optional

deviceId

Response Attributes

Content Type : JSON

Head

AttributeDescription
responseTimestamp
string

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

version
string

Version of the API passed in the request.
Example: v1

Body

AttributeDescription
resultInfo
boolean

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

ResultInfo
+
AttributeDescription
resultCode
string

This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. The different result codes corresponding to this API are mentioned below.

resultStatus
string

This parameter indicates the status of API call.

Possible values:
S
For Success
,
F
For Failure
resultMsg
string

This parameter is the result message which contains information about the result. The different result messages corresponding to this API are mentioned below in section " Response Codes and Messages".

upiAccountExist
boolean

Whether upi account exists for user

Possible Values: true/false

⇾
Staging
Production
https://securestage.paytmpayments.com/theia/api/v1/checkUPIAccountExistcopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl - X POST 'https://secure.paytmpayments.com/ theia/api/v1/checkUPIAccountExist?mid={mid}&orderId=ORDERID_98765'\
    --header 'Content-Type: application/json'\
    --data '{"head": {"tokenType": "CHECKSUM","token": "{checksum}"},"body": {"mid":"{mid}","mobileNumber": "7777777777","deviceId": "xyz"}}
copy icon