Skip to main content

Getting Started with PayPal REST APIs

Introduction

An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders., Call the Payments API to authorize payments, capture authorized payments, refund payments that have already been captured, and show payment information. Use the Payments API in conjunction with the Orders API. For more information, see the PayPal Checkout Overview., The Payment Method Tokens API saves payment methods so payers don't have to enter details for future transactions. Payers can check out faster or pay without being present after they agree to save a payment method.

The API associates a payment method with a temporary setup token. Pass the setup token to the API to exchange the setup token for a permanent token.

The permanent token represents a payment method that's saved to the vault. This token can be used repeatedly for checkout or recurring transactions such as subscriptions.

The Payment Method Tokens API is available in the US only.

Find out more here: https://developer.paypal.com/docs/api/orders/v2/

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install hadassah-shelton-sdk==3.3.3

You can also view the package at: https://pypi.python.org/pypi/hadassah-shelton-sdk/3.3.3

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
environment Environment The API environment.
Default: Environment.SANDBOX
http_client_instance HttpClient The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ['GET', 'PUT']
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
client_credentials_auth_credentials ClientCredentialsAuthCredentials The credential object for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

client = PaypalrestapisClient(
    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
        o_auth_client_id='OAuthClientId',
        o_auth_client_secret='OAuthClientSecret'
    ),
    environment=Environment.SANDBOX,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name Description
Production PayPal Live Environment
Sandbox Default PayPal Sandbox Environment

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for hadassah-shelton-sdk 3.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hadassah-shelton-sdk 3.3.3
File Size Uploaded
hadassah_shelton_sdk-3.3.3.tar.gz 168.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hadassah-shelton-sdk 3.3.3
File Interpreter ABI Platform
hadassah_shelton_sdk-3.3.3-py3-none-any.whl Python 3 none any Details

Total release size: 559.3 kB

Release files / hadassah_shelton_sdk-3.3.3.tar.gz

Download URL hadassah_shelton_sdk-3.3.3.tar.gz
Size 168.3 kB
Tags Source
SHA-256 checksum
How to use checksums
1da3785d9ed5680df267820867d157d5a1d2f1d5b7ea3ac73b7e6e76144bee07
BLAKE2b-256 checksum
How to use checksums
b45f3aa01b7c5461e17f24927e4eb38aa5593d3b10a6cc1e3924c476fd44a87a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.13

Release files / hadassah_shelton_sdk-3.3.3-py3-none-any.whl

Download URL hadassah_shelton_sdk-3.3.3-py3-none-any.whl
Size 391.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bec266b4326dfdadd0a9ce59f069b098195596f66824405ebe86ec4d2c96be7c
BLAKE2b-256 checksum
How to use checksums
681adeeea2f4da3951211fa09cd9ab36d4842ed57fa5fe02ef40a008c8a824ac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.13

Release history Release notifications | RSS feed

This release

3.3.3 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page