paytm developer docs logoDeveloperDocumentation
search

POST Fetch UPI Apps API

Use Case

This API is used by the merchants to fetch the list of PSP apps and their icons to be displayed on the checkout page.

 

The list of apps returned using this API should be displayed on the merchant's checkout page. The current set of supported apps are Paytm, BHIM UPI, PhonePe, and Google Pay.

 

We suggest that you cache the response of this API for a time period of 1 week, so that it is not called BHIM for every payment transaction and also ensures that the list of apps is maintained dynamically in nature.

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

Authorization string corresponding to the tokenType used.

requestTimestamp
string
optional

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

refId
string
optional

Ref Id

Possible Values: Any unique ID

channelId
string
optional

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

Possible Values: WEB/WAP

Body

AttributeDescription
MID
string
mandatory

This is a unique identifier provided to every merchant by Paytm. MID is part of your account credentials and is different on staging and production environment. Your staging MID is available here & production MID will be available once your activation is complete.

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
upiPspOptions
string

List Of PSP Providers 

Possible Values: List of supported UPI PSP apps

UPIPspOptions
+
AttributeDescription
name
string

Name of the UPI PSP app

Example: GooglePay,PhonePe,Paytm

iconUr
string

image path of the UPI PSP icon

Example: <URL>

resultInfo
string

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".

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