Welcome to Django payments payu’s documentation!¶

Contents:

Installation¶

At the command line:

$ easy_install django-payments-payu

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv django-payments-payu
$ pip install django-payments-payu

Django payments payu¶

NOTE: This project is still in development, so use with extreme caution.

PayU payments provider for django-payments. Uses the new PayU REST API. Supports normal, express and recurring payments.

Documentation¶

The full documentation is at https://django-payments-payu.readthedocs.io.

Quickstart¶

Install django-payments and set up PayU payment provider backend according to django-payments documentation:

class payments_payu.provider.PayuProvider(client_secret, second_key, pos_id[, sandbox=False, endpoint="https://secure.payu.com/", recurring_payments=False, express_payments=False, widget_branding=False])¶: This backend implements payments using PayU.com.

Set up the payment provider:

Example:

# use sandbox
PAYMENT_VARIANTS = {
    'payu': ('payments_payu.provider.PayuProvider', {
        'pos_id': '123456',
        'second_key': 'iseedeadpeople',
        'client_secret': 'peopleiseedead',
        'sandbox': True,
        'capture': False,
    }),
}

Here are valid parameters for the provider:

recurring_payments:
client_secret:	PayU OAuth protocol client secret
pos_id:	PayU POS ID
second_key:	PayU second key (MD5)
shop_name:	Name of the shop send to the API
sandbox:	if `True`, set the endpoint to sandbox
endpoint:	endpoint URL, if not set, the will be automatically set based on sandbox settings
	enable recurring payments, only valid with `express_payments=True`, see bellow for additional setup, that is needed
express_payments:
	use PayU express form
widget_branding:
	tell express form to show PayU branding
store_card:	(default: False) whether PayU should store the card

NOTE: notifications about the payment status from PayU are requested to be sent to django-payments process_payment url. The request from PayU can fail for several reasons (i.e. it can be blocked by proxy). Use “Show reports” page in PayU administration to get more information about the requests.

Recurring payments:

If recurring payments are enabled, the PayU card token needs to be stored in your application for usage in next payments. The next payments can be either initiated by user through (user will be prompted only for payment confirmation by the express form) or by server. To enable recurring payments, you will need to set additional things:

NOTE: Recurring payments are not enabled by default even in Sandbox, you sould consult their helpdesk to enable this.

In order to make payments recurring, the card token needs to be stored for the Payment’s user (not just the payment itself). Implement the Payment.set_renew_token() and Payment.get_renew_token().
Implement Payment.get_payment_url().
For the server initiated recurring payments you will need to create the new payment and then call payment.auto_complete_recurring().
- The method returns either string ‘success’ or url where the user can provide his CVV2 or 3D secure information.
- The 'success' string means, that the payment is waiting for notification from PayU, but no further user action is required.

Example of triggering recurring payment:

payment = Payment.objects.create(...)
redirect_url = payment.auto_complete_recurring()
if redirect_url != 'success':
    send_mail(
        'Recurring payment - action required',
        'Please renew your CVV2/3DS at %s' % redirect_url,
        'noreply@test.com',
        [user.email],
        fail_silently=False,
    )

Running Tests¶

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits¶

Tools used in rendering this package:

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/PetrDlouhy/django-payments-payu/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

Django payments payu could always use more documentation, whether as part of the official Django payments payu docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/PetrDlouhy/django-payments-payu/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up django-payments-payu for local development.

Fork the django-payments-payu repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/django-payments-payu.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv django-payments-payu
$ cd django-payments-payu/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 payments_payu tests
$ python setup.py test
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/PetrDlouhy/django-payments-payu/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_payments_payu

Credits¶

Development Lead¶

Petr Dlouhý <petr.dlouhy@email.cz>

Contributors¶

None yet. Why not be the first?

History¶

1.2.3 (2022-01-25)¶

better distinct PayU API errors

1.2.2 (2021-11-30)¶

solve the duplicate order case that errored already confirmed payment

1.2.1 (2021-10-29)¶

set fraud status if PayU anti-froud error
store PayU error on payment

1.2.0 (2021-10-11)¶

user Payment.billing_* correctly - the functions like get_user or get_user_email, get_user_first_name and get_user_last_name were redundant and are not called anymore.
Shop name is taken from provider configuration variable shop_name

1.1.0 (2021-10-05)¶

redirect to payment.get_failure_url() after API error, log the error

1.0.0 (2020-10-21)¶

first major release
many fixes
recurring payments working
proved by production environment

0.3.0 (2020-05-30)¶

fix amount quantization
add store_card parameter
fix base url parameter for express form

0.2.0 (2020-04-13)¶

Second release
Fixed testing matrix

0.1.0 (2020-04-06)¶

First release on PyPI.
Still in development.