Nexio Python API Docs | dltHub

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

Last updated:

NexioPay is a payment processing platform that provides REST APIs for managing payments, payouts, reporting and merchant operations. The REST API base URL is https://api.nexiopaysandbox.com and All requests require HTTP Basic 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 Nexio data in under 10 minutes.


What data can I load from Nexio?

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

ResourceEndpointMethodData selectorDescription
paymentspaymentsGETRetrieve list of payment transactions
payoutspayoutsGETRetrieve list of payout transactions
reportsreportsGETdataRetrieve reporting data
merchantsmerchantsGETRetrieve merchant details
terminalsterminalsGETRetrieve terminal list

How do I authenticate with the Nexio API?

Authentication uses HTTP Basic authentication where the dashboard username and password are sent via the Authorization header.

1. Get your credentials

  1. Open https://dashboard.nexiopay.com and log in with your merchant account.
  2. Navigate to the "API Credentials" or "Integration" section in the dashboard menu.
  3. Locate the generated API username and password (or create new ones if needed).
  4. Copy the username and password and store them securely for use in the dlt configuration.

2. Add them to .dlt/secrets.toml

[sources.nexio_payments_source] username = "your_username_here" password = "your_password_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 Nexio 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 nexio_payments_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline nexio_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 payments and reports from the Nexio 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 nexio_payments_source(username=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.nexiopaysandbox.com", "auth": { "type": "http_basic", "password": username, }, }, "resources": [ {"name": "payments", "endpoint": {"path": "payments"}}, {"name": "reports", "endpoint": {"path": "reports", "data_selector": "data"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="nexio_payments_pipeline", destination="duckdb", dataset_name="nexio_payments_data", ) load_info = pipeline.run(nexio_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("nexio_payments_pipeline").dataset() sessions_df = data.payments.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM nexio_payments_data.payments LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("nexio_payments_pipeline").dataset() data.payments.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 Nexio 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.


Troubleshooting

Authentication Errors

If you receive a 401 Unauthorized response, verify that the username and password in your secrets.toml are correct and that they are being sent as Basic Auth headers.

Rate Limiting

The API may enforce rate limits. If you encounter 429 Too Many Requests, implement exponential back‑off and retry after the Retry-After header period.

Service Availability

Check https://status.nexiopay.com/ for any ongoing incidents. The status page provides real‑time information about API downtime.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.


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 Nexio?

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