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. Order create is a server to server call.
Amount and order id are the mandatory fileds, the contact details like email, phone number, customer id's are conditional and depends on the underlying payment gateway/ aggregator used.
'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
Note: Auth api key should be Base64 encoded.
| Payment Gateways | Fields |
|---|---|
| CCAVENUE_V2 | metadata.CCAVENUE_V2:promo_code |
| BILLDESK | metadata.BILLDESK:AdditionalInfo3 |
| BILLDESK | metadata.BILLDESK:AdditionalInfo4 |
| FREECHARGE | metadata.FREECHARGE:campaignCode |
| HSBC_UPI | metadata.HSBC_UPI:addInfo |
| MIGS | metadata.MIGS:vpc_AddendumData |
| MIGS | metadata.MIGS:vpc_OrderInfo |
| OLAMONEY | metadata.OLAMONEY:couponCode |
| PAYTM | metadata.PAYTM:PROMO_CAMP_ID |
| PAYTM | metadata.PAYTM:CUST_ID |
| PAYTM | metadata.PAYTM:MERC_UNQ_REF |
| TATAPAY | metadata.TATAPAY: merchantTxnMetadata |
| PAYU | metadata.PAYU:offer_key |
| PAYU | metadata.PAYU:udf1 |
| PAYU | metadata.PAYU:udf2 |
| PAYU | metadata.PAYU:udf3 |
| PAYU | metadata.PAYU:udf4 |
| PAYU | metadata.PAYU:udf5 |
| PHONEPE | metadata.PHONEPE:merchantContext |
| RAZORPAY | metadata.RAZORPAY:notes[cust_id] |
| RAZORPAY | metadata.RAZORPAY:notes[cust_name] |
| RAZORPAY | metadata.RAZORPAY:offer_id |
| RAZORPAY | metadata.razorpay:PNR |
| RAZORPAY | metadata.razorpay:PaymentID |
| RAZORPAY | metadata.razorpay:lob |
| Subvention Amount | metadata.subvention_amount |
| TPSL | metadata.TPSL:shoppingCartDetails |
| TPSL | metadata.TPSL:accountNo |
| ZAAKPAY | metadata.ZAAKPAY:productDescription |
| ZAAKPAY | metadata.ZAAKPAY:product1Description |
| PAYPAL | metadata.PAYPAL:landing_page |
| PAYPAL | metadata.PAYPAL:phone_number |
| PAYPAL | metadata.PAYPAL:country_code |
| PAYPAL | metadata.PAYPAL:first_name |
| PAYPAL | metadata.PAYPAL:last_name |
| PAYPAL | metadata.PAYPAL:experience_id |
| PAYPAL | metadata.PAYPAL:brand_name |
| PAYPAL | metadata.PAYPAL:additional_data |
| PAYPAL - For Link and Pay | metadata.PAYPAL:lnp_product_name |
| PAYPAL - For Link and Pay | metadata.PAYPAL:lnp_product_code |
| PAYPAL - For Link and Pay | metadata.PAYPAL:lnp_charge_pattern |
| PAYPAL - For Link and Pay | metadata.PAYPAL:direct_wallet_version |
| PAYPAL - For Link and Pay | metadata.PAYPAL:purchase_category |
| AMAZONPAY | metadata.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 Gateways | Fields | Value |
|---|---|---|
| PAYU | metadata.PAYU:gateway_reference_id | "BUS" |
| RAZORPAY | metadata.RAZORPAY:gateway_reference_id | "BUS" |
For TRAIN LOB pass the following in order create request.
| Payment Gateways | Fields | Value |
|---|---|---|
| PAYU | metadata.PAYU:gateway_reference_id | "TRAIN" |
| RAZORPAY | metadata.RAZORPAY:gateway_reference_id | "TRAIN" |
For FLIGHT LOB pass the following in order create request.
| Payment Gateways | Fields | Value |
|---|---|---|
| PAYU | metadata.PAYU:gateway_reference_id | "FLIGHT" |
| RAZORPAY | metadata.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.