Epay Python API Docs | dltHub

Epay is a payments platform providing payin/payout, transaction query, balance and KYC APIs for merchants. The REST API base URL is https://api.epay.com and API uses an API_KEY (shared secret) included in request signatures; some newer ePay (epay.eu) product uses Bearer tokens for payments API..

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

---

What data can I load from Epay?

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

---

How do I authenticate with the Epay API?

For the classic Epay Gateway you obtain an API_KEY in the merchant dashboard and include it when calculating the V2_HASH signature (MD5‑based) passed as V2_HASH in POST parameters. The newer ePay Payments API uses HTTP Bearer tokens in the Authorization header for requests.

1. Get your credentials

1. Register/login to your Epay merchant account (https://www.epay.com/epayweb/register?lang=en). 2) Go to API Management in the dashboard. 3) Complete KYC and submit merchant application if required. 4) Generate API_KEY by clicking Recreate/Generate API_KEY and confirm with payment password and 2FA. 5) (Optional) Set IP whitelist for payout endpoints.

2. Add them to .dlt/secrets.toml

Copy
[sources.epay_source]
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 Epay 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 epay_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline epay_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 transactions and balance from the Epay 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 epay_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.epay.com",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "transactions", "endpoint": {"path": "paymentApi/getTransactionRecords", "data_selector": "TRAN_LIST"}},
            {"name": "balance", "endpoint": {"path": "paymentApi/getAccountBalance", "data_selector": "ACCOUNT_LIST"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM epay_data.transactions LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("epay_pipeline").dataset()
data.transactions.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 Epay 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 failures

If V2_HASH/signature is missing or incorrect the API returns RETURN_CODE != "0000" (e.g. 1111 or other error codes) and RETURN_MSG with error details. Ensure V2_HASH is MD5 of the exact fields specified by each endpoint and that API_KEY matches merchant dashboard value. For payout endpoints also ensure request originates from an IP in the whitelist.

Rate limits and timeouts

Classic Epay documentation does not specify rate limits; implement exponential backoff and retries on transient network errors and non-0000 return codes.

Pagination and selectors

getTransactionRecords returns pagination fields PAGE_SIZE, PAGE_NUM and the list in TRAN_LIST. Use TRAN_LIST as the data selector for records. Responses often wrap lists in RETURN_CODE/RETURN_MSG and the list key (TRAN_LIST, ACCOUNT_LIST).

Common error codes

0000: success (or RETURN_CODE: 0 in some endpoints). 1111: general failure/transaction failed. Other RETURN_CODE and RETURN_MSG provide diagnostic text.

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