nijel-thepay

======= ThePay

Library for accesing ThePay payment gateway from python

.. image:: https://github.com/nijel/thepay/workflows/Test/badge.svg :target: https://github.com/nijel/thepay/actions?query=workflow%3ATest

.. image:: https://img.shields.io/pypi/v/nijel-thepay.svg :target: https://pypi.org/project/nijel-thepay/ :alt: PyPI package

.. image:: https://codecov.io/gh/nijel/thepay/branch/master/graph/badge.svg :target: https://codecov.io/gh/nijel/thepay

======== Example

Configure ThePay account

.. code-block:: python

from thepay.config import Config
config = Config()
config.setCredentials(12345, 12345, 'abcdefg12345', 'abcdefg12345')  # Credentials from ThePay account settings

List available payment methods

.. code-block:: python

from thepay.dataApi import DataApi
data_api = DataApi(config)
payments = data_api.getPaymentMethods()

print methods as radio buttons with images

.. code-block:: python

<div>
    {% for payment in payments %}
     <div class="payment-method">
        <input type="radio" name="payment_method" value="{{ payment.id }}" id="payment_{{ payment.id }}">
        <label for="payment_{{ payment.id }}" title="{{ payment.name }}">
           <img src='http://www.thepay.cz/gate/images/logos/public/209x127/{{ payment.id }}.png' alt="{{ payment.name }}">
        </label>
     </div>
    {% endfor %}
</div>

Redirect user to ThePay - create payment

.. code-block:: python

from thepay.payment import Payment

payment = Payment(config)

payment.setValue(321)
payment.setMethodId(13) # ID of payment method from above
payment.setCustomerEmail('[e-mail]')
payment.setDescription('Order 123 payment')
payment.setReturnUrl('https://example.com/payment')  # where to redirect user after payment
payment.setMerchantData(123)  # Any custom data - not visible to user

payment.getCreateUrl()  # Redirect user to this URL to begin payment

Check incomming payment

This code should be run on returnUrl from above code

.. code-block:: python

from thepay.payment import ReturnPayment

return_payment = ReturnPayment(config)
return_payment.parseData(self.request.GET)  # Pass all GET received data in form of dict()

if not return_payment.checkSignature():
    return False  # Invalid payment signature

return_payment.getMerchantData()  # -> 123, previously saved custom data
return_payment.getValue()  # -> 321
return_payment.getStatus()  # Order status, see next paragraph

Order statuses

• 2 = STATUS_OK
• 3 = STATUS_CANCELED
• 4 = STATUS_ERROR
• 6 = STATUS_UNDERPAID
• 7 = STATUS_WAITING
• 9 = STATUS_CARD_DEPOSIT

Get info about payment

.. code-block:: python

payment_id = return_payment.getPaymentId()
payment = data_api.getPayment(payment_id)  # returns object with all payment data

======== License

LGPL