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

P2M Mandate Creation

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:- upiTxn

                      accountRefId
                      *
                      

String

Mandatory

reference id for account on which mandate is to be created

                      shouldCreateMandate
                      *
                      

Boolean

Mandatory

Value: true

                      orderId
                      *
                      

String

Mandatory

Order Id of the transaction

Example: hyperorder87647

                      showConfirmation
                      *
                      

Boolean

Mandatory

Value: false

                      signaturePayload
                      *
                      

String

Mandatory

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

                      merchantId
                      *
                      

String

Mandatory

Unique identifier associated with an account created by juspay. Ex: stock

Example:- stock

                      merchantChannelId
                      *
                      

String

Mandatory

As provided by Juspay.

                      merchantCustomerId
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

                      amount
                      *
                      

String

Mandatory

Amount eg: "2.00" Rs. Numeric String with two decimals

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.

                      merchantRequestId
                      *
                      

String

Mandatory

35 character alphanumeric unique id.

                      mandateName
                      *
                      

String

Mandatory

Name of the mandate, Helps with differentiation of all mandates

                      mandateMaxAmount
                      *
                      

ENUM

String

Mandatory

Maximum amount for a mandate.

                      mandateAmountRule
                      *
                      

ENUM

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:- EXACT / MAX

                      mandateFrequency
                      
                      

String

Optional

Defines the frequency of mandate execution, how often a customer should be charged.

Example:- ONETIME / DAILY / WEEKLY / FORTNIGHTLY / MONTHLY / BIMONTHLY / QUARTERLY / HALFYEARLY / YEARLY / ASPRESENTED / By Default it is considered as ASPRESENTED

                      mandateStartDate
                      *
                      

UNIX EPOCH timestamp (UTC timezone)

String

Mandatory

Marks the start of mandate execution

                      mandateEndDate
                      *
                      

UNIX EPOCH timestamp (UTC timezone)

String

Mandatory

Sets the endDate when mandates will stop execution

                      mandateBlockFunds
                      
                      

Boolean

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

                      mandateRuleType
                      
                      

String

Optional

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

Example:- Values possible : ON, BEFORE, AFTER.

                      mandateRuleValue
                      
                      

String

Optional

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

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

                      metadata.<issuing_psp>:gateway_reference_id
                      
                      

String

Conditional

In case of multiple merchant VPAs, this field needs to be passed. It can be obtained from the dashboard. Issuing_PSP will be either AXIS_BIZ or YES_BIZ.

Value: ABC123

                      signature
                      *
                      

String

Mandatory

Base 64 encoding of signaturePayload and Protected .

                      protected
                      *
                      

String

Mandatory

Base 64 encoding of the below parameters.

                      kid
                      *
                      

String

Mandatory

Key ID to identify the public-private key pair used for signature generation.It will be provided to you by the Juspay team.

Example: uat833359804655bb748702e324111

                      Alg
                      *
                      

String

Mandatory

Asymmetric algorithm used. Will be RS256 in this case..

Example:- RS256