Load Payrexx data to DuckDB
Build a Payrexx to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the Payrexx API base URL, auth, endpoints, and incremental loading.
Payrexx is a payment processing platform that provides a REST API to manage payments, payment providers, gateways, terminals and related resources. Everything needed to build a working Payrexx → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.
Build your Payrexx to DuckDB pipeline
Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.
PromptRunuvx dlthub-init@latestto build a pipeline from Payrexx to DuckDB and run it on dltHub
That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the Payrexx API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →
Prefer to write it yourself? Every fact the agent uses is below.
Payrexx API at a glance
| Base URL | https://api.payrexx.com/v1.0 |
| Example endpoint | GET Gateway |
| Records found at | data |
| Authentication | all requests require an API Secret passed as a header — sent in the X-API-KEY header |
| Pagination | Cursor-based via starting_after, page size via limit (or count in some cases) (default 10). The API uses two distinct pagination patterns depending on the endpoint version/service. v2.0+ services commonly use cursor-based pagination (starting_after, limit). Other endpoints use offset-based pagination (offset, count). |
| Incremental field | starting_after |
| API reference | https://developers.payrexx.com/reference/rest-api |
These values come from the Payrexx API reference — the authoritative source if anything here looks out of date.
How do I authenticate with the Payrexx API?
Authentication is handled by passing the API Secret in the X-API-KEY HTTP header.
1. Get your credentials
To obtain your API credentials, log into your Payrexx merchant dashboard. Navigate to the 'API and Plugins' section (sometimes found under 'Developer' or 'Settings' > 'API'). Click 'Add API Key', assign a name to the integration, and save it. The generated API key (API Secret) will be displayed, which you should copy securely.
2. Add them to .dlt/secrets.toml
[sources.payrexx_source] api_key = "your_api_secret_here"
dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.
What Payrexx data can I load into DuckDB?
These are the Payrexx endpoints dlt can load into DuckDB:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| gateway | Gateway | GET | data | Retrieve all gateways |
| transaction | Transaction | GET | data | Retrieve all transactions |
| invoice | Invoice | GET | data | Retrieve all invoices |
| payment_provider | PaymentProvider | GET | data | Retrieve all payment providers |
| merchant | Merchant | GET | data | Retrieve all merchants |
How do I load only new Payrexx records?
Payrexx exposes starting_after on Gateway, so dlt can request only the records that changed since the last run. Set it as the cursor_path and dlt tracks the high-water mark for you between runs.
{"name": "gateway", "endpoint": { "path": "Gateway", "data_selector": "data", "incremental": {"cursor_path": "starting_after", "initial_value": "2024-01-01T00:00:00Z"}, }}
On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.
What does the generated Payrexx pipeline look like?
A standard dlt REST API pipeline — the same code you would write by hand, loading Gateway and Invoice from the Payrexx API into DuckDB:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def payrexx_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.payrexx.com/v1.0", "auth": {"type": "api_key", "api_key": api_key, "name": "X-API-KEY", "location": "header"}, }, "resources": [ {"name": "gateway", "endpoint": {"path": "Gateway", "data_selector": "data"}}, {"name": "transaction", "endpoint": {"path": "Transaction", "data_selector": "data"}} ], } yield from rest_api_resources(config) def load_payrexx_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="payrexx_pipeline", destination="duckdb", dataset_name="payrexx_data", ) load_info = pipeline.run(payrexx_source()) print(load_info) if __name__ == "__main__": load_payrexx_to_duckdb()
Run it with python payrexx_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.
How do I query Payrexx data in DuckDB?
dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("payrexx_pipeline").dataset() df = data.gateway.df() print(df.head())
SQL:
SELECT * FROM payrexx_data.gateway LIMIT 10;
See querying your data with dataset and exploring it in marimo notebooks.
How do I deploy the Payrexx to DuckDB pipeline in production?
The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.
- Deploy & schedule — run the pipeline as a managed job with automatic retries.
- Monitor — observable job queues, alerting, and load metrics for every run.
- Transform — promote raw Payrexx loads into governed, documented models.
- Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.
What other destinations can I load Payrexx data to?
dlt loads into any of these — only the destination argument changes:
| Destination | Example value |
|---|---|
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.
Next steps
Was this page helpful?
Community Hub
Need more dlt context for Payrexx to DuckDB?
Request dlt skills, commands, AGENT.md files, and AI-native context.