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

Link Account to Vpa

The merchant can call this API to link Vpa to Account

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.

Example:- upiLinkAccount

                      customerVpa
                      *
                      

String

Mandatory

Vpa to be checked

                      accountReferenceIds
                      *
                      

Array of String

Mandatory

Reference IDs of accounts to be linked to vpa

                      udfParameters
                      
                      

String

Optional

Stringified json for udf parameters

                      allowChangingPrimaryAccount
                      
                      

String

Optional

Can primary account be changed? Default: true

                      primaryAccountMapping
                      
                      

String

Optional

Primary Account Mapping. Default: ONE_TO_ALL

Example:- Possible values: ONE_TO_ONE (account in request will be set primary for vpa passed in request) / ONE_TO_ALL (account in request will be set primary for all vpas of a customer) / NONE (account in request will not be set primary for vpa passed in request and already existing entries won't be modified for other vpaaccounts)