paytm developer docs logoDeveloperDocumentation
search

POSTNative Fetch User PayMode Status API

Use Case

API to fetch User PayMode Status in native flow. This API can be used to determine if a user has an active postpaid account or not with their phone number.

Request Attributes

Content Type : JSON

Head

AttributeDescription
version
string
optional

Version of the API.

Example: v1

channelId
string
optional

Channel through which call initiated

Possible Values: WEB, WAP

requestTimestamp
string
optional

Unix Timestamp of request
Possible Value: 1525344042691

tokenType
string
mandatory

Authorization method for this request
Possible Values: CHECKSUM, SSO, ACCESS

token
string
mandatory

Authorization string corresponding to the tokenType used
Example: 87136l2-a2k2-4a41-9f3b-642e0cb8000

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

mobileNo
string
optional

    
Customer Mobile number

Example: 7777777777

userId
string
optional

paytm userId

Example: 1000943226

referenceId
string
conditional

unique reference id and should have same value as used in create ACCESS token(v1/token/create)

Example: ref_987654321

paymentMode
string
mandatory

List of paymodes
Possible Values: ["PAYTM_DIGITAL_CREDIT"]

Response Attributes

Content Type : JSON

Head

AttributeDescription
responseTimestamp
string

    
Timestamp at which response was sent

Example: 1525344042691

version
string

Application version

Example: v1

Body

AttributeDescription
resultInfo
Object

resultInfo Object

resultInfo
+
AttributeDescription
resultStatus
string

Result Status of the transaction

Possible Values: S (Success), F (Failure), U (Unknown)

resultCode
string

Result code returned to the merchant. Max length of result code can be 64

resultMsg
string

The result Message corresponding to the transaction

payModeStatus
Object

List of user payMode status

payModeStatus
+
AttributeDescription
payModeName
string

Name of the Payment option

Possible Values: PAYTM_DIGITAL_CREDIT

status
string

Current status of Payment option
Possible Value: ACTIVE, INACTIVE

Response Codes & Messages

resultCoderesultStatusresultMsg
1006FYour Session has expired
2004FSSO Token is invalid
2005FChecksum provided is invalid
2021FInvalid token type
1001FRequest parameters are not valid
1007FMissing mandatory element
9999FSYSTEM ERROR
0000SSuccess
⇾
Staging
Production
https://securegw-stage.paytm.in/theia/api/v1/fetchUserPaymentModeStatuscopy icon
REQUEST
RESPONSE
CURL
curl --location --request POST 'https://securegw-stage.paytm.in/theia/api/v1/fetchUserPaymentModeStatus' \
--header 'Content-Type: application/json' \
--data-raw '{"head": {"tokenType": "CHECKSUM","token": "ePFv9Ec2N9C5/UfwTae3uowxNnF5OszxF1YIIzL9Ze7Htc5bA6QnJziNSmz3Ut0uktX0CKDghMGbiFUVllmOut0hk39ta8mCscx0XKhAjmw="},"body": {"mid": "k1G7l346739004133410","mobileNo": "7777777777","paymentMode": ["PAYTM_DIGITAL_CREDIT"]}}'



 
copy icon