ADadyen
Terminal themes - company level

Create a terminal theme

Changed on

Creates a terminal theme for the company specified in the path, to customize screens shown on Android payment terminals. This request only creates a basic theme with a name and a dark or light mode. We refer to this as the metadata of the theme.

Next steps are to add terminal model-specific assets (images or videos) to the theme, and to apply (activate) the theme.

The theme name must be unique for the company account; other accounts can have a theme with the same name.

To make this request, your API credential must have the following role:

  • Management API - Terminal themes read and write
post/companies/{companyId}/terminalThemes

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/companies/{companyId}/terminalThemes
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

companyIdstring required

The unique identifier of the company account.

Request body

mode'dark' | 'light' required

The terminal display mode. Possible values: dark, light.

namestring required

The name of the theme. Must be unique within the account specified in the path. Maximum 255 characters.

Response

Created

idstring required

The unique identifier of the theme. This value is generated by Adyen.

mode'dark' | 'light' required

The terminal display mode. Possible values: dark, light.

namestring required

The name of the theme.

Changes