Additional Parameters For Standing Instructions

Usecase	Variable	Type	Description
To enable Standing Instructions on UPI (i.e: UPI Autopay)	mandate.wwww {{parameter}}	Object String	Object containing a mandate detail (all mandate details are listed in mandate.{{parameter}} {object) format) (open table below to view list of parameters):

To enable Standing Instruction on Cards/ Wallet via Paytm Gateway	metadata.wwww {{parameter}}	Object String	Object containing a Metadata parameter (all metadata details are listed in metadata.{{parameter}} (object) format) Note : Applicable only for Paytm. (open table below to view list of parameters):

Mandate Object Parameters: (click to view)

Variable		Type	Description	Default
max_amount	*	String	Maximum amount for a mandate. Mandatory only if `mandate.amount_rule` = VARIABLE.
start_date	*	String	Mandate start date in UNIX EPOCH timestamp (UTC timezone). The start date has to be today’s date. Mandatory only for UPI Mandates
end_date	*	String	Mandate end date in UNIX EPOCH timestamp (UTC timezone), from when a mandate will move to EXPIRED state, and recurring mandate will not be allowed. Mandatory only for UPI Mandates
frequency		String	Defines the frequency of mandate execution, or how often a customer should be charged. (See description below table)	ASPRESENTED
rule_value	*	String	Determines the day of week or month that a mandate will be executed, depending on `mandate.frequency`. (See description below table)
amount_rule		String	Data type: ENUM Possible values: FIXED, VARIABLE. In case of FIXED, `max amount` will be equal to `amount`	VARIABLE
rule_type		String	ON / BEFORE / AFTER For Razorpay, rule_type will be updated to BEFORE. For Paytm, rule_type will be updated to AFTER Note : This parameter was found in the Process Payload, but not in the parameter list for Standing Instructions.
revokable_by_customer		Boolean	Possible Values: TRUE, FALSE If FALSE, the mandate cannot be revoked by the customer once set. It should be TRUE for Recurring and TRUE/FALSE for ONETIME	true
block_funds		Boolean	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.

* = Required
* = Conditional

mandate.frequency / mandate.rule_value definitions: (click to view)

mandate.frequency

Description: Defines the frequency of mandate execution, or how often a customer

should be charged.

Data type: String (ENUM format)

Possible values:

ONETIME, DAILY, WEEKLY, FORTNIGHTLY, MONTHLY, BIMONTHLY,
QUARTERLY, HALFYEARLY, YEARLY, ASPRESENTED

Default: ASPRESENTED

mandate.rule_value

Description: This value determines the day of week or month that a mandate will

be executed, depending on the mandate.frequency.

Data type: String (Integer format)

Possible values:

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, or 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.

Special considerations for certain values of the mandate.rule_value /

mandate.frequency parameters: (click to view)

Calculating the day of mandate execution for certain values of mandate.rule_value when mandate.frequency is set to 'FORTNIGHTLY' or 'MONTHLY'.

mandate.frequency = FORTNIGHTLY:

1. If the value is ‘14’, ‘15’, or ‘16’, and falls on the latter half of February (16th to

28th), then the mandate shall execute on the last day of February.

2. If the mandate start date is 24th January 2018 with value ‘16’, then the first

debit will be on 31st January, followed by 15th February, 28th February,

15th March, 31st March, and so on.

3. If the value is ‘16’, and the month has only 30 days, then the mandate should

execute on 30th.

4. If the mandate start date is 29th January, and the value is ‘4’, then the first debit

will be on 4th February, followed by 19th February, 4th March, and so on.

mandate.frequency = MONTHLY:

1. If the value is ‘29’, ‘30’, or ‘31’, and falls in February, then the mandate shall

execute on the last day of February.

2. If the value is ‘31’, and the next executable month has 30 days, then the

mandate will execute on the 30th.

3. If the mandate start date is 29th January and the value is ‘17’, then the first

debit will be on 17th February.

Metadata Object Parameters: (click to view)

Variable		Type	Description	Default
PAYTM_V2:SUBSCRIPTION_EXPIRY_DATE	*	String	(format -> YYYY-MM-DD) Date till at which subscription date is active will expire.	“2035-12-31”
PAYTM_V2:SUBSCRIPTION_FREQUENCY_UNIT	*	String	This, combined with interval, defines the frequency. The values supported for this attribute currently are: DAY , MONTH, YEAR. If the billing cycle is of 2 months, the value for this attribute would be MONTH.	DAY
PAYTM_V2:SUBSCRIPTION_FREQUENCY	*	String	Combined with `subscriptionFrequencyUnit`, defines the frequency of renewal transaction. If the renewal cycle is of 2 months, attribute values can be: `subscriptionFrequency` : 2, `subscriptionFrequencyUnit` : MONTH. If the renewal cycle is of 15 days, attribute values can be: `subscriptionFrequency` : 15, `subscriptionFrequencyUnit` : DAY	"1"
PAYTM_V2:SUBSCRIPTION_START_DATE	*	String	(format -> YYYY-MM-DD) Date from which to start subscription. Conditionally mandatory if SUBSCRIPTION_GRACE_DAYS is passed. If this is not passed, renewal can be called after 24 hours.
PAYTM_V2:SUBSCRIPTION_GRACE_DAYS	*	String	Number of days after renewal cycle start date for which merchant can send renewal request. Mandatory if `subscriptionStartDate` is sent in request. Conditionally mandatory if SUBSCRIPTION_START_DATE is passed. If this is not passed renewal can be called after 24 hours. (If SUBSCRIPTION_FREQUENCY_UNIT and SUBSCRIPTION_FREQUENCY are not passed (in which case, they are given default values: DAY, 1), then grace days should be 0, as renewal cycle is of 1 day, if entered more than 0, Paytm will invalidate the request)

* = Required
* = Conditional