postMessage Response (v2 Endpoint)
- Suyash Somani
- Kayleigh LaSalle
- Chris Bohatka
These objects are used in postMessage events between CruiseAPI and the merchant.
Profile Completed
The V1 and V2 profile completed objects are similar, however V2 offers additional information about the data collection to allow merchants to make decisions based on the success or failure of certain data points. For example, if Cardinal is unable to collect “CardinalData”, the merchant could opt to send the 11 required Browser Fields on the cmpi_lookup request to ensure an EMV 3DS transaction can still complete.
postMessage Response -
{
"MessageType": "profile.completed",
"Payload":{
"ActionCode":"SUCCESS",
"SessionId": "0_90de2cfc-f8c7-4793-b4fa-ddd841aa2be8",
"DataSources": {
"CardinalData": {
"Attempted": true,
"Completed": true
},
"MethodUrl": {
"Attempted": true,
"Completed": true
}
}
}
} |
postMessage Response Fields -
Field | Type | Value | Description |
|---|---|---|---|
MessageType | String | profile.completed | The message type for this object |
Payload | Profile Completed Object |
DataSources
Field | Type | Description |
|---|---|---|
CardinalData | Object | An object that describes the collection status of Cardinal data |
MethodUrl | Object | An object that describes the collection status of MethodUrl |
CardinalData Object
Field | Type | Description |
|---|---|---|
Attempted | Boolean | Indicates whether or not the collected device data and an attempt was made to send it to Cardinal's server. |
Completed | Boolean | Indicates whether or not the collected device data, was sent and successfully saved to Cardinal’s server. |
MethodUrl Object
Field | Type | Description |
|---|---|---|
Attempted | Boolean | Indicates whether a Method URL was found and attempted. |
Completed | Boolean | Indicates whether we were notified of the Method URL completion. |