---
page_title: Initiate LSP Journey API
product: HyperCredit
platform: Web
page_source: https://juspay.io/in/docs/hyper-credit/web/hypercredit-checkout/initiate-lsp-journey-api
llms_txt: https://juspay.io/in/docs/llms.txt
product_llms_txt: https://juspay.io/in/docs/hyper-credit/llms.txt
---


# **Initiate LSP Journey API** 



This API is used to initiate the **Juspay-managed Loan Marketplace journey** .

This API will:

* Create or register the financing journey context
* Associate the financing journey with the existing Juspay order
* Accept a merchant redirect URL to which the user should be sent after journey completion
* Return a Juspay-hosted journey URL that the merchant must open in a chrome custom tab or an iframe

This API should be called only when:

* The user has selected the **Loan Marketplace / Instant Loans** option, and
* For Pay-In-3, the **Create Order API** has already been called successfully


#### Header:




| Key | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| x-merchant-id | Text | Yes | Merchant id in Juspay system |
| x-origin | Text | Yes | Pass value “S2S” |
| Content-Type | Text | Yes | application/json |
| x-version | Text | Yes | API version Ex . V1 or V2 |
| x-req-id | Text | Yes | Unique Request Id |
| Authorization | Text | No | Merchant authentication key. |



#### Request Payload:




| Key | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| order_id | Text | Yes | Merchant’s identifier for the order |
| is_ec_merchant | Boolean | Yes | Specifies if the merchant is using EC APIs or PP |
| client_auth_token | Text | Yes | Client Auth token received from Euler Order Create API |



#### Pay-In-3 Request Payload Code Snippet:

```pay-in-3 request payload
{ 
"order_id": "hypercredit_671775568531", 
"is_ec_merchant": true, 
"client_auth_token": 
"tkn_akOI6lcWfPp-9pgOQjfdoYmwgwpmiujiuqdKsK3jBtFk1oT5VWMGKaz70Zlfqpjg_ge 4228xczHPiHdpvA9J0NDaVeYEeO12fopufhToBDg" 
} 

```

#### HyperCredit Request Payload Code Snippet:

```hypercredit request payload
{
  "order_id": "ORDER4567TGHk875",
  "amount": "30500",
  "description": "Complete your payment",
  "currency": "INR",
  "customer_id": "CUST57SDFG",
  "customer_email": "testeml.123@gmail.com",
  "customer_phone": "8667056789",
  "customer_dob": "06-12-1997",
  "customer_first_name": "John",
  "customer_middle_name": "",
  "customer_last_name": "Doe",
  "customer_gender": "Male",
  "customer_marital_status": "Married",
  "customer_highest_education": "Graduate",
  "customer_address_line1": "address line 1",
  "customer_address_line2": "address line 2",
  "customer_state": "Karnataka",
  "customer_pincode": "560095",
  "customer_city": "Bengaluru",
  "customer_employment_type": "salaried",
  "customer_product_name": "abc product",
  "customer_product_tenure": "2",
  "metadata.source": "Online",
  "options.get_client_auth_token": "true",
  "payment_page_client_id": "merchant_client_id",
  "action": "paymentPage",
  "metadata.sdk_payload": "true",
  "metadata.webhook_url": "https://merchant.webhookurl.com/env/webhook_url_response",
  "return_url": "https://merchant.returnurl.com/#thankyoupage"
}

```

#### Existing EC Merchant Request Payload Code Snippet:

```existing ec merchant request payload
{ 
"order_id": "adani_hypercredit_671775568531", 
"is_ec_merchant": true, 
"client_auth_token": 
"tkn_akOI6lcWfPp-9pgOQjfdoYmwgwpmqdKsK3jBtFk1oT5VWMGKaz70Zlfqpjg_ge 4228xczHPiHdpvA9J0NDaVeYEeO12fopufhToBDg" 
} 

```



#### Response Payload:




| Key | Type | Mandatory | Description |
|---|---|---|---|
| order_id | Text | Yes | Merchant’s identifier for the order |
| order_status | Enum | Yes | CREATED|PENDING|CHARGED| PARTIALLY_CHARGED|JUSPAY_DECLINED|MERCHANT_DECLINED|FAILED|REFUNDED |
| payment_links | Payment Link  | No | List of payment  |
| sdk_payload | Text | No | Stringified Json of the sdk payload generated. This can be used to directly open the sdk flow |
| error_info | Error | No | Error message |
| expiry_at | Text | No | Order Expiry time  Timestamp in UTC  Example: 2024-11-09T16:19:55Z |
| id | Text | No | Identifier corresponding to Order Create Request |


**Payment Link:** 


| Key | Type | isMandatory | Description |
|---|---|---|---|
| web | Text | No | link to initiate loan journey |
| mobile | Text | No | link to initiate loan journey |
| iframe | Text | No | link to initiate loan journey. Incase of IFrame, please make sure to enable CORS opener Policy. |


**Error:** 


| Key | Type | isMandatory | Description |
|---|---|---|---|
| code | Text | No | Error code if any |
| message | Text | No | Error message if any |



#### Sample Response Code Snippet:

```sample response
{ 
"order_id": "daakdjsnakjsndjkassdad4rerrvsfrtgrg", 
"order_status": "CREATED", 
"payment_links": { 
"mobile": "https://integ-expresscheckout-api.juspay.in/credit/c/vBzyH7", 
"web": "https://integ-expresscheckout-api.juspay.in/credit/c/vBzyH7", 
"iframe": "https://integ-expresscheckout-api.juspay.in/credit/c/vBzyH7" }, 
"qr_code": null,
"sdk_payload": null, 
"error_info": { 
    "code": "NO_ERROR", 
    "message": "Execution successful", 
    }, 
"status": "SUCCESS", 
"id": "LSPb580e4fabf7a40djiji3598c561bfdad176d9", 
"expiry_at": "2025-05-07T14:35:41Z" 
}

```


> **Note**
> For HyperCredit Payloads, refer to the [[Payload Documentation].](https://juspay.io/in/docs/in/docs/in/docs/hyper-credit/web/checkout-financing/what-youll-integrate#variants)



---

## See Also

- [Create Order API](https://juspay.io/in/docs/hyper-credit/web/hypercredit-checkout/create-order-api)
- [Order Status API](https://juspay.io/in/docs/hyper-credit/web/hypercredit-checkout/order-status-api)