--- page_title: Initiating the SDK product: UPI TPAP SDK platform: React Native page_source: https://juspay.io/in/docs/upi-tpap-sdk/react-native/interaction-with-sdk/initiating-the-sdk llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/upi-tpap-sdk/llms.txt --- ## 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: ### Step 1 Import HyperSDK Import the HyperSDK namespace to get access to HyperServices class in your code #### Code Snippets: - #### Functional Code Snippet: ```functional {"success":false,"message":"Failed to fetch snippet"} ``` #### Class Code Snippet: ```class {"success":false,"message":"Failed to fetch snippet"} ``` ### Step 2 Create an instance of HyperServices The SDK exposes the `HyperServices` class. Create an object of this class for all upcoming operations #### Code Snippets: - #### Functional Code Snippet: ```functional {"success":false,"message":"Failed to fetch snippet"} ``` #### Class Code Snippet: ```class {"success":false,"message":"Failed to fetch snippet"} ``` ### Step 3 Create Initiate payload 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. #### Code Snippets: - #### Functional Code Snippet: ```functional {"success":false,"message":"Failed to fetch snippet"} ``` #### Class Code Snippet: ```class {"success":false,"message":"Failed to fetch snippet"} ``` ### Step 3.1 Create Initiate payload For ClientAuthToken Refer to the following table for information about the description and sample payload. #### Code Snippets: - #### Functional Code Snippet: ```functional {"success":false,"message":"Failed to fetch snippet"} ``` #### Class Code Snippet: ```class {"success":false,"message":"Failed to fetch snippet"} ``` ### Initiate Parameters ## Request Payload - **RequestId**: - Description: Unique uuid-v4 string - Value: $requestId - Tags: String, Mandatory - **Service**: - Description: Value: in.juspay.hyperapi - Tags: String, Mandatory - **Payload**: - Description: Parameters required to call Hyper SDK API - Value: - **Action**: - Description: Operation to be performed in the SDK. Should be initiate for this call. - Value: Value: initiate - Tags: String, Mandatory - **ClientId**: - Description: Client Id assigned by juspay. Usual convention is merchant_id - Value: Example: stock - Tags: String, Mandatory - **Environment**: - Description: 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' - Value: Example: sandbox - Tags: String, Mandatory - **IssuingPsp**: - Description: Bank on which the merchant has been onboarded. - Value: Example: YES_BIZ/AXIS_BIZ - Tags: String, Mandatory - **MerchantKeyId**: - Description: Key ID to identify the public-private key pair used for signature generation. - Value: Example: 1234 - Tags: String, Mandatory - **Signature**: - Description: Generated signature for signature payload. See signature generation process in pre-requisites section. - Tags: String, Mandatory - **SignaturePayload**: - Description: Signature payload is a stringified JSON of the details mentioned in the below table. - Value: - **Merchant_id**: - Description: Unique identifier associated with an account created by juspay. - Value: Example: stock - Tags: String, Mandatory - **Customer_id**: - Description: Any unique reference associated with your customer. - Value: Example: abcde12345 - Tags: String, Mandatory - **Timestamp**: - Description: Time when request is created in milliseconds. - Value: Example: 1665996901100 - Tags: String, Mandatory - Tags: String, Mandatory - **ShouldCreateCustomer**: - Description: Value: true - Tags: Boolean, Mandatory - **MerchantLoader**: - Description: 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 - Value: Value: false - Tags: Boolean, Optional - Tags: JSON, Mandatory ## Response Payload - **RequestId**: - Description: Unique uuid-v4 string - Value: $requestId - Tags: String, Mandatory - **Service**: - Description: Value: in.juspay.hyperapi - Tags: String, Mandatory - **Payload**: - Description: Parameters required to call Hyper SDK API - Value: - **Action**: - Description: Operation performed in the SDK. - Value: Value: initiate - Tags: String - **Status**: - Description: Status of the Operation. - Value: Possible values : SUCCESS / FAILURE - Tags: String - Tags: JSON, Mandatory > **Note** > [Click here](../miscellaneous/additional-parameters) for additional initiate parameters #### Code Snippets: - #### Functional Code Snippet: ```functional {"success":false,"message":"Failed to fetch snippet"} ``` #### Class Code Snippet: ```class {"success":false,"message":"Failed to fetch snippet"} ``` ### Step 4 Call initiate 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 > **Warning** > Initiate is a fire-and-forget call. For every HyperService instance you should **call initiate only once.** #### Code Snippets: - #### Functional Code Snippet: ```functional {"success":false,"message":"Failed to fetch snippet"} ``` #### Class Code Snippet: ```class {"success":false,"message":"Failed to fetch snippet"} ``` --- ## Complete Code Reference The following code files are referenced in the steps above: ### App.js ``` {"success":false,"message":"Failed to fetch snippet"} ``` ### InitiatePayload.txt ``` {"success":false,"message":"Failed to fetch snippet"} ``` ### App.js ``` {"success":false,"message":"Failed to fetch snippet"} ``` --- ## See Also - [Adding Frameworks (iOS)](https://juspay.io/in/docs/upi-tpap-sdk/react-native/getting-the-sdk/adding-frameworks) - [Process](https://juspay.io/in/docs/upi-tpap-sdk/react-native/interaction-with-sdk/process)