Body
Create Order for Split Settlement
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/orders
Production Link
POST
https://api.juspay.in/orders
Headers
Content-Type
*
string
Required
application/x-www-form-urlencoded
Authorization
*
string
Required
Basic of Base64 encoded API key
x-routing-id
*
String
Required
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.
Example:- customer_1122
Parameters
order_id
*
string
Mandatory
A unique Identifier for the order.
amount
*
number
Mandatory
The total order amount. Will accept double values with upto two decimal places.
return_url
string
A fully qualified URL such as http://shop.merchant.com/
to which the customer will be redirected after payment completion. This URL shouldn’t contain any query parameters. This URL takes higher precedence over the common return URL configured in your account settings.
metadata
object
split_settlement_details
*
string
Mandatory
This field describes how much amount is to be settled into the resepctive sub account ids. Summation of amount for all the sub account ids has to be equal to the original order amount.
marketplace
JSON
Conditional
Marketplace (Parent merchant account ID) specific data to be passed
amount
*
Number
Mandatory
Amount to be settled in parent merchant settlement account
mdr_borne_by
String
Conditional
Example:- MARKETPLACE/ VENDOR/ ALL
vendor
JSON
Conditional
Vendor (Sub account IDs) specific data to be passed
split
array
Conditional
Split settlement information to be passed
sub_mid
*
String
Mandatory
Sub Account ID (maintained at JusPay’s end) to be passed.
amount
*
Number
Mandatory
Amount to be settled in the sub account
merchant_commission
*
Number
Mandatory
Merchant commission to be borne by sub account IDs
notes
String
To pass custom parameters
note
*
String
Mandatory
To pass custom information to be passed on to the gateway (NOTE: For Razorpay all values passed within the block are passed)
juspayVendorId
*
String
Mandatory
Required for Mapping the gateway transaction id for the vendor
200 : Success
Response Body
status
string
CREATED
status_id
integer
id
string
ordeh_06a7c87b83d7453191ba6a4f9919860c
order_id
string
splitsettlement_1619009418_test
payment_links
object
iframe
string
https://api.juspay.in/merchant/ipay/ordeh_06a7c87b83d7453191ba6a4f9919860c
web
string
https://api.juspay.in/merchant/pay/ordeh_06a7c87b83d7453191ba6a4f9919860c
mobile
string
https://api.juspay.in/merchant/pay/ordeh_06a7c87b83d7453191ba6a4f9919860c?mobile=true
400 : Invalid Input data
Response Body
status
string
ERROR
error_code
string
invalid_request
error_message
string
Split settlement amount is not equal to order amount
status_id
null