UI Direct Links
1. UPI Transaction History
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 upiUiTransactionHistory for this call.
Example:- Value: upiUiTransactionHistory
Key ID to identify the public-private key pair used for signature generation.
Example: 1234
Offset for transactions to be returned.
Example: 0
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: upiUiTransactionHistory
Status of the Operation. Possible values : SUCCESS/FAILURE
Example: SUCCESS
Possible values :- true/false
Error Message
Error Code
Value: process_result
2. UPI Send Money
This operation lets the user directly access the SendMoney flow.
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 upiUiSendMoney for this call.
Example:- Value: upiUiSendMoney
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
To pay directly to a vpa, it needs to be passed otherwise user is redirected to Recent Transaction, and can choose and pay from them.
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: upiUiSendMoney
Status of the Operation. Possible values : SUCCESS/FAILURE
Example: SUCCESS
Unique Identifier of the account.
Example:- abcde12345abcde
UPI request id returned by gateway for the transaction
Example: ABC123456789
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:- pay
Possible values :- true/false
Error Message
Error Code
Value: process_result
3. UPI Number
This operation lets the user directly access the UPI Number or mapper screen
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 upiUiMapper for this call.
Example:- Value: upiUiMapper
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: upiUiMapper
Status of the Operation. Possible values : FAILURE/BACKPRESS
Example: BACKPRESS
Possible values :- true/false
Error Message
Error Code
Value: process_result
4 UPI Lite Direct link.
This operation lets the user directly access the UPI Lite screen.
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 upiUiLinkedAccounts for this call.
Example:- Value: upiUiLinkedAccounts
This key will be used to identify UPI Lite flow in the SDK.
Example: lite
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: upiUiLinkedAccounts
Status of the Operation. Possible values : BACKPRESS
Example: BACKPRESS
Possible values :- true/false
Error Message
Error Code
Value: process_result
5. UPI Scan Pay
This operation lets the user directly access the QR code scanner, and pay.
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 upiUiScanPay for this call.
Example:- Value: upiUiScanPay
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
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: upiUiScanPay
Status of the Operation. Possible values : SUCCESS/FAILURE
Example: SUCCESS
Unique Identifier of the account.
Example:- abcde12345abcde
UPI request id returned by gateway for the transaction
Example: ABC123456789
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:- pay
Payee Name
Example: ABC
Amount to be paid. Numeric String with two decimals.
Example: 20.00
Example: 2022-01-28T14:44:51+05:30
Possible values :- true/false
Error Message
Error Code
Value: process_result
6. Get Bank List
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 getBankList for this call.
Example:- Value: getBankList
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:- getBankList
Status of the Operation. Possible values : FAILURE / FRESH / BOUND / LINKED. Accounts will be available only in case status is LINKED.
Session token response
It's an array of Vpa Accounts. We will get this only after successful linking of accounts.
UPI ID linked to account
Accounts linked to this vpa
Type of account
Example: Savings
Account Reference Id
Account holder name
Example: ABC
Is mpin set?
Example:- Possible values: true/false
Account Number with last few digits visible
Is this account the primary account
Example:- Possible values: true/false
Account IFSC
Name of branch in which account is registered
Name of bank
IIN Code for the bank
hash bank account
Status of the Operation. Possible values : FAILURE / FRESH / BOUND / LINKED. Accounts will be available only in case status is LINKED.
If the current device is in bound state or not.
Example:- Possible values: true/false
List of linked accounts.
UPI ID linked to account
Accounts linked to this vpa
Type of account
Example: CURRENT
Account Reference Id
Account holder name
Example: ABC
Is mpin set?
Example:- Possible values: true/false
Account Number with last few digits visible
Is this account the primary account
Example:- Possible values: true/false
Account IFSC
Name of branch in which account is registered
Name of bank
IIN Code for the bank
hash bank account
Possible values :- true/false
Error Message
Error Code
Value: process_result
7. My Qr Code
This operation lets the user directly access the My QR code screen.
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 upiUiQrCode for this call.
Example:- Value: upiUiQrCode
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: upiUiQrCode
Status of the Operation. Possible values : BACKPRESS/FAILURE
Example: BACKPRESS
Possible values :- true/false
Error Message
Error Code
Value: process_result
8. Bank Transfer
This operation lets the user directly access the Bank Transfer screen.
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 upiUiBankTransfer for this call.
Example:- Value: upiUiBankTransfer
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: upiUiBankTransfer
Status of the Operation. Possible values : SUCCESS/FAILURE
Example: SUCCESS
Unique Identifier of the account.
Example:- abcde12345abcde
UPI request id returned by gateway for the transaction
Example: ABC123456789
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:- pay
Possible values :- true/false
Error Message
Error Code
Value: process_result
9. Account Management
This operation lets the user directly access the Account Management screen.
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 upiUiLinkedAccounts for this call.
Example:- Value: upiUiLinkedAccounts
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: upiUiLinkedAccounts
Status of the Operation. Possible values : SUCCESS/FAILURE
Example: SUCCESS
Possible values :- true/false
Error Message
Error Code
Value: process_result
10. Transaction Detail
This operation lets the user directly access the Transaction Detail screen.
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 upiUiTransactionDetails for this call.
Example:- Value: upiUiTransactionDetails
JSON containing all transaction related data .
Amount for which the particular transaction was executed. Numeric String with two decimals
Example:- eg : 5000
Response Code received from NPCI
upiRequestId as passed in request
Payee Name
Payee Vpa
Payer Name
Payer Vpa
Remarks for this transaction
Time at which this transaction was executed.
Type of transaction.
If the transaction was P2M transaction or P2P transaction
Example:- true / false
Time after which the transaction would expire
Response Message received from NPCI
Merchant generated id for the mandate request.
If this transaction was self initiated or not
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: upiUiTransactionDetails
Status of the Operation. Possible values : SUCCESS/FAILURE
Example: SUCCESS
Possible values :- true/false
Error Message
Error Code
Value: process_result