Are you looking for test card numbers?

Would you like to contact support?

Atenção, esta página não se encontra disponível em Português
Point-of-sale icon

Automate the management of your terminals

Use APIs to order, assign, and configure payment terminals.

In your Customer Area, you can manually order, assign, and configure terminals, and schedule actions like installing Android apps. However, doing this manually can be too time-consuming or impractical.

To automate the management of terminals you can make API requests. Our APIs let you order, assign, and configure terminals. Then, when the configured terminal is delivered to the store that it is assigned to, store staff only need to board the terminal. You can also schedule terminal actions through API.

API key and permissions

To authenticate your requests, you need to have an API credential with an API key and the following roles:

  • Management API—this role allows you to get company and merchant account IDs
  • Create/Manage terminal orders via API
  • View terminal TFM settings via API—this role allows you to view terminal settings
  • Update terminal TFM settings via API—this role allows you to configure terminal settings
  • POS Terminal Management API—this role allows you to assign terminals

You must specify the API key in the X-API-Key header of your requests.

You can create an API key in your test Customer Area. To access the live endpoints, you need to generate a new API key in your live Customer Area.

If you are using a Terminal API integration with cloud-based communications, you can use the existing API key that you use for Terminal API requests.


Versioning is handled as part of the endpoint URL. For example, to send a request to version 1 of the /merchants endpoint of the Management API, use:

What do you want to do?