/python-payson

Python API for the Payson payments provider

Primary LanguagePythonMIT LicenseMIT

python-payson

Python API to the Payson payments provider.

Installation

From pypi (recommended):

$ pip install payson_api

If this doesn't work the entire library is contained in a single Python module, payson_api.py. Just drop it anywhere in your projects PYTHONPATH. It is not dependent on anything outside the Python standard library (except in the tests).

Tested with Python 2.7.

Examples

Initiate payment:

import decimal
import payson_api

from your_settings_module import payson_user_id, payson_user_key

api = payson_api.PaysonApi(payson_user_id, payson_user_key)

receiver = payson.Receiver(email='payments@example.com',
                           firstName=u'Pelle',
                           lastName=u'Persson',
                           amount=decimal.Decimal('125.0'),
                           primary=False)

payment_response = api.pay(returnUrl='http://example.com/return_url',
                           cancelUrl='http://example.com/cancel_url',
                           memo=u'Purchase of nice things.',
                           senderEmail='anna.andersson@example.com',
                           senderFirstName=u'Anna',
                           senderLastName=u'Andersson',
                           receiverList=[receiver, ])
                       
if payment_response.success:
    # Redirect users browser to Payson
    redirect(payment_response.forward_pay_url)

Get payment details:

payment_details = api.payment_details(payment_response.token)
if payment_details.status == 'COMPLETED':
    #  We got money :)
    ...

Data Types

  • all strings except urls and e-mail addresses are expected to be unicode
  • monetary values returned are converted to decimal.Decimal
  • timestamps are converted to datetime.datetime
  • true/false is converted to bool
  • error codes are converted to int
  • the 'custom' field is serialized/deserialized with JSON

More documentation

Please see the docstrings included in payson_api.py and/or the Payson API documentation

Testing

The PaysonApi constructor detects if user id and key used are testing credentials and will then use the Payson test system.

The included test.py file includes some automated tests using python-mechanize that can be run with nosetests. The tests are broken right now due to changes in the flow over at Payson. Fixing this is on the TODO list :)

Contact

The author of this software offers integration services if requested. Reach him through github.

Issues are reported through github.