Body
Create Order
You can pass the payload in the order creation API or in the session API call.
Note
part_numberkey have to be sequential in case of fixed planno_of_partsshould total to the total number of parts in the fixed planplan_due_dateof the selected plan by user will be considered as order expiryplan_idmust be unique for each planmaximum_no_of_partsandminimum_part_amountare mandatory parameters in case of EDITABLE plans.key
statusinside part_payment takesOPTIONAL/REQUIREDas value. Selected OPTIONAL means users will see part payment as one of the option to make payment.due_dateandplan_due_datehave to be EPOCH time for part payment details
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/session
Authorization Header
Basic Auth
*
Base64 Encoded Username:Password
Required
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Request Schema: application/json
order_id
*
Mandatory
Required
Your order ID
first_name
First name of the customer
last_name
Last name of the customer
customer_phone
Customer’s phone number
payment_page_client_id
Client ID in case of Hypercheckout merchant
service
Example:- in.juspay.hyperpay
merchant_id
*
String
Mandatory
your_merchantID
amount
*
String
Mandatory
order amount
payment_rules
*
Required
Refer to sample curl for keys
This key is an object that holds part payment information. Refer to the sample curl. Payment Rules key is an object which contains additional information including the part payment plan details which are explained below.
Payment Rules
payment_flows
*
String
Mandatory
Required
It is an object which defines this as a part payment order. This key takes value as part_payment
part_payment
*
String
Mandatory
Required
This key is a value to payment_flows which determines if the order is a part payment order. It is an object
status
*
String
Mandatory
Required
This key tells us if the part payment will be available as an optional or a required payment type. If value is sent as OPTIONAL, then other payment methods will be available to users to choose from, choosing this will make the order full swipe. In case the status value is sent as REQUIRED, then only part payment will be available as an option to make payment.
info
*
String
Mandatory
Required
This key contains information about the payment flow defined above
plan_info
*
Mandatory
Required
This is an array which contains information about the plan types in the part payment options
plan_type
*
String
Mandatory
Required
It can take values as FIXED/EDITABLE. If the plan is fixed payment plan (predefined amount of each parts and due dates, then choose value as FIXED. If you wish for users to choose the amount and make payment in parts, then EDITABLE can be sent.
fixed_plan_details
*
String
Mandatory
Required
This key will come in case plan_type is choosen as FIXED. It contains keys to define plan conditions like plan_id, no_of_parts and parts_info.
plan_id
*
String
Mandatory
Required
This is the plan ID set by the merchant.
no_of_parts
*
String
Mandatory
Required
This defines the number parts present in the fixed plan details. This key is only to be sent in case of fixed plan.
parts_info
*
Mandatory
Required
This is an array which contains informarion about each parts in a fixed plan
amount
*
String
Mandatory
Required
Inside parts_info, this is the amount of each parts set in the fixed plan
due_date
*
String
Mandatory
Required
Inside parts_info, this defines the expiry date of that particular part. Send the values in EPOCH timestamp
part_number
*
Int
Mandatory
Required
This is the part number of the fixed plan. Value also needs to be sent in the transaction call to denote which part the user is trying to make the payment for.
plan_due_date
*
String
Mandatory
Required
This is the plan expiry date. If user chooses this plan, then that plan’s due date becomes the expiry date of the order.
editable_plan_details
*
String
Mandatory
Required
In case you wish to let user decide the part amounts, then EDITABLE can be sent in the plan_type. The above key defines the details of the editable plan.
minimum_part_amount
*
String
Mandatory
Required
For editable plans, you must define the minimum amount which user must choose to make payment of each part.
maximum_no_of_parts
*
String
Mandatory
Required
For editable plans, you must also define the total maximum number of parts in which user should make the complete payment of the order.
200 : Success
Response Body
status
String
Example:- NEW
id
String
Example:- ordeh_0bf87dee38ff444d82f37a225a9d2638
order_id
String
Example:- 1749026515
payment_links
Object
web
String
Example:- https://sandbox.assets.juspay.in/payment-page/order/ordeh_0bf87dee38ff444d82f37a225a9d2638
expiry
String
Example:- 2025-06-11T08:41:55Z
sdk_payload
Object
requestId
String
Example:- ee2cca9e5bd1414885bf3ac4e8870c14
service
String
Example:- in.juspay.hyperpay
payload
Object
metadata.JUSPAY:gatewayReferenceId
String
Example:- testmode
firstName
String
Example:- John
clientId
String
Example:- your_clientID
paymentRules
Object
payment_flows
Object
part_payment
Object
status
String
Example:- OPTIONAL
info
Object
plan_info
Array
customerId
String
Example:- sftrj5ty4tg4gtfsd4
orderId
String
Example:- 1749026515
returnUrl
String
Example:- https://sandbox.juspay.in/end
currency
String
Example:- INR
customerPhone
String
Example:- 965234xxxx
service
String
Example:- in.juspay.hyperpay
gatewayId
String
Example:- 23
emailAddress
String
Example:- test007@gmail.com
description
String
Example:- test
environment
String
Example:- sandbox
lastName
String
Example:- Wick
merchantId
String
Example:- your_merchantID
amount
String
Example:- 20000.0
clientAuthTokenExpiry
String
Example:- 2025-06-04T08:56:55Z
clientAuthToken
String
Example:- tkn_90e7ae9f0cab4b90874a4da10dd6e6cc
action
String
Example:- paymentPage
collectAvsInfo
Boolean
Example:- false
expiry
String
Example:- 2025-06-11T08:41:55Z
order_expiry
String
Example:- 2025-06-11T08:41:55Z
Have questions?
- Need help? Contact support
- LLM? Read llms.txt