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

Approve Decline Mandate

This api is to review and take some action on a pending mandate request. requestType can be APPROVE or DECLINE.

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 upiApproveDeclineMandate for this call.

Example:- upiApproveDeclineMandate.

                      requestType
                      *
                      

String

Mandatory

Value: APPROVE or DECLINE

                      merchantKeyId
                      *
                      

String

Mandatory

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

                      merchantRequestId
                      *
                      

String

Mandatory

Merchant generated id for the mandate request.

                      mandateRequestId
                      *
                      

String

Mandatory

upiRequestId used during create or update mandate, present in gatewayMandateId in mandatePayload.

                      signature
                      *
                      

String

Mandatory

Signature generated for the signaturePayload.

                      accountReferenceId
                      *
                      

String

Mandatory

reference id for selected accounts

                      timestamp
                      *
                      

String

Mandatory

Timestamp of when request was initiated.

                      payeeVpa
                      
                      

String

Conditional

VPA of the Payee involved in the mandate. Should be passed only if requestType is APPROVE.

                      payerVpa
                      *
                      

String

Mandatory

VPA of the Payer involved in the mandate.

                      payeeName
                      *
                      

String

Mandatory

Name of the Payee involved in the mandate.

                      amount
                      *
                      

String

Mandatory

Amount for mandate. Numeric String with two decimals

                      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

                      customer_id
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.