Create Order for Split Settlement

The response for this API is a Status, Redirect Info object (parameter group). (click to open table)

NOTE:

This response is the same as that for the Create Order API.

Field	Type	Description
id	String	Unique ID generated by JusPay for the given order.
order_id	String	Given order ID.
status	String	Status of the order. If you receive “CREATED”, then the order is successfully created (see Appendix below for status mapping). If you invoke this API with an order_id which is already created, then this API will return the result of /order/status API.
status_id	String	Status ID is a numeric id corresponding to the status value. See Appendix below for code meaning.
payment_links.web	String	Link to checkout page that is optimized for Desktop for the given order.
payment_links.mobile	String	Link to Mobile optimized checkout page for the given order.
payment_links.iframe	String	Link to iFrame checkout screen. This is typically embedded inside of your own page.

Payment Links
Order create response now has payment links for web, mobile & iFrame. These links can directly be emailed or messaged to your customers. They will be redirected using a link to enter payment information. 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.

APPENDIX Order status codes and meaning

Order Status	ID	Meaning
CREATED	1	Returned when the order is successfully created.
NEW	10	Newly created order.
PENDING_VBV	23	Authentication is in progress. The customer has to approve the mandate through the PSP App of their choice.
CHARGED	21	Successful transaction. The subscription cost of the period has been charged.
AUTHENTICATION_FAILED	26	User did not complete authentication.
AUTHORIZATION_FAILED	27	User completed authentication, but the bank refused the transaction.
JUSPAY_DECLINED	22	User input is not accepted by the underlying PG.
AUTHORIZING	28	Transaction status is pending from bank.

Request Parameter Details (click to open table)
- includes metadata object for Split Settlement Details

Field		Type	Description
order_id	*	String	A unique Identifier for the order.
amount	*	Double	The total order amount. Will accept double values with up to 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. split_settlement_details= {...}		JSON object	This describes how much amount is to be settled into the respective sub account IDs. Summation of amount for all the sub account ids has to be equal to the original order amount.

Parameters for the metadata.split_settlement_details object:

Field		Type	Description
mdr_borne_by	*	String	MARKETPLACE/ VENDOR/ ALL
marketplace	*	JSON object	Marketplace (Parent merchant account ID) specific data to be passed
vendor	*	JSON object	Vendor (Sub account IDs) specific data to be passed

Parameters for the marketplace object:


amountwwww	*	Double	Amount to be settled in parent merchant settlement account

Parameters for the vendor object:


split: [{...},{...}...] wwwwwwwww	*	Array of Objects	Split settlement information to be passed

Parameters for each split object in array:

Field		Type	Description
sub_mid	*	String	Sub Account ID (maintained at JusPay’s end) to be passed.
amount	*	Double	Amount to be settled in the sub account
merchant_commission	*	Double	Merchant commission to be borne by sub account IDs

* = Required
* = Conditional