paytm developer docs logoDeveloperDocumentation
search

POSTFetch All Payment Offers API

Use Case

To fetch merchant's all payment instrument based offers with Paytm ecosystem

Request Attributes

Content Type : JSON

Head

AttributeDescription
requestTimeStamp
string
optional

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

channelId
string
mandatory

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

Possible values: WEB , WAP

tokenType
string
mandatory

This is for the authentication mechanism.
For checksum authentication, the value is CHECKSUM.
 

token
string
mandatory

For tokenType CHECKSUM, Inputs could be CHECKSUM (signature) value.

Body

AttributeDescription
mid
string
mandatory

Paytm provides MID as a unique identifier to each merchant. You get the production MID post the account activation.
 

Example: 216820000002516036253

requestId
string
mandatory

Unique reference ID which is given in request payload

Response Attributes

Content Type : JSON

Head

AttributeDescription
responseTimestamp
string

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

 

Eg. 1588402269

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.

paymentOffers
Object

Payment offers contain promo details like promo code, offer, termsUrl, etc.

paymentOffers
+
AttributeDescription
promocode
string

This is unique code for discount.

offer
object

Offers available.

Offer
+
AttributeDescription
title
string

Name of the promode for display.

text
string

Description of the promocode.

icon
string

Image of the icon.

termsUrl
string

URL to fetch details terms and condition.

termsTitle
string

Terms & condition for applying promo.

validFrom
string

Request timestamp in milliseconds.

validUpto
string

Request timestamp in milliseconds.

isPromoVisible
enum string

To handle flash sale.

Response Codes & Messages

resultCoderesultStatusresultMsg
0000SSuccess
1001FRequest parameters are not valid
9999FSomething went wrong
2005FChecksum provided is invalid
1006FSession expired
1007FMissing mandatory element
501FSystem Error
2013FMid in the query param doesn't match with the Mid send in the request
6050FrequestId in the query param doesn't match with the requestId send in the request
2222FInvalid request body
1011FParameter illegal Note: If the value is not allowed in request parameters then the result message should be in the format of "Invalid {field name}" For example:Invalid tokenType, etc
⇾
Staging
Production
https://stage-router.paytm.in/aoa-pay-option-service/v2/fetchAllPaymentOffers?mid={mid}&requestId={requestId}copy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl --location 'https://stage-router.paytm.in/aoa-pay-option-service/v2/fetchAllPaymentOffers?mid=YOUR_MID_HERE&requestId=purnima02' \
--header 'Content-Type: application/json' \
--header 'Cache-Control: max-age=0' \
--data '{"body": {"mid": "YOUR_MID_HERE","requestId": "purnima02"},"head": { "requestTimeStamp": "{requestTimeStamp}","channelId": "WEB","tokenType": "CHECKSUM","token": "{CHECKSUM}"}}'




 
copy icon