Migration Guide: POS Terminal Management API to Management API

Overview

This guide provides a mapping of functionalities from the deprecated POS Terminal Management API to the new Management API. Follow these instructions to update your integration.

Authentication

Ensure your API Key has the right permissions for making requests to the live endpoints of Management API. Read more about how to manage API permissions here.

Endpoints Mapping

1. Assign Terminals

• Old API:

⠀⠀• Endpoint: https://postfmapi-live.adyen.com/postfmapi/terminal/v1/assignTerminals

⠀⠀• Method: POST

⠀⠀• Documentation Link

• New API:

⠀⠀• Endpoint: https://management-live.adyen.com/v3/terminals/{terminalId}/reassign

⠀⠀• Method: POST

⠀⠀• API credential role: Management API - Assign Terminal

⠀⠀• Documentation Link

2. Find Terminal

• Old API:

⠀⠀• Endpoint: https://postfmapi-live.adyen.com/postfmapi/terminal/v1/findTerminal

⠀⠀• Method: POST

⠀⠀• Documentation Link

• New API:

⠀⠀• Endpoint: https://management-live.adyen.com/v3/terminals

⠀⠀• Method: GET

⠀⠀• API credential role: Management API - Terminals read

⠀⠀• Documentation Link

⠀⠀• Note: unique terminal ID can be specified in the ”searchQuery” parameter of the new /terminals endpoint

3. Get Stores Under Account

• Old API:

⠀⠀• Endpoint: https://postfmapi-live.adyen.com/postfmapi/terminal/v1/getStoresUnderAccount

⠀⠀• Method: POST

⠀⠀• Documentation Link

• New API:

⠀⠀• Endpoint: https://management-live.adyen.com/v3/stores

⠀⠀• Method: GET

⠀⠀• API credential role: Management API - Stores read

⠀⠀• Documentation Link

4. Get Terminal Details

• Old API:

⠀⠀• Endpoint: https://postfmapi-live.adyen.com/postfmapi/terminal/v1/getTerminalDetails

⠀⠀• Method: POST

⠀⠀• Documentation Link

• New API:

⠀⠀• Endpoint: https://management-live.adyen.com/v3/terminals

⠀⠀• Method: GET

⠀⠀• API credential role: Management API - Terminals read

⠀⠀• Documentation Link

⠀⠀• Note: ”storeDetails” available at: https://management-test.adyen.com/v3/stores/{storeId}

5. Get Terminals Under Account

• Old API:

⠀⠀• Endpoint: https://postfmapi-live.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount

⠀⠀• Method: POST

⠀⠀• Documentation Link

• New API:

⠀⠀• Endpoint: https://management-live.adyen.com/v3/terminals

⠀⠀• Method: GET

⠀⠀• API credential role: Management API - Terminals read

⠀⠀• Documentation Link

Additional Resources

For a full list of endpoints and detailed instructions, please refer to the Management API documentation.

If you need further assistance, please contact our team.

FAQ

Where can I find the “terminalStatus” returned by the Get Terminal Details endpoint?

The GET /terminals endpoint on Management API returns two additional fields that can be used to obtain the same information contained in the old “terminalStatus” field:

• “lastActivityAt” shows the last time the terminal was online, which was previously indicated by the “OnlineLastXDays” status

• “assignment” shows what’s the terminal’s assignment status, which was previously indicated by one of “ReAssignToMerchantInventoryPending”, “ReAssignToStorePending”, “ReAssignToInventoryPending”

Please refer to the API Reference for the documentation on the response returned by Management API.

Where can I find the “storeDetails” returned by the Get Terminal Details endpoint?

The GET /terminals endpoint on Management API returns a “storeId” inside the “assignment” field. This identifier can be used to then call the GET /stores/{storeId} to retrieve more details, if needed.