Customize your Android payment terminals with themes

You can create multiple themes to customize the appearance of your Android payment terminals. This allows you to reflect your brand identity and showcase promotions during the payment flow. You can customize these themes for specific terminal models, and apply them at company, merchant account, store, or terminal level.

If you do not create and apply your own theme, your terminals use the default Adyen theme in dark mode.

Requirements

Before you begin, take into account the following requirements, limitations, and preparations.

How it works

You can create and manage themes in two ways:

• In your Customer Area
• Using Management API calls

If you manage multiple merchant accounts, using API calls lets you create and apply themes across accounts without logging in to each one separately.

In both cases, the steps are the same:

1. You create a theme at company or merchant account level and define its general settings: a name and dark or light mode.

2. You add images or videos (referred to as assets) for each combination of terminal model and screen type that you want to customize. You can customize the following screen types:

   • Logo: your brand logo.

     A logo uploaded for a theme takes precedence over a logo uploaded outside a theme using Customer Area device settings or a /terminalLogos endpoint.

   • Home screen: the default background screen.

   • Idle screen: the screen saver, shown when the terminal is inactive. If a shopper interacts with the screen, the terminal returns to the Home screen. This is only available on countertop, non-battery powered terminals, for example P630, SFO1, and M450.

   • After payment: a screen shown after the payment is completed.

     Showing content on this screen extends the total transaction time.

   • Shopper engagement: a screen shown during a shopper engagement request. The image or video appears on the screen together with the content from the API request. This is only available on terminals with larger screens, for example SFO1 and M450.

   Supported screen types, file types, and resolutions vary per terminal model. See Supported assets.

3. You apply the theme:

   • You can apply themes at company, merchant account, store, or individual terminal level.
   • At company level, you can only apply a theme created at company level. At the other levels, you can apply a company theme or a theme created at merchant account level.

4. Manage your themes: update the name or mode of a theme, replace or delete assets, unapply a theme, or delete a theme.

Create a theme

You can create a theme for your Android payment terminals in the Customer Area or using Management API calls. Select the tab below for your preferred method.

You now have a theme with assets. To use the theme on your terminals, apply it at the required level. You can also update or remove the theme and its assets. See Manage your themes.

Apply a theme

After creating a theme, you can apply it in the Customer Area or with API calls. Select the tab below for your preferred method.

A theme applied at a lower level overrides a theme from a higher level. When you remove a lower-level theme, terminals fall back to the theme defined at the next level up. If no theme is defined at any level, the Adyen default theme is used.

The theme takes effect when the terminal downloads the configuration during its next maintenance call.

If WebSockets are enabled, changes apply to your terminal almost immediately. Optionally, you can update the configuration manually on the terminal.

Manage your themes

After creating a theme, you can modify or remove the theme and its assets. If you have applied a theme, you can also switch to a different theme that you created. You can do this in the Customer Area or using API calls. Select the tab below for your preferred method.

Supported assets

The following asset file formats are supported:

The maximum file size is 100 MB for SFO1 and M450, and 10 MB for all other models.

The following table shows which screen types are supported per terminal model, and the maximum resolution for image and video assets.

Terminal model	Home screen	Idle screen	After payment	Shopper engagement
SFO1	Max. 1280 x 800	Max. 1280 x 800	Max. 1280 x 800	Max. 574 x 634
M450	Max. 1280 x 800	Max. 1280 x 800	Max. 1280 x 800	Max. 574 x 634
S1F2, S1E2L	Max. 720 x 1280		Max. 720 x 1280
S1F4	Max. 720 x 1600		Max. 720 x 1600
S1U2	Max. 720 x 1280		Max. 720 x 1280
S1E4PRo	Max. 720 x 1560		Max. 720 x 1560
AMS1	Max. 480 x 800		Max. 480 x 800
P630	Max. 320 x 480		Max. 320 x 480

See also