Ch 3 - (08/20/2019) Added displayExitButton option to the Payment CCA section of external facing documentation

Owned by Doug O'Bryon (Unlicensed)
Last updated: Aug 20, 2019
2 min read


***Changes made on 08/20/2019 are delineated below in Red.***

Added displayExitButton option to the Payment CCA section of our external facing documentation


Payment

CCA

An object to describe how you want the user interactions to behave. Currently this configuration only applies to CCA.

Field
Type
Default
Description

viewstringmodal

What type of UI experience to use when Songbird injects payment brand UI elements into the page.

Possible Values:

  • modal - Render as a modal window. This view type renders the payment brand over your page, making it feel separate from your page.

frameworkstringcardinal

What kind of view framework should be used to render the payment brand. If your site is using a supported framework and you have custom styles applied to it, we will use that framework to make keep the consistent look and feel of your site.

When using any other frameworks than 'cardinal' your site is responsible for including the framework assets including CSS, JavaScript, and any other additional files needed.


Possible Values:

  • cardinal - Use the custom Cardinal view framework built and maintained by CardinalCommerce. Songbird will handle all UI rendering and styles, no additional work is needed.
  • inline - Render inline to the page. This view type embeds the payment brand into the page making it feel like it's a part of your website.
  • bootstrap3 - Use bootstrap 3 modal to render the UI elements.

(Note:  For more information regarding choosing your framework visit View Frameworks#Inline).


displayLoadingbooleanfalse

A flag to enable / disable a loading screen while requests are being made to Centinel API services. This can provide feedback to the end user that processing is taking place and they should not try to reload the page, or navigate away.


displayExitButton
falseBoolean
  • false - Disables the exit icon on the modal
  • true - Enables the exit icon on the modal
Will display an X icon in the corner of the modal window to allow for end users to close the authentication modal without completing it. Clicking the close button will result in the payments.validated event to be triggered with a 10011error, Canceled by user