--- page_title: What You’ll Integrate product: HyperCredit platform: Web page_source: https://juspay.io/in/docs/hyper-credit/web/checkout-financing/what-youll-integrate llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/hyper-credit/llms.txt --- # **WHAT YOU’LL INTEGRATE** 1. **Session API** 2. **Status API** 3. **Webhooks** ## **Session API** The Session API is a server-to-server API that creates an order in Juspay and returns the payment URLs along with other order information. The payment URLs render the Juspay Payment Page where HyperCredit is available as a Payment Option. #### **Endpoints:** | Environment | Method | Endpoint | |---|---|---| | Sandbox | POST | https://sandbox.juspay.in/session | | Production | POST | https://api.juspay.in/session | #### **Typical integration sequence:** * **Create the order context.** Generate a unique order ID and collect the customer and product data required for the selected flow. * **Call the Session API.** Send the request from your Server to the appropriate sandbox or production endpoint. * **Launch HyperCheckout.** Use the returned session or payment-link data to open the checkout experience in the merchant channel. #### **Variants:** Depending on the industry you are catering, the payload changes as outlined below. 1. **Generic** : Standard order creation payload for checkout financing. **Request payload:** [Open Generic Request JSON](/hyper-credit/web/request-payloads/generic#Generic-Payload) Purpose of the Generic fields: | Field | Description | Type | Mandatory | |---|---|---|---| | order_id | Unique identifier for the order created by the merchant. | String | Yes | | amount | Total order amount for which the customer is seeking financing/payment. | String | Yes | | description | Description of the transaction or product being purchased. | String | No | | customer_id | Unique identifier assigned to the customer by the merchant. | String | Yes | | customer_email | Customer’s email address. | String | No | | customer_phone | Customer’s mobile number. | String | Yes | | customer_dob | Customer’s date of birth. | String | No | | metadata.customerPan | PAN of the customer | String | No | | customer_first_name | Customer’s first name. | String | No | | customer_middle_name | Customer’s middle name, if applicable. | String | No | | customer_last_name | Customer’s last name. | String | No | | customer_gender | Customer’s gender. | String | No | | metadata.monthlyIncome | Monthly Income of the customer | String | No | | customer_marital_status | Customer’s marital status. | String | No | | customer_highest_education | Customer’s highest level of education. | String | No | | customer_address_line1 | Primary address line of the customer. | String | No | | customer_address_line2 | Additional address details, such as apartment, building, or locality. | String | No | | customer_state | State in which the customer resides. | String | No | | customer_pincode | Customer’s PIN code. | String | No | | customer_city | Customer’s city of residence. | String | No | | customer_employment_type | Customer’s employment category, such as salaried or self-employed. | String | No | | payment_page_client_id | Client ID used to initialise the HyperCredit payment page. | String | Yes | | return_url | URL to which the customer is redirected after completing or exiting the payment journey. | String | Yes | 2. **Insurance** : Insurance premium financing with policy, nominee, and primary-holder information. **Request payload:** [Open Insurance Request JSON](/hyper-credit/web/request-payloads/insurance#Insurance-Payload) Purpose of the Insurance-specific fields: | Field | Description | Type | Mandatory | |---|---|---|---| | metadata.customer_product_name | Policy Name | String | Yes | | metadata.customer_product_payment_type | Policy Tenure in Years | String | Yes | | customer_policy_ref_no | Merchant or insurer’s policy reference number | String | Yes | | metadata.customer_policy_no | Issued or existing insurance policy number | String | Yes | | metadata.policy_renewal_year | Renewal year or policy tenure year | String | Conditional | | metadata.customer_policy_type | Policy transaction type, such as NEW or RENEWAL | String | Yes | | customer_nominee_name | Name of the insurance nominee | String | No | | customer_nominee_phone | Nominee’s mobile number | String | No | | is_primary_holder | Indicates whether the customer is the primary policyholder | String | No | 3. **Education:** Course-fee and education-finance flow for students and academic programs. **Request payload:** **[Open Education request JSON](/hyper-credit/web/request-payloads/education#Education-Payload)** Purpose of the Education-specific fields: | Field | Description | Type | Mandatory | |---|---|---|---| | metadata.student_name | Name of the student for whom the payment is being made | String | Yes | | metadata.student_admission_type | Admission type, such as NEW or EXISTING | String | Yes | | metadata.customer_product_name | Course Name, such as MBA | String | Yes | | metadata.customer_product_payment_type | Course Tenure in Months | String | Yes | 4. **Travel:** Travel-booking financing for merchants  **Request payload:** **[Open Travel request JSON](/hyper-credit/web/request-payloads/travel#Travel-Payload)** Purpose of the Travel-specific fields: | Field | Description | Type | Mandatory | |---|---|---|---| | metadata.origin | Starting location of the journey | String | Yes | | metadata.destination | Destination of the journey | String | Yes | | metadata.travel_start_date | Journey or service start date | String | Yes | | metadata.travel_end_date | Journey or service end date | String | Yes | | metadata.travel_type | Travel-related product type, such as flight, hotel, or visa | String | Yes | | metadata.agent_email_id | Travel agent’s email address | String | Yes | | metadata.agent_mobile | Travel agent’s mobile number | String | Yes | | metadata.agent_name | Travel agent or agency name | String | Yes | | metadata.brand_name | Brand shown or associated with the booking | String | Yes | 5. **Consumer Durables:** Financing for devices, appliances, and other physical consumer products. **Request payload:** **[Open Consumer Durables request JSON](/hyper-credit/web/request-payloads/consumer-durables#Consumer-Durables-Payload)** Purpose of the Consumer-durables specific fields: | Field | Description | Type | Mandatory | |---|---|---|---| | Order Basket | Contains details of all products in the order | Array Json | Yes | | brand | Product manufacturer or brand | String | Yes | | category | Main product category | String | Yes | | sub_category | Product subcategory or SKU ID | String | Yes | | product_name | Name of the financed product | String | Yes | | product_price | Price per product or listed product price | String | Yes | | total_amount | Total Product Value | String | Yes | | unit | Product quantity | String | Yes | | imei_required | Whether IMEI / Serial Number Validation is required for the product | String | Yes | 6. **University:** University tuition or semester-fee financing with course, intake, and payment-plan context. **Request payload:** **[Open University request JSON](/hyper-credit/web/request-payloads/university#University-Payload)** Purpose of the university-specific fields: | Field | Description | Type | Mandatory | |---|---|---|---| | metadata.customer_product_specialization | Course specialization, such as Business Analytics | String | Yes | | metadata.customer_course_category | Course category, such as UG, PG, or diploma | String | Yes | | metadata.customer_course_year | Academic or admission year | String | Yes | | metadata.customer_course_month | Academic or admission month | String | Yes | | metadata.customer_current_semester | Student’s current semester | String | Yes | | metadata.customer_fee_payment_type | Fee category, such as semester or annual fee | String | Yes | | metadata.customer_fee_payment_tenure | Tenure of the Fee Payment Type | String | Yes | 7. **Coaching:** Coaching, certification, and exam-preparation financing with expanded applicant and institute information. **Request payload:** **[Open Coaching request JSON](/hyper-credit/web/request-payloads/coaching#Coaching-Payload)** Purpose of the Coaching-specific fields: | Field | Description | Type | Mandatory | |---|---|---|---| | metadata.coachingExamName | Exam or certification associated with the coaching course | String | Yes | | metadata.coachingCourseMode | Course mode, such as online or offline | String | Yes | | metadata.instituteName | Name of the coaching institute | String | Yes | | metadata.companyName | Customer’s employer or associated company | String | Yes | > **Note** > Required parameters vary by lender. Always consult your Juspay SPOC for the exact parameter list before building your Session API call. ## **Status APIs** ### **[Order Status API](/hyper-credit/web/status-tracking/status-apis#Order-Status-API)** **[:](/hyper-credit/web/status-tracking/status-apis#Order-Status-API)** This server-to-server API provides a high-level overview of a transaction's lifecycle within the Juspay ecosystem. By polling the Order Status API, you can track the broad state of an order—from initial creation to final success, failure, or expiry—to manage standard order fulfillment. Integrate as outlined [here](https://juspay.io/in/docs/hyper-checkout/web/base-sdk-integration/order-status-api).  ### **[Loan Status API](/hyper-credit/web/status-tracking/status-apis#Loan-Status-API)** **[:](/hyper-credit/web/status-tracking/status-apis#Loan-Status-API)** This API offers deeper, real-time visibility into the specific loan application and its financing journey. It tracks granular loan application sub-statuses like KYC completion, offer selection, and final loan disbursement. Real-time customer progress can be tracked and customer drop-off stages can be identified. Integrate as outlined[](/hyper-credit/web/status-tracking/status-apis#Loan-Status-API)[here](/hyper-credit/web/status-tracking/status-apis#Loan-Status-API). > **Note** > _Please note that Loan Status API is optional; integrate this functionality only for tracking the status of the loan application._ ## **Webhooks** Webhooks are direct, real-time notifications sent to your server whenever key events occur in the order—such as Order Created or Order Successful and the loan application journey—such as KYC Completed or Loan Active. **Order Webhooks:** Please refer [here](/hyper-checkout/web/base-sdk-integration/webhooks) for the webhook payload to track the order status.  **Loan Webhooks:** Please refer [here](/hyper-credit/web/status-tracking/webhooks#Loan-Webhooks:) for the webhook payload to track the order status. While configuring Loan webhooks is optional, we highly recommend using them alongside the Order Status API. Relying solely on API polling can cause delays if a status changes between your requests. Webhooks eliminate this gap by instantly pushing updates to your system, ensuring you can provide timely, accurate order updates to your customers. **Note:** Loan Webhooks cannot be enabled directly by the merchant. To configure them, please reach out to the Juspay HyperCredit team with your preferred server path and domain details. --- ## See Also - [Pre-Requisites](https://juspay.io/in/docs/hyper-credit/web/checkout-financing/pre-requisites) - [Overview](https://juspay.io/in/docs/hyper-credit/web/smartconvert/overview)