Form Ineligible

The Form Ineligible command performs a form-initiated ineligible operation. This command is used to abandon the transaction after the system has determined that the user is not eligible to complete it. This may be due to geographic restrictions or for some other reason.

Support

Form Ineligible 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.

Option

Description

milestone

string (Maximum length 100 characters) A transaction milestone event to record with the transaction. For example, "Customer 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": "formIneligible",
    "requestKey": "96b45311175fc320d875483950b2847c"
}

Response

info

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 existing JSON similar to the User Save and User Submitt response messages. The form should display a Customer 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/not-available.html?submitKey=bb9c87a62c83f2b642240d97edda50a9"
}

400 Bad Request

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