Using the Fyre API

This page provides a high-level overview of how POS partners work with Fyre using the API.

The Fyre API is the primary technical interface between partner systems and the Fyre platform. It is used to exchange data in both directions, including delivering transactional data to Fyre and accessing selected partner-facing information generated by the platform.

This page explains how the API fits into the integration lifecycle and what partners should expect before moving on to authentication and implementation details.

Purpose of the API integration

The Fyre API serves as a shared interface through which partners integrate once and extend functionality over time.

Through the API, partners can:

• Deliver transactional data during the preparation phase and in production

• Retrieve information related to their outlets

• Access insights and aggregated results generated by Fyre

• Participate in activation and challenge-based features as they are enabled

Using a single API for all interactions ensures consistent authentication, predictable behavior, and avoids the need for multiple technical interfaces as new capabilities are introduced.

How the API fits into the integration process

API usage is introduced once the preparation phase is underway.

During preparation, the API may be used to deliver the initial one-month transactional data sample. After this phase is approved, the same API integration continues to be used as the integration expands.

Over time, the API may support:

• Historical data delivery, where applicable

• Ongoing daily production data delivery

• Access to additional partner-facing data and features

While the scope of available endpoints may grow, partners integrate once and continue using the same interface as functionality evolves.

Data formats and processing behavior

For transactional delivery, Fyre strongly recommends aligning with the standardized transactional data format.

The standardized format defines the canonical structure used across partners and markets and is referenced by all delivery mechanisms.

All API submissions are stored upon receipt and processed asynchronously as part of Fyre’s ingestion pipeline. Validation, enrichment, and aggregation do not occur at the time data is submitted.

Partners should ensure that data sent via the API is complete and final at the time of delivery.

Security and access model

Access to the API is managed centrally by Fyre and aligned with the agreed integration scope.

Before any data can be delivered or accessed, partners must be granted API access. This access determines which operations are available and which data can be exchanged.

Details on authentication and API access are described in the next section.

Where to go next

To configure secure access, continue with Authentication & API Access.

To implement specific endpoints, payloads, and error handling, see API Reference.