Initiate Payload

HyperSDK offers an easier client-side integration by unifying data and API calls.
Some part of the data required to complete operations which will be common and can be collected before HyperSDK is actually required to continue operation will be added as a part of Initiate payload.

Param Details

Key

Type

Required

Description

action

String

Yes

operation to be performed in the SDK.
Should be initiate for this call.

merchantId

String

Yes

Username of the account that you hold at Juspay

clientId

String

Yes

Unique identifier associated with static resources assigned by juspay.
Format: merchantId_platform ie, If MerchantId is M1
then Client id: M1_android, M1_ios

customerId

String

Yes

Any unique reference associated with your customer.

environment

String

No

Juspay remote environment to be used for completing an operation.
Possible values: <sandbox/prod>
Defaults to production in case not passed.

Input

{
    "requestId" : "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a", 
    "service" : "in.juspay.hyperapi",
    "payload"  : { 
            "action" : "initiate",
        "merchantId" : "<Merchant Id>", 
        "clientId" : "<Client Id>", 
        "customerId" : "<Customer Id>", //Any unique refrences to current customer
        "environment" : "sandbox"|"prod",
    }
}

Output

{
    "service": "in.juspay.hyperapi",
    "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a",
    "payload": {
     "action": "initiate",
     "status": "success"
    },
    "errorMessage": "",
    "errorCode": "",
    "error": false
 }

What’s Next
Did this page help you?