Create a terminal theme

post/merchants/{merchantId}/terminalThemes

Creates a terminal theme for the merchant account 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 merchant 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
Endpoint destination URL
https://management-test.adyen.com/v3/merchants/{merchantId}/terminalThemes
merchantIdstringRequired

The unique identifier of the merchant account.

modestringRequired

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

namestringRequired
Max length: 255

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

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 201

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Not Found

  • 422

    Unprocessable Entity

  • 500

    Internal Server Error