List Offer
List Offer called for listing the ACTIVE offers at a particular point in time based on the configurations in the offers operations dashboard.
List Offers call filters through the complete set of Merchant offers configured in the dashboard and provides key details per offer such as:
Offer description and terms
Offer eligibility for the current transaction
Offer benefits with calculation rules (Discount / Cashback / EMI Discount Value)
Order amount pre/post discount
Eligible payment instruments/methods for an offer
Eligible Products along with offer breakup for each of the product
Optimistic Behaviour : List Offers API has an Optimistic behaviour wherein if any param is not passed in the request, Offer engine will assume that this param will be received in the later part of the journey and hence response will be given without evaluating this param at that point.
This is due to the fact that ListOffers can be called at any point in the consumer Journey like Home page, Product details page, Cart, Payment page etc. where certain information might not be available.
Order level details
Unique ID generated by JusPay for the given order
Order Amount
Currency passed during order creation
Payment channel used for making transaction. Possible values ANDROID, IOS, WEB and MWEB
The user defined fields passed during order creation
The user defined fields passed during order creation
The user defined fields passed during order creation
The user defined fields passed during order creation
The user defined fields passed during order creation
The user defined fields passed during order creation
The user defined fields passed during order creation
The user defined fields passed during order creation
The user defined fields passed during order creation
The user defined fields passed during order creation
List of Products/SKU details for Offer application
Unique ID for the product where offer eligibility/applicability checks needs to be performed
Number of items against a particular product
Price of the individual product
Amount of the split transaction. Should be passed only for split transaction flows
Contains Price breakup of the cart amount. Can be used when Offer shouldn’t be applied on components like tax, delivery fees etc.
Note :
Sum of the amounts in amount_info should be equal to the order amount
Base price value of the cart
Any additional components of the cart. Eg : tax, delivery fees etc
Name of the additional component
Supported Values : DELIVERYCHARGE, DELIVERYTIP, DONATION, SURCHARGE, TAX, OTHERCHARGES, PACKINGCHARGE
Amount of the corresponding additional component
Array of Payment Method Information
Unique identifier that can be sent by the merchant for the respective Payment Instruments
Payment Method Type of the transaction. Possible values are "CARD" | "NB" | "UPI" | "WALLET" | "REWARD"
Payment Method of the transaction
Valid Card Number
A valid card token obtained using /card/list API
Unique identifier received from Payv3 (Only for Payv3 integrations).
Card type of the valid card.(Only for Payv3 integrations).
Bank Code
Card bin of the valid card
Card subtype of the valid card
Valid VPA of the customer
UPI App package name
UPI transaction type. Possible values are UPI_PAY, UPI_COLLECT
To Fetch EMI Offer for that praticular intsrument
Example:- True/False
Customer id passed during order creation
Email Id of the customer passed during order creation
Phone number of the customer passed during order creation
Coupon code configured on Juspay Dashboard
Contains details of the best offers against an order, mapped to eligible payment types sent in the request
Unique payment method reference ID sent in request body
Offer details for the best offer available against the above payment_method_reference
Unique offer ID of the eligible offer
Cashback amount benefit associated with the offer
Discount amount benefit associated with the offer
Offer amount that needs to be validated for a given order. Merchant discount benefit is used to validate offer and order amount in the backend and payment locking in the payment page
Total offer benefit amount associated with the offer ID
Order details breakup
Order amount before offer is applied (for merchant discount benefit, this is the amount post application of offer)
Order amount applicable for calculation of offer
Final order amount after offer has been applied
Discount amount applied on order
Offer discount amount that should be validated in the back end
Cashback amount applied on order
Total offer amount applicable on the order
Breakdown of benefits on the order
Benefits type, can be either CASHBACK | DISCOUNT | MERCHANT_DISCOUNT | EMI_DISCOUNT | EMI_CASHBACK
Calculation rule for offer, can be either PERCENTAGE | ABSOLUTE
List of strings that shows order amount elements on which offer has been applied
Breakdown of active offers based on offers configured on the dashboard by merchant
Unique ID associated with active offers
Status of the offer, can be either ACTIVE or INACTIVE
Offer code configured by merchant on the offers dashboard
Offer description details including title, description, tnc etc
UI configuration details of an offer
Product application mode of an order, can be either PRODUCT | LINE_ITEM | ORDER
Order rules breakdown with amount and payment instrument detail
Offer benefit amount associated with an offer ID
Order basket with product level details uploaded along with WHITELIST/BLACKLIST specification for those offers
Platforms on which offers are applicable
WHITELIST/BLACKLIST of customer IDs that were uploaded during offer configuration
Eligible payment instruments for an offer
WHITELIST/BLACKLIST of gateways that were uploaded during offer configuration
WHITELIST/BLACKLIST of filters that were uploaded during offer configuration
Specifying the transaction type for an offer - can be ORDER (full swipe transactions) or EMI (EMI transactions)
Order level breakdown with details
Eligible payment methods (for ELIGIBLE offers) based on the payment_method_reference sent as request