Transaction Signing with UI
Mandatory Server Settings | KONY_APP_KEY |
<App key of the fabric application> (e.g., h728h89031832jdy9292) |
---|---|---|
KONY_APP_SECRET |
<App secret of the fabric application> (e.g., 89bv2894673792003jy2) |
Transaction Signing Component Properties
S.No. | Property Name | Purpose |
---|---|---|
1 |
username |
This property is used to set the username to the component. |
2 | tds | This property is used to define transaction message. |
3 | isRMSEnabled | This property identifies whether RMS is active or not. |
4 | thresholdAmount | This property defines maximum amount per transaction for RMS payments. |
5 | currency | This property defines type of currency for RMS payments. |
Transaction Signing Component Functions
resetUIFieldsPublic |
This function resets the UI to its original state. |
|
|
Parameters |
N/A |
|
Return Type |
Undefined |
initiate |
This function initiates transaction with Approve online.. |
|
|
Parameters |
N/A |
|
Return Type |
Undefined |
changeTSMode |
This function allows user to switch between transaction mode i.e., Approve, Offline, Challenge, and SMS. |
|
|
Parameters |
N/A |
|
Return Type |
Undefined |
Transaction Signing Component Flow
There are three flows in the Transaction Signing component.
- Only one flow can be active at a time, and the required flow can be set to active in the component by selecting the corresponding flex.
- If you do not fill one of the mandatory text field, an error is returned.
Flex name: flxTSApprove – Online
-
The user enters the transaction details (Account, Amount, and a Description) and then clicks Submit.
-
If users have more than one HID Approve device registered, it will list down all the device.
-
The user can select a device to which to send a Push notification.
-
On clicking any of the devices, a notification will be sent to that particular registered HID Approve device from where the user can approve or deny the transaction
-
-
If users have only one device registered, the notification will be sent to that registered HID Approve device from where the user can approve or deny the transaction
Flex name: flxTSOffline – Offline
- In the HID Approve app, the user taps the Signature icon and enters the transaction details (Account, Amount and a Description).
- The user taps on the screen to generate to a Secure Code.
- The user enters the Secure Code in the corresponding field in the portal and clicks Submit.
- The component validates the Secure Code.
They must also enter the same data in the Web channel.
Flex name: flxTSChallenge – Challenge-Response
- The user enters the transaction details (Account, Amount and a Description) and generates a Secure Code.
- In the HID Approve app, the user taps the Challenge-Response icon and enters the Secure Code in the Challenge field and taps the screen to generate the response (Secure Code).
- The user enters the generated response code in the Secure Code field of the portal and clicks Submit.
- The component validates the transaction.
Transaction Component Services
Object Services
ServiceName | DataModel | CustomVerb | Purpose | Input Parameters | Invoking |
---|---|---|---|---|---|
HIDTransactionSigning |
SignatureValidation |
validateSignature |
Offline transaction signing that validates the Transaction details. |
username, password (Secure Code), authType (Default) ClientID (Default) |
HIDChallengeValidationService > signatureValidation |
HIDTransactionSigning |
GenerateChallenge |
generateChallenge |
Generate a Challenge OTP. |
username, deviceId, authType |
HIDChallengeService > generateChallenge |
HIDTransactionSigning |
ChallengeValidation |
validateChallenge |
Validate the Secure Code entered from the HID Approve app. |
username, password, authType |
HIDChallengeValidationService > validate |
HIDTransactionSigning |
ApproveTransactInitiate |
approveTransactInitiate |
Initiate the Push notification on the HID Approve device. |
username |
TransactionSigningApproveInit > initiate |
HIDTransactionSigning |
ApproveStatus |
poll |
Poll to the ApproveCallback service to get the status of the user's response to the HID Approve Push notification. |
mfa_key (authRequest Id from the initiateApprove service response) |
HIDPollConsensus > getHIDApprovalStatus |
HIDTransactionSigning | Devices | searchDevices | Get the list of devices associated with the user. | username | SearchPushDevicesOrch > getDevices |
Fabric Services
Names | Operation Name | Service Type | Description |
---|---|---|---|
ClientIdentity |
- |
Identity |
Fetches the Client Bearer Token |
ClientAuthIdentityWrapper |
getClientBearerToken |
Integration |
IntegrationWrapper of ClientIdentity |
DependencyManager |
|
Integration |
Resolves the dependencies for HIDProcessor.jar. |
TransactionSigningApproveInit |
Initiate |
Integration |
Sends an HID Approve Push notification to the user's registered device. |
HIDPollConsensus |
getHIDApprovalStatus |
Integration |
Java service to fetch the callback response of the HID Approve Push notification. |
HIDChallengeService |
generateChallenge |
Integration |
Service generates a Secure Code |
HIDChallengeValidationService |
validate |
Integration |
Validates the Secure Code obtained from the HID Approve app after validating challenge Secure Code. |
HIDChallengeValidationService |
signatureValidation |
Integration |
Validates the transaction details with the Secure Code obtained from the HID Approve app. |
SearchServices | searchDeviceAuth | Integration | Lists the devices associated with the user. |
Java Services
Service Name | Purpose | Dependencies | Called by (Service Name-Operation) |
---|---|---|---|
HIDPollForConsensus |
Java service which keeps polling for 45 seconds to get the status of the HID Approve Push notification sent to the user. |
|
HIDPollConsensus-getHIDApprovalStatus |
Listener Endpoints (HTTP Servlets)
Name | URL | Purpose | Dependencies |
---|---|---|---|
ApproveCallBackEndpoint |
https://hidglobal-dev.konycloud.com/services/ApproveCallBackEndpoint |
Listen to the callback response sent by the HID Authentication Service for the user's response to the HID Approve Push notification. |
|
Authentication Pre/Post Processors
Names | Description | Used by (ServiceName-Operation) |
---|---|---|
SearchDeviceAuthPostProcessor |
Processes the output of Search devices for user service output to set the friendlyname, start date and expiry date to empty when the particular record in the collection does not have the value. (Post processor to fix the platform issue as collection does not work correctly on the Kony platform). |
SearchServices-SearchDeviceAuth |
Transaction Signing Pre/Post Processors
Names | Description | Used by (ServiceName-Operation) |
---|---|---|
TransactionSigningApprovePreprocessor |
Forms the payload for the HID Approve Push notification. |
TransactionSigningApproveInit - Initiate |