Flitt Python API Docs | dltHub

Build a Flitt-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

Flitt's API supports Apple Pay and Google Pay for web and mobile. To start, create Apple Pay certificates and register a Merchant ID. For Google Pay, integrate with Flitt's payment options. The REST API base URL is https://pay.flitt.com/api and API requests use a merchant payment key to build a SHA1 signature (sent as request parameter signature); reports require an Authorization token (HTTP header "Authorization: Token ...") obtained via application credentials..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Flitt data in under 10 minutes.


What data can I load from Flitt?

Here are some of the endpoints you can load from Flitt:

ResourceEndpointMethodData selectorDescription
checkout_urlapi/checkout/urlPOSTresponseCreate hosted checkout URL (response.checkout_url returned under response)
checkout_tokenapi/checkout/tokenPOSTresponseCreate payment token for embedded/mobile flows (response.token under response)
create_captureapi/capture/createPOSTresponseCreate a capture operation (responses are under response)
get_capture_statusapi/capture/statusPOSTresponseGet capture status (response contains status under response)
create_reversalapi/reversal/createPOSTresponseCreate reversal; response under response
get_reversal_statusapi/reversal/statusPOSTresponseGet reversal status; response under response
reports_gethttps://portal.flitt.com/api/extend/company/report/POSTdataObtain report rows; response contains data (array of rows), fields, rows_count
reports_tokenhttps://portal.flitt.com/authorizer/token/application/getPOSTtokenObtain short-lived report access token (response contains token)

How do I authenticate with the Flitt API?

For payment endpoints each POST request includes a signature parameter (SHA1 of request fields and merchant payment key). For reports obtain a short-lived token by POSTing application_id/date/signature (SHA512) to https://portal.flitt.com/authorizer/token/application/get and send it in the Authorization header as "Authorization: Token ".

1. Get your credentials

  1. Create or log in to Flitt merchant account (or contact Flitt support for application id). 2) In merchant/test settings obtain merchant_id and payment key (test keys available in Testing docs: merchant_id 1549901, test secret key "test"). 3) For reports request application_id and private key from Flitt support, then call the authorizer endpoint to retrieve a token.

2. Add them to .dlt/secrets.toml

[sources.flitt_apple_pay_source] payment_key = "your_payment_key_here" merchant_id = "your_merchant_id_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.


How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Flitt API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

python flitt_apple_pay_pipeline.py

If everything is configured correctly, you'll see output like this:

Pipeline flitt_apple_pay_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset flitt_apple_pay_data The duckdb destination used duckdb:/flitt_apple_pay.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

dlt pipeline flitt_apple_pay_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.


Python pipeline example

This example loads checkout/url and checkout/token from the Flitt API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def flitt_apple_pay_source(payment_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://pay.flitt.com/api", "auth": { "type": "api_key", "payment_key": payment_key, }, }, "resources": [ {"name": "checkout_url", "endpoint": {"path": "api/checkout/url", "data_selector": "response"}}, {"name": "checkout_token", "endpoint": {"path": "api/checkout/token", "data_selector": "response"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="flitt_apple_pay_pipeline", destination="duckdb", dataset_name="flitt_apple_pay_data", ) load_info = pipeline.run(flitt_apple_pay_source()) print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.


How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

import dlt data = dlt.pipeline("flitt_apple_pay_pipeline").dataset() sessions_df = data.checkout_url.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM flitt_apple_pay_data.checkout_url LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("flitt_apple_pay_pipeline").dataset() data.checkout_url.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.


What destinations can I load Flitt data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.


Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

  • data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
  • dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for Flitt?

Request dlt skills, commands, AGENT.md files, and AI-native context.