Checkout.com Python API Docs | dltHub

Checkout.com is a payment processing platform that provides APIs for payments, refunds, customers, and other financial services. The REST API base URL is https://{prefix}.api.checkout.com/{path} and All requests require either an API secret key or an OAuth2 access 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 Checkout.com data in under 10 minutes.

---

What data can I load from Checkout.com?

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

---

How do I authenticate with the Checkout.com API?

Authentication can be performed by sending the secret API key in the Authorization: Bearer <secret_key> header, or by obtaining an OAuth2 access token and using it in the same header.

1. Get your credentials

1. Log in to the Checkout.com Dashboard.
2. Navigate to Developers → API keys.
3. Click Create secret key to generate a new secret API key; copy it.
4. For OAuth, go to Developers → OAuth clients.
5. Click Create client, note the displayed client_id and client_secret.
6. Store these values securely for use in dlt configuration.

2. Add them to .dlt/secrets.toml

Copy
[sources.checkoutcom_source]
api_key = "your_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:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
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:

Copy
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 Checkout.com 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:

Copy
python checkoutcom_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline checkoutcom_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 customers from the Checkout.com API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def checkoutcom_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{prefix}.api.checkout.com/{path}",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "payments", "endpoint": {"path": "payments", "data_selector": "data"}},
            {"name": "customers", "endpoint": {"path": "customers", "data_selector": "data"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="checkoutcom_pipeline",
        destination="duckdb",
        dataset_name="checkoutcom_data",
    )
    load_info = pipeline.run(checkoutcom_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):

Copy
import dlt

data = dlt.pipeline("checkoutcom_pipeline").dataset()
sessions_df = data.payments.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM checkoutcom_data.payments LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("checkoutcom_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 Checkout.com data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

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 – occurs when the API key or OAuth token is missing, malformed, or revoked. Verify that the Authorization: Bearer <secret_key> header is correct and that the key has not been disabled.

Rate Limiting

• 429 Too Many Requests – the API enforces request limits per merchant. Implement exponential back‑off and respect the Retry-After header returned with the response.

Pagination Quirks

• List endpoints return pagination fields such as has_more and _links.next.href. Continue fetching subsequent pages while has_more is true or a _links.next URL is provided.

Server Errors

• 502 Bad Gateway – temporary upstream issue; retry the request after a short delay.

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.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack