JusPayHyperCheckoutResponse
Type: schema
TypeScript Definition
typescript
JusPayHyperCheckoutResponse: {{
id?: string;
status?: string;
order_id?: string;
payment_links?: {
web?: string;
expiry?: string | null;
};
sdk_payload?: {
requestId?: string;
service?: string;
payload?: {
clientId?: string;
merchantId?: string;
clientAuthToken?: string;
clientAuthTokenExpiry?: string;
environment?: string;
orderId?: string;
amount?: string;
action?: string;
customerId?: string;
firstName?: string;
lastName?: string;
returnUrl?: string;
customerPhone?: string;
customerEmail?: string;
currency?: string;
description?: string;
/**
* @description Use for taking consent of subscription payments. If this key is used it will ask user to give consent for subscription payment.
* @constant
*/
"options.createMandate"?: "REQUIRED";
/** @description Maximum amount that can be charged in recurring payment. */
"mandate.maxAmount"?: string;
/** @description subscription start time */
"mandate.start_date "?: string;
/** @description subscription end time */
"mandate.end_date "?: string;
/**
* @description subscription frequency
* @constant
*/
"mandate.frequency"?: "MONTHLY";
/**
* @description When frequency is passed as WEEKLY, FORTNIGHTLY, MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, or YEARLY then is it required that the exact day of the period should be passed.
*
* 1-7 when frequency is WEEKLY. In weekly, serial numbers start from Monday. Monday represents 1 and Sunday represents 7.
*
* 1-16 when frequency is FORTNIGHTLY. This mandate is executed twice a month. First day of the month is represented by value '1' and ends with '15' on 15th day of the month. Then again starts with '1' for 16th of the month and ends with the last day of the month.
*
* 1-31 when frequency is MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, or YEARLY.
* @enum {string}
*/
"mandate.rule_value "?: "1-7" | "1-16" | "1-31";
};
};
/** Format: date-time */
order_expiry?: string;
};
/** JuspayNetBanking */
}OpenAPI Schema
json
{
"title": "JusPayHyperCheckoutResponse",
"type": "object",
"externalDocs": {
"url": "https://llm-docs.commercengine.io/storefront/schemas/JusPayHyperCheckoutResponse",
"description": "API reference for the JusPayHyperCheckoutResponse schema"
},
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"order_id": {
"type": "string"
},
"payment_links": {
"type": "object",
"properties": {
"web": {
"type": "string"
},
"expiry": {
"type": [
"string",
"null"
]
}
}
},
"sdk_payload": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"service": {
"type": "string"
},
"payload": {
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"merchantId": {
"type": "string"
},
"clientAuthToken": {
"type": "string"
},
"clientAuthTokenExpiry": {
"type": "string"
},
"environment": {
"type": "string"
},
"orderId": {
"type": "string"
},
"amount": {
"type": "string"
},
"action": {
"type": "string"
},
"customerId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"returnUrl": {
"type": "string"
},
"customerPhone": {
"type": "string"
},
"customerEmail": {
"type": "string"
},
"currency": {
"type": "string"
},
"description": {
"type": "string"
},
"options.createMandate": {
"description": "Use for taking consent of subscription payments. If this key is used it will ask user to give consent for subscription payment.\n",
"const": "REQUIRED"
},
"mandate.maxAmount": {
"description": "Maximum amount that can be charged in recurring payment.",
"type": "string"
},
"mandate.start_date ": {
"description": "subscription start time",
"type": "string"
},
"mandate.end_date ": {
"description": "subscription end time",
"type": "string"
},
"mandate.frequency": {
"description": "subscription frequency",
"const": "MONTHLY"
},
"mandate.rule_value ": {
"description": "When frequency is passed as WEEKLY, FORTNIGHTLY, MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, or YEARLY then is it required that the exact day of the period should be passed.\n\n1-7 when frequency is WEEKLY. In weekly, serial numbers start from Monday. Monday represents 1 and Sunday represents 7.\n\n1-16 when frequency is FORTNIGHTLY. This mandate is executed twice a month. First day of the month is represented by value '1' and ends with '15' on 15th day of the month. Then again starts with '1' for 16th of the month and ends with the last day of the month.\n\n1-31 when frequency is MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, or YEARLY.",
"type": "string",
"enum": [
"1-7",
"1-16",
"1-31"
]
}
}
}
}
},
"order_expiry": {
"type": "string",
"format": "date-time"
}
}
}Auto-generated from OpenAPI spec and TypeScript definitions