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

List Mandate

This api will be used for getting a list of mandates.

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. Should be upiListMandate for this call.

Example:- upiListMandate

                      limit
                      *
                      

String

Mandatory

Maximum number of rows to be returned.

Example:- eg. 100

                      offset
                      *
                      

String

Mandatory

Offset for mandates to be returned.

Example:- 0

                      status
                      *
                      

String

Mandatory

Type of mandates to be returned.

                      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.

                      signature
                      *
                      

String

Mandatory

Signature generated for the signaturePayload .