Skip to content

PayuPaymentInfo

Type: schema

TypeScript Definition

typescript
PayuPaymentInfo: {{
            key?: string;
            txnid?: string;
            /** Format: double */
            amount?: number;
            productinfo?: string;
            firstname?: string;
            lastname?: string;
            email?: string;
            phone?: string;
            /**
             * @description To be used in case we want to take consent for subscription payment.
             *     To create consent for subscription, value of this parameter must be 1.
             * @constant
             */
            si?: 1;
            /** @description Send this json object for creating subscription consent. */
            si_details?: {
                /**
                 * Format: double
                 * @description Maximum amount that can be charged in recurring payment.
                 */
                billingAmount?: number;
                /** @constant */
                billingCurrency?: "INR";
                /**
                 * @description Subscription frequency.
                 * @constant
                 */
                billingCycle?: "MONTHLY";
                /**
                 * @description Billing Interval is closely coupled with the billingCycle field and denotes at what frequency, the subscription plan needs to be executed. For monthly subscriptions, parameter values need to be sent in the request are:
                 *     billingCycle = MONTHLY
                 *     billingInterval = 1
                 *     Similarly, by keeping the following values, customer will be charged once in every 3 days:
                 *     billingCycle = DAILY
                 *     billingInterval = 3
                 */
                billingInterval?: number;
                /**
                 * Format: date
                 * @description subscription start date
                 */
                paymentStartDate?: string;
                /**
                 * Format: date
                 * @description subscription end date
                 */
                paymentEndDate?: string;
            };
            /** @description return url in case of payment failure. */
            furl?: string;
            /** @description return url in case of payment success. */
            surl?: string;
            hash?: string;
        };
        /** PayuPaymentMethod */
}

OpenAPI Schema

json
{
  "title": "PayuPaymentInfo",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/PayuPaymentInfo",
    "description": "API reference for the PayuPaymentInfo schema"
  },
  "properties": {
    "key": {
      "type": "string"
    },
    "txnid": {
      "type": "string"
    },
    "amount": {
      "type": "number",
      "format": "double"
    },
    "productinfo": {
      "type": "string"
    },
    "firstname": {
      "type": "string"
    },
    "lastname": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "si": {
      "description": "To be used in case we want to take consent for subscription payment.\nTo create consent for subscription, value of this parameter must be 1.",
      "const": 1
    },
    "si_details": {
      "description": "Send this json object for creating subscription consent.",
      "type": "object",
      "properties": {
        "billingAmount": {
          "description": "Maximum amount that can be charged in recurring payment.",
          "type": "number",
          "format": "double"
        },
        "billingCurrency": {
          "const": "INR"
        },
        "billingCycle": {
          "description": "Subscription frequency.",
          "const": "MONTHLY"
        },
        "billingInterval": {
          "description": "Billing Interval is closely coupled with the billingCycle field and denotes at what frequency, the subscription plan needs to be executed. For monthly subscriptions, parameter values need to be sent in the request are:\nbillingCycle = MONTHLY\nbillingInterval = 1\nSimilarly, by keeping the following values, customer will be charged once in every 3 days:\nbillingCycle = DAILY\nbillingInterval = 3",
          "type": "integer"
        },
        "paymentStartDate": {
          "description": "subscription start date",
          "type": "string",
          "format": "date"
        },
        "paymentEndDate": {
          "description": "subscription end date",
          "type": "string",
          "format": "date"
        }
      }
    },
    "furl": {
      "description": "return url in case of payment failure.",
      "type": "string"
    },
    "surl": {
      "description": "return url in case of payment success.",
      "type": "string"
    },
    "hash": {
      "type": "string"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: