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

Pause / Unpause mandate

This api will be used for PAUSE/UNPAUSE an active mandate. requestType can be PAUSE or UNPAUSE. If requestType is PAUSE then pauseStart, pauseEnd are required. pauseStart and pauseEnd are not required when requestType is UNPAUSE

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

                      accountReferenceId
                      *
                      

String

Mandatory

reference id for selected accounts

                      amount
                      *
                      

String

Mandatory

Amount for mandate. Numeric String with two decimals

Example:- eg. 25.00

                      orgMandateId
                      *
                      

String

Mandatory

gatewayMandateId returned during create mandate

                      pauseStart
                      
                      

String

Optional

Required for PAUSE request

Example:- eg. YYYY/MM/DD

                      pauseEnd
                      
                      

String

Optional

Required for PAUSE request

Example:- eg. YYYY/MM/DD

                      payeeVpa
                      *
                      

String

Mandatory

VPA of the Payee involved in the mandate

                      payerVpa
                      *
                      

String

Mandatory

Payer Vpa

                      payeeName
                      *
                      

String

Mandatory

Name of the Payee involved in the mandate

                      remarks
                      
                      

String

Optional

Any mandate summary. If passed in request, it will be same in response else a default value is send

                      requestType
                      *
                      

String

Mandatory

Possible values: PAUSE/UNPAUSE

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.

                      upiRequestId
                      *
                      

String

Mandatory

Unique request id for upi transaction

                      merchantKeyId
                      *
                      

String

Mandatory

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

                      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. Ex: stock

Example:- stock

                      customer_id
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.

                      amount
                      *
                      

String

Mandatory

Amount for which merchant requested the mandate. Numeric String with two decimals

                      currency
                      
                      

String

Optional

The currency passed during order creation. Default is INR

                      signature
                      *
                      

String

Mandatory

Signature generated for the signaturePayload .