Skip to content

Checkout Branding

Checkout Branding page showing the six collapsible sections alongside a Work in Progress preview panel

Checkout Branding controls how a brand appears to customers during the checkout process — logos, icons, brand colours, semantic theme palettes, and the copy used in the checkout UI. Changes here affect the live checkout experience for all customers under this brand.

Permissions

ActionPermission required
Edit checkout brandingtenant:update:branding

Sections

The form is organised into six collapsible sections. Expand a section to edit its fields; collapse it to save space. A validation error indicator appears on the section header if any field within it is invalid.

Identity

Identity section expanded showing Brand Name, Portal Name, and Portal Meta Description fields

Core identity strings used in the checkout portal.

FieldDescription
Brand NameThe name shown to customers as the brand (e.g. in page titles and headings)
Portal NameThe name of the checkout portal itself, distinct from the brand name
Portal Meta DescriptionThe HTML <meta name="description"> content for the checkout portal, used by search engines and link previews

Logos

Logos section expanded showing upload fields for Light Theme, Neutral Theme, and Dark Theme logos

Full-width logotype images used in the checkout UI. A separate logo can be supplied for each visual theme so the brand's mark always looks correct against any background.

FieldDescription
Logo for Light ThemeSVG logo displayed when the checkout uses a light theme
Logo for Neutral ThemeSVG logo displayed when the checkout uses a neutral (mid-tone) theme
Logo for Dark ThemeSVG logo displayed when the checkout uses a dark theme

Images are stored as Base64-encoded SVG data URIs.

Icons

Icons section expanded showing square icon upload fields for each visual theme

Square icon images (favicons / app icons) for each visual theme. These appear in browser tabs and as shortcut icons.

FieldDescription
Icon for Light ThemeSquare SVG icon for light theme contexts
Icon for Neutral ThemeSquare SVG icon for neutral theme contexts
Icon for Dark ThemeSquare SVG icon for dark theme contexts

Colors

Colors section expanded showing four brand colour picker fields: Primary, Secondary, Accent, and Tertiary

The four brand colours that seed the checkout palette. These are used directly in UI elements and as the basis for the per-theme colour overrides in the Themes section.

FieldDescription
Brand Primary ColorThe main brand colour — used for primary buttons, links, and key UI elements
Brand Secondary ColorA supporting colour for secondary actions and accents
Brand Accent ColorA highlight colour for emphasis elements
Brand Tertiary ColorA fourth brand colour for additional visual variety

Themes

Themes section expanded showing the Light, Neutral, and Dark sub-tabs each with ten semantic colour fields

Fine-grained semantic colour palettes for each of the three checkout visual themes: Light, Neutral, and Dark. Each theme has the same set of ten colour roles.

FieldDescription
BackgroundPage background colour
SurfaceCard and panel surface colour
HighlightInteractive highlight and focus colour
InfoInformational state colour
SuccessSuccess/confirmation state colour
NotifyNotification/alert state colour
WarningWarning state colour
ErrorError state colour
QuestionQuestion/prompt state colour
CancelCancel/destructive action state colour

Copy & Text

Copy and Text section expanded showing customisable term fields with macro hints

Customisable strings used in the checkout portal UI. Each term supports macro substitution.

TermMacros availableDescription
app.pages.main.titlebrandName, channelNameThe main page title shown in the checkout portal
app.layouts.channel_selection.titlebrandNameThe title shown on the payment channel selection screen

Macros are written as {{macroName}} in the term value and are substituted at render time with the relevant runtime values.

TIP

A right-hand preview panel is planned but not yet available. Save changes and open the checkout portal directly to verify how branding appears to customers.

Saving changes

Click Save to apply all changes across all sections, or Reset to revert to the last saved values. Validation runs across all sections on save — check each section header for error indicators if the save is rejected.