PayPal HTTP Client

Warnings

• gotcha paypalhttp is a low-level HTTP client, not a full PayPal SDK. It provides the HTTP transport layer but does not include high-level API wrappers, specific PayPal API models, or built-in authentication for PayPal's services. Users often expect a higher-level SDK when interacting with 'PayPal' libraries.
  Fix: Use a higher-level PayPal SDK (e.g., `paypal-checkout-serversdk` for checkout or `paypal-payouts-sdk` for payouts) which leverages `paypalhttp` internally and handles API-specific concerns and authentication.
• gotcha Authentication and full API URL construction are external concerns. `paypalhttp.HttpClient` requires a base URL during initialization and expects request objects to provide relative paths. Authentication (e.g., OAuth tokens for PayPal APIs) must be injected into requests or handled by a subclassing client, as shown in official PayPal SDKs.
  Fix: When integrating with PayPal APIs, always use `paypalhttp` through a wrapper like `paypalcheckoutsdk.core.PayPalHttpClient` or implement your own `HttpClient` subclass to manage base URLs and inject authentication headers correctly.
• gotcha Error handling for API responses requires explicit checks. While `paypalhttp` will raise exceptions for network or client-side issues, HTTP errors returned by the API (e.g., 400 Bad Request, 404 Not Found, 500 Internal Server Error) are represented in the `response.status_code` and `response.result` attributes, not as exceptions. You must inspect these values.
  Fix: After executing a request, always check `response.status_code` to determine if the API call was successful (typically `2xx`). Parse `response.result` for API-specific error details when the status code indicates an error.

Install

• pip install paypalhttp Install stable version

Imports

• HttpClient

  from paypalhttp.http_client import HttpClient

  HttpClient is nested in the 'http_client' module.
• GetRequest

  from paypalhttp.requests import GetRequest

  HTTP request classes (GetRequest, PostRequest, etc.) are in the 'requests' module.
• JsonSerializer

  from paypalhttp.serializers import JsonSerializer

  Serializers (JsonSerializer, MultipartSerializer, etc.) are in the 'serializers' module.

Quickstart

This quickstart demonstrates how to instantiate a basic `HttpClient`, define a GET request, and execute it against a public test API (`httpbin.org`). It highlights the low-level nature of `paypalhttp`, where you define the base URL and manage request details yourself. In a real PayPal integration, `paypalhttp.HttpClient` is typically subclassed to handle authentication and specific PayPal API base URLs.

import os
from paypalhttp.http_client import HttpClient
from paypalhttp.requests import GetRequest
from paypalhttp.serializers import JsonSerializer

# Define a custom client that uses a base URL
class MyGenericApiClient(HttpClient):
    def __init__(self):
        # paypalhttp is a low-level client; it doesn't handle authentication
        # or full API paths directly. It expects a base URL and relative paths.
        # In real PayPal SDKs, this would be 'https://api.sandbox.paypal.com'
        # or 'https://api.paypal.com'. Using httpbin.org for a runnable example.
        super().__init__('https://httpbin.org')

# Instantiate the custom client
client = MyGenericApiClient()

# Create a GET request to a test endpoint
request = GetRequest('/get') # This will hit https://httpbin.org/get

# You can add headers, parameters, or a body (with a serializer)
request.headers['User-Agent'] = 'PayPalHttp-Client-Example'

print(f"Making request to: {client.environment_url}{request.path}")

try:
    # Execute the request
    response = client.execute(request)

    print(f"\nStatus Code: {response.status_code}")
    print(f"Headers: {response.headers}")
    # The 'result' attribute contains the deserialized response body
    # For httpbin.org/get, this is typically a JSON object.
    print(f"Result (JSON): {response.result}")

except Exception as e:
    print(f"\nError executing request: {e}")