integrations.sh
← all integrations

adyen.com – TfmAPIService

OpenAPI apis-guru payment

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 .

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 . 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 .

Versioning

Terminal Management API supports 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/getTerminalsUnderAccount

When 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.

Homepage
https://api.apis.guru/v2/specs/adyen.com:TfmAPIService/1.json
Provider
adyen.com:TfmAPIService / TfmAPIService
OpenAPI version
3.1.0
Spec (JSON)
https://api.apis.guru/v2/specs/adyen.com/TfmAPIService/1/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/adyen.com/TfmAPIService/1/openapi.yaml

Tools (7)

Extracted live via the executor SDK.

  • general.postAssignTerminals

    Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory.

  • general.postFindTerminal

    Returns the company account, merchant account, or store that a payment terminal is assigned to.

  • general.postGetStoresUnderAccount

    Returns a list of stores associated with a company account or a merchant account, including the status of each store.

  • general.postGetTerminalDetails

    Returns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in the terminal list in your Customer Area and in the Terminal Fleet report.

  • general.postGetTerminalsUnderAccount

    Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded).

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools