We are no longer using PayPal at FundedByMe do to terrible customer service and techincal issues with PayPal. We have now moved to Mangopal and are maintaining django-mangopay a django wrapper for their API. If you are interesting is becoming the offical maintainer of this library please let us know.
The API and the modules in this repository might be subject to smaller changes and not all Paypal Adaptive endpoints are covered. FundedByMe will help make the covering of the Pay, Preapproval and IPN endpoints as good as possible but we might not have the resources to perfect this project.
Making Preapprovals and using them to create Payments is fully supported together with Paypal's IPN push API. Please reach out to us if you're interested in helping maintaining this package.
Install package from PyPI:
$ pip install django-paypal-adaptive
Add to your project's INSTALLED_APPS setting:
INSTALLED_APPS = (
# …
'paypaladaptive',
)Sync the database:
$ python manage.py syncdb
Or if you're using South you might want to add an initial migration for future changes:
$ python manage.py schemamigration paypaladaptive --initial
$ python manage.py syncdb --migrate
Create and process a preapproval for a payment.
from paypaladaptive.models import Preapproval
from money.Money import Money
preapproval = Preapproval()
preapproval.money = Money(2000, 'usd')
preapproval.save()
preapproval.process(next='/home/', displayMaxTotalAmount=True)
# Redirect the user to the next_url() value
redirect_url = preapproval.next_url()Create and process a payment to two receivers from a preapproval key.
from paypaladaptive.models import Payment
from paypaladaptive.api import ReceiverList, Receiver
from money.Money import Money
key = 'PA-2MT146200X905683P'
platform = Receiver(amount=100, email="merchant@example.com", primary=False)
merchant = Receiver(amount=1900, email="mrbuyer@antonagestam.se", primary=True)
receivers = ReceiverList([platform, merchant])
p = Payment()
p.money=Money(2000, 'USD')
p.save()
p.process(receivers, preapproval_key=key)Paypal Adaptive uses IPN messages to ping your server about Payment and Preapproval updates. Using IPN requires you to listen for incoming calls from Paypal. Sometimes Paypal has issues with their IPN service and therefor you might sometimes need to ping them for an update of the status instead. This package comes with both and they can be used in parallel. That way you get both the speed and asynchronous nature of IPN messages and the stability of delayed lookups. Delayed lookups are disabled by default and requires Celery to be installed. To install this requirement automatically, use:
$ pip install django-paypal-adaptive[delayed-updates]
And set PAYPAL_USE_DELAYED_UPDATES to True in your Django settings. Note
that this requires you to setup Celery on your own.
You can also implement your own background tasks and logic and call
Preapproval.update() and Payment.update() when you find it appropriate.
The Payment and Preapproval inherit from an abstract model PaypalAdaptive and therefor shares some data fields.
PaypalAdaptive.money
money is a python-money MoneyField. MoneyField extends Django's DecimalField
so has max_digits and decimal_places attributes that can be set with the
PAYPAL_MAX_DIGITS and PAYPAL_DECIMAL_PLACES settings.
PaypalAdaptive.created_date
DateTimeField with auto_now_add=True.
PaypalAdaptive.debug_request
Raw request body (JSON)
PaypalAdaptive.debug_response
Raw response body (JSON)
PaypalAdaptive.secret_uuid
Secret identifier of each object.
Payment.status
Possible values are:
'new' # Payment only exists locally
'created' # Payment exists on Paypal
'error' # Something along the process has gone wrong. Check status_detail
# for more info.
'returned' # User has returned via the Payment return_url
'completed' # The Payment is complete
'refunded' # The Payment is refunded
'canceled' # The Payment has been canceled
Payment.status_detail
Stores error messages from the latest transaction
Payment.pay_key
Corresponds to Paypal Adaptive's payKey
Payment.transaction_id
Corresponds to Paypal Adaptive's transactionId
Preapproval.status
Possible values are:
'new' # Preapproval only exists locally — not known to Paypal
'created' # Preapproval has been saved on Paypal
'error' # Something has gone wrong, check status_detail for more info
'returned' # User has returned via the Preapproval return_url
'approved' # Preapproval is completed — ready to be used in payment
'canceled' # Preapproval has been canceled
'used' # Preapproval has been used in payment
Preapproval.status_detail
Stores error messages from the latest transaction
Preapproval.valid_until_date
Preapproval expiry date
django.conf.settings.PAYPAL_APPLICATION_ID
Your Paypal application ID. Will default to APP-80W284485P519543T if
DEBUG is set to True.
django.conf.settings.PAYPAL_USERID
Paypal User ID
django.conf.settings.PAYPAL_PASSWORD
Paypal password
django.conf.settings.PAYPAL_SIGNATURE
Paypal signature
django.conf.settings.PAYPAL_EMAIL
Paypal Email
django.conf.settings.PAYPAL_USE_IPN
Whether or not to listen for incoming IPN messages. Defaults to True.
django.conf.settings.PAYPAL_USE_DELAYED_UPDATES
Whether or not to schedule update tasks for Preapprovals and Payments. Defaults
to False.
django.conf.settings.DEFAULT_CURRENCY
Used by python-money, will default to USD
django.conf.settings.PAYPAL_DECIMAL_PLACES
Number of decimal places assigned to the MoneyField (used by Payment and Preapproval models).
django.conf.settings.PAYPAL_MAX_DIGITS
Max number of digits assigned to the Moneyfield (used by Payment and Preapproval models).
django.conf.settings.PAYPAL_TEST_WITH_MOCK
Set whether tests should be run with built-in mocking responses and requests or if the testing should spawn requests that hits Paypal's APIs directly. Defaults to True.
To run the tests, first install the test requirements:
$ [sudo] pip install -r requirements_test.txt --use-mirrors
The script that runs the tests simulates an installed Django app and is located
in runtests.py. Execute it like this:
$ python runtests.py
Do you want to contribute? We'll gladly accept pull requests as long as your code is well tested and contributes to the goal of this library.
django-paypal-adaptive av FundedByMe är licensierad under en Creative Commons Erkännande 3.0 Unported licens.
Based on a work at https://github.com/gmcguire/django-paypal-adaptive.
