UPI Management with UI
1. UPI Profile Management
This operation supports all UPI Profile management features.
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
value: in.juspay.hyperapi
Parameters required to call Hyper SDK API
Operation to be performed in the SDK to open the management screen.
Example:- value: management
Key ID to identify the public-private key pair used for signature generation.
Example: 1234
Signature generated for the signaturePayload.
Signature payload is a stringified JSON of the details mentioned in the below table.
Unique identifier associated with an account created by juspay.
Example: stock
Any unique reference associated with your customer.
Example: abcde12345
Time when request is created in milliseconds.
Example: 1665996901100
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
value: in.juspay.hyperapi
Response Parameters
Operation performed in the SDK.
Example:- value: management
Status of the Operation. Possible values : SUCCESS, PENDING, FAILURE
Example: SUCEESS
Possible values :- true/false
Error Message
Error Code
value: process_result
2. UPI Incoming Intent for Collect
This operation will enable the merchant app to accept incoming UPI Intent requests from other apps.
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
value: in.juspay.hyperapi
Parameters required to call Hyper SDK API
Operation to be performed in the SDK. Should be incomingIntent for this call.
Example:- value: incomingIntent
Key ID to identify the public-private key pair used for signature generation.
Example: 1234
It will be provided by the app triggering the merchant app for UPI transaction
Signature generated for the signaturePayload.
Signature payload is a stringified JSON of the details mentioned in the below table.
Unique identifier associated with an account created by juspay.
Example: stock
Any unique reference associated with your customer.
Example: abcde12345
Time when request is created in milliseconds.
Example: 1665996901100
UPI request id returned by gateway for the transaction
Example: ABC123456789
Customer reference number (rrn).
Example: 1234567890
Pass false to hide payment status screen. Default value: true
Example:- Possible values: true/false
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
value: in.juspay.hyperapi
Response Parameters
Operation performed in the SDK.
Example:- value: incomingIntent
Status of the Operation. Possible values : PAYMENT_SUCCESS, PAYMENT_FAILURE, BACKPRESS
Example: PAYMENT_SUCCESS
Unique Identifier of the account.
Example:- abcde12345abcde
Customer reference number (rrn)
Example: 1234567890
Response code returned by gateway for the mandate Operation.
Example: 00
Response message returned by gateway for the mandate Operation.
Example: Your transaction is successful.
Name of the action Performed.
Example:- Possible values: block/spam/approve/decline
Possible values :- true/false
Error Message
Error Code
value: process_result
3. Approve UPI Collect
This operation will enable the merchant app to accept incoming UPI Collect requests from other apps. A merchant server endpoint will be configured on the axis backend. Hook will be triggered to the merchant server, which should be integrated to the merchant app GCM/FCM.
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
value: in.juspay.hyperapi
Parameters required to call Hyper SDK API
Operation to be performed in the SDK. Should be approveCollect for this call.
Example:- Value: approveCollect
Key ID to identify the public-private key pair used for signature generation.
Example: 1234
It will be provided by the app triggering the merchant app for UPI transaction. It should be base64 encrypted
UPI request id returned by gateway for the transaction
Example: ABC123456789
Customer reference number (rrn).
Example: 1234567890
Signature generated for the signaturePayload.
Signature payload is a stringified JSON of the details mentioned in the below table.
Unique identifier associated with an account created by juspay.
Example: stock
Any unique reference associated with your customer.
Example: abcde12345
Time when request is created in milliseconds.
Example: 1665996901100
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
value: in.juspay.hyperapi
Response Parameters
Operation performed in the SDK.
Example:- Value: approveCollect
Status of the Operation. Possible values : SUCCESS/FAILURE/PENDING
Example: SUCCESS
Possible values :- true/false
Error Message
Error Code
value: process_result
4. UPI Incoming Intent for Mandate
This operation will enable the merchant app to accept incoming UPI Intent requests from other apps.
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
value: in.juspay.hyperapi
Parameters required to call Hyper SDK API
Operation to be performed in the SDK. Should be incomingIntent for this call.
Example:- Value: incomingMandate
Key ID to identify the public-private key pair used for signature generation.
Example: 1234
It will be provided by the app triggering the merchant app for UPI transaction
Signature generated for the signaturePayload.
Signature payload is a stringified JSON of the details mentioned in the below table.
Unique identifier associated with an account created by juspay.
Example: stock
Any unique reference associated with your customer.
Example: abcde12345
Time when request is created in milliseconds.
Example: 1665996901100
UPI request id returned by gateway for the transaction
Example: ABC123456789
Customer reference number (rrn).
Example: 1234567890
Pass false to hide payment status screen. Default value: true
Example:- Possible values: true/false
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
value: in.juspay.hyperapi
Response Parameters
Operation performed in the SDK.
Example:- Value: incomingMandate
Status of the Operation. Possible values : PAYMENT_SUCCESS, PAYMENT_FAILURE, BACKPRESS
Example: PAYMENT_SUCCESS
Unique Identifier of the account.
Example:- abcde12345abcde
Details of the incoming mandate from the webhook
Example: abc12345
Customer reference number (rrn)
Example: 1234567890
Response code returned by gateway for the mandate Operation.
Example: 00
Response message returned by gateway for the mandate Operation.
Example: Your transaction is successful.
Name of the action Performed.
Example:- Values: approve/decline
Possible values :- true/false
Error Message
Error Code
value: process_result
5. Approve UPI Mandate
This operation will enable the merchant app to accept incoming UPI Mandate requests from other apps. A merchant server endpoint will be configured on the axis backend. Hook will be triggered to the merchant server, which should be integrated to the merchant app GCM/FCM.
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
value: in.juspay.hyperapi
Parameters required to call Hyper SDK API
Operation to be performed in the SDK. Should be approveMandate for this call.
Example:- Value: approveMandate
Key ID to identify the public-private key pair used for signature generation.
Example: 1234
Details of the incoming mandate from the webhook
Example: abc12345
Customer reference number (rrn).
Example: 1234567890
Signature generated for the signaturePayload.
Signature payload is a stringified JSON of the details mentioned in the below table.
Unique identifier associated with an account created by juspay.
Example: stock
Any unique reference associated with your customer.
Example: abcde12345
Time when request is created in milliseconds.
Example: 1665996901100
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
value: in.juspay.hyperapi
Response Parameters
Operation performed in the SDK.
Example:- Value: approveMandate
Status of the Operation. Possible values : SUCCESS, FAILURE, PENDING, BACKPRESS
Example: SUCCESS
Possible values :- true/false
Error Message
Error Code
value: process_result