PATCH /companies/{companyId}/terminalLogos
Updates the logo that is configured for a specific payment terminal model at the company identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal).
- To change the logo, specify the image file as a Base64-encoded string.
- To restore the logo inherited from the Adyen PSP level, specify an empty logo value.
To make this request, your API credential must have the following role:
- Management API—Terminal settings read and write
In the live environment, requests to this endpoint are subject to rate limits.
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" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
model |
String | Yes |
The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
data |
String | No |
The image file, converted to a Base64-encoded string, of the logo to be shown on the terminal. |
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.