POSTApply Offer API
Use Case
Paytm Apply Offer API is used to apply bank offer and subvention offer on the transaction.
Request Attributes
Head
Attribute | Description |
---|---|
token string conditional | Authorization string corresponding to the tokenType used. Note: It is mandatory for token type CHECKSUM, SSO/ACCESS |
tokenType string mandatory | Authorization method for this request. Example: TXN_TOKEN/ACCESS/SSO/CHECKSUM |
txnToken string conditional | This is the unique transaction token received in the response of Initiate Transaction API. It is valid for 15 minutes. Note: It is mandatory for token type TXN_TOKEN |
channelId string mandatory | The parameter value identifies the Channel for which API call is initiated. Example: WEB/WAP |
Body
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
items List<Object> conditional | List of items on which offers have to be applied. Note: It is required for items based offers not required for amount based offers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
items +
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
orderId string optional | The Unique reference ID of the Order. It is alphanumeric and max length is 50 characters. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
paymentDetails Object mandatory | List of payment methods for which offers have to be applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
paymentDetails +
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
custId string optional | Unique reference ID for every customer which is generated by merchant. Special characters allowed in CustId are @, ! ,=,_ ,$, . | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
offerDetails Object conditional | Offer details object to be passed only for amount-based offers. Note: OfferDetails along with items can not be passed. Also, It is required only for Amount based offers. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
offerDetails +
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
amountBasedBankOffer boolean conditional | Flag to identify the type of offer to applied i.e, Amount based or SKU based offer. Mandatory to be sent as false for item based offer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
amountBasedSubvention boolean conditional | Flag to identify the type of subvention to applied i.e, Amount based or SKU based subvention. Mandatory to be sent as false for item based subvention |
Response Attributes
Head
Attribute | Description |
---|---|
requestId string | Unique reference ID which is given in request payload |
responseTimeStamp string | EPOCH timestamp of the time at which response is being sent. |
version string | Version of the API |
Body
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ResultInfo Object | This parameter gives information about the result of the API response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resultInfo +
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
paymentDetails Object | List of payment methods having offer details | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
paymentDetails +
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unifiedOffersToken string | Token which is generated when merchant intends to apply offers in the payment on the passed instrument of the customer. It will be needed to send in the Initiate Transaction API request. |
Response Codes & Messages
resultCode | resultStatus | resultMsg |
---|---|---|
1001 | F | Request parameters are not valid |
0001 | F | Failed |
2005 | F | Checksum provided is invalid |
1006 | F | Your session has expired |
2100 | F | Invalid Access Token |
2004 | F | SSO Token is invalid |
0002 | F | No Offers Available |
curl --location --request POST 'https://securegw-stage.paytm.in/theia/api/v1/offerApply?referenceId=123456789' \
--header 'Content-Type: application/json' \
--data '{ "head": { "channelId": "WEB", "tokenType": "CHECKSUM", "token": {CHECKSUM}},
"body": {"mid": "YOUR_MID_HERE", "custId": "1000177185", "items": [{"id": "123", "productId": "8903287020ABC", "brandId": "123","categoryId": "1234", "price": 8000.25,"offerDetails": { "emiOfferDetails": { "offerId": "2130582" }, "bankOfferDetails": [{"offerId": "2126546"} ] } } ], "paymentDetails": { "orderAmount": 8000.25, "paymentOptions": [{"issuingBank": "HDFC","issuingNetworkCode": "VISA","payMethod": "EMI","cardNo":"4111111111111111","tenure": [{ "value": 6,"unit": "MONTH"}]}]}}}'