Skip to content

JuspayPaymentGatewayParams

Type: schema

TypeScript Definition

typescript
JuspayPaymentGatewayParams: {{
            /**
             * @description discriminator enum property added by openapi-typescript
             * @enum {string}
             */
            payment_gateway: "JUSPAY";
            /**
             * @description `paymentPage` is the default option that you should select when using hyper-checkout
             * @enum {string}
             */
            action: "paymentPage" | "paymentManagement";
            /**
             * @description Use `hyper-checkout` for Juspay hosted checkout
             * @enum {string}
             */
            integration_type: "hyper-checkout" | "express-checkout";
            /** @description This is the URL that the gateway will redirect to once payment processing is complete. This will be a GET request by default */
            return_url: string;
            /** @description The exact gateway reference ID that was set up in the integration */
            gateway_reference_id: string;
        };
        /** JuspayPaymentMethod */
}

OpenAPI Schema

json
{
  "title": "JuspayPaymentGatewayParams",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/JuspayPaymentGatewayParams",
    "description": "API reference for the JuspayPaymentGatewayParams schema"
  },
  "required": [
    "payment_gateway",
    "action",
    "integration_type",
    "return_url",
    "gateway_reference_id"
  ],
  "properties": {
    "payment_gateway": {
      "type": "string",
      "default": "JUSPAY",
      "const": "JUSPAY"
    },
    "action": {
      "description": "`paymentPage` is the default option that you should select when using hyper-checkout",
      "type": "string",
      "enum": [
        "paymentPage",
        "paymentManagement"
      ]
    },
    "integration_type": {
      "description": "Use `hyper-checkout` for Juspay hosted checkout",
      "type": "string",
      "enum": [
        "hyper-checkout",
        "express-checkout"
      ]
    },
    "return_url": {
      "description": "This is the URL that the gateway will redirect to once payment processing is complete. This will be a GET request by default",
      "type": "string"
    },
    "gateway_reference_id": {
      "description": "The exact gateway reference ID that was set up in the integration",
      "type": "string"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: