Skip to main content

Version: 19.05 (EOL)

User Cancel

The User Cancel command performs a user-initiated cancel abandonment operation.

Support​

User Cancel was introduced in Transact Manager 17.10, and continues to be available in later Transact Manager and Journey Manager 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, "User:Cancelled".

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": "userCancel",
   "requestKey": "96b45311175fc320d875483950b2847c"
}

Response​

The response to this command is based on the standard Open UX API HTTP response. For more information, see HTTP Response.

200 OK​

On a successful response, the server returns the following JSON response message. The form should display the Cancel Success modal page. Generally, the form will not be required to perform any further operations, however, the server may instruct the form to redirect the user to another location.

{
   "formStatus": "Abandoned",
   "redirectUrl": "https://www.mycorp.com/forms/support.htm?submitKey=bb9c87a62c83f2b642240d97edda50a9"
}