Paysimple Python API Docs | dltHub

PaySimple is a payment processing platform and API for accepting and managing payments, customers, and related payment resources. The REST API base URL is https://api.paysimple.com and All requests require an Authorization header (merchant basic scheme or reseller scheme)..

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

---

What data can I load from Paysimple?

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

---

How do I authenticate with the Paysimple API?

PaySimple issues an API username and API key. For merchant-level requests include an Authorization header that begins with the literal word "basic" followed by a space and then the API username, a colon, and the API key (PaySimple does NOT use Base64 encoding). For reseller-level access use the literal scheme "reseller" followed by a space and the reseller API key. Optionally include PaySimple-Merchant-Id header when acting on behalf of a merchant.

1. Get your credentials

1. Contact PaySimple / your PaySimple integration team or account manager to request API access. 2) PaySimple will provision API credentials (API username and API key) and deliver them via encrypted email. 3) Store the API key securely (do not expose in browser). 4) For reseller access request a reseller API key; for merchant-scoped actions note the merchant id for PaySimple-Merchant-Id header.

2. Add them to .dlt/secrets.toml

Copy
[sources.paysimple_source]
api_username = "your_api_username_here"
api_key = "your_api_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 Paysimple 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 paysimple_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline paysimple_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 customers and transactions from the Paysimple 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 paysimple_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.paysimple.com",
            "auth": {
                "type": "http_basic",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "customers", "endpoint": {"path": "v4/customer"}},
            {"name": "transactions", "endpoint": {"path": "ps/transact/reporting/transaction/{transactionId}"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="paysimple_pipeline",
        destination="duckdb",
        dataset_name="paysimple_data",
    )
    load_info = pipeline.run(paysimple_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("paysimple_pipeline").dataset()
sessions_df = data.customers.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM paysimple_data.customers LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("paysimple_pipeline").dataset()
data.customers.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 Paysimple 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

Authorization failures

Ensure Authorization header is formatted exactly as PaySimple requires: use the literal scheme word basic then a space then API_USERNAME:API_KEY (no Base64). A 401/403 typically indicates missing or malformed Authorization header or incorrect credentials. If acting for a merchant, include PaySimple-Merchant-Id header with the merchant id.

Pagination and list responses

Many list endpoints return a top-level JSON array (e.g. device list, location_group list, v4 customer list). Check the endpoint's reference response: if the API returns an array no additional data selector is required; otherwise inspect the exact response body for the key that contains records.

Rate limits and error codes

PaySimple responses include HTTP status codes. Common response codes: 200 OK, 400 Bad Request, 401/403 Authorization errors, 404 Not Found. Transaction/reporting endpoints also surface PaySimple response_code fields (4-digit codes) in responses (1000=success, 5000=action required). Follow processor messages in acquirer_message/outcome for decline/error details.

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