Additional Processes
1. UPI Onboarding and Mandate Creation
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
This will represent an Array of bank codes for the respective bank accounts. This is a mandatory for TPV use case
Example: ["550055", "551100"]
Defines the initiation mode of the mandate, required only in case of SBMD use case.
Example: 13
Defines the purpose code of the mandate, required only in case of SBMD use case.
Example: 76
It can be either P2P_PAY or P2M_PAY. By default it would be P2M_PAY.
Example: P2M_PAY
Is of the format : tmCode-segmentCode-uccCode-brokerref, required only in case of SBMD use case.
Example: 111-CM-1122334456-brokerref
Value: true
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
Unique Identifier for the order. Should be Alphanumeric with character length less than 21.
Using only sequential or numeric characters is not recommended.
Example: ABC123456789
Any unique reference associated with your customer.
Example: abcde12345
Mandate amount. Numeric String with two decimals
Example: 100.0
Time when request is created in milliseconds.
Example: 1665996901100
This is a mandatory parameter only in case of TPV. Array of bank account hashes generated using below method:
payerAccountHash = 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"]
Example: metadata.YES_BIZ:ABC, metadata.AXIS_BIZ.XYZ
'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'
Example: REQUIRED
Maximum amount for a mandate.
Example: 2000.0
FIXED, VARIABLE. In case of FIXED amount_rule, amount will be equal to max amount. Defaults to VARIABLE
Example: FIXED
Defines the frequency of mandate execution, how often a customer should be charged. It can be ONETIME, DAILY, WEEKLY, FORTNIGHTLY, MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, YEARLY, ASPRESENTED. By Default it is considered as ASPRESENTED
Example: MONTHLY
Sets the end Date when mandates will stop execution
Example: 1665996901100
Marks the start of mandate execution
Example: 1665996902100
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.
Example: true
Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRESENTED recurrencePattern.
Example:- Values: ON/BEFORE/AFTER
Between 1-31 and depends on recurrencePattern
Example:- Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRESENTED 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. 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
Unique uuid-v4 string
Example:- $requestId
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
Value: true
Unique identifier associated with an account created by juspay.
Example: stock
Any unique reference associated with your customer.
Example: abcde12345
Unique Identifier for the order. Should be Alphanumeric with character length less than 21.
Using only sequential or numeric characters is not recommended.
Example: ABC123456789
clientAuthToken
Example: tkn_2p2k1b6d26eg4740b9ef01294d3a43b4
Default 15min (functionality to be extended if configuration to change signature expiry is added)
Example: 2021-07-19T07:20:53.318Z
Reference ID for selected account
Example: ABC123456789
Amount to be paid. Numeric String with two decimals
Example: 2.00
Example: metadata.YES_BIZ:ABC, metadata.AXIS_BIZ.XYZ
'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'
Example: REQUIRED
Maximum amount for a mandate.
Example: 2000.0
FIXED, VARIABLE. In case of FIXED amount_rule, amount will be equal to max amount. Defaults to VARIABLE
Example: FIXED
It can be either P2P_PAY or P2M_PAY. By default it would be P2M_PAY.
Example: P2M_PAY
Defines the frequency of mandate execution, how often a customer should be charged. It can be ONETIME, DAILY, WEEKLY, FORTNIGHTLY, MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, YEARLY, ASPRESENTED. By Default it is considered as ASPRESENTED
Example: MONTHLY
Sets the end Date when mandates will stop execution
Example: 1665996901100
Marks the start of mandate execution
Example: 1665996902100
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.
Example: true
Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRESENTED recurrencePattern.
Example:- Values: ON/BEFORE/AFTER
Between 1-31 and depends on recurrencePattern
Example:- Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRESENTED 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. 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
2. 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