JavaScript is disabled. Some features may not work. You can also read the static version: View text version

ClientAuthToken vs Signature

Outer Payload

The APIs in the doc follow a common top level structure for each request and response body with a common outer payload and an API specific inner payload.

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example: abcd-12345-abcd-12345

                      service
                      *
                      

String

Mandatory

Value: in.juspay.hyperapi

                      payload
                      *
                      

JSON

Mandatory

Parameters required to call Hyper SDK API

Inner Payload

1. Payload structure Signature Support

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example: abcd-12345-abcd-12345

                      service
                      *
                      

String

Mandatory

Value: in.juspay.hyperapi

                      payload
                      *
                      

JSON

Mandatory

Parameters required to call Hyper SDK API

                      merchantKeyId
                      *
                      

String

Mandatory

Key ID to identify the public-private key pair used for signature generation.

                      signature
                      *
                      

String

Mandatory

Signature generated for the signaturePayload.

                      signaturePayload
                      
                      

Parameters required to call Hyper SDK API

                      merchant_id
                      *
                      

String

Mandatory

Unique identifier associated with an account created by juspay.

Example: stock

                      customer_id
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.

2. Payload structure with clientAuthToken

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example: abcd-12345-abcd-12345

                      service
                      *
                      

String

Mandatory

Value: in.juspay.hyperapi

                      payload
                      *
                      

JSON

Mandatory

Parameters required to call Hyper SDK API

                      clientAuthToken
                      *
                      

String

Mandatory

clientAuthToken

                      merchantID
                      *
                      

String

Mandatory

Unique identifier associated with an account created by juspay.

Example: stock

                      customerId
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

Parameters Difference with Example

For a clientAuthToken-based payload, you need to make several changes in the signature-based payload.

First, remove the keys "merchantKeyId," "signature," and "signaturePayload" from the payload. These keys are no longer necessary.

Next, focus on the contents of the "signaturePayload" key. Change all the key names inside the "signaturePayload" object to adhere to the camel case convention. For example, if you have a key named "merchant_id", change it to "merchantId". Apply this transformation to all the keys inside the "signaturePayload" object.

Once you have modified the key names, add them to the "payload" object. You can eliminate the "timestamp" key as well. Refer the below example.

Signature

ClientAuthToken

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example:- $requestId

                      service
                      *
                      

String

Mandatory

Value: in.juspay.hyperapi

                      payload
                      *
                      

JSON

Mandatory

Parameters required to call Hyper SDK API

                      action
                      *
                      

String

Mandatory

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

Example:- Value: initiate

                      clientId
                      *
                      

String

Mandatory

Client Id assigned by juspay. Usual convention is merchant_id

Example: stock

                      environment
                      *
                      

String

Mandatory

Environment to be used for the session. Accepted values are 'sandbox' or 'production'

Example: sandbox

                      issuingPsp
                      *
                      

String

Mandatory

Bank on which the merchant has been onboarded.

Example: YES_BIZ

                      merchantKeyId
                      *
                      

String

Mandatory

Key ID to identify the public-private key pair used for signature generation.

Example: 1234

                      signature
                      *
                      

String

Mandatory

Generated signature for signature payload. See signature generation process in pre-requisites section.

                      signaturePayload
                      *
                      

String

Mandatory

Signature payload is a stringified JSON of the details mentioned in the below table.

                      merchant_id
                      *
                      

String

Mandatory

Unique identifier associated with an account created by juspay.

Example: stock

                      customer_id
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

Example: abcde12345

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.

Example: 1665996901100