Ch 2 - (08/19/2019 Update) Moved "inline" Description from View Field to Framework Field

Owned by Daryl Licursi (Unlicensed)
Last updated: Mar 06, 2020
2 min read

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

Moved "inline" description from the View field to the Framework field, and also added a link offering more information for choosing a framework.

Payment

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

Field

Type

Default

Description

Field

Type

Default

Description

view

string

modal

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.

  • inline - Render inline to the page. This view type embeds the payment brand into the page making it feel like its a part of your website.

framework

string

cardinal

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)

displayLoading

boolean

false

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.