Order Create call for Mandates/ Autopay
To register mandate, pass mandate related parameters in the Create Order API to create a mandate registration order.
Enum: 'REQUIRED' , "OPTIONAL'.
Defines what kind mandate support is available during a session. Required to create a Mandate.
Chose between the follow values based upon requirements :-
REQUIRED : Mandate is must for completing transaction. Only instruments which support Mandate will be shown
OPTIONAL : Mandate is a user choice for completing transaction.
Example:-
OPTIONAL
This is the maximum amount which can be debited via mandate. Required, only when amount type is variable. If amount type is fixed, amount parameter itself will be considered as max amount.
Please be informed that the value assigned to "mandate.max_amount" will be displayed to the user when they open any UPI apps for payment. The value assigned to "amount" field will be used to show the amount on our Hypercheckout page
Example:-
1000.0
Mandate start date in UNIX EPOCH timestamp (UTC timezone). The start date has to be today's date
Example:-
1633087969
Mandate end date in UNIX EPOCH timestamp (UTC timezone). Post end date, mandate will move to EXPIRED state and recurring mandate will not be allowed.
Default: will be Mandate start date + 30 years
Example:-
1633088989
Defines the frequency of mandate execution, how often a customer should be charged.
Data type ENUM:
ONETIME (Supported only by UPI)
DAILY
WEEKLY
FORTNIGHTLY
MONTHLY
BIMONTHLY
QUARTERLY
HALFYEARLY
YEARLY
ASPRESENTED
Default: ASPRESENTED
Note:
1. Daily is not supported by Billdesk and Paytm (For cards)
2. In UPI AutoPay, ONETIME frequency, Mandate is valid only for 90 Days
Example:-
ASPRESENTED
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.
Not required when frequency is ONETIME, DAILY, ASPRESENTED.
For Razorpay, rule_value will be considered as the last date of the week/month/year. For Paytm, rule_value will be considered as today's date/day
Example:-
1
Defines the amount rule for recurring debit.
Data type ENUM: FIXED, VARIABLE.
By default, it is considered as VARIABLE.
Example:-
FIXED
Set to true if funds have to be blocked while a mandate is being created. Should be true for ONETIME and false for Recurring. By default value will be TRUE for ONETIME and FALSE for Recurring.
Example:-
false
Please find below the complete list of parameters for this API.
Unique Identifier for the order. Should be Alphanumeric with character length less than 21.
Example:-
order-id-9876580
Amount that the customer has to pay. Will accept stringified double or integer values with upto two decimal places. For example, "100.15" and "100" are valid input but "100.1532" is not valid.
Example:-
1.00
Client side authenticaion token required for Hyper SDK calls
Example:- Value : true
It is the ID with which merchant refers to a customer object. This id is used to access the stored payment methods, allow EMI transactions and setup subscriptions.
In case of guest login it should be an empty string.
Example:-
customer-id-007
Email address of the customer. If the backend gateway requires it, then you must send this value.
Example:-
test@gmail.com
Mobile number or fixed line number of the customer. If the backend gateway requires it, then you must send this value.
Example:-
9999999912
ISO string of the currency. Use INR for Indian Rupee. Among other accepted values are EUR, USD, GBP. Default value: INR
Short description for the order. We send this information to the backend gateways whenever there is a provision for this.
A fully qualified URL which the customer will be redirected after payment completion. It is also required to provide the control back to SDK after the completion of transaction. This URL shouldn't contain any query parameters or Ip address. This URL takes higher precedence over the common return URL configured in your account settings.
Example:-
https://shop.merchant.com
An identifier for the product. Fits well for impulse purchase usecases.
Example:-
John
Specify your preferred gateway for this order. Refer to mapping here
.
Example:-
15
First name in the billing address
Last name in the billing address
Line1 in the billing address
Line2 in the billing address
Line3 in the billing address
Billing address city
Billing address state
Billing address country
Billing address postal code or zip code
Mobile or phone number in the billing address
ISO Country code Default value: IND
First name in the shipping address
Last name in the shipping address
Line1 in the shipping address
Line2 in the shipping address
Line3 in the shipping address
Shipping address city
Shipping address state
Shipping address country
Shipping address postal code or zip code
Mobile or phone number in the shipping address
ISO Country code Default value: IND
Have questions?
- Need help? Contact support
- LLM? Read llms.txt