API Overview - HyperPulseX

REST API that handles all the campaigns from 3rd party sources.

JSON API should include the following request headers and payload (request body) parameters as per the requirement. Any invalid parameters will be ignored or request discarded by service.

Last Change on: 7th March 2025

Authored by: Mod91 Team / HyperPulseX

Request Header:

Parameter

Type

Description

Mandatory

clientId

String

API client reference string. Shared by HyperPulseX

Y

dateTime

Timestamp

Timestamp including milliseconds.

Y

hmac

String

Generated HMAC value of request payload.

Y

clientId: Shared by Synergistic Financial Networks Pvt. Ltd (Mosambee) with client after successful setup of client in API platform system.

dateTime: timestamp in milliseconds. Ex – 1655780920129, if date time is Tuesday, June 21, 2022 3:08:40.129 AM

hmac: Client generate HMAC with shared secret key and request body payload.

algorithm: HmacSha512

hmac = encodeBase64(hmac(‘clientId + datetime +request payload’, ‘secret key’))

Request Payload (Body):

Parameter

Type

Description

Mandatory

clientId

String

Client reference or identifier value provided by Mosambee.

Y

encRequestMsg

String

Encrypted value of request payload. Refer API section for fields detail.

Y

Request Payload Encryption:

Each request JSON object or array is encrypted using symmetric key and generated cipher text value will be the final data used in encRequestMsg field.

Algorithm: AES, Mode: GCM, Padding: NoPadding, Key Size: 256 Bits

Last updated

Was this helpful?