Skip to main content

Version: 17.10 (EOL)

Form Start

The Form Start command performs a form start operation. This operation ignores the formData parameter value if you provide it.

Support​

Form Start is supported in Transact Manager 17.10 and later releases.

Options​

All options are optional unless otherwise indicated.

OptionDescription
milestonestring (Maximum length 100 characters)

A transaction milestone event to record with the transaction. For example, "Customer Started".

Milestones are used to store transaction analytics information only. Do not store sensitive or PII data in milestones.

These milestones are recorded in the transaction history table for business reporting, and are also published to the Transact licensing service to support custom licensing agreements.

Example​

{
   "type": "formStart",
   "requestKey": "96b45311175fc320d875483950b2847c"
}

Response​

200 OK​

On a successful response, the server returns the existing JSON specifying the form status.

{
    "formStatus": "Opened"
}

400 Bad Request​

On an invalid response, the server sends a JSON error message.