These are a list of objects used in the step up portion of the Cardinal CruiseAPI flow.

Post Message Objects

These objects are used in postMessage events between Cardinal CruiseAPI integration and the merchant.

Basic Message Format

The below fields will be included in every message.

Field	Type	Possible Values	Description

Field	Type	Possible Values	Description
MessageType	String	stepUp.acsRedirection stepUp.completion stepUp.error	This field describes the type of object that is being passed on the message.

Step Up Completion

This event can be used to inform the merchant that the step up process has completed and that the next step of the transaction flow should be taken (cmpi_authenticate). This event is not an indicator of the Step Up attempt success or failure. This is equal to receiving a POST request on the Merchants ReturnURL in the older, traditional ReturnURL flow.

Field	Type	Value	Description

Field	Type	Value	Description
MessageType	String	stepUp.completion	The message type for this object
TransactionId	String		The Core transactionId the event is in reference to. This value is first returned on the cmpi_lookup
MD	String		Optional Field. The MD field that the merchant sent on the /StepUp request to CentinelAPI. This can be used to send a merchant transactional identifier, for example a sessionId, on the request to have echoed back when the step up process has competed.

Message Object Sample

{
  "MessageType": "stepUp.completion",
  "TransactionId": "2VXhY9usqpQhb5YN1250",
  "MD": "560bd1aa-9521-41f1-a1f6-a4c846b8683d"
}

Step Up Error

This event informs the merchant that an error was encountered during processing. This message is the end of a step up attempt. There are 2 basic cases where this error can be triggered:

Merchant is using PostMessage completion flow, all errors will be returned via the postMessage API through the browser
Merchant is using ReturnURL completion flow, but Cardinal was unable to recover the ReturnURL.

This sequence of events is highly improbable, yet it serves as a last resort safeguard, aiming to restore control to the merchants.

Please be aware -

Cardinal will always try to include as much data in the error object as possible. However it is possible that the error may occur in such a way that the TransactionId and the MD fields may not be available to include in the error message. Merchants should account for the possibility that those fields maybe missing, or lack values.

MessageType will always be included.

Field	Type	Value	Required	Description

Field	Type	Value	Required	Description
MessageType	String	stepUp.error	Yes	The message type for this object
TransactionId	String		No	Centinel TransactionId is referenced in the event. This value is first returned on the `cmpi_lookup`.
MD	String		No	Optional Field. The MD field sent by the merchant on the /StepUp request to Cardinal. This can be used to send a merchant transactional identifier, for example a sessionId, on the request to have echoed back when the step up process has completed.

Message Object Sample

{
  "MessageType": "stepUp.error",
  "TransactionId": "2VXhY9usqpQhb5YN1250",
  "MD": "560bd1aa-9521-41f1-a1f6-a4c846b8683d"
}

Step Up ACS Page Loaded (Optional)

This event triggers during a the step up flow when the ACS page iframe has triggered the onload event. This informs the merchant that the step up page has properly loaded and redirected to the ACS page. This event is not intended to represent a successfully rendered ACS challenge, as Cardinal is unable to programmatically view or process the contents of the ACS frame due to it being rendered as a cross domain iframe. This is simply intended as a notification that the step up page has properly rendered and submitted to the ACS. While unlikely, it's important to know that it is possible this event can be triggered even if the ACS has rendered an error page.

This event is behind a Payer Authentication configuration Enable Step Up PostMessage is required to be enabled for this event to be available for the merchant

Field	Type	Value	Description

Field	Type	Value	Description
MessageType	String	stepUp.acsRedirection	The message type for this object
TransactionId	String		The Core transactionId the event is in reference to. This value is first returned on the cmpi_lookup

{
  "MessageType": "stepUp.acsRedirection",
  "TransactionId": "Wan8wbhnN45SmHTT2Yg0"
}

Sample Integration

The below sample shows how a merchant could add support for handling all postMessage events available on the StepUp endpoint

1 Post Message Objects
- - 1.1.1 Basic Message Format
- 1.2 Step Up Completion
- 1.3 Step Up Error
- 1.4 Step Up ACS Page Loaded (Optional)
2 Sample Integration