python-paypal-api 0.1.1

Paypal Python 3 API integration

PYTHON-PAYPAL-API

Paypal's Rest API

A python 3 wrapper to access Paypal Rest API with an easy-to-use interface.

Install

pip install python-paypal-api

Donate

If you find this project is useful consider donating or sponsor it to keep on going on it, thank you.

Overview

You need obtain your own credentials with Paypal that may include a paypal personal or business account and access as developer. Please view the official Paypal Developer

You can also check how use the credentials on the documentation of this Python Paypal API.

Environment Credentials

from python_paypal_api.api import Identity

os.environ["client_id"] = "your-client-id"
os.environ["client_secret"] = "your-client-secret"
# os.environ["client_mode"] = "PRODUCTION"

# Can omit client_mode if using SANDBOX

result = Identity().get_userinfo()

Code Credentials

You can use your credentials as follows passing it to the client as a dict. Please review the full documentation to see all posibilities to include your credentials.

Python code

from python_paypal_api.api import Identity

my_credentials = dict(
    client_id="your-client-id",
    client_secret="your-client-secret",
    client_mode="PRODUCTION"
)

# Can omit client_mode to use SANDBOX

result = Identity(credentials=my_credentials).get_userinfo()

YAML Credentials

Use a config.yaml file with your credentials for more convenience and manage diferent accounts or profiles. You can store a Sandbox and Production (Live) credentials to comvenient switch from sandbox to live environment. Note: default credentials without client_mode will use SANDBOX paypal endpoint for testing

Create a file config.yaml (From version 0.1.1 the file use the default name provided by confuse package and use template validation)

Please review the full documentation to see all posibilities to include in your configuration.

version: '1.0'

configuration:

  production:
    client_id: 'your-client-id'
    client_secret: 'your-client-secret'
    client_mode: 'PRODUCTION'
  default:
    client_id: 'your-client-id-sandbox'
    client_secret: 'your-client-secret-sandbox'

Python code

from python_paypal_api.api import Identity

# Leave empty will use the 'default' account
result = Identity().get_userinfo()
# will use germany account data
result = Identity(credentials="production").get_userinfo()

Search path for config.yaml

• macOS: ~/.config/python-paypal-api and ~/Library/Application Support/python-paypal-api
• Other Unix: ~/.config/python-paypal-api and /etc/python-paypal-api
• Windows: %APPDATA%\python-paypal-api where the APPDATA environment variable falls back to %HOME%\AppData\Roaming if undefined

Confuse Help

Managing obtained credentials

By default the package will store it in cache to use the LRU Cache from cachetools but the cache will be available only during the script living environment, so once you get the token, any call will use the cached token but since the script terminates the cached key will be gone.

There is a way to create a 600 permissions file in the configuration search path. This is because the token obtained it will ve valid for 32400 seconds and storing it will reduce the calls to the oauth paypal endpoint. The token also can be stored encrypted, for complex configurations read the Python Paypal API Help.

from python_paypal_api.api import Identity
from python_paypal_api.base import PaypalApiException
import logging

try:

    result = Identity(store_credentials=True).get_userinfo()
    logging.info(result)

except PaypalApiException as error:
    logging.error(error)

Exceptions

You can use a try except statement when you call the API and catch exceptions if some problem ocurred:

from python_paypal_api.api import Identity
from python_paypal_api.base import PaypalApiException
import logging

try:

    result = Identity().get_userinfo()
    logging.info(result)

except PaypalApiException as error:
    logging.error(error)

Debug

Use debug=True if you want see some logs like the header you submit to the api endpoint, the method and path used among the params and the data submitted if any, to trace possible errors.

from python_paypal_api.api import Identity,
from python_paypal_api.base import PaypalApiException
import logging

try:

    result = Identity(debug=True).get_userinfo()
    logging.info(result)

except PaypalApiException as error:
    logging.error(error)

Paypal Current Resources

• Catalog
• Disputes
• Identity
• Invoices
• Orders
• Partner Referral
• Tracking
• Transactions

API NOTICE

This API is based on the API Client created by @saleweaver but adapted to paypal auth requeriments and improved system for token call

DISCLAIMER

We are not affiliated with PayPal

LICENSE