What is the Integrated API?

The Takepayments Integrated API provides a RESTful interface for initiating and managing payment transactions across in-store, Pay At Table, and online channels. It acts as the primary integration point between your POS or application layer and your card terminals, enabling you to trigger payments, pass transaction context, and receive real-time outcomes from payment terminals and hosted payment flows.

Designed to be simple to adopt, the API follows standard REST conventions and uses clear, predictable request and response models. Once authenticated, your application can start transactions, track their status, and reconcile results without direct interaction with the payment device. The platform handles terminal communication, customer interaction, and transaction orchestration, allowing your system to remain the single source of truth.

In the following sections, we cover the topics below in the same order as the navigation for this section.

1. Authentication: How to securely authenticate with the API using OAuth 2.0 client credentials flow.
2. Integrated API: Where to find the v1 and v2 API reference and playground links.
3. Pairing a terminal: How to pair your terminal with the API to enable transaction processing.
4. Initiating transactions: How to create payment transactions, including passing order details and transaction context.
5. Handling transaction lifecycles: Understanding the various states of a transaction and how to handle asynchronous updates from the API.
6. Changing supervisor code: How to access the supervisor menu and update the terminal supervisor code.
7. Pay At Table: How to set up Pay At Table and work through the supporting integration and business flows.
8. Migration to non-legacy pairing: What changes when moving existing devices from the legacy pairing flow to the non-legacy model.

Together, these sections cover the main workflows you need to integrate a terminal, transact against it, configure the device, and support the operational flows around it.