Mint Payments Python API Docs | dltHub

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

Last updated:

Mint Payments' REST API supports JSON responses and includes endpoints for creating and updating payment links. The API documentation is available for reference. Use HTTP requests to interact with the API. The REST API base URL is https://secure-uatsb.mintpayments.net/eft/v1/ and all requests require a Bearer token for authentication.

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 Mint Payments data in under 10 minutes.


What data can I load from Mint Payments?

Here are some of the endpoints you can load from Mint Payments:

ResourceEndpointMethodData selectorDescription
transactionstransaction_searchGETtransactionsSearch/query transactions with filters (payer_number, payee_number, date range, paging).
payeespayee-searchGETpayeesSearch payees by company number/name; supports paging and filters.
transactiontransaction-by-id/{transaction_id}GETGet a single transaction by Mint transaction_id (response contains transaction object).
status_history{transaction_id}/status-historyGETstatus_historyGet status history entries for a transaction (returns status_history array).
errors(various endpoints)GETDocs list standard HTTP status codes and error details in response_code/response_message.

How do I authenticate with the Mint Payments API?

MintEFT uses API keys provided by Mint. Provide the API key in the Authorization header as a Bearer token (Authorization: Bearer <API_KEY>).

1. Get your credentials

  1. Contact Mint Payments onboarding/support to request API access for your account.
  2. Mint will issue an API key (for UAT and production as appropriate).
  3. Store the API key securely and supply it as a Bearer token in the Authorization header.

2. Add them to .dlt/secrets.toml

[sources.mint_payments_source] api_key = "your_mint_api_key_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 Mint Payments 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 mint_payments_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline mint_payments_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 transactions and payees from the Mint Payments 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 mint_payments_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://secure-uatsb.mintpayments.net/eft/v1/", "auth": { "type": "bearer", "token": api_key, }, }, "resources": [ {"name": "transactions", "endpoint": {"path": "transaction_search", "data_selector": "transactions"}}, {"name": "payees", "endpoint": {"path": "payee-search", "data_selector": "payees"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="mint_payments_pipeline", destination="duckdb", dataset_name="mint_payments_data", ) load_info = pipeline.run(mint_payments_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("mint_payments_pipeline").dataset() sessions_df = data.transactions.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM mint_payments_data.transactions LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("mint_payments_pipeline").dataset() data.transactions.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 Mint Payments 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 Mint Payments?

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