POS Terminal Management API (deprecated)
This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal,…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store.
For more information, refer to Classic assign terminals.
>From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our Management API.
Authentication
Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in How to get the API key. Then set this key to the X-API-Key header value, for example:
curl
-H "Content-Type: application/json" \
-H "X-API-Key: Your_API_key" \
...Note that when going live, you need to generate new web service user credentials to access the live endpoints.
Roles and permissions
To use the POS Terminal Management API, you need the POS Terminal Management API role added to your API credential. Your Adyen contact will set up the roles for you.
Versioning
Terminal Management API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.
For example:
https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccountWhen using versioned endpoints, Boolean response values are returned in string format: "true" or "false".
If you omit the version from the endpoint URL, Boolean response values are returned like this: true or false.
Going live
To access the live endpoints, you need an API key from your live Customer Area.
Use this API key to make requests to:
https://postfmapi-live.adyen.com/postfmapi/terminal/v1Endpoints 5
General
- POSTAssign terminals
/assignTerminalsDeprecated. Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant… - POSTGet the account or store of a terminal
/findTerminalDeprecated. Returns the company account, merchant account, or store that a payment terminal is assigned to. >From January 1, 2025 POS Terminal Management API… - POSTGet the stores of an account
/getStoresUnderAccountDeprecated. Returns a list of stores associated with a company account or a merchant account, including the status of each store. >From January 1, 2025 POS… - POSTGet the details of a terminal
/getTerminalDetailsDeprecated. Returns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in… - POSTGet the list of terminals
/getTerminalsUnderAccountDeprecated. Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in…
API details
- Base URL
https://postfmapi-test.adyen.com/postfmapi/terminal/v1- Authentication
- An API key in the X-API-Key header
HTTP Basic authentication (username and password) - Operations
- 5 operations on 5 pathsPOST 5
5 marked deprecated - Main resources
- General 5
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Adyen's published OpenAPI description (Adyen/adyen-openapi) (MIT)
How to test the POS Terminal Management API (deprecated) in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the POS Terminal Management API (deprecated) collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Assign terminals” (POST /assignTerminals), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the POS Terminal Management API (deprecated)?
This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal,… It is listed under Payments and has 5 endpoints.
Who publishes the POS Terminal Management API (deprecated)?
It is listed from Adyen's public API description (an OpenAPI document), not published by Adyen on Swastik Codes. Anyone who controls adyen.com can claim the profile by adding a DNS TXT record.
What is the base URL of the POS Terminal Management API (deprecated)?
Requests go to https://postfmapi-test.adyen.com/postfmapi/terminal/v1. Endpoint paths are added to this base URL.
How do I authenticate with the POS Terminal Management API (deprecated)?
It accepts 2 methods: an API key in the X-API-Key header; HTTP Basic authentication (username and password).
How many endpoints does the POS Terminal Management API (deprecated) have?
5 operations on 5 paths (5 POST). The largest groups are General.
Is forking the POS Terminal Management API (deprecated) free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.