Open In-App UPI via Payment Page
Once the IN-APP-UPI is opened, your users can proceed with the transactions.
1. Onboarding & Pay
Unique uuid-v4 string
Example:- $requestId
Value: in.juspay.hyperpay
Parameters required to call Hyper SDK API
Operation to be performed in the SDK. Should be initiate for this call.
Example:- Value: paymentPage
Client Id assigned by juspay. Usual convention is merchant_id_OS
Example: stock_OS
Environment to be used for the session. Accepted values are 'sandbox' or 'production'
Example: sandbox
Bank on which the merchant has been onboarded.
Example: YES_BIZ
Key ID to identify the public-private key pair used for signature generation.
Example: 1234
Value: true
Environment to be used for the UPI. Accepted values are 'sandbox' or 'production'
Example: sandbox
Only required for logging.
Example:- Value: 1
Unique Client id shared during onboarding
Signature payload is a stringified JSON of the details mentioned in the below table.
Unique identifier associated with an account created by juspay.Ex: stock
Any unique reference associated with your customer.
Order id for the transaction.
Amount to be paid
Example: 2.00
Time when request is created in milliseconds.
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
Value: in.juspay.hyperapi
Response Parameters
Operation performed in the SDK.
Example:- Value: onboardingAndPay
Status of the Operation. Possible values : SUCCESS, PENDING, FAILURE, Pay_Failure, BACKPRESS, USER_ABORTED
Example: SUCCESS
Array of bank accounts linked
UPI ID linked to account
Example: abc@xyz
Account Details
Bank Code
Example: 123456
Bank Name
Example: YES Bank
Account Number with last few digits visible
Example: XXXXXXXXX1234
Is MPIN set?
Example:- Value: true/false
Unique Identifier for the account
Example: abcd1234xyz
Is the account primary?
Example:- Value: true/false
Type of account: SAVINGS/CURRENT/OVERDRAFT
Example: SAVINGS
IFSC Code
Example: ABCD0123456
Order id for the transaction
Example: ABCDE12345
Example: moz3hjuAtiiQriCVFBn
Possible values :- true/false
Error Message
Error Code
Value: process_result
2. Onboarding and Create Mandate
This is a conditional step, and is only supposed to be implemented if you have kept shouldCreateMandate as true in ProcessPayload call.
Unique uuid-v4 string
Example:- $requestId
Value: in.juspay.hyperpay
Parameters required to call Hyper SDK API
Operation to be performed in the SDK. Should be initiate for this call.
Example:- Value: paymentPage
Client Id assigned by juspay. Usual convention is merchant_id_OS
Example: stock_OS
Environment to be used for the session. Accepted values are 'sandbox' or 'production'
Example: sandbox
Bank on which the merchant has been onboarded.
Example: YES_BIZ
Key ID to identify the public-private key pair used for signature generation.
Example: 1234
Value: true
Environment to be used for the UPI. Accepted values are 'sandbox' or 'production'
Example: sandbox
Only required for logging.
Example:- Value: 1
If needed to enable the mandates. True: for mandate transaction flow & False : for non mandate transaction flow
Example:- true
Unique Client id shared during onboarding
Signature payload is a stringified JSON of the details mentioned in the below table.
Unique identifier associated with an account created by juspay.Ex: stock
Any unique reference associated with your customer.
Order is for the transaction.
Time when request is created in milliseconds.
Amount.
Example:- eg: Rs 2.00
Currency in which the amount will be added.
Example:- INR
Mobile Number of the customer
Email id of the customer.
Name of the mandate
REQUIRED means that the transaction for this order has to be definitely converted to a mandate. OPTIONAL means that the final decision of conversion of the transaction lies at the /txns api call with the flag 'should_create_mandate
Maximum amount for a mandate.
FIXED, VARIABLE. By default VARIABLE. In case of FIXED amount_rule, amount will be equal to max amount.
Defines the frequency of mandate execution, how often a customer should be charged.Eg: ONETIME, DAILY, WEEKLY, FORTNIGHTLY, MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, YEARLY, ASPRESENTED(By default is considered as aspresented)
Starting date of the mandate.
Ending date of the mandate.
Denotes whether customer's fund should be blocked or not. Only applicable for ONETIME mandate. For recurring mandate it should always be false, for onetime it can be true or false. Default value is false.
Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRENTED recurrencePattern.
Example:- ON/BEFORE/AFTER
Recurrence Value for Mandate. It is not required for ONETIME, DAILY and ASPRENTED recurrencePattern between 1-31 and depends on recurrencePattern.
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
Value: in.juspay.hyperapi
Response Parameters
Operation performed in the SDK.
Example:- Value: onboardingAndPay
Status of the Operation. Possible values : SUCCESS, PENDING, FAILURE, Pay_Failure, BACKPRESS, USER_ABORTED
Example: SUCCESS
Contains relevant mandate data
Amount to be paid
Example: 500.00
Values possible: FIXED/VARIABLE
Example: FIXED
Values possible: true/false
Timestamp upto which mandate creation request is valid. It will only be present if mandate is initiated by PAYEE.
Example:- Timestamp in YYYY-MM-DDTHH:MM:SS+05:30 format, request timestamp plus expiry minutes passed in request.
UPI request id returned by gateway for the mandate
Example: abc12345
Customer reference number (rrn) for the mandate Operation
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.
Response status returned by gateway
Example: SUCCESS
Describes whether PAYER or PAYEE has initiated the mandate.
Example: PAYER
Name of the mandate
Example: Test Mandate
Timestamp of when this request was attempted
Example: 2021-12-30T14:17:06+05:30.
upiRequestId of the create request.
Example: abcd123456
Merchant Category Code of the payee merchant.
Example: 1234
Name of the Payee involved in mandate. It will be present only if role is PAYER.
Example: ABC
VPA of payee
Example: abc@xyz
Name of the Payer involved in mandate. It will be present only if role is PAYEE.
Example: XYZ
Defines whether mandate is revocable by PAYER or not. For onetime mandate it can be true or false. Default value is true.
Example:- Value: true/false
vpa of payer
Example: pqr@xyz
Recurrence Pattern for Mandate
Example: WEEKLY
Recurrence Rule for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern.
Example: ASPRESENTED
Recurrence Value for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern.
Example: 2
Reference url for the mandate. It will be same value if passed in request else it will be a default url.
Example: www.abcxyz.com
Any mandate summary. If passed in request, it will be same in response else a default value is sent.
Example: UPI Mandate
Role of the customer for this mandate.
Example:- Value: PAYER/PAYEE
Describes whether the mandate will be shared with payee or not. For onetime mandate it can be true or false. Default value is true.
Example:- Value: true/false
Type of Mandate Creation
Example: UPI_MANDATE
Unique Mandate Number used for execution of the mandate. Will be sent only if mandate is initiated by Payer.
Example: uniqueMandateNumber@xyz
Date before which mandate can be executed.
Example: 2022/09/20
As passed for validityStart in request
Example: 2022/01/20
Possible values :- true/false
Error Message
Error Code
Value: process_result
For more calls refer this section Management Calls