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

UPI Profile Management

This operation supports all UPI Profile management features.

Process Parameters - Signature Support

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 to open the management screen.

Example:- value: management

                      merchantKeyId
                      *
                      

String

Mandatory

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

Example: 1234

                      signature
                      *
                      

String

Mandatory

Signature generated for the signaturePayload.

                      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.

Example: stock

                      customer_id
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

Example: abcde12345

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.

Example: 1665996901100

                      customer_mobile_number
                      
                      

String

Conditional

12 digit mobile number to be passed (with 91 prefix). To be passed when issuing PSP is BHIM or when device binding has to be limited to a particular mobile number.

                      shouldExitOnDeregister
                      
                      

Boolean

optional

This key needs to be passed to exit the user from the sdk flow after delinking.

Example: True/False

Process Parameters - ClientAuthToken Support

Request

Response

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example:- $requestId

                      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 to open the management screen.

Example:- value: management

                      merchantId
                      *
                      

String

Mandatory

Unique identifier associated with an account created by juspay.

Example: stock

                      customerId
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

Example: abcde12345

                      clientAuthToken
                      *
                      

String

Mandatory

clientAuthToken

Example: tkn_2p2k1b6d26eg4740b9ef01294d3a43b4

                      authExpiry
                      
                      

String

Optional

Default 15min (functionality to be extended if configuration to change signature expiry is added)

Example: 2021-07-19T07:20:53.318Z

                      shouldExitOnDeregister
                      
                      

Boolean

optional

This key needs to be passed to exit the user from the sdk flow after delinking.

Example: True/False