P2P Create Mandate
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
Value: in.juspay.hyperapi
Parameters required to call Hyper SDK API
Operation to be performed in the SDK.
Example:- upiCreateMandate
reference id for account on which mandate is to be created
Amount for which mandate is to created. Numeric String with two decimals
Example:- eg: 2.00
Rule on Mandate Amount. If amountRule is MAX, then mandate can be executed for amount less than or equal to the passed amount . If amountRule is EXACT, then mandate should always be executed for the same amount.
Example:- MAX / EXACT
Unique Identifier for bank account across banks
Denotes whether customer's fund should be blocked or not. Only applicable for ONETIME mandate. For recurring mandate it should always be false, for onetime it can be true or false. Default value is false.
Example:- true / false
Currency to use
Example:- eg : INR
Expiry date of mandate
Values: PAYER / PAYEE
Defines the initiationMode of the mandate
Name of the mandate
Example:-
Merchant Category Code
Key ID to identify the public-private key pair used for signature generation.
Merchant Signature
Merchant generated id for the mandate request.
Payee Vpa
Payer Account Hash
Defines whether mandate is revocable by PAYER or not. Applicable only when it is ONETIME mandate and initiatedBy PAYEE. For recurring mandate it should always be true, for onetime it can be true or false. Default value is true.
Example:- true / false
Payer Vpa
Defines the purpose code of the mandate
Recipient Name
Recurrence Pattern for Mandate. Denotes at what frequency mandate can be executed.
Example:- ONETIME / DAILY / WEEKLY / FORTNIGHTLY / MONTHLY / BIMONTHLY / QUARTERLY / HALFYEARLY / YEARLY / ASPRESENTED
Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRENTED recurrencePattern.
Example:- ON / BEFORE / AFTER
Recurrence Value for Mandate. It is not required for ONETIME, DAILY and ASPRENTED recurrencePattern.
Example:- between 1-31 and depends on recurrencePattern.
Details for refUrl, whether it is 01 (advertisement), 02(Invoice). If nothing is passed, a default value of `00` is set up and same will be sent back in response.
Invoice as sent by merchant or reference to the mandate in the form of url. If nothing is passed then a default value is set for this tag and same will be send back in response.
Any mandate summary
Time of mandate creation
Transaction Reference Id
INTENT_MANDATE / QR_MANDATE
Unique identifier (uuid) for the request sent to NPCI
Date after which mandate can be executed
String with proper date format YYYY/MM/DD
Signature payload is a stringified JSON of the details mentioned in the below table.
Unique identifier associated with an account created by juspay.
Example: stock
Any unique reference associated with your customer.
Example: abcde12345
Mandate amount. Numeric String with two decimals
Example: 100.0
Currency to use
Example: INR
Mobile no
Example: 1234567890
Customer Email
Example: abc@xyz.com
Time when request is created in milliseconds.
Example: 1665996901100
Example: metadata.YES_BIZ:ABC, metadata.AXIS_BIZ.XYZ
Example: REQUIRED
Maximum amount for a mandate.
Example: 2000.0
FIXED, VARIABLE. In case of FIXED amount_rule, amount will be equal to max amount. Defaults to VARIABLE
Example: FIXED
Defines the frequency of mandate execution, how often a customer should be charged. It can be ONETIME, DAILY, WEEKLY, FORTNIGHTLY, MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, YEARLY, ASPRESENTED. By Default it is considered as ASPRESENTED
Example: MONTHLY
Sets the end Date when mandates will stop execution
Example: 1665996901100
Marks the start of mandate execution
Example: 1665996902100
Denotes whether customer's fund should be blocked or not. Only applicable for ONETIME mandate. For recurring mandate it should always be false, for onetime it can be true or false. Default value is false.
Example: true
Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRESENTED recurrencePattern.
Example:- Values: ON/BEFORE/AFTER
Between 1-31 and depends on recurrencePattern
Example:- Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRESENTED recurrencePattern.
Signature generated for the signaturePayload .

