Nexi Checkout Python API Docs | dltHub

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

Last updated:

Nexi Checkout is a payment processing API that provides payment, reporting, and onboarding endpoints. The REST API base URL is https://api.dibspayment.eu and All requests require an Authorization header containing the secret API key with no Bearer prefix..

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 Nexi Checkout data in under 10 minutes.


What data can I load from Nexi Checkout?

Here are some of the endpoints you can load from Nexi Checkout:

ResourceEndpointMethodData selectorDescription
payments/v1/payments/{paymentId}GETRetrieves details of a single payment (single object).
payment_methods/v1/paymentmethodsGETReturns a top‑level array of available payment methods.
subscription_charges/v1/subscriptions/charges/{bulkId}GETpagePaginated list of subscription charge records.
balances/report/v1/balancesGETdataList of balance objects per currency.
payouts/report/v1/payoutsGETpayoutsList of payout objects with pagination info.

How do I authenticate with the Nexi Checkout API?

Authentication uses a secret API key supplied in the Authorization header; the header value is the raw key with no Bearer prefix.

1. Get your credentials

  1. Log in to the Nexi Checkout developer portal (https://developer.nexigroup.com).
  2. Open your application/project dashboard.
  3. Choose API Keys or Credentials from the sidebar.
  4. Locate the Secret API Key for the desired environment (Test or Live).
  5. Copy the key; this is the value you will place in secrets.toml or pass to the dlt source.
  6. Keep the key confidential and do not share it publicly.

2. Add them to .dlt/secrets.toml

[sources.nexi_checkout_source] api_key = "your_secret_api_key"

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 Nexi Checkout 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 nexi_checkout_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline nexi_checkout_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 payouts from the Nexi Checkout 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 nexi_checkout_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.dibspayment.eu", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "payments", "endpoint": {"path": "v1/payments/{paymentId}"}}, {"name": "payouts", "endpoint": {"path": "report/v1/payouts", "data_selector": "payouts"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="nexi_checkout_pipeline", destination="duckdb", dataset_name="nexi_checkout_data", ) load_info = pipeline.run(nexi_checkout_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("nexi_checkout_pipeline").dataset() sessions_df = data.payments.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM nexi_checkout_data.payments LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("nexi_checkout_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 Nexi Checkout 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

  • 401 Unauthorized / 403 Forbidden: Occur when the Authorization header is missing, malformed, or contains an invalid secret key. Ensure the exact secret API key is sent without a Bearer prefix.

Rate Limiting

  • 429 Too Many Requests: The Payment API enforces rate limits. When received, implement exponential back‑off and retry after a short pause.

Pagination Quirks

  • Endpoints such as /v1/subscriptions/charges/{bulkId} return a page array and a boolean more flag. Continue fetching subsequent pages while more is true.
  • Reporting endpoints like /report/v1/payouts provide numberOfPayouts and a payouts array; use the count to determine if additional calls are needed.

General Errors

  • The API returns typical HTTP error codes (400, 404, 500) with a JSON body containing status and message fields, e.g. { "status": "error", "message": "..." }.

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 Nexi Checkout?

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