Body
Session API
This is a Server-to-Server API which accepts order parameters as an input to create order in the Juspay system, and returns payment links.
The parameters you need to pass might vary depending on the lender requirements. Therefore, it is always recommended to consult the Juspay team for the required parameters before generating a session.
‘Metadata’ is used to send custom params to the payment aggregators, irrespective of default parameters.
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/session
Production Link
POST
https://api.juspay.in/session
Authorization Header
Basic Auth
*
required
Basic Authorization should be sued for the API testing.
Headers
x-merchantid
*
String
Mandatory
Once you have completed JusPay onboarding, JusPay will provide you with your Merchant ID.
Content-Type
*
String
Mandatory
Example:- application/json
Request Schema: application/json
Basic Parameter
order_id
*
String
Mandatory
A unique Order ID generated by merchant.
This Order ID will have transactions mapped to it.
amount
*
String
Mandatory
This is the order amount for which the purchase is being made.
description
String
can be collected
A short text explaining the purpose or details of the transaction.
currency
String
Can be collected
The currency in which the transaction is made (e.g., INR, USD).
customer_id
*
String
Mandatory
Unique identifier of the customer in merchant’s system.
customer_email
*
String
Mandatory
can be collected on UI
E-mail id of the customer.
customer_phone
*
String
Mandatory
can be collected on UI
Phone number of the customer.
customer_dob
String
can be collected on UI
Customer’s date of birth in the dd-mm-yyyy format.
customer_first_name
String
can be collected on UI
Customer’s first name.
customer_middle_name
String
can be collected on UI
Customer’s middle name.
customer_last_name
String
can be collected on UI
Customer’s last name.
customer_gender
String
can be collected on UI
Following values are accepted: Male | Female | Others
customer_marital_status
String
can be collected on UI
Customer’s marital status: Following values are accepted: Single | Married
customer_highest_education
String
can be collected on UI
Customer’s Highest Educational Qualification. Following Values are accepted:
Undergraduate | Professional Degree | Graduate | Post Graduate | Ph.D | Others
customer_address_line1
String
can be collected on UI
Address of the customer
customer_address_line2
String
can be collected on UI
Address of teh customer
customer_state
String
can be collected on UI
State of Residenec of the customer
customer_pincode
String
can be collected on UI
Customer’s Pincdoe
customer_city
String
can be collected on UI
Customer’s City
customer_annual_income
String
can be collected on UI
Anual Income oof the Customer
customer_employment_type
String
can be collected on UI
Customer’s employment type. Following values are accepted:
SALARIED | SELF_EMPLOYED
customer_product_name
*
String
Mandatory
Depends on Lender
Product Name of the Merchant. Should be passed by Merchant
customer_product_tenure
*
String
Mandatory
Depends on Lender
Tenure of the loan that is being requested
metadata.source
*
String
Mandatory
Channel Source (Example : Online)
metadata.sdk_payload
*
Boolean
Mandatory
payment_page_client_id
*
String
Mandatory
Client ID which controls the UI Parameters of the payment page.
This is generated by Juspay
action
*
String
Mandatory
Payment Page
Example:- paymentPage
return_url
*
String
Mandatory
This URL specifies where the control should redirect after the completion of the payment process.
Example:- juspay.in
Insurance Specific Parameter
customer_policy_ref_no
*
String
Mandatory
Policy Reference Number of the customer. This policy reference number will be passed to lenders, and same will be used for saving loan application at Juspay’s end.
metadata.customer_policy_type
*
String
Mandatory
This indicates whether the policy is new or being renewed.
The accepted types are NEW or RENEWAL.
metadata.policy_renewal_year
*
String
Mandatory
Frequency or duration of the policy gets renewed.
metadata.customer_policy_no
*
String
Mandatory
Customer’s Policy Reference Number
insured_member_details
*
String
Mandatory
Details of the insured member. This is an array and details of all insured member shall be provided.
Education Specific Parameters
metadata.customer_product_name
*
String
Mandatory
Name of the product/course (MBA).
metadata.customer_product_payment_type
*
String
Mandatory
Tenure of Loan
metadata.student_name
*
String
Mandatory
Student’s full name (John Doe).
metadata.student_admission_type
*
String
Mandatory
Admission type (NEW, could also be RENEWAL/TRANSFER in other cases).
Travel Specific Parameters
metadata.origin
*
String
Mandatory
Travel origin location (Bangalore).
metadata.destination
*
String
Mandatory
Travel destination (Mangalore).
metadata.travel_start_date
*
String
Mandatory
Start date of travel (29-Dec-2024).
metadata.travel_end_date
*
String
Mandatory
End date of travel (31-Dec-2024).
metadata.travel_type
*
String
Mandatory
Type of travel (e.g., Visa, could also be One-way, Return, etc. depending on use-case).
metadata.agent_email_id
*
String
Mandatory
Travel agent’s email (xyz@gmail.com
).
metadata.agent_mobile
*
String
Mandatory
Travel agent’s phone number (9888888888).
metadata.agent_name
*
String
Mandatory
Travel agent/agency name (Juspay B2C).
metadata.brand_name
*
String
Mandatory
Associated brand name (Juspay B2C).
User Defined Parameters (UDF)
udf1 , udf2 , udf3 , udf4, udf5
string (Upto 255 characters)
No special characters supported
User Defined Parameter (UDF)
This field can be used to send any user defined parameters
The UDF parameters for orders can be seen in the JUSPAY dashboard under each order
Example:- user5349
udf6 , udf7 , udf8 , udf9 , udf10
string (Upto 255 characters)
Special characters supported
User Defined Parameter (UDF)
This field can be used to send any user defined parameters
The UDF parameters for orders can be seen in the JUSPAY dashboard under each order
Example:- user_5349
200 : Success
Response Body
sdk_payload
JSON
Process SDK Call Payload. This is supposed to be passed to your frontend application to open the Hypercheckout screen.
payment_links
string
Https link using which user can open the Hypercheckout screen and perform transaction against the order created
order_id
string
Max Length : 21
Order Id passed during order creation
status
string
Max Length : 255
Status of order
Example:-
NEW
400 : Invalid Input data
Response Body
status
string
Max Length : 255
Bad Request
error_code
string
Max Length : 255
Details of keys missing
Example:-
Mandatory fields are missing
error_message
string
Max Length : 255
Further Details of keys missing
401 : Authentication Failed
Response Body
status
string
Max Length : 255
error
error_code
string
Max Length : 255
access_denied
404 : Not Found
Response Body
status
string
Max Length : 255
error
error_code
string
Max Length : 255
Internal server Error
500 : Unexpected Error
Response Body
status
string
Max Length : 255
error
error_code
string
Max Length : 255
Internal server Error