Metadata-Version: 2.4
Name: pretix-thepay
Version: 6.0.2
Summary: The Pay payment provider for Pretix
Author-email: KrisIsNew <thepay.pretix@krisisnew.xyz>
Maintainer-email: KrisIsNew <thepay.pretix@krisisnew.xyz>
License: Apache-2.0
Project-URL: homepage, https://github.com/krisisnewxyz/pretix-thepay
Project-URL: repository, https://github.com/krisisnewxyz/pretix-thepay
Project-URL: documentation, https://github.com/krisisnewxyz/pretix-thepay
Project-URL: issues, https://github.com/krisisnewxyz/pretix-thepay/issues
Keywords: pretix,payment,thepay
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
Requires-Dist: pretix>=2.7.0
Requires-Dist: requests>=2.25.0

pretix-thepay
=============

The Pay payment provider plugin for Pretix.

This plugin provides full integration with the The Pay payment gateway for Pretix event ticketing system, implementing secure payment processing with The Pay REST API and HMAC-SHA256 signature verification.

Features
--------

- Full The Pay integration with REST API
- Secure payment processing with HMAC-SHA256 signatures
- Support for multiple currencies (ISO 4217)
- Server-to-server notifications (IPN)
- User redirect handling
- Test mode support
- Proper error handling and logging
- Multi-language support (Czech, Slovak, English)

Installation
------------

Install from PyPI::

    pip install pretix-thepay

Or install from source::

    pip install -e /path/to/pretix-thepay

Add the plugin to your Pretix configuration (``pretix.cfg``)::

    [pretix]
    plugins = pretix_thepay

Restart your Pretix instance.

Configuration
-------------

1. Go to your event's payment settings in the Pretix control panel.
2. Enable the The Pay payment provider.
3. Configure the following settings:

   - **Merchant ID**: Your The Pay merchant ID
   - **Project ID**: Your The Pay project ID
   - **API Password**: Your The Pay API password
   - **API URL**: The Pay API URL
     - Production: ``https://api.thepay.cz/``
     - Test: Use the test API URL provided by The Pay
   - **Gate URL**: The Pay gate URL for redirects
     - Production: ``https://gate.thepay.cz/``
     - Test: Use the test gate URL provided by The Pay
   - **Language**: Default language for payment gateway (Czech, Slovak, or English)
   - **Test Mode**: Enable for testing

Requirements
------------

- Pretix >= 4.0.0
- Python >= 3.8
- requests >= 2.25.0

Security
--------

This plugin implements The Pay's security requirements:

- All payment requests are signed using HMAC-SHA256 with your API password
- All payment responses are verified using HMAC-SHA256 signatures
- API credentials are stored securely in Pretix's configuration
- Message integrity is verified for all transactions

How It Works
------------

1. **Payment Initiation**: When a customer selects The Pay, a payment is created via The Pay REST API and the customer is redirected to The Pay gateway.

2. **Payment Processing**: The customer completes payment on The Pay's secure gateway.

3. **Return Handling**: After payment, the customer is redirected back to your Pretix instance, where the payment status is verified using The Pay's signature.

4. **Server Notification**: The Pay also sends a server-to-server notification to confirm the payment status.

Supported Currencies
--------------------

The Pay supports all ISO 4217 currency codes. Common currencies include:

- CZK (Czech Koruna)
- EUR (Euro)
- USD (US Dollar)
- GBP (British Pound)
- PLN (Polish Zloty)
- And many more...

Docker Installation
-------------------

You can install the plugin in a Dockerized Pretix environment::

    FROM pretix/standalone:stable
    USER root
    RUN pip3 install pretix-thepay
    USER pretixuser
    RUN cd /pretix/src && make production

Troubleshooting
---------------

Payment Not Processing
^^^^^^^^^^^^^^^^^^^^^^

- Verify your merchant ID and project ID are correct
- Check that API password is correct
- Ensure the API and gate URLs are correct for your environment (test/production)
- Check Pretix logs for detailed error messages

Signature Verification Failures
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- Verify you're using the correct API password
- Ensure parameters are being sent in the correct format
- Check that the signature generation matches The Pay's requirements

API Connection Issues
^^^^^^^^^^^^^^^^^^^^^

- Verify network connectivity to The Pay API
- Check that API URL is accessible
- Ensure firewall rules allow outbound connections to The Pay servers

License
-------

Apache Software License 2.0

Support
-------

For issues related to:

- **Plugin functionality**: Check the Pretix documentation and plugin development guide
- **The Pay integration**: Refer to The Pay's integration documentation at https://docs.thepay.eu/
- **Payment processing**: Contact The Pay support

References
----------

- `Pretix Plugin Development Guide <https://docs.pretix.eu/dev/development/api/index.html>`_
- `The Pay API Documentation <https://docs.thepay.eu/>`_
- `The Pay API Client (PHP) <https://packagist.org/packages/thepay/api-client>`_

