Create Order

Create an order that is a representation of your shopping cart. The order contains important information like amount, customer details, shipping address, billing address, etc. Only after an order is created, payment can be started.

'UDF' is used to pass any additional information that is required to be stored at Juspay for any analysis or other operations. In some cases, these UDFs are passed to the downstream gateways as well.

Juspay supports 10 UDFs (UDF1 to UDF10). The values passed in UDFs are reflected back in the order status response and in webhooks back to the merchant. If there are any special characters that need to be passed in UDF values, please use UDF 6 to 10 for passing the same. UDF 1 to 5 can be used to pass values which do not have any special characters.

‘Metadata’ is used to send custom params to the payment aggregators, irrespective of default parameters, The supported parameters

Payment GatewaysFields
CCAVENUE_V2metadata.CCAVENUE_V2:promo_code
BILLDESKmetadata.BILLDESK:AdditionalInfo3
BILLDESKmetadata.BILLDESK:AdditionalInfo4
FREECHARGEmetadata.FREECHARGE:campaignCode
HSBC_UPImetadata.HSBC_UPI:addInfo
MIGSmetadata.MIGS:vpc_AddendumData
MIGSmetadata.MIGS:vpc_OrderInfo
OLAMONEYmetadata.OLAMONEY:couponCode
PAYTMmetadata.PAYTM:PROMO_CAMP_ID
PAYTMmetadata.PAYTM:CUST_ID
PAYTMmetadata.PAYTM:MERC_UNQ_REF
PAYUmetadata.PAYU:offer_key
PAYUmetadata.PAYU:udf1
PAYUmetadata.PAYU:udf2
PAYUmetadata.PAYU:udf3
PAYUmetadata.PAYU:udf4
PAYUmetadata.PAYU:udf5
PHONEPEmetadata.PHONEPE:merchantContext
RAZORPAYmetadata.RAZORPAY:notes[cust_id]
RAZORPAYmetadata.RAZORPAY:notes[cust_name]
RAZORPAYmetadata.RAZORPAY:offer_id
Subvention Amountmetadata.subvention_amount
TPSLmetadata.TPSL:shoppingCartDetails
TPSLmetadata.TPSL:accountNo
ZAAKPAYmetadata.ZAAKPAY:productDescription
ZAAKPAYmetadata.ZAAKPAY:product1Description
PAYPALmetadata.PAYPAL:landing_page
PAYPALmetadata.PAYPAL:phone_number
PAYPALmetadata.PAYPAL:country_code
PAYPALmetadata.PAYPAL:first_name
PAYPALmetadata.PAYPAL:last_name
PAYPALmetadata.PAYPAL:experience_id
PAYPALmetadata.PAYPAL:brand_name
PAYPALmetadata.PAYPAL:additional_data
PAYPAL - For Link and Paymetadata.PAYPAL:lnp_product_name
PAYPAL - For Link and Paymetadata.PAYPAL:lnp_product_code
PAYPAL - For Link and Paymetadata.PAYPAL:lnp_charge_pattern
PAYPAL - For Link and Paymetadata.PAYPAL:direct_wallet_version
PAYPAL - For Link and Paymetadata.PAYPAL:purchase_category
AMAZONPAYmetadata.AMAZONPAY:sellerNote

To use multiple MID setup, please pass reference Id as per the following format:

Assume you have three line of businesses BUS, TRAIN and FLIGHT and using RAZORPAY and PAYU gateways.

For BUS LOB pass the following in order create request.

Payment GatewaysFieldsValue
PAYUmetadata.PAYU:gateway_reference_id"BUS"
RAZORPAYmetadata.RAZORPAY:gateway_reference_id"BUS"

For TRAIN LOB pass the following in order create request.

Payment GatewaysFieldsValue
PAYUmetadata.PAYU:gateway_reference_id"TRAIN"
RAZORPAYmetadata.RAZORPAY:gateway_reference_id"TRAIN"

For FLIGHT LOB pass the following in order create request.

Payment GatewaysFieldsValue
PAYUmetadata.PAYU:gateway_reference_id"FLIGHT"
RAZORPAYmetadata.RAZORPAY:gateway_reference_id"FLIGHT"

📘

Note:

Subvention Amount: The amount for which the EMI interest should not be calculated.
For example - if the Order amount is 100, the subvention amount is 10, interest will be calculated for 100-10 = 90.
Subvention amount can be from 0 to 100. If subvention amount = order amount then its no-cost EMI
The mechanism of running offers or subvention amount is the responsibility of merchants in collaboration with PG/Banks.

Payment Links
Order create response now has payment links for web, mobile & iFrame. These links can directly be emailed or messaged to your customers. If you wish to use your own branding, then you can embed the iframe link into your page. Note that, these links are not valid perpetually. As soon as your order expires (this can be changed via our dashboard), the link will cease to work.

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!