AffiniPay Python API Docs | dltHub
Build a AffiniPay-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.
Last updated:
AffiniPay (8am) provides payment gateway and merchant management APIs for processing transactions and managing accounts. The REST API base URL is https://api.8am.com and Requests require either an API key using HTTP Basic Authentication or an OAuth access token using Bearer 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 add "dlt[hub]" and start loading AffiniPay data in under 10 minutes.
What data can I load from AffiniPay?
Here are some of the endpoints you can load from AffiniPay:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| transactions | v1/transactions | GET | results | List paginated transactions |
| recurring_charges | v1/recurring/charges | GET | results | List paginated recurring charges |
| cards | v1/cards | GET | results | List paginated saved cards |
| banks | v1/banks | GET | results | List paginated saved bank accounts |
| contacts_attachments | contacts/{contact_id}/attachments | GET | results | List paginated attachments for a contact |
How do I authenticate with the AffiniPay API?
Merchant and payment gateway API requests use HTTP Basic Authentication with a base64-encoded key, while OAuth flows use Bearer tokens passed in the Authorization header.
1. Get your credentials
To obtain API credentials, log in to your AffiniPay product dashboard (e.g., AffiniPay, ClientPay, CPACharge, or LawPay). Navigate to the developer settings by clicking your name in the top-right corner and selecting Developers. Within the Authorized Applications grid, locate 'My Website' and click 'Show Credentials' to reveal your Public Key, Secret Keys, and Account ID. Note that this section is only available to users with Administrator or Developer roles.
2. Add them to .dlt/secrets.toml
[sources.affinipay_source] access_token = "your_bearer_access_token_here" secret_key = "your_gateway_secret_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 init uv add "dlt[hub]"
1. Install the dlt AI harness:
uv run dlthub 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:
uv run dlthub ai toolkit install rest-api-pipeline
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 AffiniPay 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:
uv run python affinipay_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline affinipay_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset affinipay_data The duckdb destination used duckdb:/affinipay.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
uv run dlthub 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 v1/transactions and v1/cards from the AffiniPay 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 affinipay_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.8am.com", "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_key}, }, "resources": [ {"name": "transactions", "endpoint": {"path": "v1/transactions", "data_selector": "results"}}, {"name": "cards", "endpoint": {"path": "v1/cards", "data_selector": "results"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="affinipay_pipeline", destination="duckdb", dataset_name="affinipay_data", ) load_info = pipeline.run(affinipay_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("affinipay_pipeline").dataset() sessions_df = data.transactions.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM affinipay_data.transactions LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("affinipay_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 AffiniPay data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example 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 harness:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-platform— Deploy, schedule, and monitor your pipeline in production.
uv run dlthub ai toolkit install data-exploration uv run dlthub ai toolkit install dlthub-platform
Was this page helpful?
Community Hub
Need more dlt context for AffiniPay?
Request dlt skills, commands, AGENT.md files, and AI-native context.