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

Update/Revoke Mandate

This api will be used for updating / revoking a mandate. requestType can be UPDATE or REVOKE. Only amount and validityEnd can be updated. If requestType is REVOKE then the mandate will be revoked.

Only the entity (PAYER/PAYEE) whoever has initiated the create mandate request can UPDATE the 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. Should be upiUpdateRevokeMandate for this call.

Example:- upiUpdateRevokeMandate

                      accountReferenceId
                      *
                      

String

Mandatory

reference id for selected accounts

                      amount
                      *
                      

String

Mandatory

Amount for mandate . Updated amount if requestType is UPDATE. Numeric String with two decimals

                      expiry
                      
                      

String

Conditional

Required for UPDATE request

                      initiatedBy
                      *
                      

String

Mandatory

Who has created this update/revoke request. Possible values :- PAYER / PAYEE

Example:- Possible values :- PAYER / PAYEE

                      orgMandateId
                      *
                      

String

Mandatory

gatewayMandateId returned during create mandate

                      payeeVpa
                      
                      

String

Mnadatory

VPA of the Payee involved in the mandate.

                      payerVpa
                      *
                      

String

Mandatory

VPA of the Payer involved in the mandate.

                      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

Example:- Possible values: UPDATE / REVOKE

                      timestamp
                      *
                      

String

Mandatory

Timestamp of when request was initiated.

                      upiRequestId
                      *
                      

String

Mandatory

Unique request id for upi transaction

                      validityEnd
                      
                      

String

Optional

Required for UPDATE request

                      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

                      signaturePayload
                      *
                      

String

Mandatory

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

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for the customer.

                      merchantId
                      *
                      

String

Mandatory

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

                      amount
                      *
                      

String

Mandatory

Amount to be paid. Numeric String with two decimals

Example:- eg: 2.00

                      currency
                      
                      

String

Optional

Currency to use

Example:- eg: INR

                      merchantChannelId
                      *
                      

String

Mandatory

As provided by Juspay.

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.