paypal, rest, sdk, payments, invoice, subscription, webhook
pip install paypalrestsdk==1.13.3


Deprecation Notice:

This SDK is deprecated. You can continue to use it, but no new features or support requests will be accepted. For alternatives, please visit the current SDK homepage on the PayPal Developer Portal


Continuous integration status:

Build Status Coverage Status

The PayPal REST SDK provides Python APIs to create, process and manage payment. The Paypal REST APIs are fully supported by the sdk.

The REST APIs are getting closer to parity with older merchant APIs. Check out

If deploying on Google appengine and running into issues since requests is a dependency, see #66 for workaround.

The Payment Card Industry (PCI) Council has mandated that early versions of TLS be retired from service. All organizations that handle credit card information are required to comply with this standard. As part of this obligation, PayPal is updating its services to require TLS 1.2 for all HTTPS connections. At this time, PayPal will also require HTTP/1.1 for all connections. See the PayPal TLS Update repository for more information.

**TLSv1_2 warning: Due to PCI compliance, merchant servers using a version of TLS that does not support TLSv1_2 will receive a warning.

**To verify that your server supports PCI compliant version of TLS, test against the PayPal sandbox environment which uses TLS 1.2.

PayPal Checkout v2

Please note that if you are integrating with PayPal Checkout, this SDK and corresponding API v1/payments are in the process of being deprecated.

We recommend that you integrate with API v2/checkout/orders and v2/payments. Please refer to the Checkout Python SDK to continue with the integration.

2.0 Release Candidate!

We're releasing a brand new version of our SDK! 2.0 is currently at release candidate status, and represents a full refactor, with the goal of making all of our APIs extremely easy to use. 2.0 includes all of the existing APIs (except payouts), and includes the new Orders API (disputes and Marketplace coming soon). Check out the FAQ and migration guide, and let us know if you have any suggestions or issues!

System Requirements

PayPal SDK depends on the following system libraries:

  • libssl-dev
  • libffi-dev

On Debian-based systems, run:

apt-get install libssl-dev libffi-dev


Install using pip:

pip install paypalrestsdk


Register for a developer account and get your client_id and secret at PayPal Developer Portal.

import paypalrestsdk
  "mode": "sandbox", # sandbox or live
  "client_id": "EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM",
  "client_secret": "EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM" })

Configure through environment variables:

export PAYPAL_MODE=sandbox   # sandbox or live

Configure through a non-global API object

import paypalrestsdk
my_api = paypalrestsdk.Api({
  'mode': 'sandbox',
  'client_id': '...',
  'client_secret': '...'})

payment = paypalrestsdk.Payment({...}, api=my_api)

Create Payment

import paypalrestsdk
import logging

  "mode": "sandbox", # sandbox or live
  "client_id": "EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM",
  "client_secret": "EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM" })

payment = paypalrestsdk.Payment({
    "intent": "sale",
    "payer": {
        "payment_method": "paypal"},
    "redirect_urls": {
        "return_url": "http://localhost:3000/payment/execute",
        "cancel_url": "http://localhost:3000/"},
    "transactions": [{
        "item_list": {
            "items": [{
                "name": "item",
                "sku": "item",
                "price": "5.00",
                "currency": "USD",
                "quantity": 1}]},
        "amount": {
            "total": "5.00",
            "currency": "USD"},
        "description": "This is the payment transaction description."}]})

if payment.create():
  print("Payment created successfully")

Authorize Payment

for link in payment.links:
    if link.rel == "approval_url":
        # Convert to str to avoid Google App Engine Unicode issue
        approval_url = str(link.href)
        print("Redirect for approval: %s" % (approval_url))

Execute Payment

payment = paypalrestsdk.Payment.find("PAY-57363176S1057143SKE2HO3A")

if payment.execute({"payer_id": "DUFRQ8GWYMJXC"}):
  print("Payment execute successfully")
  print(payment.error) # Error Hash

Get Payment details

# Fetch Payment
payment = paypalrestsdk.Payment.find("PAY-57363176S1057143SKE2HO3A")

# Get List of Payments
payment_history = paypalrestsdk.Payment.all({"count": 10})


Create subscription payments i.e. planned sets of future recurring payments at periodic intervals. Billing plans serve as the template for a subscription while billing agreements can be used to have customers subscribe to the plan.

Create a billing plan

from paypalrestsdk import BillingPlan

billing_plan = BillingPlan({
    "name": "Fast Speed Plan",
    "description": "Create Plan for Regular",
    "merchant_preferences": {
        "auto_bill_amount": "yes",
        "cancel_url": "",
        "initial_fail_amount_action": "continue",
        "max_fail_attempts": "1",
        "return_url": "",
        "setup_fee": {
            "currency": "USD",
            "value": "25"
    "payment_definitions": [
            "amount": {
                "currency": "USD",
                "value": "100"
            "charge_models": [
                    "amount": {
                        "currency": "USD",
                        "value": "10.60"
                    "type": "SHIPPING"
                    "amount": {
                        "currency": "USD",
                        "value": "20"
                    "type": "TAX"
            "cycles": "0",
            "frequency": "MONTH",
            "frequency_interval": "1",
            "name": "Regular 1",
            "type": "REGULAR"
    "type": "INFINITE"

response = billing_plan.create()

Check out more samples. The Subscription REST APIs are fully supported by the sdk.

Also, check out a flask application demonstrating the use of subscription APIs from both merchant and customer points of view.

Future Payments

Check out this sample for executing future payments for a customer who has granted consent on a mobile device.

Third Party Invoicing

Check out this sample for executing third party invoicing for a merchant who has granted consent to send invoice on their behalf.


Create and manage Orders, i.e. getting consent from buyer for a purchase but only placing the funds on hold when the merchant is ready to fulfill the order, have a look at samples


For creating batch and single payouts, check out the samples for payouts and payout items. The Payouts feature enables you to make PayPal payments to multiple PayPal accounts in a single API call.

Create a synchronous payout

from paypalrestsdk import Payout, ResourceNotFound

payout = Payout({
    "sender_batch_header": {
        "sender_batch_id": "batch_1",
        "email_subject": "You have a payment"
    "items": [
            "recipient_type": "EMAIL",
            "amount": {
                "value": 0.99,
                "currency": "USD"
            "receiver": "",
            "note": "Thank you.",
            "sender_item_id": "item_1"

if payout.create(sync_mode=True):
    print("payout[%s] created successfully" %

Explore further payment capabilities

For exploring additional payment capabilites, such as handling discounts, insurance, soft_descriptor and invoice_number, have a look at this example. These bring REST payment functionality closer to parity with older Merchant APIs.

Customizing a PayPal payment experience

Customizing a PayPal payment experience is available as of version 1.5.0 enabling merchants to provide a customized experience to consumers from the merchant’s website to the PayPal payment. Get started with the supported rest methods and samples.

Webhooks - Receive notifications about PayPal Payments

To receive notifications from PayPal about Payment events on your server, webhook support is now available as of version 1.6.0.

  • For creating and managing Webhook and Webhook Events, check out the samples to see how you can use the Python sdk to create and manage webhooks and webhook events.
  • See this sample for verifying that the webhook response is unaltered, from PayPal and targeted towards the intended recipient.
  • See this sample for parsing webhook payload and getting the resource delivered via the webhook event.


Create, send and manage invoices.

Create an invoice

from paypalrestsdk import Invoice

invoice = Invoice({
  'merchant_info': {
    "email": "",
  "billing_info": [{
    "email": ""
  "items": [{
      "name": "Widgets",
      "quantity": 20,
      "unit_price": {
        "currency": "USD",
        "value": 2

response = invoice.create()

OpenID Connect

import paypalrestsdk
from paypalrestsdk.openid_connect import Tokeninfo, Userinfo

  "mode": "sandbox",
  "client_id": "CLIENT_ID",
  "client_secret": "CLIENT_SECRET",
  "openid_redirect_uri": "" })

# Generate login url
login_url = Tokeninfo.authorize_url({ "scope": "openid profile"})

# Create tokeninfo with Authorize code
tokeninfo = Tokeninfo.create("Replace with Authorize code")

# Refresh tokeninfo
tokeninfo = tokeninfo.refresh()

# Create tokeninfo with refresh_token
tokeninfo = Tokeninfo.create_with_refresh_token("Replace with refresh_token")

# Get userinfo
userinfo  = tokeninfo.userinfo()

# Get userinfo with access_token
userinfo  = Userinfo.get("Replace with access_token")

# Generate logout url
logout_url = tokeninfo.logout_url()


  • Include Headers and Content by setting logging level to DEBUG, particularly for Paypal-Debug-Id if requesting PayPal Merchant Technical Services for support logging.basicConfig(level=logging.INFO).
  • Full request and response headers and body is visible at DEBUG level logging only for sandbox or non-production mode. This is done to prevent sensitive information from getting logged in live mode.

Check out more samples. The Invoicing REST APIs are fully supported by the sdk.


Code released under SDK LICENSE


Pull requests and new issues are welcome. See for details.