Additional Processes
1. UPI Mandate Creation (onboardingAndPay)
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 onboardingAndPay for this call.
Example:- Value: onboardingAndPay
Unique identifier associated with an account created by juspay.
Example: stock
Value: true
Protected payload is a stringified JSON of the details mentioned in the below table.
Key ID to identify the public-private key pair used for signature generation.It will be provided to you by the Juspay team.
Example: uat833359804655gg748702e324111
Algorithm to generate JWS signature in respect to base 64.
Example:- RS256
Generated by base 64 encoding of signaturePayload and Protected.
Base 64 encoded stringified signature payload
Unique identifier associated with an account created by juspay.
Example: stock
As provided by Juspay.
Example: ABC123
Amount to be paid. Numeric String with two decimals. If it's use for mutual funds then total amount of the mutual fund would be considered.
Example: 2.00
Currency code
Constraints:String - INR
Rule on Mandate Amount. If amountRule is MAX, then mandate can be executed for amount less than or equal to the passed amount . If amountRule is EXACT, then mandate should always be executed for the same amount.
Constraints:MAX,EXACT
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. If blockFund and payerRevocable are both send false for a request then request will be rejected. Default value is false.
Constraints:String - true,false
Merchant generated unique request Id for the transaction.
Example: ABC123456789
Any unique reference associated with your customer.
Example: abcde12345
Time when request is created in milliseconds.
Example: 1665996901100
Name against which mandate is triggered. If initiatedBy is PAYER then payeeName or vice-versa. If name is not present with merchant payerVpa can be sent.
Recurrence Pattern for Mandate. Denotes at what frequency mandate can be executed.
Constraints:ONETIME, DAILY, WEEKLY, FORTNIGHTLY,MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, YEARLY, ASPRESENTED
Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRENTED recurrencePattern.
Constraints:ON, BEFORE, AFTER.
Recurrence Value for Mandate. It is not required for ONETIME, DAILY and ASPRENTED recurrencePattern.
Constraints:between 1-31 and depends on recurrencePattern.
Name of the mandate
Vpa of the payee.
Constraints:Valid VPA
Defines whether mandate is revocable by PAYER or not. Applicable only when it is ONETIME mandate and initiatedBy PAYEE. For recurring mandate it should always be true, for onetime it can be true or false. If blockFund and payerRevocable are both send false for a request then request will be rejected. Default value is true.
Constraints:String - true/false.
Date before which mandate can be execute
Constraints:String with proper date format YYYY/MM/DD
Date after which mandate can be executed
Constraints:String with proper date format YYYY/MM/DD
Reference url for the mandate. It is mainly kept for future purpose for invoice in inbox feature, if nothing is passed then a default value is set for this tag and same will be send back in response.
Any mandate summary
Descibes whether mandate will be shared with payee or not. Required only when it is ONETIME mandate and initiatedBy PAYER. For recurring mandate it should always be true, for onetime it can be true or false. Default value is true.
Constraints:String - true,false
Array of bank account hashes generated using below method:
bankAccountHashes = sha256( account Number + first 4 digit of account IFSC)
From account Number the leading zeros should be removed and then the hash should be calculated.
Eg: accNo = 0000123456789 ifsc = ABCD0000345
Hash will be calculated on 123456789ABCD
Example: ["fejgfvhef67t376", "gryiu349rewiufdhsy8934"]
Pass false to hide payment status screen. Default value: true
Example:- Possible values: true/false
Array of bank codes for the respective bank accounts.
Example: ["550055", "551100"]
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
Account selected for payment
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
IFSC Code
Example: ABCD0123456
Account selected for payment
UPI ID linked to account
Example: abc@xyz
Accounts linked to this vpa
IIN Code for the bank
Name of bank
Account Number with last few digits visible
Length of mpin
Is mpin set?
Example:- Possible values: true/false
Account Reference Id
Length of OTP
Example: 6
Length of atm pin
Example: 6
Type of account
Example: Savings
Name of branch in which account is registered
Unique Identifier for bank account across banks
Account IFSC
Is this account the primary account
Example:- Possible values: true/false
Name of account holder
Example: ABC
Session token data for the user.
Status of the Operation. Possible values : FAILURE / FRESH / BOUND / LINKED. Accounts will be available only in case status is LINKED.
It's an array of Vpa Accounts. We will get this only after successful linking of accounts.
Vpa
Accounts linked to this vpa
IIN Code for the bank
Name of bank
Account Number with last few digits visible
Length of mpin
Is mpin set?
Example:- Possible values: true/false
Account Reference Id
Length of OTP
Example: 6
Length of atm pin
Example: 6
Type of account
Example: Savings
Name of branch in which account is registered
Unique Identifier for bank account across banks
Account IFSC
Is this account the primary account
Example:- Possible values: true/false
Name of account holder
Example: ABC
If the current device is in bound state or not.
Example:- Possible values: true/false
Contains relevant mandate data
Amount to be paid. Numeric String with two decimals
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