ADadyen
Terminal themes - company level

Add an asset to a terminal theme

Changed on

Adds an image or video (an 'asset') to a terminal theme owned by the company 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 /companies/{companyId}/terminalThemes/{id}/assets/replace endpoint.

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

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

Request

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

Path parameters

companyIdstring required

The unique identifier of the company account.

idstring required

The unique identifier of the terminal theme.

Query parameters

type'logo' | 'homeScreen' | 'idleScreen' | 'afterPaymentScreen' | 'shopperEngagementScreen' required

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.
model'All' | 'SFO1' | 'M450' | 'S1F2' | 'S1E2L' | 'S1F2L' | 'S1F4Pro' | 'S1E4Pro' | 'S1U2' | 'S1U2M4' | 'LDN1' | 'AMS1' | 'P630' required

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.

Request body multipart/form-data

filestring binary required

The asset file. The part must declare a specific supported Content-Type; which Content-Type is accepted depends on the asset type and terminal model (see the endpoint description for the full mapping). The file extension is derived from it. A request with a generic or missing Content-Type such as application/octet-stream is rejected with response code 422. The maximum asset size depends on the terminal model: up to 100 MB for SFO1 and M450, or 10 MB for all other models.

Response

Created

modelstring required

The terminal model that the asset is for. Must be one of the supported terminal models.

typestring required

The screen type that the asset is for. Possible values: logo, homeScreen, idleScreen, afterPaymentScreen, shopperEngagementScreen.

urlstring required

The CDN URL for this asset, including the token as a query parameter (?token=). This URL is valid for 24 hours.

Changes