Initiating the SDK
To initialise the SDK, client needs to call the initiate SDK API. The initiate api call boots up the SDK and makes it ready for all other operations
Follow the below steps to make an initiate SDK call:
Import the HyperSDK namespace to get access to HyperServices class in your code
The SDK exposes the HyperServices class. Create an object of this class for all upcoming operations
Initiate API takes two parameters as input. One of the parameter is a JSON object referred as InitiatePayload. This payload contains certain key value pairs used by the SDK to perform a successful initiate
Refer to the following table for information about the description and sample payload.
Refer to the following table for information about the description and sample payload.
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 initiate for this call.
Example:- Value: initiate
Client Id assigned by juspay. Usual convention is merchant_id
Example: stock
Environment to be used for the session, while in testing it is sandbox and production when we are moving to releasing this app. Accepted values are 'sandbox' or 'production'
Example: sandbox
Bank on which the merchant has been onboarded.
Example: YES_BIZ/AXIS_BIZ
Key ID to identify the public-private key pair used for signature generation.
Example: 1234
Generated signature for signature payload. See signature generation process in pre-requisites section.
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
Value: true
This key can be passed to so that merchant can show their own loaders and as well get the loader related events from the SDK, by default it’s value is false
Example:- Value: false
Click here
for additional initiate parameters
During its lifecycle, SDK emits multiple events to communicate about the transaction status. All of these events are received by an instance of HyperPaymentsCallbackAdapter.
This callback handler is passed as the second argument to the initiate API call.
The final step is to call the Initiate SDK API.
The initiate method takes two parameters: InitiatePayload and HyperPaymentsCallbackAdapter. Use the functions created in the above steps to create the parameters
Initiate is a fire-and-forget call. For every HyperService instance you should call initiate only once.