--- page_title: List Offer product: OFFER ENGINE page_source: https://juspay.io/in/docs/offer-engine/docs/api-integration/list-offer openapi: https://juspay.io/in/docs/api/swagger?document=https%3A%2F%2Fjuspay.io%2Fin%2Fdocs%2Foffer-engine%2Fdocs%2Fapi-integration%2Flist-offer llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/offer-engine/llms.txt --- ## API Version: default # Offer List API for listing the ACTIVE offers at a particular point in time based on the configurations in the offers operations dashboard. List Offers API filters through the complete set of Merchant offers configured in the DB and provides key details per offer such as: 1. Offer description and terms 2. Offer eligibility for the current transaction 3. Offer benefits with calculation rules (Discount / Cashback / EMI Discount Value) 4. Order amount pre/post discount 5. Eligible payment instruments/methods for an offer 6. Eligible Products along with offer breakup for each of the product > **Note** > **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. ## Endpoints: - Sandbox: https://sandbox.juspay.in/v1/offers/list - Production: https://api.juspay.in/v1/offers/list ## Request Type: POST ## Authorization: #### Basic Auth: Consists of two parts. * Username: API Key obtained from Juspay dashboard * Password: Empty string Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg== - Tags: Base64 Encoded Username:Password, Mandatory ## Headers: #### x-merchantid: The merchant id that a merchant hold at Juspay. - Tags: string, Required #### Content-Type: application/json - Tags: String #### x-routing-id: We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID. > **Warning** > This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer. - Value: customer_1122 - Tags: String, Required ## Sample Code Snippets: ### Sample Request: #### Request - With Coupon Code Code Snippet: ```request - with coupon code curl --location --request POST 'https://smartgateway.hdfc.bank.in/v1/offers/list' \ --header 'Authorization: ' \ --header 'Content-Type: application/json' \ --header 'x-routing-id: customer_1122'\ --data-raw '{ "order": { "order_id": "SDEA5645", "amount": "12000", "currency": "INR" }, "payment_method_info": [ { "payment_method_type": "CARD", "payment_method_reference": "card_number_identifier", "card_number": "4111111111111111", "bank_code": "SBI", "card_type": "CREDIT" }, { "payment_method_type": "CARD", "payment_method_reference": "card_tkn_identifier", "card_token": "tkn_89876654365" }, { "payment_method_type": "WALLET", "payment_method_reference": "MOBIKWIK", "payment_method": "MOBIKWIK" }, { "upi_vpa": "testcustomer@oksbi", "payment_method_type": "UPI", "payment_method_reference": "navyamotaiah@oksbi", "payment_method": "UPI", "txn_type": "UPI_COLLECT" }, { "upi_app": "com.google.android.apps.nbu.paisa.user", "payment_method_type": "UPI", "payment_method_reference": "com.google.android.apps.nbu.paisa.user", "payment_method": "UPI", "txn_type": "UPI_PAY" }, { "payment_method_type": "CONSUMER_FINANCE", "payment_method_reference": "ZESTMONEY", "payment_method": "ZESTMONEY" }, { "payment_method_type": "NB", "payment_method_reference": "AXIS_BANK_NB", "payment_method": "NB_AXIS" }, { "payment_method_type": "CARD", "payment_method_reference": "AMEX_EMI_6", "is_emi": "true", "emi_bank": "AMEX", "emi_tenure":"6" } ], "customer": { "id": "customer123", "email": "customer5453@gmail.com", "mobile": "9999999999" }, "offer_code": "Coupon_Offer" }' ``` #### Request - Without Coupon Code Code Snippet: ```request - without coupon code curl --location --request POST 'https://smartgateway.hdfc.bank.in/v1/offers/list' \ --header 'Authorization: ' \ --header 'x-routing-id: customer_1122'\ --header 'Content-Type: application/json' \ --data-raw '{ "order": { "order_id": "SDEA5645", "amount": "12000", "currency": "INR" }, "payment_method_info": [ { "payment_method_type": "CARD", "payment_method_reference": "card_number_identifier", "card_number": "4111111111111111", "bank_code": "SBI", "card_type": "CREDIT" }, { "payment_method_type": "WALLET", "payment_method_reference": "MOBIKWIK", "payment_method": "MOBIKWIK" }, { "upi_vpa": "testcustomer@oksbi", "payment_method_type": "UPI", "payment_method_reference": "navyamotaiah@oksbi", "payment_method": "UPI", "txn_type": "UPI_COLLECT" }, { "upi_app": "com.google.android.apps.nbu.paisa.user", "payment_method_type": "UPI", "payment_method_reference": "com.google.android.apps.nbu.paisa.user", "payment_method": "UPI", "txn_type": "UPI_PAY" }, { "payment_method_type": "CONSUMER_FINANCE", "payment_method_reference": "ZESTMONEY", "payment_method": "ZESTMONEY" }, { "payment_method_type": "NB", "payment_method_reference": "AXIS_BANK_NB", "payment_method": "NB_AXIS" } ], "customer": { "id": "customer123", "email": "customer5453@gmail.com", "mobile": "9999999999" } }' ``` #### Request - With Order Basket Code Snippet: ```request - with order basket curl --location --request POST 'https://smartgateway.hdfcuat.bank.in/v1/offers/list' \ --header 'Authorization: ' \ --header 'x-routing-id: customer_1122'\ --header 'Content-Type: application/json' \ --data-raw '{ "order": { "order_id": "1698406992", "amount": "12000", "currency": "INR", "basket": "[{\"id\":\"id1\",\"unitPrice\":10000,\"quantity\":1},{\"id\":\"id2\",\"unitPrice\":2000,\"quantity\":1}]" }, "payment_method_info": [ { "payment_method_type": "CARD", "payment_method_reference": "card_number_identifier", "card_number": "4111111111111111", "bank_code": "SBI", "card_type": "CREDIT" }, { "payment_method_type": "CARD", "payment_method_reference": "card_tkn_identifier", "card_token": "tkn_89876654365" }, { "payment_method_type": "WALLET", "payment_method_reference": "MOBIKWIK", "payment_method": "MOBIKWIK" }, { "upi_vpa": "testcustomer@oksbi", "payment_method_type": "UPI", "payment_method_reference": "navyamotaiah@oksbi", "payment_method": "UPI", "txn_type": "UPI_COLLECT" }, { "upi_app": "com.google.android.apps.nbu.paisa.user", "payment_method_type": "UPI", "payment_method_reference": "com.google.android.apps.nbu.paisa.user", "payment_method": "UPI", "txn_type": "UPI_PAY" }, { "payment_method_type": "CONSUMER_FINANCE", "payment_method_reference": "ZESTMONEY", "payment_method": "ZESTMONEY" }, { "payment_method_type": "NB", "payment_method_reference": "AXIS_BANK_NB", "payment_method": "NB_AXIS" }, { "payment_method_type": "CARD", "payment_method_reference": "AMEX_EMI_6", "is_emi": "true", "emi_bank": "AMEX", "emi_tenure":"6" } ] }' ``` #### Request - With Amount Breakup Code Snippet: ```request - with amount breakup curl --location --request POST 'https://smartgateway.hdfcuat.bank.in/v1/offers/list' \ --header 'Authorization: ' \ --header 'x-routing-id: customer_1122'\ --header 'Content-Type: application/json' \ --data-raw '{ "order": { "order_id": "1698406955", "amount": "12000", "currency": "INR", "amount_info": "{\"base_amount\":\"11000\",\"add_on_amounts\":[{\"name\":\"deliverytip\",\"amount\":\"100\"},{\"name\":\"deliverycharge\",\"amount\":\"400\"},{\"name\":\"donation\",\"amount\":\"100\"},{\"name\":\"surgecharge\",\"amount\":\"100\"},{\"name\":\"packingcharge\",\"amount\":\"100\"},{\"name\":\"tax\",\"amount\":\"100\"},{\"name\":\"othercharges\",\"amount\":\"100\"}]}" }, "payment_method_info": [ { "payment_method_type": "CARD", "payment_method_reference": "AMEX_EMI_6", "is_emi": "true", "emi_bank": "AMEX", "emi_tenure":"6" }, { "payment_method_type": "WALLET", "payment_method_reference": "MOBIKWIK", "payment_method": "MOBIKWIK" }, { "upi_vpa": "testcustomer@oksbi", "payment_method_type": "UPI", "payment_method_reference": "navyamotaiah@oksbi", "payment_method": "UPI", "txn_type": "UPI_COLLECT" }, { "upi_app": "com.google.android.apps.nbu.paisa.user", "payment_method_type": "UPI", "payment_method_reference": "com.google.android.apps.nbu.paisa.user", "payment_method": "UPI", "txn_type": "UPI_PAY" }, { "payment_method_type": "CONSUMER_FINANCE", "payment_method_reference": "ZESTMONEY", "payment_method": "ZESTMONEY" }, { "payment_method_type": "NB", "payment_method_reference": "AXIS_BANK_NB", "payment_method": "NB_AXIS" } ] }' ``` ### Sample Response: #### With Coupon Code: ```json { "offers": [ { "offer_rules": { "amount": { "currency": "INR", "amount_info": [], "min_order_amount": "1.00" }, "payment_instrument": [ { "variant": [], "payment_method": [], "payment_method_type": "CARD", "app": [], "type": [], "issuer": [] } ], "gateways": [], "filters": { "whitelist": [], "blacklist": [] }, "txn_type": [ "ORDER" ] }, "order_breakup": { "final_order_amount": "11900.00", "offer_amount": "100.00", "order_amount": "12000.00", "applicable_order_amount": "12000.00", "discount_amount": "100.00", "merchant_discount_amount": "0.00", "cashback_amount": "0.00", "benefits": [ { "amount_info": [], "type": "DISCOUNT", "calculation_rule": "ABSOLUTE", "value": 100 } ] }, "offer_id": "2f23b007-4fdd-4526-b037-e3c95e571464", "status": "ELIGIBLE", "reason": [], "offer_code": "Coupon_Offer", "offer_description": { "sponsored_by": "com.abipbl.upi", "title": "Coupon Offer Demo", "description": "", "tnc": "" }, "ui_configs": { "offer_display_priority": 0, "auto_apply": "false", "should_validate": "true", "is_hidden": "false" }, "application_mode": "ORDER", "eligible_saved_payment_methods": [ "card_number_identifier", "card_tkn_identifier" ], "actions": [] } ], "best_offer_combinations": [] } ``` #### Without Coupon Code: ```json { "best_offer_combinations": [ { "payment_method_reference": "card_number_identifier", "offers": [ { "offer_id": "e975d78c-5139-45b5-b30c-dc4afb05cca9", "cashback_amount": "0.00", "discount_amount": "100.00", "merchant_discount_amount": "0.00", "total_offered_amount": "100.00" } ], "order_breakup": { "order_amount": "12000.00", "applicable_order_amount": "12000.00", "final_order_amount": "11900.00", "discount_amount": "100.00", "merchant_discount_amount": "0.00", "cashback_amount": "0.00", "offer_amount": "100.00", "benefits": [ { "amount_info": [], "type": "DISCOUNT", "calculation_rule": "ABSOLUTE", "value": 100 } ] } }, { "payment_method_reference": "MOBIKWIK", "offers": [ { "offer_id": "e975d78c-5139-45b5-b30c-dc4afb05cca9", "cashback_amount": "0.00", "discount_amount": "100.00", "merchant_discount_amount": "0.00", "total_offered_amount": "100.00" } ], "order_breakup": { "order_amount": "12000.00", "applicable_order_amount": "12000.00", "final_order_amount": "11900.00", "discount_amount": "100.00", "merchant_discount_amount": "0.00", "cashback_amount": "0.00", "offer_amount": "100.00", "benefits": [ { "amount_info": [], "type": "DISCOUNT", "calculation_rule": "ABSOLUTE", "value": 100 } ] } }, { "payment_method_reference": "navyamotaiah@oksbi", "offers": [ { "offer_id": "e975d78c-5139-45b5-b30c-dc4afb05cca9", "cashback_amount": "0.00", "discount_amount": "100.00", "merchant_discount_amount": "0.00", "total_offered_amount": "100.00" } ], "order_breakup": { "order_amount": "12000.00", "applicable_order_amount": "12000.00", "final_order_amount": "11900.00", "discount_amount": "100.00", "merchant_discount_amount": "0.00", "cashback_amount": "0.00", "offer_amount": "100.00", "benefits": [ { "amount_info": [], "type": "DISCOUNT", "calculation_rule": "ABSOLUTE", "value": 100 } ] } }, { "payment_method_reference": "com.google.android.apps.nbu.paisa.user", "offers": [ { "offer_id": "e975d78c-5139-45b5-b30c-dc4afb05cca9", "cashback_amount": "0.00", "discount_amount": "100.00", "merchant_discount_amount": "0.00", "total_offered_amount": "100.00" } ], "order_breakup": { "order_amount": "12000.00", "applicable_order_amount": "12000.00", "final_order_amount": "11900.00", "discount_amount": "100.00", "merchant_discount_amount": "0.00", "cashback_amount": "0.00", "offer_amount": "100.00", "benefits": [ { "amount_info": [], "type": "DISCOUNT", "calculation_rule": "ABSOLUTE", "value": 100 } ] } }, { "payment_method_reference": "ZESTMONEY", "offers": [ { "offer_id": "e975d78c-5139-45b5-b30c-dc4afb05cca9", "cashback_amount": "0.00", "discount_amount": "100.00", "merchant_discount_amount": "0.00", "total_offered_amount": "100.00" } ], "order_breakup": { "order_amount": "12000.00", "applicable_order_amount": "12000.00", "final_order_amount": "11900.00", "discount_amount": "100.00", "merchant_discount_amount": "0.00", "cashback_amount": "0.00", "offer_amount": "100.00", "benefits": [ { "amount_info": [], "type": "DISCOUNT", "calculation_rule": "ABSOLUTE", "value": 100 } ] } }, { "payment_method_reference": "AXIS_BANK_NB", "offers": [ { "offer_id": "e975d78c-5139-45b5-b30c-dc4afb05cca9", "cashback_amount": "0.00", "discount_amount": "100.00", "merchant_discount_amount": "0.00", "total_offered_amount": "100.00" } ], "order_breakup": { "order_amount": "12000.00", "applicable_order_amount": "12000.00", "final_order_amount": "11900.00", "discount_amount": "100.00", "merchant_discount_amount": "0.00", "cashback_amount": "0.00", "offer_amount": "100.00", "benefits": [ { "amount_info": [], "type": "DISCOUNT", "calculation_rule": "ABSOLUTE", "value": 100 } ] } } ] } ``` #### With Order Basket: ```json { "offers": [ { "offer_rules": { "amount": { "currency": "INR", "amount_info": [], "min_order_amount": "1.00" }, "order_basket": [ { "mode": "WHITELIST", "active": true, "rule_type": "ELIGIBILITY" }, { "mode": "WHITELIST", "rule_type": "APPLICABILITY" } ], "payment_instrument": [], "gateways": [], "filters": { "whitelist": [], "blacklist": [] }, "txn_type": [ "ORDER" ] }, "order_breakup": { "final_order_amount": "11800.00", "offer_amount": "200.00", "product_discounts": [ { "product_id": "id1", "product_quantity": 1, "product_applicable_quantity": 1, "unit_price": "10000.00", "discount_amount": "100.00", "cashback_amount": "0.00", "merchant_discount_amount": "0.00" }, { "product_id": "id2", "product_quantity": 1, "product_applicable_quantity": 1, "unit_price": "2000.00", "discount_amount": "100.00", "cashback_amount": "0.00", "merchant_discount_amount": "0.00" } ], "order_amount": "12000.00", "applicable_order_amount": "12000.00", "discount_amount": "200.00", "merchant_discount_amount": "0.00", "cashback_amount": "0.00", "benefits": [ { "amount_info": [], "type": "DISCOUNT", "calculation_rule": "ABSOLUTE", "value": 100 } ] }, "offer_id": "004c1ff3-339c-44d1-868f-43a58bd205af", "status": "ELIGIBLE", "reason": [], "offer_code": "Product_Offer", "offer_description": { "sponsored_by": "com.msf.angelmobile", "title": "Product Offer Demo", "description": "", "tnc": "" }, "ui_configs": { "offer_display_priority": 0, "auto_apply": "false", "should_validate": "true", "is_hidden": "false" }, "application_mode": "PRODUCT", "eligible_saved_payment_methods": [ "card_number_identifier", "card_tkn_identifier", "MOBIKWIK", "navyamotaiah@oksbi", "com.google.android.apps.nbu.paisa.user", "ZESTMONEY", "AXIS_BANK_NB" ], "actions": [] } ] } ``` #### With Amount Breakup: ```json { "offers": [ { "offer_rules": { "amount": { "currency": "INR", "amount_info": [ "base_amount", "deliverycharge" ], "min_order_amount": "50.00" }, "additional_payment_filters": { "emi_eligibility": [ { "bank_plan": [ { "tenure": [ 6 ], "bank": "AMEX" } ], "type": "STANDARD" } ] }, "payment_instrument": [ { "variant": [], "payment_method": [], "payment_method_type": "CARD", "app": [], "type": [ "CREDIT" ], "issuer": [ "JP_AMEX" ] } ], "gateways": [], "filters": { "whitelist": [], "blacklist": [] }, "txn_type": [ "EMI" ] }, "order_breakup": { "emi_discounts": [ { "bank": "AMEX", "emi_type": "STANDARD", "tenure": 6, "interest_rate": 15, "emi_discount_amount": "469.88", "emi_cashback_amount": "0.00", "offer_amount": "669.88", "final_order_amount": "11330.12" } ], "order_amount": "12000.00", "applicable_order_amount": "11300.00", "discount_amount": "200.00", "merchant_discount_amount": "0.00", "cashback_amount": "0.00", "benefits": [ { "amount_info": [ "base_amount", "deliverytip", "donation", "packingcharge" ], "type": "DISCOUNT", "calculation_rule": "ABSOLUTE", "value": 200 }, { "amount_info": [ "base_amount", "deliverytip", "donation", "packingcharge" ], "emi_type": "NO_COST", "type": "EMI_DISCOUNT", "calculation_rule": "PERCENTAGE", "value": 100 } ] }, "offer_id": "c6843bf7-762a-4e20-895d-0ef57e476ed3", "status": "ELIGIBLE", "reason": [], "offer_code": "Amount_Info_Offers", "offer_description": { "sponsored_by": "com.abipbl.upi", "title": "Amount Info Offers", "description": "", "tnc": "" }, "ui_configs": { "offer_display_priority": 0, "auto_apply": "false", "should_validate": "true", "is_hidden": "false" }, "application_mode": "ORDER", "eligible_saved_payment_methods": [ "AMEX_EMI_6" ], "actions": [] } ]} ``` ## Query Parameters: #### ?emi=true: Used when there are offers configured for EMI Option. **For displaying EMI based offers, ?emi=true should be sent in API request.** If not sent, then EMI based offers will not be returned in the response even if EMI offers were configured on the dashboard - Tags: string ## Body Parameters: ### Parameters: #### order: - Description: Order level details - Value: - **Order_id**: - Description: Unique ID generated by JusPay for the given order - Tags: string - **Amount**: - Description: Order Amount - Tags: string, Required - **Currency**: - Description: Currency passed during order creation - Tags: string, Required - **Payment_channel**: - Description: Payment channel used for making transaction. Possible values ANDROID, IOS, WEB and MWEB - Tags: string - **Udf1**: - Description: The user defined fields passed during order creation - Tags: string - **Udf2**: - Description: The user defined fields passed during order creation - Tags: string - **Udf3**: - Description: The user defined fields passed during order creation - Tags: string - **Udf4**: - Description: The user defined fields passed during order creation - Tags: string - **Udf5**: - Description: The user defined fields passed during order creation - Tags: string - **Udf6**: - Description: The user defined fields passed during order creation - Tags: string - **Udf7**: - Description: The user defined fields passed during order creation - Tags: string - **Udf8**: - Description: The user defined fields passed during order creation - Tags: string - **Udf9**: - Description: The user defined fields passed during order creation - Tags: string - **Udf10**: - Description: The user defined fields passed during order creation - Tags: string - **Basket**: - Description: List of Products/SKU details for Offer application - Value: - **Id**: - Description: Unique ID for the product where offer eligibility/applicability checks needs to be performed - Tags: String, Mandatory - **Quantity**: - Description: Number of items against a particular product - Tags: integer, Mandatory - **UnitPrice**: - Description: Price of the individual product - Tags: Double, Mandatory - Tags: Stringified Array of Objects - **Split_amount**: - Description: Amount of the split transaction. Should be passed only for split transaction flows - Tags: String - **Amount_info**: - Description: 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 - Value: - **Base_amount**: - Description: Base price value of the cart - Tags: String, Mandatory - **Add_on_amounts**: - Description: Any additional components of the cart. Eg : tax, delivery fees etc - Value: - **Name**: - Description: Name of the additional componentSupported Values : DELIVERYCHARGE, DELIVERYTIP, DONATION, SURCHARGE, TAX, OTHERCHARGES, PACKINGCHARGE - Tags: String, Mandatory - **Amount**: - Description: Amount of the corresponding additional component - Tags: String, Mandatory - Tags: Array of Objects - Tags: Stringified Object - Tags: object #### payment_method_info: - Description: Array of Payment Method Information - Value: - **Payment_method_reference**: - Description: Unique identifier that can be sent by the merchant for the respective Payment Instruments - Tags: string, Required - **Payment_method_type**: - Description: Payment Method Type of the transaction. Possible values are "CARD" | "NB" | "UPI" | "WALLET" | "REWARD" - Tags: string - **Payment_method**: - Description: Payment Method of the transaction - Tags: string - **Card_number**: - Description: Valid Card Number - Tags: string - **Card_token**: - Description: A valid card token obtained using /card/list API - Tags: string - **Card_alias**: - Description: Unique identifier received from Payv3 (Only for Payv3 integrations). - Tags: string - **Card_type**: - Description: Card type of the valid card.(Only for Payv3 integrations). - Tags: string - **Bank_code**: - Description: Bank Code - Tags: string - **Card_bin**: - Description: Card bin of the valid card - Tags: string - **Card_sub_type**: - Description: Card subtype of the valid card - Tags: string - **Upi_vpa**: - Description: Valid VPA of the customer - Tags: string - **Upi_app**: - Description: UPI App package name - Tags: string - **Txn_type**: - Description: UPI transaction type. Possible values are UPI_PAY, UPI_COLLECT - Tags: string - **Is_emi**: - Description: To Fetch EMI Offer for that praticular intsrument - Value: True/False - Tags: String - Tags: object #### customer: - Value: - **Id**: - Description: Customer id passed during order creation - Tags: string - **Email**: - Description: Email Id of the customer passed during order creation - Tags: string - **Phone**: - Description: Phone number of the customer passed during order creation - Tags: string - Tags: object #### offer_code: - Description: Coupon code configured on Juspay Dashboard - Tags: string ## API Responses: ### 200: #### best_offer_combinations: - Description: Contains details of the best offers against an order, mapped to eligible payment types sent in the request - Value: - **Payment_method_reference**: - Description: Unique payment method reference ID sent in request body - Tags: String - **Offers**: - Description: Offer details for the best offer available against the above payment_method_reference - Value: - **Offer_id**: - Description: Unique offer ID of the eligible offer - Tags: String, Mandatory - **Cashback_amount**: - Description: Cashback amount benefit associated with the offer - Tags: String, Mandatory - **Discount_amount**: - Description: Discount amount benefit associated with the offer - Tags: String, Mandatory - **Merchant_discount_amount**: - Description: 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 - Tags: String, Mandatory - **Total_offered_amount**: - Description: Total offer benefit amount associated with the offer ID - Tags: String - Tags: Object - **Order_breakup**: - Description: Order details breakup - Value: - **Order_amount**: - Description: Order amount before offer is applied (for merchant discount benefit, this is the amount post application of offer) - Tags: String, Required - **Applicable_order_amount**: - Description: Order amount applicable for calculation of offer - Tags: String, Required - **Final_order_amount**: - Description: Final order amount after offer has been applied - Tags: String, Required - **Discount_amount**: - Description: Discount amount applied on order - Tags: String, Required - **Merchant_discount_amount**: - Description: Offer discount amount that should be validated in the back end - Tags: String, Required - **Cashback_amount**: - Description: Cashback amount applied on order - Tags: String, Required - **Offer_amount**: - Description: Total offer amount applicable on the order - Tags: String, Required - **Benefits**: - Description: Breakdown of benefits on the order - Value: - **Type**: - Description: Benefits type, can be either CASHBACK | DISCOUNT | MERCHANT_DISCOUNT | EMI_DISCOUNT | EMI_CASHBACK - Tags: Enum - **Calculation_rule**: - Description: Calculation rule for offer, can be either PERCENTAGE | ABSOLUTE - Tags: Enum - **Amount_info**: - Description: List of strings that shows order amount elements on which offer has been applied - Tags: String - Tags: Object, Required - **Product_discounts**: - Description: Product level offer breakdown - Value: - **Product_id**: - Description: Unique identifier for products - Tags: String - **Product_quantity**: - Description: Quantity of product in an order - Tags: Integer - **Product_applicable_quantity**: - Description: Applicable product quantity to calculate offer - Tags: Integer - **Unit_price**: - Description: Price per unit of offer - Tags: String - **Discount_amount**: - Description: Discount applicable on order amount - Tags: String - **Cashback_amount**: - Description: Cashback applicable on order amount - Tags: String - **Merchant_discount_amount**: - Description: Amount to be validated in the backend for a product - Tags: String - **Capped_instant_discount_amount**: - Description: Maximum discount applicable on a product - Tags: String - **Capped_cashback_amount**: - Description: Maximum cashback applicable on a product - Tags: String - **Emi_discount**: - Description: EMI discount/cashback applicable on a product based on tenure and interest rate - Tags: Object - Tags: Object - Tags: String, Mandatory - Tags: Object #### offers: - Description: Breakdown of active offers based on offers configured on the dashboard by merchant - Value: - **Offer_id**: - Description: Unique ID associated with active offers - Tags: String, Mandatory - **Status**: - Description: Status of the offer, can be either ACTIVE or INACTIVE - Tags: String, Mandatory - **Offer_code**: - Description: Offer code configured by merchant on the offers dashboard - Tags: String, Mandatory - **Offer_description**: - Description: Offer description details including title, description, tnc etc - Tags: Object, Mandatory - **Ui_configs**: - Description: UI configuration details of an offer - Tags: Object, Mandatory - **Application_mode**: - Description: Product application mode of an order, can be either PRODUCT | LINE_ITEM | ORDER - Tags: Enum, Mandatory - **Offer_rules**: - Description: Order rules breakdown with amount and payment instrument detail - Value: - **Amount**: - Description: Offer benefit amount associated with an offer ID - Tags: json - **Order_basket**: - Description: Order basket with product level details uploaded along with WHITELIST/BLACKLIST specification for those offers - Tags: json - **Platform**: - Description: Platforms on which offers are applicable - Tags: json - **Additional_payment_filters**: - Description: EMI eligibility rules for the offer with tenure and bank details - Tags: json - **Customer**: - Description: WHITELIST/BLACKLIST of customer IDs that were uploaded during offer configuration - Tags: json - **Payment_instrument**: - Description: Eligible payment instruments for an offer - Tags: json - **Gateways**: - Description: WHITELIST/BLACKLIST of gateways that were uploaded during offer configuration - Tags: json - **Filters**: - Description: WHITELIST/BLACKLIST of filters that were uploaded during offer configuration - Tags: json - **Txn_type**: - Description: Specifying the transaction type for an offer - can be ORDER (full swipe transactions) or EMI (EMI transactions) - Tags: json - Tags: Object, Mandatory - **Order_breakup**: - Description: Order level breakdown with details - Tags: Object - **Eligible_saved_payment_methods**: - Description: Eligible payment methods (for ELIGIBLE offers) based on the payment_method_reference sent as request - Tags: String, Mandatory - Tags: Object ### 400: #### json: - Tags: json ### 401: #### json: - Tags: JSON ### API Latency Guidelines #### **What is API Latency?** Time taken by the server to respond to the API request. #### **Average API Percentile Metrics and Recommended Timeout** **TP50 (ms)** : This represents the median latency, meaning 50% of all requests are completed in this time or less. It indicates the typical performance experienced by the majority of users. **TP90 (ms)** : This value shows that 90% of requests are completed within this time, leaving 10% of requests that take longer. It gives insight into the performance for a broader set of users, beyond the median. **TP99 (ms)** : This value indicates that 99% of requests finish within this time, with only 1% of requests taking longer. It helps identify outlier cases where latency may become an issue for a small group of users. **TP99.9 (ms)** : This metric captures extreme latency outliers, where only 0.1% of requests take longer than this value. It’s useful for understanding edge cases where performance degrades for very few users. **TP99.99 (ms)** : This measures the most rare and severe performance outliers, where just 0.01% of requests exceed this time. Monitoring this helps in addressing the rarest and most critical latency issues that may impact user experience in exceptional scenarios. | Transaction Percentile | Latency (ms) | |---|---| | TP50 (ms) | 49.277 | | TP90 (ms) | 128.11 | | TP99 (ms) | 404 | | TP99.9 (ms) | 640.38 | | Recommended Timeout(ms) | 1000 | > **Warning** > The recommended timeouts are based on TP99.9 data, though edge cases (0.01% of requests) may still exceed these limits and are captured in the TP99.99 data as shown below. > > > | Transaction Percentile | Latency (ms) | > |---|---| > | TP99.99 (ms) | 4456.05 | > | Recommended Timeout(ms) | 5000 | > --- ## See Also - [Integration Architecture - Payv3](https://juspay.io/in/docs/offer-engine/docs/payv3-offers-integration/integration-architecture--payv3) - [Order Status for Offers](https://juspay.io/in/docs/offer-engine/docs/api-integration/order-status-for-offers)