The fetch_offers API fetches all active (with the Live status on Dashboard) offers for this Merchant ID.
Note:
If the amount are received in the request, the discount calculation for each offer is also sent as part of the response. If the amount is not received, the response does not contain the discount calculation fields.
Endpoints
| Test Environment | https://sandbox.payu.in/offers/transactions |
| Production Environment | https://api.payu.in/offers/transactions |
Request Headers
The request header contains the following fields:
| Field | Description | Example |
|---|---|---|
| Date mandatory | The date and time should be in the GMT time conversion(not the IST). For example, current time in India is 18:00:00 IST, the time in the date header should be 12:30:00 GMT. | Thu, 17 Feb 2022 08:17:59 GMT |
| Digest mandatory | Base 64 encode of (sha256 hash of the JSON data (post to server). | vpGay5D/dmfoDupALPplYGucJAln9gS29g5Orn+8TC0= |
| Authorization mandatory | This field is in the following format:hmac username="smsplus", algorithm="hmac-sha256", headers="date digest", signature="CkGfgbho69uTMMOGU0mHWf+1CUAlIp3AjvsON9n9/E4="Where the above format includes the following: - username: The merchant key of the merchant. - algorithm: This must have the value as hmac-sha256 that is used for this API - headers: This must have the value as date digest - signature: This must contain the hmacsha256 of (signing_string, merchant_secret), where: - signing_string: This is in the "Date"+"\n"+"Digest" format. Here, the Date and Digest is the same values in the fields listed in this table For example, "Thu, 17 Feb 2022 08:17:59 GMT""\n"+“vpGay5D/dmfoDupALPplYGucJAln9gS29g5Orn+8TC0=“ - merchant_secret: The merchant Salt of the merchant. For more information on getting the merchant Salt, refer to Generate Merchant Key and Salt on PayU Dashboard | hmac username="smsplus", algorithm="hmac-sha256", headers="date digest", signature="zGmP5Zeqm1pxNa+d68DWfQFXhxoqf3st353SkYvX8HI=" |
| platformId mandatory | This field contains the platform ID and include the value as 1. | 1 |
The following sample Java code contains the logic used to encrypt as described in the above table:
import com.google.gson.Gson;
import com.google.gson.JsonObject;
import org.apache.commons.codec.binary.Base64;
import org.joda.time.DateTime;
import org.joda.time.format.DateTimeFormat;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.security.InvalidKeyException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
public class HmacAuth {
public static String getSha256(String input) {
try {
MessageDigest md = MessageDigest.getInstance("SHA-256");
byte[] digest = md.digest(input.getBytes());
return Base64.encodeBase64String(digest);
} catch (NoSuchAlgorithmException ignored) {}
return null;
}
public static JsonObject getRequestBody(){
JsonObject requestJson = new JsonObject();
requestJson.addProperty("firstname","John");
requestJson.addProperty("lastname","Doe");
return requestJson;
}
public static void main(String[] args) throws NoSuchAlgorithmException, InvalidKeyException {
String key = "smsplus";
String secret = "admin";
Gson gson = new Gson();
String date = DateTimeFormat.forPattern("EEE, dd MMM yyyy HH:mm:ss 'GMT'").withZoneUTC().print(new DateTime());
System.out.println(date);
JsonObject requestJson = getRequestBody();
String digest = getSha256(gson.toJson(requestJson));
System.out.println(digest);
String signingString = new StringBuilder()
.append("date: " + date)
.append("\ndigest: " + digest).toString();
Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
SecretKeySpec secret_key = new SecretKeySpec(secret.getBytes(), "HmacSHA256");
sha256_HMAC.init(secret_key);
String signature = Base64.encodeBase64String(sha256_HMAC.doFinal(signingString.getBytes()));
String authorization = new StringBuilder()
.append("hmac username=\"")
.append(key)
.append("\", algorithm=\"hmac-sha256\", headers=\"date digest\", signature=\"")
.append(signature)
.append("\"").toString();
System.out.println(authorization);
}
}
Request Parameters
| Parameter | Description | Example |
|---|---|---|
Amountoptional | floatThe offer transaction amount | |
offerKeysoptional | String ArrayThis field contains list of keys to filter the offer in an array format. | SummerSpecialOffer2021@q1Bh0jsogwqP |
paymentIdoptional | LongUnique reference ID for a transaction which is generated by merchant and sent in the request | 110 |
userTokenoptional | String LongThis parameter is used to uniquely identify a user for a client/merchant. | |
skusDetailoptional | String ArrayThe skusDetail is in an array format and contains the SKU offer details. For more information, refer to | |
autoApplyoptional | Boolean This parameter must be set to true if the offer is automatically applied. | true |
Notes:
- If you had enable the Enforce Offer flag with PayU, the best offer out of the all the offers passed will be applied for the customer. While using this API, the autoApply parameter must be set to true if the offer is automatically applied.
- All the parameters are optional, but the header is mandatory.
skusDetail Parameter Description
In addition to the request parameters listed in the Fetch Offers API section, the skusDetail parameter is posted with the following fields are posted in an array:
| Field | Description |
|---|---|
skuAmountoptional | String The price of one/ single unit of SKU is specified in this field. |
skuIdmandatory | String The product identifier to select offer is specified in this field. |
quantity
optional | String The quantity for the product is specified in this field. |
offerKeysoptional | StringThe offer keys to filter at SKU-level is specified in this field. |
Sample request and response for a normal transactional offer
With autoApply=true
Sample request
{
"amount": 300,
"offerKeys": [],
"paymentId": 12332345,
"autoApply": true,
"userToken": "token"
}
Sample response
{
"code": "200",
"message": "Offer Retrieved Successfully",
"status": 1,
"result": {
"failureReason": null,
"clientId": 42693,
"mid": 180012,
"amount": 300,
"couponsAvailable": true,
"isUserPersonalizedOffersAvailable": true,
"offers": [
{
"failureReason": null,
"stepSize": null,
"externalOfferType": null,
"valid": true,
"offerKey": "Test@A0RwlqkXSPkK",
"type": "MERCHANT",
"title": "Test",
"description": "Test",
"tnc": "Test",
"tncLink": null,
"minTxnAmount": 100.00,
"maxTxnAmount": 1000.00,
"offerType": "INSTANT",
"minRangeDiscount": null,
"maxRangeDiscount": null,
"validFrom": "2024-10-14 00:00:00",
"validTo": "2024-10-15 23:59:59",
"discountDetail": {
"discountType": "ABSOLUTE",
"discountPercentage": null,
"discount": 100.00,
"discountedAmount": 200.00,
"maxDiscount": 100.00
},
"isNoCostEmi": false,
"isSubvented": false,
"isSkuOffer": false,
"creditCard": [
{
"networks": [],
"banks": [
{
"code": "AIRP",
"title": "Airtel Payments bank"
}
],
"title": null,
"paymentCode": null,
"handle": null
}
],
"debitCard": [
{
"networks": [
{
"code": "AMEX",
"title": "Amex CreditCard"
}
],
"banks": [],
"title": null,
"paymentCode": null,
"handle": null
}
],
"netBanking": [
{
"title": "Kotak Mahindra Bank",
"paymentCode": "162B",
"handle": null
}
],
"wallet": [
{
"title": "Amazon Pay",
"paymentCode": "AMZPAY",
"handle": null
}
],
"clw": null,
"upi": [
{
"title": "SamsungPay",
"paymentCode": "SamsungPay",
"handle": [
"pingpay"
]
}
],
"emi": {
"debitCard": {
"banks": [
{
"bankCode": "UTIB",
"bankName": "Axis Debit Card",
"tenureOption": [
{
"minDpRange": null,
"maxDpRange": null,
"isDpEmi": false,
"downPaymentUnit": null,
"title": "9 Months",
"paymentCode": "AXISD09",
"handle": null,
"discountDetail": null,
"linkedOffers": []
}
]
}
]
},
"creditCard": {
"banks": [
{
"bankCode": "AUSF",
"bankName": "AU Small Finance Bank Credit Card",
"tenureOption": [
{
"minDpRange": null,
"maxDpRange": null,
"isDpEmi": false,
"downPaymentUnit": null,
"title": "3 Months",
"paymentCode": "AUSF03",
"handle": null,
"discountDetail": null,
"linkedOffers": []
}
]
}
]
},
"cardLess": {
"banks": [
{
"bankCode": "HDFC_CL",
"bankName": "Hdfc Card Less ",
"tenureOption": [
{
"minDpRange": null,
"maxDpRange": null,
"isDpEmi": false,
"downPaymentUnit": null,
"title": "18 months",
"paymentCode": "HDFCCL18",
"handle": null,
"discountDetail": null,
"linkedOffers": []
}
]
}
]
},
"other": {
"banks": [
{
"bankCode": "BAJFIN",
"bankName": "Bajaj Finance Card Less ",
"tenureOption": [
{
"minDpRange": null,
"maxDpRange": null,
"isDpEmi": false,
"downPaymentUnit": null,
"title": "9 months",
"paymentCode": "BAJFIN09",
"handle": null,
"discountDetail": null,
"linkedOffers": []
}
]
}
]
}
},
"bnpl": [
{
"title": "LazyPay",
"paymentCode": "LAZYPAY",
"handle": null,
"tenureOption": null
},
{
"title": "HDFC Bank FlexiPay",
"paymentCode": "HDFCF",
"handle": null,
"tenureOption": [
{
"title": "HDFC Bank FlexiPay - 15 Days",
"paymentCode": "HDFCF15",
"handle": null
}
]
}
],
"skuDetail": null,
"isAcrossSkuQuantity": false,
"offerCategory": null,
"isBaseOffer": false,
"recordType": "OFFER",
"toDisplay": true,
"disallowTransactionInvalidOffer": false,
"isAllPaymentMethodsAvailable": false,
"isCohortOffer": false,
"isGstSubvented": false,
"isExternalOffer": false,
"issuerId": null,
"issuerName": null,
"isNudgeOnlyOffer": false
}
],
"skusDetail": null,
"flagToFail": false,
"isSkuOffer": false
},
"traceId": "1efe4312-d59c-4706-978c-2180a5c2e956"
}
With autoApply=false
Sample request
{
"amount": 300,
"autoApply": false,
"offerKeys": [
"TestOffer@fY6HdoP7da8L"
]
}
Sample response
{
"code": "200",
"message": "Offer Retrieved Successfully",
"status": 1,
"result": {
"failureReason": null,
"clientId": 42693,
"mid": 180012,
"amount": 300,
"couponsAvailable": true,
"isUserPersonalizedOffersAvailable": false,
"offers": [
{
"failureReason": null,
"stepSize": null,
"externalOfferType": null,
"recordSubType": null,
"valid": true,
"offerKey": "TestOffer@fY6HdoP7da8L",
"type": "MERCHANT",
"title": "TestOffer",
"description": "offer",
"tnc": "tnc",
"tncLink": null,
"minTxnAmount": 101.00,
"maxTxnAmount": 111111.00,
"offerType": "INSTANT",
"minRangeDiscount": null,
"maxRangeDiscount": null,
"validFrom": "2024-10-14 00:00:00",
"validTo": "2024-11-30 23:59:00",
"discountDetail": {
"discountType": "ABSOLUTE",
"discountPercentage": null,
"discount": 100.00,
"discountedAmount": 200.00,
"maxDiscount": 100.00
},
"isNoCostEmi": false,
"isSubvented": false,
"isSkuOffer": false,
"creditCard": null,
"debitCard": null,
"netBanking": null,
"wallet": null,
"clw": null,
"upi": null,
"emi": null,
"bnpl": null,
"skuDetail": null,
"isAcrossSkuQuantity": false,
"offerCategory": null,
"isBaseOffer": false,
"recordType": "OFFER",
"toDisplay": true,
"disallowTransactionInvalidOffer": false,
"isAllPaymentMethodsAvailable": true,
"isCohortOffer": false,
"isGstSubvented": false,
"isExternalOffer": false,
"issuerId": null,
"issuerName": null,
"isNudgeOnlyOffer": false,
"offerMilestone": null,
"userMilestone": null,
"userDetail": null,
"isUserVerificationRequired": false,
"isPersonalisedUniqueCoupon": false
}
],
"skusDetail": null,
"flagToFail": false,
"isSkuOffer": false,
"paymentId": null
},
"traceId": "4c6603a3-3fed-4a13-a44d-7e59e3df11d3"
}
Failure scenarios
- Merchant ID does not exists
Merchant ID does not exists
{
"code": "404",
"message": "Merchant with merchant Id :1800122 does not exists",
"status": 0,
"exceptionId": "9cf201ab-2ad3-439e-a7a6-f707d2f76e48"
}
- The platform for client mismatch or does not exists
{
"code": "404",
"message": "client with clientId :4 , platformId :12 does not exists.",
"status": 0,
"exceptionId": "6985749b-9de4-4d39-9242-d19d35a82d0c"
}
- Service unavailable
{
"code": "500",
"message": "Service Unavailable",
"status": 0,
"exceptionId": "65466805-5be1-4fa4-912d-d28cf620d687"
}
- Invalid request
{
"code": "400",
"message": "Invalid Request",
"status": 0,
"exceptionId": "252e1602-2a9a-449a-8f17-f55fe1f0949a"
}
Sample request and response for a SKU-based offer
With autoApply=true
Sample request
{
"amount": 300,
"autoApply": true,
"paymentId": 12332345,
"userToken": "token"
"skusDetail": [
{
"skuAmount": 300,
"quantity": 1,
"skuId": "sampleProductId",
"offerKeys": []
}
]
}
Sample response
{
"code": "200",
"message": "Offer Retrieved Successfully",
"status": 1,
"result": {
"failureReason": null,
"clientId": 42693,
"mid": 180012,
"amount": 300,
"couponsAvailable": true,
"isUserPersonalizedOffersAvailable": false,
"offers": [
{
"failureReason": null,
"stepSize": null,
"externalOfferType": null,
"recordSubType": null,
"valid": true,
"offerKey": "TestOffer@fY6HdoP7da8L",
"type": "MERCHANT",
"title": "TestOffer",
"description": "offer",
"tnc": "tnc",
"tncLink": null,
"minTxnAmount": 101.00,
"maxTxnAmount": 111111.00,
"offerType": "INSTANT",
"minRangeDiscount": null,
"maxRangeDiscount": null,
"validFrom": "2024-10-14 00:00:00",
"validTo": "2024-11-30 23:59:00",
"discountDetail": {
"discountType": "ABSOLUTE",
"discountPercentage": null,
"discount": 100.00,
"discountedAmount": 200.00,
"maxDiscount": 100.00
},
"isNoCostEmi": false,
"isSubvented": false,
"isSkuOffer": false,
"creditCard": null,
"debitCard": null,
"netBanking": null,
"wallet": null,
"clw": null,
"upi": null,
"emi": null,
"bnpl": null,
"skuDetail": null,
"isAcrossSkuQuantity": false,
"offerCategory": null,
"isBaseOffer": false,
"recordType": "OFFER",
"toDisplay": true,
"disallowTransactionInvalidOffer": false,
"isAllPaymentMethodsAvailable": true,
"isCohortOffer": false,
"isGstSubvented": false,
"isExternalOffer": false,
"issuerId": null,
"issuerName": null,
"isNudgeOnlyOffer": false,
"offerMilestone": null,
"userMilestone": null,
"userDetail": null,
"isUserVerificationRequired": false,
"isPersonalisedUniqueCoupon": false
}
],
"skusDetail": {
"skus": [
{
"skuId": "sampleProductId",
"skuCategory": null,
"quantity": 1,
"skuAmount": 300,
"offers": [
{
"failureReason": null,
"stepSize": null,
"externalOfferType": null,
"recordSubType": null,
"valid": true,
"offerKey": "hellosku@rFTxczzbDmj6",
"type": "MERCHANT",
"title": "hello sku",
"description": "qwe4",
"tnc": "123e",
"tncLink": null,
"minTxnAmount": 11.00,
"maxTxnAmount": 1000000.00,
"offerType": "INSTANT",
"minRangeDiscount": null,
"maxRangeDiscount": null,
"validFrom": "2024-10-15 00:00:00",
"validTo": "2024-10-16 23:59:59",
"discountDetail": {
"discountType": "ABSOLUTE",
"discountPercentage": null,
"discount": 10.00,
"discountedAmount": 290.00,
"maxDiscount": 10.00
},
"isNoCostEmi": false,
"isSubvented": false,
"isSkuOffer": true,
"creditCard": null,
"debitCard": null,
"netBanking": null,
"wallet": null,
"clw": null,
"upi": null,
"emi": null,
"bnpl": null,
"skuDetail": {
"skuId": "sampleProductId",
"skuCategory": null,
"skuName": "sampleProductName",
"minQuantity": 1,
"maxQuantity": 5,
"minAmount": 10.00,
"maxAmount": 100000.00,
"quantity": 1,
"skuAmount": 300
},
"isAcrossSkuQuantity": false,
"offerCategory": null,
"isBaseOffer": false,
"recordType": "OFFER",
"toDisplay": true,
"disallowTransactionInvalidOffer": false,
"isAllPaymentMethodsAvailable": true,
"isCohortOffer": false,
"isGstSubvented": false,
"isExternalOffer": false,
"issuerId": null,
"issuerName": null,
"isNudgeOnlyOffer": false,
"offerMilestone": null,
"userMilestone": null,
"userDetail": null,
"isUserVerificationRequired": false,
"isPersonalisedUniqueCoupon": false
}
]
}
]
},
"flagToFail": false,
"isSkuOffer": false,
"paymentId": null
},
"traceId": "1b565184-43dc-4be3-9e61-c6f8b324f476"
}
With autoApply=false
Sample request
{
"amount": 300,
"autoApply": false,
"skusDetail": [
{
"skuAmount": 300,
"quantity": 1,
"skuId": "sampleProductId",
"offerKeys": ["hellosku@rFTxczzbDmj6"]
}
]
}
Sample response
{
"code": "200",
"message": "Offer Retrieved Successfully",
"status": 1,
"result": {
"failureReason": null,
"clientId": 42693,
"mid": 180012,
"amount": 300,
"couponsAvailable": true,
"isUserPersonalizedOffersAvailable": false,
"offers": [
{
"failureReason": null,
"stepSize": null,
"externalOfferType": null,
"recordSubType": null,
"valid": true,
"offerKey": "TestOffer@fY6HdoP7da8L",
"type": "MERCHANT",
"title": "TestOffer",
"description": "offer",
"tnc": "tnc",
"tncLink": null,
"minTxnAmount": 101.00,
"maxTxnAmount": 111111.00,
"offerType": "INSTANT",
"minRangeDiscount": null,
"maxRangeDiscount": null,
"validFrom": "2024-10-14 00:00:00",
"validTo": "2024-11-30 23:59:00",
"discountDetail": {
"discountType": "ABSOLUTE",
"discountPercentage": null,
"discount": 100.00,
"discountedAmount": 200.00,
"maxDiscount": 100.00
},
"isNoCostEmi": false,
"isSubvented": false,
"isSkuOffer": false,
"creditCard": null,
"debitCard": null,
"netBanking": null,
"wallet": null,
"clw": null,
"upi": null,
"emi": null,
"bnpl": null,
"skuDetail": null,
"isAcrossSkuQuantity": false,
"offerCategory": null,
"isBaseOffer": false,
"recordType": "OFFER",
"toDisplay": true,
"disallowTransactionInvalidOffer": false,
"isAllPaymentMethodsAvailable": true,
"isCohortOffer": false,
"isGstSubvented": false,
"isExternalOffer": false,
"issuerId": null,
"issuerName": null,
"isNudgeOnlyOffer": false,
"offerMilestone": null,
"userMilestone": null,
"userDetail": null,
"isUserVerificationRequired": false,
"isPersonalisedUniqueCoupon": false
}
],
"skusDetail": {
"skus": [
{
"skuId": "sampleProductId",
"skuCategory": null,
"quantity": 1,
"skuAmount": 300,
"offers": [
{
"failureReason": null,
"stepSize": null,
"externalOfferType": null,
"recordSubType": null,
"valid": true,
"offerKey": "hellosku@rFTxczzbDmj6",
"type": "MERCHANT",
"title": "hello sku",
"description": "qwe4",
"tnc": "123e",
"tncLink": null,
"minTxnAmount": 11.00,
"maxTxnAmount": 1000000.00,
"offerType": "INSTANT",
"minRangeDiscount": null,
"maxRangeDiscount": null,
"validFrom": "2024-10-15 00:00:00",
"validTo": "2024-10-16 23:59:59",
"discountDetail": {
"discountType": "ABSOLUTE",
"discountPercentage": null,
"discount": 10.00,
"discountedAmount": 290.00,
"maxDiscount": 10.00
},
"isNoCostEmi": false,
"isSubvented": false,
"isSkuOffer": true,
"creditCard": null,
"debitCard": null,
"netBanking": null,
"wallet": null,
"clw": null,
"upi": null,
"emi": null,
"bnpl": null,
"skuDetail": {
"skuId": "sampleProductId",
"skuCategory": null,
"skuName": "sampleProductName",
"minQuantity": 1,
"maxQuantity": 5,
"minAmount": 10.00,
"maxAmount": 100000.00,
"quantity": 1,
"skuAmount": 300
},
"isAcrossSkuQuantity": false,
"offerCategory": null,
"isBaseOffer": false,
"recordType": "OFFER",
"toDisplay": true,
"disallowTransactionInvalidOffer": false,
"isAllPaymentMethodsAvailable": true,
"isCohortOffer": false,
"isGstSubvented": false,
"isExternalOffer": false,
"issuerId": null,
"issuerName": null,
"isNudgeOnlyOffer": false,
"offerMilestone": null,
"userMilestone": null,
"userDetail": null,
"isUserVerificationRequired": false,
"isPersonalisedUniqueCoupon": false
}
]
}
]
},
"flagToFail": false,
"isSkuOffer": false,
"paymentId": null
},
"traceId": "131b13ad-4655-437e-82cd-0db2908c379d"
}
Failure scenarios
- Merchant ID does not exists
Merchant ID does not exists
{
"code": "404",
"message": "Merchant with merchant Id :1800122 does not exists",
"status": 0,
"exceptionId": "9cf201ab-2ad3-439e-a7a6-f707d2f76e48"
}
- The platform for client mismatch or does not exists
{
"code": "404",
"message": "client with clientId :4 , platformId :12 does not exists.",
"status": 0,
"exceptionId": "6985749b-9de4-4d39-9242-d19d35a82d0c"
}
- Service unavailable
{
"code": "500",
"message": "Service Unavailable",
"status": 0,
"exceptionId": "65466805-5be1-4fa4-912d-d28cf620d687"
}
- Invalid request
{
"code": "400",
"message": "Invalid Request",
"status": 0,
"exceptionId": "252e1602-2a9a-449a-8f17-f55fe1f0949a"
}
- Offer key is mandatory when autoApply=false
{
"code": "400",
"message": "Offer key is mandatory when offer is not auto applied",
"status": 0,
"exceptionId": "0e2012e76b4347f48d58808bf3c39122",
"traceId": "4baa1329-b3c5-479c-b98e-b3f2a99f0158"
}
Response Parameters
The response involves the following parameters and the result parameter contains the offer results:
| Parameter | Description | Example |
|---|---|---|
| code | This parameter returns the HTTP status code based on . | 200 |
| message | String This parameter is the result message which contains information about the result | Offer Validated Successfull |
| status | This parameter returns the status of web service call. The status can be any of the following: - 0 - If web service call failed. - 1 - If web service call succeeded | 1 |
| result | JSON Object This parameter gives the information about the result of the API response in a JSON format. For more information, refer to the result Parameter JSON Details subsection. | Refer to the result Field JSON Details subsection. |
result Parameter JSON Details
The result parameter contains the result in a JSON format and the fields in the JSON are described in the following table. The offers field in this JSON contains the offer details as described in the following table:
| Field | Description | Example |
|---|---|---|
| failureReason | String This field contains reason for offer failure. | |
| clientId | Integer This field contains reference of the merchant. | 5861 |
| mid | IntegerThis field contains the unique identifier provided by PayU to each merchant. | 1 |
| amount | Float This field contains the Offer transaction amount | 15000 |
| couponsAvailable | Boolean This field contains the flag to indicate whether the coupons are available. | true |
| isUserPersonalizedOffersAvailable | Boolean This field contains the flag to indicate whether the personalized offers available. | false |
| offers | JSON Object This field contains the list of offer with details in a JSON format. For more information, refer to the offers Field JSON Details subsection. | Refer to the offers Field JSON Details subsection. |
The sample value for the result parameter in a JSON format is similar to the following:
{
"code": "200",
"message": "Offer Retrieved Successfully",
"status": 1,
"result": {
"failureReason": null,
"clientId": 42693,
"mid": 180012,
"amount": 300,
"couponsAvailable": true,
"isUserPersonalizedOffersAvailable": false,
"offers": [
{
"failureReason": null,
"stepSize": null,
"externalOfferType": null,
"recordSubType": null,
"valid": true,
"offerKey": "TestOffer@fY6HdoP7da8L",
"type": "MERCHANT",
"title": "TestOffer",
"description": "offer",
"tnc": "tnc",
"tncLink": null,
"minTxnAmount": 101.00,
"maxTxnAmount": 111111.00,
"offerType": "INSTANT",
"minRangeDiscount": null,
"maxRangeDiscount": null,
"validFrom": "2024-10-14 00:00:00",
"validTo": "2024-11-30 23:59:00",
"discountDetail": {
"discountType": "ABSOLUTE",
"discountPercentage": null,
"discount": 100.00,
"discountedAmount": 200.00,
"maxDiscount": 100.00
},
"isNoCostEmi": false,
"isSubvented": false,
"isSkuOffer": false,
"creditCard": null,
"debitCard": null,
"netBanking": null,
"wallet": null,
"clw": null,
"upi": null,
"emi": null,
"bnpl": null,
"skuDetail": null,
"isAcrossSkuQuantity": false,
"offerCategory": null,
"isBaseOffer": false,
"recordType": "OFFER",
"toDisplay": true,
"disallowTransactionInvalidOffer": false,
"isAllPaymentMethodsAvailable": true,
"isCohortOffer": false,
"isGstSubvented": false,
"isExternalOffer": false,
"issuerId": null,
"issuerName": null,
"isNudgeOnlyOffer": false,
"offerMilestone": null,
"userMilestone": null,
"userDetail": null,
"isUserVerificationRequired": false,
"isPersonalisedUniqueCoupon": false
}
],
"skusDetail": {
"skus": [
{
"skuId": "sampleProductId",
"skuCategory": null,
"quantity": 1,
"skuAmount": 300,
"offers": [
{
"failureReason": null,
"stepSize": null,
"externalOfferType": null,
"recordSubType": null,
"valid": true,
"offerKey": "hellosku@rFTxczzbDmj6",
"type": "MERCHANT",
"title": "hello sku",
"description": "qwe4",
"tnc": "123e",
"tncLink": null,
"minTxnAmount": 11.00,
"maxTxnAmount": 1000000.00,
"offerType": "INSTANT",
"minRangeDiscount": null,
"maxRangeDiscount": null,
"validFrom": "2024-10-15 00:00:00",
"validTo": "2024-10-16 23:59:59",
"discountDetail": {
"discountType": "ABSOLUTE",
"discountPercentage": null,
"discount": 10.00,
"discountedAmount": 290.00,
"maxDiscount": 10.00
},
"isNoCostEmi": false,
"isSubvented": false,
"isSkuOffer": true,
"creditCard": null,
"debitCard": null,
"netBanking": null,
"wallet": null,
"clw": null,
"upi": null,
"emi": null,
"bnpl": null,
"skuDetail": {
"skuId": "sampleProductId",
"skuCategory": null,
"skuName": "sampleProductName",
"minQuantity": 1,
"maxQuantity": 5,
"minAmount": 10.00,
"maxAmount": 100000.00,
"quantity": 1,
"skuAmount": 300
},
"isAcrossSkuQuantity": false,
"offerCategory": null,
"isBaseOffer": false,
"recordType": "OFFER",
"toDisplay": true,
"disallowTransactionInvalidOffer": false,
"isAllPaymentMethodsAvailable": true,
"isCohortOffer": false,
"isGstSubvented": false,
"isExternalOffer": false,
"issuerId": null,
"issuerName": null,
"isNudgeOnlyOffer": false,
"offerMilestone": null,
"userMilestone": null,
"userDetail": null,
"isUserVerificationRequired": false,
"isPersonalisedUniqueCoupon": false
}
]
}
]
},
"flagToFail": false,
"isSkuOffer": false,
"paymentId": null
},
"traceId": "131b13ad-4655-437e-82cd-0db2908c379d"
}
offers Field JSON Details
The offers field in the result JSON contains the offer details and details for each payment mode in a JSON format as described in the following table:
| Field | Description | Example |
|---|---|---|
| failureReason | String This field contains reason for offer failure. | |
| stepSize | String This field contains step size. | |
| externalOfferType | String This field contains the external offer type. | |
| recordSubType | String This field contains the record sub-type. | |
| valid | String This field contains flag whether the is valid. | |
| offerKey | String This field contains the unique identifier for a particular offer. | SummerSpecialOffer2021@q1Bh0jsogwqP |
| type | String This field contains the offer owner. | MERCHANT |
| title | String This field contains the title of the offer that will be displayed for customers. | festive_500 |
| description | String This field contains the description of offer for the merchant's reference. | festive discount |
| tnc | String This field contains the Terms & Conditions for applying promo that will be displayed to customers while accessing the link provided in the tncLink field. | abc |
| tncLink | String This field contains URL to fetch details on Terms & Conditions and details specified in the tnc is displayed. | abcd |
| minTxnAmount | Float The field contains the minimum transaction amount offer will be applicable. | 10.00 |
| maxTxnAmount | Float The field contains the maximum transaction amount offer will be applicable | 25000.00 |
| offerType | String The field contains any of the following type of offer:- INSTANT - CASHBACK | INSTANT |
| validFrom | String The field contains the offer start time. | 2021-07-01 17:02:11 |
| validTo | String The field contains the offer end time. | 2022-08-05 15:53:16 |
| discountDetail | JSON Object This field contains the discount detail of the offer in a JSON format. This field contain the following fields in a JSON format:- discountType: This field contains any of the following discount type that was defined: - ABSOLUTE - PERCENTAGE - discountPercentage: This field contains the define the discount percentage. - discount: This field contains the total discount available on the transaction once applied the specific offer. - discountedAmount: This field contains the final Net amount of the transaction after applying the specific offer. - maxDiscount: The field contains the max discount available on an offer. | |
| isNoCostEmi | BooleanThis field contains any of the following values to specify whether th_e offer is no cost EMI offer or normal offer. | true |
| creditCard | JSON Object The field contains the offer configuration details for credit card with the fields in a JSON format:- networks: The list of card networks for which the offer is supported similar to the example. - banks: The list of banks with codes supported are listed similar to the example. - title: This parameter contains the payment title that is used to identify the particular payment option. - paymentCode: the payment code that is used to identify the particular payment option. - discountDetail: The discount detail an array format as in the example. | networks: { "code": "MAST", "title": "Master Network" }, { "code": "VISA", "title": "VIsa Network" } banks: { "code": "ICICI", "title": "ICICI credit card" }, { "code": "HDFC", "title": "HDFC credit card" } |
| debitCard | JSON ObjectThe field contains the offer configuration details for debit card in a JSON format with the following fields:- networks: The list of card networks for which the offer is supported similar to the example. - banks: The list of banks with codes supported are listed similar to the example. - title: This parameter contains the payment title that is used to identify the particular payment option. - paymentCode: the payment code that is used to identify the particular payment option. | networks: { "code": "MAST", "title": "Master Network" }, { "code": "VISA", "title": "Visa Network" } banks: { "code": "ICICI", "title": "ICICI debit card" }, { "code": "HDFC", "title": "HDFC debit card" } |
| netBanking | JSON Object The field contains the offer configuration details for NetBanking in JSON format similar to the example. | { "title": "axis bank", "paymentCode": "AXIB1" }, { "title": "Bank of India", "paymentCode": "BOIB" }, { "title": "Canara Bank", "paymentCode": "CABB" } } |
| wallet | JSON ObjectThe field contains the offer configuration details for Wallet in a JSON format similar to the example. | { "title": "freecharge", "paymentCode": "FREC" } |
| upi | JSON ObjectThe field contains the offer configuration details for UPI in JSON format similar to the example. | { "title": "upi", "paymentCode": "UPI" } |
| emi | JSON Object The field contains the offer configuration details for EMI in a JSON format with the following fields:- debitCard: Contains the list of banks and tenure option similar to the example. - creditCard: Contains the list of banks and tenure option similar to the example. | DebitCard: { "banks": [ { "bankCode": "CITI", "tenureOption": [ { "title": "CITI Bank 3EMI", "paymentCode": "EMI03", "discountDetail": null }, { "title": "CITI Bank 6 EMI", "paymentCode": "EMI06", "discountDetail": null } ] }, { "bankCode": "AXIS", "tenureOption": [ { "title": "AXIS Bank 3 EMI", "paymentCode": "EMI3", "discountDetail": null } ] } ] } creditCard: { "banks": [ { "bankCode": "CITI", "tenureOption": [ { "title": "CITI Bank 9 EMI", "paymentCode": "EMI09", "discountDetail": null } ] }, { "bankCode": "AXIS", "tenureOption": [ { "title": "AXIS Bank 12 EMI", "paymentCode": "EMI12", "discountDetail": null } ] } ] } } |
The sample value for offers field in a JSON is similar to the following:
"offers": [
{
"offerKey": "SummerSpecialOffer2021@q1Bh0jsogwqP",
"type": "MERCHANT",
"title": "festive_500",
"description": "festive discount",
"tnc": "abc",
"tncLink": "abcd",
"minTxnAmount": 10.00,
"maxTxnAmount": 25000.00,
"offerType": "INSTANT",
"validFrom": "2021-07-01 17:02:11",
"validTo": "2022-08-05 15:53:16",
"discountDetail": {
"discountType": "PERCENTAGE",
"discountPercentage": 10.00,
"discount": 100.00,
"discountedAmount": 14900,
"maxDiscount": 100.00
},
"isNoCostEmi": false,
"creditCard": [
{
"networks": [
{
"code": "MAST",
"title": "Master Network"
},
{
"code": "VISA",
"title": "VIsa Network"
}
],
"banks": [
{
"code": "ICICI",
"title": "ICICI debit card"
},
{
"code": "HDFC",
"title": "HDFC debit card"
}
],
"title": null,
"paymentCode": null
}
],
"debitCard": [
{
"networks": [
{
"code": "MAST",
"title": "Master Network"
}
],
"banks": [
{
"code": "HDFC",
"title": "HDFC debit card"
}
],
"title": null,
"paymentCode": null
}
],
"netBanking": [
{
"title": "axis bank",
"paymentCode": "AXIB1"
},
{
"title": "Bank of India",
"paymentCode": "BOIB"
},
{
"title": "Canara Bank",
"paymentCode": "CABB"
}
],
"wallet": [
{
"title": "freecharge",
"paymentCode": "FREC"
}
],
"upi": [
{
"title": "upi",
"paymentCode": "UPI"
}
],
"emi": {
"debitCard": {
"banks": [
{
"bankCode": "CITI",
"tenureOption": [
{
"title": "CITI Bank 3EMI",
"paymentCode": "EMI03",
"discountDetail": null
},
{
"title": "CITI Bank 6 EMI",
"paymentCode": "EMI06",
"discountDetail": null
}
]
},
{
"bankCode": "AXIS",
"tenureOption": [
{
"title": "AXIS Bank 3 EMI",
"paymentCode": "EMI3",
"discountDetail": null
}
]
}
]
},
"creditCard": {
"banks": [
{
"bankCode": "CITI",
"tenureOption": [
{
"title": "CITI Bank 9 EMI",
"paymentCode": "EMI09",
"discountDetail": null
}
]
},
{
"bankCode": "AXIS",
"tenureOption": [
{
"title": "AXIS Bank 12 EMI",
"paymentCode": "EMI12",
"discountDetail": null
}
]
}
]
}
}
},
{
"offerKey": "SummerSpecialOffer2021@oi7gMfLOobVZ",
"type": "MERCHANT",
"title": "Summer Special Offer 2021",
"description": "20% Instant discount",
"tnc": "Discount will be applied instantly after applying coupon code",
"tncLink": "www.icicibank/offer/t&c",
"minTxnAmount": 500.00,
"maxTxnAmount": 100000.00,
"offerType": "CASHBACK",
"validFrom": "2020-12-31 15:53:16",
"validTo": "2022-02-28 15:53:16",
"discountDetail": null,
"isNoCostEmi": true,
"creditCard": null,
"debitCard": null,
"netBanking": null,
"wallet": null,
"upi": null,
"emi": {
"debitCard": {
"banks": [
{
"bankCode": "CITI",
"tenureOption": [
{
"title": "CITI Bank 6 EMI",
"paymentCode": "EMI06",
"discountDetail": {
"discountPercentage": 16.0,
"discount": 835.12,
"discountedAmount": 15000
}
},
{
"title": "CITI Bank 3EMI",
"paymentCode": "EMI03",
"discountDetail": {
"discountPercentage": 15.0,
"discount": 444.33,
"discountedAmount": 15000
}
}
]
}
]
},
"creditCard": {
"banks": [
{
"bankCode": "AXIS",
"tenureOption": [
{
"title": "AXIS Bank 12 EMI",
"paymentCode": "EMI12",
"discountDetail": {
"discountPercentage": 14.5,
"discount": 1420.79,
"discountedAmount": 15000
}
}
]
}
]
}
}
}
]