POST /merchants/{merchantId}/terminalThemes/{id}/assets

Adds an image or video (an 'asset') to a terminal theme owned by the merchant account specified in the path. This endpoint is rate limited.

An asset is used for a specific screen type or screen element, and a specific Android terminal model. You must specify this using the query parameters type and model. The asset binary itself is uploaded as multipart/form-data with a single file part called file, which must declare one of the following supported Content-Type values:

image/svg+xml: only for the combination type logo with model All.
video/mp4 or video/quicktime: only for model SFO1 or M450.
image/jpeg (or image/jpg): for all model values except All.
image/png: for all model values except All.
image/gif: for all model values except SFO1 and M450.

The maximum size of the asset depends on the terminal model: 100 MB for model SFO1 and M450, or 10 MB for all other model values.

If the theme already has an asset for the same combination of type and model, the request fails and you need to upload the new asset using the /merchants/{merchantId}/terminalThemes/{id}/assets/replace endpoint.

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
`id`	String	Yes	The unique identifier of the terminal theme.
`merchantId`	String	Yes	The unique identifier of the merchant account.

Query parameters

Name Type Required Description

Name	Type	Required	Description
`type`	String	Yes	The screen type or screen element that the asset is for: logo: your logo. Only supported if `model` is All. homeScreen: the default background screen. idleScreen: a screensaver shown when the terminal is inactive. Only supported if `model` is SFO1 or M450. afterPaymentScreen: a screen shown after the payment is completed. shopperEngagementScreen: a screen shown during a shopper engagement request. Only supported if `model` is SFO1 or M450. Valid values: `"afterPaymentScreen"` `"shopperEngagementScreen"` `"idleScreen"` `"homeScreen"` `"logo"`
`model`	String	Yes	The Android terminal model that the asset is for. Use All only if the `type` is logo. For every other screen type specify a single Android terminal model such as AMS1. Valid values: `"M450"` `"S1U2"` `"AMS1"` `"S1E2L"` `"S1F2L"` `"S1E4Pro"` `"S1U2M4"` `"LDN1"` `"P630"` `"S1F2"` `"SFO1"` `"S1F4Pro"` `"All"`

type

String

Yes

The screen type or screen element that the asset is for:

logo: your logo. Only supported if model is All.
homeScreen: the default background screen.
idleScreen: a screensaver shown when the terminal is inactive. Only supported if model is SFO1 or M450.
afterPaymentScreen: a screen shown after the payment is completed.
shopperEngagementScreen: a screen shown during a shopper engagement request. Only supported if model is SFO1 or M450.

Valid values:

"afterPaymentScreen"
"shopperEngagementScreen"
"idleScreen"
"homeScreen"
"logo"

model

String

Yes

The Android terminal model that the asset is for. Use All only if the type is logo. For every other screen type specify a single Android terminal model such as AMS1.

Valid values:

"M450"
"S1U2"
"AMS1"
"S1E2L"
"S1F2L"
"S1E4Pro"
"S1U2M4"
"LDN1"
"P630"
"S1F2"
"SFO1"
"S1F4Pro"
"All"

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.