Body
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:
Offer description and terms
Offer eligibility for the current transaction
Offer benefits with calculation rules (Discount Value/Cashback Value)
Order amount pre/post discount
Eligible payment instruments/methods for an offer undefined
Request
Response
API Endpoints
Production Link
POST
https://api.juspay.in/v1/offers/list
Authorization Header
Basic Auth
*
Base64 Encoded Username:Password
Mandatory
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
x-merchantid
string
Recommended
Unique identifier for the merchant. This is the Merchant ID provided by Juspay. The value is case sensitive.
Note
Passing this value will help us route efficiently at network level.
Example:- x-merchantid: testaccount
Content-Type
String
application/x-www-form-urlencoded
Query Params
?emi=true
string
Used when there are offers configured for EMI Option
Parameters
order
object
order_id
string
Unique ID generated by JusPay for the given order
amount
*
string
Required
Order Amount
currency
*
string
Required
Currency passed during order creation
payment_channel
string
Payment channel used for making transaction. Possible values ANDROID, IOS, WEB and MWEB
udf1
string
The user defined fields passed during order creation
udf2
string
The user defined fields passed during order creation
udf3
string
The user defined fields passed during order creation
udf4
string
The user defined fields passed during order creation
udf5
string
The user defined fields passed during order creation
udf6
string
The user defined fields passed during order creation
udf7
string
The user defined fields passed during order creation
udf8
string
The user defined fields passed during order creation
udf9
string
The user defined fields passed during order creation
udf10
string
The user defined fields passed during order creation
basket
Stringified Array
List of Products/sku details for offer application
id
*
String
Mandatory
Unique ID for the product where offer eligibility/applicability checks needs to be performed
quantity
*
double
Mandatory
Number of items against a particular product
unitPrice
*
double
Mandatory
Price of the individual product
payment_method_info
object
Array of Payment Method Information
payment_method_reference
string
Unique identifier that can be sent by the merchant for the respective Payment Instruments
payment_method_type
string
Payment Method Type of the transaction. Possible values are "CARD" | "NB" | "UPI" | "WALLET" | "REWARD"
payment_method
string
Payment Method of the transaction
card_number
string
Valid Card Number
card_token
string
A valid card token obtained using /card/list API
card_alias
string
Unique identifier received from Payv3 (Only for Payv3 integrations).
card_type
string
Card type of the valid card.(Only for Payv3 integrations).
bank_code
string
Bank Code
card_bin
string
Card bin of the valid card
card_sub_type
string
Card subtype of the valid card
upi_vpa
string
Valid VPA of the customer
upi_app
string
UPI App package name
txn_type
string
UPI transaction type. Possible values are UPI_PAY, UPI_COLLECT
customer
object
id
string
Customer id passed during order creation
email
string
Email Id of the customer passed during order creation
phone
string
Phone number of the customer passed during order creation
offer_code
string
Coupon code configured on Juspay Dashboard
200 : Success
Response Body
json
json
400 : Invalid Input data
Response Body
json
json
401 : Authentication Failed
Response Body
json
JSON
Have questions?
- Need help? Contact support
- LLM? Read llms.txt