Juspay

https://juspay.io/in/docs
Admin
Juspay offers a comprehensive suite of payment products and integrations, enabling businesses to...
Tokens:945,569
Snippets:8,028
Trust Score:9.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Run setup command

Source: https://juspay.io/in/docs/integration-cli/docs/integrate-with-cli/get-started

Execute the setup process using npx or via a global npm installation.

```bash
npx juspay checkout agent-setup
```

```bash
npm install -g juspay  
juspay checkout agent-setup
```

--------------------------------

### Verify installation

Source: https://juspay.io/in/docs/integration-cli/docs/integrate-with-cli/get-started

List all configured agents and their respective scopes to ensure correct setup.

```bash
npx juspay checkout agent-setup list
```

--------------------------------

### SFTP Connection Example

Source: https://juspay.io/in/docs/dashboard/docs/payments/sftp-access-setup

An example of connecting to the Juspay SFTP server using a specific private key and username.

```bash
sftp -i ~/.ssh/juspay_merchant_key.pem merchant_user@sftp.juspay.in
```

--------------------------------

### Install React Plugin

Source: https://juspay.io/in/docs/upi-tpap-sdk/react-native/getting-the-sdk/getting-sdk

Install the hyper-sdk-react package via npm.

```bash
npm install hyper-sdk-react
```

--------------------------------

### Install Hyper SDK Capacitor

Source: https://juspay.io/in/docs/hyper-checkout/capacitor/base-sdk-integration/getting-sdk

Commands to install the SDK package and synchronize the Capacitor project.

```bash
npm install hyper-sdk-capacitor
npx cap sync
```

--------------------------------

### customer_id Example

Source: https://juspay.io/in/docs/ec-api/docs/mandates/list-mandate

Example value for the mandatory customer_id path parameter.

```text
cst_lz7zmpemoo5okgav
```

--------------------------------

### Install Pods

Source: https://juspay.io/in/docs/ec-headless/ios/base-sdk-integration/getting-sdk

Run these commands in your terminal to update the pod repository and install the dependencies.

```bash
pod repo update
pod install
```

--------------------------------

### EMI Plans API Response Example

Source: https://juspay.io/in/docs/payv3/web/base-integration/emi-plans-api

Example JSON response showing EMI plan details including interest, tenure, and processing fees.

```json
"gateway_id": 27,
                                                "supported_features": null
                                            },
                                            {
                                                "gateway": "HDFCBANK_SMARTGATEWAY",
                                                "gateway_id": 202,
                                                "supported_features": null
                                            }
                                        ],
                                        "metadata": null,
                                        "tnc": null,
                                        "additional_processing_fee_info": {
                                            "value": "199.00",
                                            "user_message": "199 + GST",
                                            "fee": "199.00",
                                            "gst": "35.82",
                                            "type": "ABSOLUTE"
                                        },
                                        "total_cashback_amount": null,
                                        "tenure": 6,
                                        "total_instant_discount_amount": null,
                                        "total_monthly_amount_payable": "4384.77",
                                        "additional_processing_fee": "234.82",
                                        "kfs_link": null,
                                        "auth_amount": "25123.25",
                                        "schedule_of_charges": null,
                                        "total_amount_payable": "26308.62",
                                        "additional_discount_amount": null
                                    },
                                    {
                                        "total_interest_amount": "1704.49",
                                        "offer_info": null,
                                        "bank_interest_rate": "16.00",
                                        "offer_type": null,
                                        "offer_ids": null,
                                        "other_payment_info": null,
                                        "product_details": null,
                                        "txn_emi_type": "STANDARD_EMI",
                                        "interest_discount_amount": null,
                                        "supported_gateways": [
                                            {
                                                "gateway": "BILLDESK",
                                                "gateway_id": 27,
                                                "supported_features": null
                                            },
                                            {
                                                "gateway": "HDFCBANK_SMARTGATEWAY",
                                                "gateway_id": 202,
                                                "supported_features": null
                                            }
                                        ],
                                        "metadata": null,
                                        "tnc": null,
                                        "additional_processing_fee_info": {
                                            "value": "299.00",
                                            "user_message": "299 + GST is Applicable",
                                            "fee": "299.00",
                                            "gst": "53.82",
                                            "type": "ABSOLUTE"
                                        },
                                        "total_cashback_amount": null,
                                        "tenure": 9,
                                        "total_instant_discount_amount": null,
                                        "total_monthly_amount_payable": "2980.86",
                                        "additional_processing_fee": "352.82",
                                        "kfs_link": null,
                                        "auth_amount": "25123.25",
                                        "schedule_of_charges": null,
                                        "total_amount_payable": "26827.74",
                                        "additional_discount_amount": null
                                    },
                                    {
                                        "total_interest_amount": "2230.20",
                                        "offer_info": null,
                                        "bank_interest_rate": "16.00",
                                        "offer_type": null,
                                        "offer_ids": null,
```

--------------------------------

### EMI Plans API Request for Cards

Source: https://juspay.io/in/docs/payv3/web/base-integration/emi-plans-api

Example request payload for fetching EMI plans for credit cards.

```json
{
    "cart_amount": "25123.25",
    "emi_plans": {
        "STANDARD_EMI": {
            "CREDIT": {
                "payment_method": "CARD",
                "payment_method_type": "CARD",
                "issuers": [
                    {
                        "emi_bank": "AXIS",
                        "issuer_name": "Axis Bank",
                        "juspay_bank_code": "JP_AXIS",
                        "bank_plan_description": null,
                        "tenures": [
                            {

```

--------------------------------

### EMI Plans API Request for Cards

Source: https://juspay.io/in/docs/payv3/web/base-integration/emi-plans-api

Use these cURL commands to fetch EMI options. The first example is for new cards, while the second includes saved card support via customer_id and get_saved_card_emi_options.

```bash
-H 'Authorization: Basic <base64 of Merchant API Key>' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'x-routing-id: customer_1122'\
--data-urlencode 'order_amount=69999.00' \
--data-urlencode 'merchant_id=<JusPay Merchant ID>' \
--data-urlencode 'mobile_number=9999999999' \
--data-urlencode 'order_basket=[{"id":"491838009","description":"Test Product","quantity":1,"unitPrice":69999.00,"category":"Electronics","sku":"12345","productUrl":"https://www.google.com","sellerType":"VENDOR","customParams":{"name1":"value1","name2":"value2"}}]'
```

```bash
curl --location 'https://sandbox.juspay.in/v2/emi/plans' \
--header 'Authorization: Basic RUZDQzdENEEy*************==' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'x-routing-id: customer_1122' \
--data-urlencode 'order_amount=25123.25' \
--data-urlencode 'merchant_id=Merchant' \
--data-urlencode 'mobile_number=8754102262' \
--data-urlencode 'order_basket=[{"id":"491838009","description":"Test Product","quantity":1,"unitPrice":25123.25,"category":"Electronics","sku":"12345","productUrl":"https://www.google.com","sellerType":"VENDOR","customParams":{"name1":"value1","name2":"value2"}}]' \
--data-urlencode 'customer_id=8754102262' \
--data-urlencode 'get_saved_card_emi_options=true'
```

--------------------------------

### EMI Plans API Response Structure

Source: https://juspay.io/in/docs/payv3/web/base-integration/emi-plans-api

Example JSON response for EMI plans, including card-based and low-cost EMI configurations.

```json
                                    }
                                ],
                                "issuer_name": "ICICI Bank",
                                "emi_bank": "ICICI",
                                "juspay_bank_code": "JP_ICICI",
                                "bank_plan_description": null
                            }
                        ],
                        "payment_method": "CARD",
                        "payment_method_type": "CARD"
                    },
                    "CARDLESS": null,
                    "DEBIT": null
                },
                "LOW_COST_EMI": {
                    "CREDIT": {
                        "issuers": [
                            {
                                "tenures": [
                                    {
                                        "total_interest_amount": "2045.97",
                                        "offer_info": null,
                                        "bank_interest_rate": "15.00",
                                        "offer_type": null,
                                        "offer_ids": null,
                                        "other_payment_info": null,
                                        "product_details": [
                                            {
                                                "interest_discount_amount": "502.46",
                                                "emi_instant_discount_amount": "0.00",
                                                "additional_cashback_info": null,
                                                "emi_cashback_amount": "0.00",
                                                "product_amount": "25123.25",
                                                "product_id": "491838009",
                                                "bank_interest_amount": "2045.97",
                                                "total_amount_payable": "24620.79"
                                            }
                                        ],
                                        "txn_emi_type": "LOW_COST_EMI",
                                        "interest_discount_amount": "502.46",
                                        "supported_gateways": [
                                            {
                                                "gateway": "PINELABS",
                                                "gateway_id": 74,
                                                "supported_features": null
                                            }
                                        ],
                                        "metadata": null,
                                        "tnc": null,
                                        "additional_processing_fee_info": {
                                            "value": "199.00",
                                            "user_message": "199 + GST is Applicable",
                                            "fee": "199.00",
                                            "gst": "35.82",
                                            "type": "ABSOLUTE"
                                        },
                                        "total_cashback_amount": "0.00",
                                        "tenure": 12,
                                        "total_instant_discount_amount": "502.46",
                                        "total_monthly_amount_payable": "2222.23",
                                        "additional_processing_fee": "234.82",
                                        "kfs_link": null,
                                        "auth_amount": "24620.79",
                                        "schedule_of_charges": null,
                                        "total_amount_payable": "26666.76",
                                        "additional_discount_amount": "0.00"
                                    },
                                    {
                                        "total_interest_amount": "3088.15",
                                        "offer_info": null,
                                        "bank_interest_rate": "15.00",
                                        "offer_type": null,
                                        "offer_ids": null,
                                        "other_payment_info": null,
                                        "product_details": [
                                            {
                                                "interest_discount_amount": "0.00",
                                                "emi_instant_discount_amount": "0.00",
                                                "additional_cashback_info": null,
                                                "emi_cashback_amount": "615.51",
                                                "product_amount": "25123.25",
```

--------------------------------

### EMI Plans API Response Structure

Source: https://juspay.io/in/docs/payv3/web/base-integration/emi-plans-api

Example JSON response structure for EMI plans, including card-based and cardless payment method details.

```json
{
                                "type": "ABSOLUTE"
                            },
                            {
                                "additional_processing_fee": "352.82",
                                "bank_interest_rate": "16.00",
                                "tenure": 12,
                                "total_amount_payable": "27353.40",
                                "total_interest_amount": "2230.15",
                                "total_monthly_amount_payable": "2279.45",
                                "total_instant_discount_amount": null,
                                "total_cashback_amount": null,
                                "product_details": null,
                                "supported_gateways": [
                                    {
                                        "gateway": "BILLDESK",
                                        "gateway_id": 27,
                                        "supported_features": null
                                    }
                                ],
                                "metadata": null,
                                "offer_type": null,
                                "offer_ids": null,
                                "interest_discount_amount": null,
                                "additional_discount_amount": null,
                                "tnc": "https://smartgateway.hdfcbank.com/hyper/assets/docs/HDFC-DebitCard-EMI-TermsConditions.html",
                                "txn_emi_type": "STANDARD_EMI",
                                "other_payment_info": null,
                                "kfs_link": "https://sandbox.juspay.in/kfs?token=TkRZMlltVmxOVE00WmpCak5qaGxZekV3TWpSaVkyWTJPRFZqWmpoak5ERXRPSUMyT1FXaExPUEpjdEYyZFZ0NGowVjk4UGVkWFR6ZGxSRXZrUlhOOHNtaFBqdUNjcXRwd2hSbUxsVTdWeURsNXJTKzBaRWFZOVpLUy9aUWovYUF6OFVlcGp6cURocHRNRUI5aDdPdmlmeFhyK1NKL01qUWpLRmthOUpBMkhtNjRYVjgrZnlwamtFSUxaSEU4TytncmFzUXNrSi9SelRySWtWdE8rb0J3V3VQVDNzc2VRUk5aTURqQjFVYnkrNlArNkpIblNtOVhKSWE=",
                                "additional_processing_fee_info": {
                                    "value": "299.00",
                                    "user_message": "299 + GST is Applicable",
                                    "fee": "299.00",
                                    "gst": "53.82",
                                    "type": "ABSOLUTE"
                                },
                                "schedule_of_charges": "https://smartgateway.hdfcbank.com/hyper/assets/docs/HDFC-DebitCard-EMI-ScheduleOfCharges.html",
                                "offer_info": null,
                                "auth_amount": "25123.25"
                            }
                        ]
                    }
                ]
            },
            "CARDLESS": {
                "payment_method": "CONSUMER_FINANCE",
                "payment_method_type": "CONSUMER_FINANCE",
                "issuers": [
                    {
                        "emi_bank": "LAZYPAY_CLEMI",
                        "issuer_name": "LAZYPAY",
                        "juspay_bank_code": "JP_LAZYPAY",
                        "bank_plan_description": null,
                        "tenures": [
                            {
                                "additional_processing_fee": "296.45",
                                "bank_interest_rate": "20.00",
                                "tenure": 3,
                                "total_amount_payable": "25965.25",
                                "total_interest_amount": "842.00",
                                "total_monthly_amount_payable": "8655.00",
                                "total_instant_discount_amount": null,
                                "total_cashback_amount": null,
                                "product_details": null,
                                "supported_gateways": [
                                    {
                                        "gateway": "LAZYPAY",
                                        "gateway_id": 252
                                    }
                                ],
                                "metadata": null,
                                "surcharge_details": null,
                                "offer_type": null,
                                "offer_ids": null,
                                "interest_discount_amount": null,
                                "additional_discount_amount": null,
                                "total_deferred_cashback_amount": null,
                                "tnc": null,
                                "tnc_clauses": null
```

--------------------------------

### EMI Plans API Response JSON

Source: https://juspay.io/in/docs/payv3/web/base-integration/emi-plans-api

Example JSON structure representing EMI plan details for card transactions, including interest, fees, and discount calculations.

```json
{
                                        "kfs_link": null,
                                        "auth_amount": "23123.25",
                                        "schedule_of_charges": null,
                                        "total_amount_payable": "24145.32",
                                        "additional_discount_amount": "2000.00"
                                    },
                                    {
                                        "total_interest_amount": "1439.68",
                                        "offer_info": null,
                                        "bank_interest_rate": "15.00",
                                        "offer_type": null,
                                        "offer_ids": null,
                                        "other_payment_info": null,
                                        "product_details": [
                                            {
                                                "interest_discount_amount": "462.46",
                                                "emi_instant_discount_amount": "2000.00",
                                                "additional_cashback_info": null,
                                                "emi_cashback_amount": "0.00",
                                                "product_amount": "25123.25",
                                                "product_id": "491838009",
                                                "bank_interest_amount": "1439.68",
                                                "total_amount_payable": "22660.79"
                                            }
                                        ],
                                        "txn_emi_type": "LOW_COST_EMI",
                                        "interest_discount_amount": "462.46",
                                        "supported_gateways": [
                                            {
                                                "gateway": "PINELABS",
                                                "gateway_id": 74,
                                                "supported_features": null
                                            }
                                        ],
                                        "metadata": null,
                                        "tnc": null,
                                        "additional_processing_fee_info": {
                                            "value": "299.00",
                                            "user_message": "299 + GST is Applicable",
                                            "fee": "299.00",
                                            "gst": "53.82",
                                            "type": "ABSOLUTE"
                                        },
                                        "total_cashback_amount": "0.00",
                                        "tenure": 9,
                                        "total_instant_discount_amount": "2462.46",
                                        "total_monthly_amount_payable": "2677.83",
                                        "additional_processing_fee": "352.82",
                                        "kfs_link": null,
                                        "auth_amount": "22660.79",
                                        "schedule_of_charges": null,
                                        "total_amount_payable": "24100.47",
                                        "additional_discount_amount": "2000.00"
                                    },
                                    {
                                        "total_interest_amount": "4029.69",
                                        "offer_info": null,
                                        "bank_interest_rate": "15.00",
                                        "offer_type": null,
                                        "offer_ids": null,
                                        "other_payment_info": null,
                                        "product_details": [
                                            {
                                                "interest_discount_amount": "502.46",
                                                "emi_instant_discount_amount": "0.00",
                                                "additional_cashback_info": null,
                                                "emi_cashback_amount": "0.00",
                                                "product_amount": "25123.25",
                                                "product_id": "491838009",
                                                "bank_interest_amount": "4029.69",
                                                "total_amount_payable": "24620.79"
                                            }
                                        ],
                                        "txn_emi_type": "LOW_COST_EMI"
```

--------------------------------

### initiate(InitiatePayload, HyperPaymentsCallbackAdapter)

Source: https://juspay.io/in/docs/upi-tpap-sdk/react-native/interaction-with-sdk/initiating-the-sdk

The initiate method boots up the SDK and prepares it for subsequent operations. This is a fire-and-forget call that should be invoked only once per HyperService instance.

```APIDOC
## initiate(InitiatePayload, HyperPaymentsCallbackAdapter)

### Description
Initializes the HyperSDK. This method must be called to prepare the SDK for all other operations.

### Parameters
- **InitiatePayload** (JSON) - Required - A JSON object containing configuration parameters including action, clientId, environment, issuingPsp, merchantKeyId, signature, and signaturePayload.
- **HyperPaymentsCallbackAdapter** (Object) - Required - An adapter to handle callbacks from the SDK.

### Request Body (InitiatePayload)
- **requestId** (String) - Required - Unique uuid-v4 string.
- **service** (String) - Required - Value: in.juspay.hyperapi.
- **payload** (JSON) - Required - Contains:
  - **action** (String) - Required - Value: initiate.
  - **clientId** (String) - Required - Merchant ID assigned by Juspay.
  - **environment** (String) - Required - 'sandbox' or 'production'.
  - **issuingPsp** (String) - Required - Bank on which the merchant is onboarded.
  - **merchantKeyId** (String) - Required - Key ID for signature generation.
  - **signature** (String) - Required - Generated signature.
  - **signaturePayload** (String) - Required - Stringified JSON containing merchant_id, customer_id, timestamp, and shouldCreateCustomer.
  - **merchantLoader** (Boolean) - Optional - Whether to show merchant-defined loaders.
```

--------------------------------

### Get Order Status Authentication Response

Source: https://juspay.io/in/docs/ec-api/docs/resources/safe-20

Example of the second_factor_response block returned by the getOrderStatus API.

```json
{
"eci": "07",
"cavv": null,
"threeDSVersion": "2.2.0",
"threeDSTransStatusReason": "01",
"threeDSServerTransID": "c10e57e3-7fdd-4f17-b154-1f04515ab426",
"threeDSTransStatus": "N",
"cavvAlgorithm": null,
"threeDSTransId": "3f083000-5050-47a0-b413-f180a490ce85"
}
```

--------------------------------

### Setup HTML Structure

Source: https://juspay.io/in/docs/clicktopay/docs/how-to-integrate/integration-steps

Basic HTML boilerplate required to host the ClickToPay widget container and load the necessary script.

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Click to Pay Integration</title>
</head>
<body>
    <div id="click-to-pay-checkout"></div>
    <script src="https://sandbox.juspay.in/js/click-to-pay.js"></script>
</body>
</html>
```

--------------------------------

### Get Available Mandate Apps

Source: https://juspay.io/in/docs/ec-headless/android/mandates/upiintent-payments

Retrieves a list of all UPI apps installed on the device that support mandate transactions.

```APIDOC
## Get Available Mandate Apps

### Description
This action retrieves the list of all UPI apps available on the device that support mandate transactions. These apps should be displayed to the user according to UPI guidelines.

### Method
SDK Method Call

### Parameters
- **action** (String) - Required - Must be set to 'getMandateApps'.
```

--------------------------------

### Java - Get Session Token Request Payload

Source: https://juspay.io/in/docs/upi-plugin-sdk/android/miscellaneous/get-session-token

Example JSON payload for requesting a session token using the UPI Plugin SDK in Java. Ensure to replace placeholders like <clientAuthToken> with actual values.

```java
{
  "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiGetSessionToken",
    "clientAuthToken": "<clientAuthToken>",
    "authExpiry" : "2023-07-19T14:15:40Z",
    "merchantId": "stock",
    "customerId": "abcde12345"
      }
}
```

--------------------------------

### Get Order Status (Encrypted Request)

Source: https://juspay.io/in/docs/api-reference/docs/express-checkout/order-status-api

This example shows how to fetch order status using an encrypted request with a JWT payload. Replace the placeholder JWT with your actual encrypted payload and ensure the x-merchantid and Authorization headers are correctly set.

```bash
curl --location 'https://sandbox.juspay.in/v4/order-status' \
--header 'Content-Type: application/json' \
--header 'x-merchantid: *****' \
--header 'Authorization: Basic ***********************' \
--data '{ 
    "JWT": "******** Add Encrypted payload Here *********************************************************************************************************************************************************"
}
'

```

--------------------------------

### HyperServices.initiate

Source: https://juspay.io/in/docs/upi-tpap-sdk/ios/interaction-with-sdk/initiating-the-sdk

Initializes the SDK to prepare it for subsequent operations. This method should be called only once per HyperService instance.

```APIDOC
## initiate(payload: InitiatePayload, callback: HyperPaymentsCallbackAdapter)

### Description
Boots up the SDK and makes it ready for all other operations. This is a fire-and-forget call.

### Parameters
- **payload** (InitiatePayload) - Required - A JSON object containing configuration and authentication details.
- **callback** (HyperPaymentsCallbackAdapter) - Required - An instance to handle events emitted by the SDK during its lifecycle.

### Request Example
{
  "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "initiate",
    "merchantKeyId": "<Merchant Key Id>",
    "clientId": "<Client Id>",
    "merchantLoader": false,
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload>",
    "environment": "sandbox",
    "upiEnvironment": "sandbox",
    "issuingPsp": "YES_BIZ",
    "shouldCreateCustomer": true,
    "logLevel": 1
  }
}
```

--------------------------------

### Business Model Example

Source: https://juspay.io/in/docs/payout/docs/integration/order-create

Example value for the businessModel parameter.

```json
Ecommerce
```

--------------------------------

### Initiate UPI SDK in Java

Source: https://juspay.io/in/docs/upi-plugin-sdk/android/interaction-with-sdk/initiating-the-sdk

Call the `initiate` method on the `hyperServicesHolder` to start the SDK, ensuring it's only called once per instance.

```java
//This function initiate the Juspay SDK
    private void initiateUpiSDK() {
        if(!hyperServicesHolder.isInitialised()){
            initiatePayload = createInitiatePayload();
            hyperServicesHolder.initiate(initiatePayload);
        }
    }
```

--------------------------------

### Sample SFTP Connection Command

Source: https://juspay.io/in/docs/dashboard/docs/payments/sftp-access-setup

Use this command to connect to the SFTP server using your private key. Replace placeholders with your actual credentials.

```bash
sftp -i /path/to/private_key.pem <username>@<hostname>
```

--------------------------------

### Payee Type Example

Source: https://juspay.io/in/docs/payout/docs/integration/order-create

Example values for the payeeType parameter.

```json
PARTNER | PUBLTD | PVTLTD | PROP | SOC | TRUST | GOVT
```

--------------------------------

### Document ID Example

Source: https://juspay.io/in/docs/payout/docs/integration/order-create

Example value for the docId parameter.

```json
"OACPS2488J"
```

--------------------------------

### Initialize Hyper Services in Activity

Source: https://juspay.io/in/docs/upi-tpap-sdk/android/miscellaneous/terminate

Instantiate the HyperServiceHolder and set the callback adapter within the onStart lifecycle method.

```kotlin
override fun onStart() {
        super.onStart()
        //block:start:create-hyper-services-instance

        hyperServicesHolder = HyperServiceHolder(this)

        //block:end:create-hyper-services-instance

        initiatePaymentsSDK()
        hyperServicesHolder!!.setCallback(createHyperPaymentsCallbackAdapter())
    }
```
Tokens:
Raw