POSTFetch All Offers API

Use Case

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

Request Attributes

Content Type : JSON

Head

Attribute	Description
requestId string optional	Unique reference ID which is given in request payload
requestTimestamp string(15) optional	EPOCH timestamp of the time at which request is being sent. Example: 1588402269
version string(4) optional	Version of the API. Example: v1
channelId string(3) mandatory	The parameter value identifies the Channel for which API call is initiated. Possible values: WEB For websites, the value to be passed should be "WEB" , WAP For Mobile websites/App, the value to be passed should be "WAP"
tokenType string mandatory	This is for the authentication method. • For SSO token authentication, the value is SSO. • For checksum authentication, the value is CHECKSUM.
token string optional	• In case of tokenType SSO, Inputs could be SSO token value. • In case of tokenType CHECKSUM, Inputs could be CHECKSUM value. Note: Create the checksum using the body parameter of the request.

Body

Attribute	Description
mid string(20) 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

Response Attributes

Content Type : JSON

Head

Attribute	Description
requestId string	Unique reference ID for a transaction which is generated by merchant and sent in the request
responseTimestamp string(15)	EPOCH timestamp of the time at which response is being sent. Example: 1588402269
version string(2)	Version of the API passed in the request. Example: v1

Body

Attribute

Description

resultInfo

object

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

ResultInfo

Attribute	Description
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.
resultCodeId string	Result code id returned to merchant.
resultStatus string	This parameter indicates the status of API call. Possible Values: S For Success , F For Failure
resultMsg string (256)	This parameter is the result message which contains information about the result.The different result messages corresponding to this API are mentioned below.

paymentOffers

object

Payment offers contains promo details like promocode, offer, termsUrl, etc.

PaymentOffers

Attribute

Description

promocode

string

This is unique code for discount.

offer

object

Offers available.

Offer

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

resultCode	resultStatus	resultMsg
00000000	S	Success
1001	F	Request parameters are not valid.
9999	F	Something went wrong.
2005	F	Checksum provided is invalid.

⇾

Staging

Production

https://securestage.paytmpayments.com/theia/api/v1/fetchAllPaymentOffers?mid={mid} copy icon

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl -X POST 'https://securestage.paytmpayments.com/theia/api/v1/fetchAllPaymentOffers?mid={mid}' \
--header 'Content-Type: application/json' \
--data '{"body":{"mid":"{mid}"},"head":{"channelId":"WEB","tokenType":"CHECKSUM","token":"{CHECKSUM}"}}'