JavaScript is disabled. Some features may not work. You can also read the static version: View text version

P2P Create Mandate

Process Parameters

Request

Response

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example: abcd-12345-abcd-12345

                      service
                      *
                      

String

Mandatory

Value: in.juspay.hyperapi

                      payload
                      *
                      

JSON

Mandatory

Parameters required to call Hyper SDK API

                      action
                      *
                      

String

Mandatory

Operation to be performed in the SDK.

Example:- upiCreateMandate

                      accountReferenceId
                      *
                      

String

Mandatory

reference id for account on which mandate is to be created

                      amount
                      *
                      

String

Mandatory

Amount for which mandate is to created. Numeric String with two decimals

Example:- eg: 2.00

                      amountRule
                      *
                      

String

Mandatory

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

                      bankAccountUniqueId
                      
                      

String

Optional

Unique Identifier for bank account across banks

                      blockFund
                      
                      

String

Optional

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
                      
                      

String

Optional

Currency to use

Example:- eg : INR

                      expiry
                      
                      

String

Optional

Expiry date of mandate

                      initiatedBy
                      *
                      

String

Mandatory

Values: PAYER / PAYEE

                      initiationMode
                      
                      

String

Optional

Defines the initiationMode of the mandate

                      mandateName
                      *
                      

String

Mandatory

Name of the mandate

Example:-

mcc

String

Optional

Merchant Category Code

                      merchantKeyId
                      *
                      

String

Mandatory

Key ID to identify the public-private key pair used for signature generation.

                      merchantSignature
                      
                      

String

Optional

Merchant Signature

                      merchantRequestId
                      *
                      

String

mandatory

Merchant generated id for the mandate request.

                      payeeVpa
                      *
                      

String

Mandatory

Payee Vpa

                      payerAccountHash
                      
                      

String

Optional

Payer Account Hash

                      payerRevocable
                      
                      

String

Optional

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

                      payerVpa
                      *
                      

String

Mandatory

Payer Vpa

                      purpose
                      
                      

String

Optional

Defines the purpose code of the mandate

                      recipientName
                      *
                      

String

Mandatory

Recipient Name

                      recurrencePattern
                      *
                      

String

Mandatory

Recurrence Pattern for Mandate. Denotes at what frequency mandate can be executed.

Example:- ONETIME / DAILY / WEEKLY / FORTNIGHTLY / MONTHLY / BIMONTHLY / QUARTERLY / HALFYEARLY / YEARLY / ASPRESENTED

                      recurrenceRule
                      
                      

String

Optional

Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRENTED recurrencePattern.

Example:- ON / BEFORE / AFTER

                      recurrenceValue
                      
                      

String

Optional

Recurrence Value for Mandate. It is not required for ONETIME, DAILY and ASPRENTED recurrencePattern.

Example:- between 1-31 and depends on recurrencePattern.

                      refCategory
                      
                      

String

Optional

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.

                      refUrl
                      
                      

String

Optional

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.

                      remarks
                      
                      

String

Optional

Any mandate summary

                      shareToPayee
                      
                      

String

Optional

                      timestamp
                      *
                      

String

Mandatory

Time of mandate creation

                      transactionReference
                      
                      

String

Optional

Transaction Reference Id

                      transactionType
                      *
                      

String

Mandatory

INTENT_MANDATE / QR_MANDATE

                      upiRequestId
                      *
                      

String

Mandatory

Unique identifier (uuid) for the request sent to NPCI

                      validityStart
                      *
                      

String

Mandatory

Date after which mandate can be executed

                      validityEnd
                      *
                      

String

Mandatory

String with proper date format YYYY/MM/DD

                      signaturePayload
                      *
                      

String

Mandatory

Signature payload is a stringified JSON of the details mentioned in the below table.

                      merchant_id
                      *
                      

String

Mandatory

Unique identifier associated with an account created by juspay.

Example: stock

                      customer_id
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

Example: abcde12345

                      amount
                      *
                      

String

Mandatory

Mandate amount. Numeric String with two decimals

Example: 100.0

                      currency
                      
                      

String

Optional

Currency to use

Example: INR

                      customer_phone
                      
                      

String

Optional

Mobile no

Example: 1234567890

                      customer_email
                      
                      

String

Optional

Customer Email

Example: abc@xyz.com

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.

Example: 1665996901100

                      metadata.<issuing_psp>:madate_name
                      *
                      

String

Mandatory

Example: metadata.YES_BIZ:ABC, metadata.AXIS_BIZ.XYZ

                      options.create_mandate
                      *
                      

String ENUM

Mandatory

Example: REQUIRED

                      mandate.max_amount
                      *
                      

String

Mandatory

Maximum amount for a mandate.

Example: 2000.0

                      mandate.amount_rule
                      *
                      

String ENUM

Mandatory

FIXED, VARIABLE. In case of FIXED amount_rule, amount will be equal to max amount. Defaults to VARIABLE

Example: FIXED

                      mandate.frequency
                      
                      

String ENUM

Optional

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

                      mandate.start_date
                      *
                      

UNIX EPOCH timestamp (UTC timezone)

Mandatory

Sets the end Date when mandates will stop execution

Example: 1665996901100

                      mandate.end_date
                      *
                      

UNIX EPOCH timestamp (UTC timezone)

Mandatory

Marks the start of mandate execution

Example: 1665996902100

                      mandate.block_funds
                      
                      

Boolean

Optional

Example: true

                      mandate.rule_type
                      
                      

String

Optional

Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRESENTED recurrencePattern.

Example:- Values: ON/BEFORE/AFTER

                      mandate.rule_value
                      
                      

String

Optional

Between 1-31 and depends on recurrencePattern

Example:- Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRESENTED recurrencePattern.

                      signature
                      *
                      

String

Mandatory

Signature generated for the signaturePayload .