Songbird Objects

Continue Data

The data object used to restart the session for the transaction that is being continued. Each payment brand that supports continue may have a different object.

CCA Continue

Only used in a Hybrid transaction, this object passes the required data from the merchant to Songbird to render an ACS authentication screen via the Cardinal.continue function.

Key

Description

Type

Required

AcsUrlThe ACSUrl field returned on the CMPI_LOOKUP response from Cardinal CentinelStringY
PayloadThe Payload field returned on the CMPI_LOOKUP response from Cardinal CentinelStringY

Setup Complete Data

This object is returned back to the merchant on the 'payments.setupComplete' event as the first argument.

FieldDescType
sessionIdMerchant Consumer Session Id - This is the consumer's session id assigned to this user by Centinel API.String
modulesAn array of modules that were attempted to be loaded and their status. You can determine which payment brands were loaded successfully and which may have been configured on the merchant account but failed to load properly.Array of Module State Objects
Example setup complete data object
{
  "sessionId": "0_4f85c155-6604-4056-8957-7090412af179",
  "modules": [{
    "module": "CCA",
    "loaded": true
  }]
}

Module State

This object is returned from the 'payments.setupComplete' event within an array and can be used to determine what modules were attempted to be loaded on page load. This object allows you to determine if a payment brand was successfully loaded, or failed to load.

Key

Description

Type

Required

loadedIf the module was successfully loaded or not.BooleanY
modulename of the payment brand / module the report is forStringY