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

Set/Reset MPIN

The merchant can call this API to allow a customer to set/reset their Bank/Credit Account MPIN via respective Debit card/ Credit card/ Aadhaar OTP flow as applicable.

For Aadhaar OTP flow, a prior Get Accounts call will have to be done with additional parameter aadhaarConsent as true after taking user’s consent on set Mpin screen. In response of the same if aadhaarEnabled parameter is true, then only allow user to set Mpin via Aadhaar flow based on the first 6 digit’s of Aadhaar entered by user.

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

Action to be performed on SDK

Example:- upiSetMpin

                      customerVpa
                      *
                      

String

Mandatory

VPA of the customer linked to account

                      card
                      
                      

String

Conditional

The last 6 digits of customer's card. Applicable for set mpin using card .

                      expiry
                      *
                      

String

Mandatory

Expiry date for the customer's card in MMYY format

                      getCardDetailsInCL
                      
                      

String

Optional

True when Card Details to be taken in NPCI CL screen instead of own designed screens. Applicable for set mpin using card.

Example: True/False

                      aadhaarNo
                      
                      

String

Conditional

First six digits of customer's Aadhaar number. Applicable for set Mpin via Aadhaar OTP Flow

Example: 111122

                      aadhaarConsent
                      
                      

boolean

Conditional

Aadhar Consent either be True or False. Applicable for set Mpin via Aadhaar OTP Flow

Example:- True/false

                      upiRequestId
                      *
                      

String

Mandatory

Unique identifier (uuid) for the request sent to NPCI

                      accountReferenceId
                      *
                      

String

Mandatory

Unique Identifier for the account for which Mpin is to be set

                      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

                      merchantChannelId
                      *
                      

String

Mandatory

As provided by Juspay.

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.

                      signature
                      *
                      

String

Mandatory

Base 64 encoding of signaturePayload and Protected .