https://github.com/particulatesolutions/django-paypal-plus

Django plugin for PayPal's Orders and Webhooks API
https://github.com/particulatesolutions/django-paypal-plus

django paypal paypal-rest-api

Last synced: 3 months ago
JSON representation

Django plugin for PayPal's Orders and Webhooks API

• Host: GitHub
• URL: https://github.com/particulatesolutions/django-paypal-plus
• Owner: ParticulateSolutions
• License: mit
• Created: 2017-09-28T07:38:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-26T07:38:50.000Z (6 months ago)
• Last Synced: 2024-10-06T09:15:47.049Z (4 months ago)
• Topics: django, paypal, paypal-rest-api
• Language: Python
• Homepage:
• Size: 203 KB
• Stars: 3
• Watchers: 4
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[//]: # (# django-paypal-plus [![Build Status](https://travis-ci.org/ParticulateSolutions/django-paypal-plus.svg?branch=master)](https://travis-ci.org/ParticulateSolutions/django-paypal-plus))

[![Stable Version](https://img.shields.io/pypi/v/django-paypal-plus?color=blue)](https://pypi.org/project/django-paypal-plus/)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Linting: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

`django-paypal-plus` is a Django plugin that provides integration with PayPal's Orders API and Webhooks API. The package allows for the creation, management, and updating of orders through PayPal's Orders API. It also includes support for creating and listening to webhooks, enabling real-time communication between your application and PayPal's servers for capturing order events.

## Installation

The installation process for django-paypal-plus is straightforward and consists of two main steps:

1. Install the package in your virtual environment using pip:

	```bash

	pip install django-paypal-plus

	```

2. Configure your Django project by adding the following lines to your settings file:

	```python

	# django-paypal-plus

	INSTALLED_APPS += ('django_paypal', )

	

	PAYPAL = True

	

	# Replace the following dummy values with your own PayPal API credentials. These are used in our default webhook view.

	PAYPAL_API_CLIENT_ID = "Your-PayPal-Client-ID"

	PAYPAL_API_SECRET = "Your-PayPal-Secret"

	

	# Optional settings

	PAYPAL_AUTH_CACHE_KEY = "paypal_auth_cache_key" # Default is "django-paypal-auth"

	PAYPAL_AUTH_CACHE_TIMEOUT = 3600 # Default is 600 seconds

	PAYPAL_WEBHOOK_ID = "Your-PayPal-Webhook-ID" # Default is None

	```

## Requirements

```

1. Django >= 2.2

2. Python >= 3.8

```

## Usage

### Create a new order

```python

paypal_wrapper = PaypalWrapper(

	auth=APIAuthCredentials(

		client_id=django_paypal_settings.PAYPAL_API_CLIENT_ID, client_secret=django_paypal_settings.PAYPAL_API_SECRET

	)

)

paypal_order = paypal_wrapper.create_order(

	intent='sale',

	intent='CAPTURE',

	payer={'payment_method': 'paypal'},

	purchase_units=,

	note_to_payer="Thank you for your purchase!",

	payment_source=paypal_api.PaymentSource(paypal=paypal_api.PayPal()),

	cancellation_url=,

	transactions=,

	success_url=

)

```

### Capture an order

```python

paypal_wrapper.capture_order(resource_id)

```

### Listening to webhooks

By default, django-paypal-plus has a ``PaypalWebhookView`` listening to Order events. If you haven't already set up webhooks on PayPal,

``paypal_wrapper.setup_webhooks()`` will do that for you.

## Copyright and license

Copyright 2024 - Tim Burg for Particulate Solutions GmbH, under [MIT license](https://github.com/minddust/bootstrap-progressbar/blob/master/LICENSE).