POST /companies/{companyId}/terminalThemes
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
Servers
- https://management-test.adyen.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
companyId |
String | Yes |
The unique identifier of the company account. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
The name of the theme. Must be unique within the account specified in the path. Maximum 255 characters. |
mode |
String | Yes |
The terminal display mode. Possible values: dark for a dark screen background, or light for a light screen background. Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.