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

International Activation

The UPI enabled customer apps shall provide for customer activation flow in their apps. Activation can be done for a specific time period e.g. for travel duration or enabled till disabled again. The maximum activation period can be of 3 months.

This function is used to capture the activation of UPI International by the user on PSP/Application.

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:- upiInternationalActivation

                      accountReferenceId
                      *
                      

String

Mandatory

reference id for selected accounts

                      upiRequestId
                      *
                      

String

Mandatory

Unique merchant id shared during onboarding

                      ifsc
                      *
                      

String

Mandatory

Account IFSC

                      startDate
                      
                      

String

Optional

Start date of the Activation (yyyy/mm/dd)

Example:- 2023/12/10

                      endDate
                      
                      

String

Optional

End date of the Activation (yyyy/mm/dd)

Example:- 2023/12/20

                      merchantKeyId
                      *
                      

String

Mandatory

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

                      signature
                      *
                      

String

Mandatory

Signature generated for the signaturePayload

Example:-

                      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.

                      requestType
                      *
                      

String

Mandatory

Action to be performed for the International account of the user.

Example:- ACTIVATE/DEACTIVATE/FORCE_QUERY