CData Python Connector for PayPal

Build 26.0.9655

CData Python Connector for PayPal

Overview

The CData Python Connector for PayPal allows developers to write Python scripts with connectivity to PayPal. The connector wraps the complexity of accessing PayPal data in an interface commonly used by Python connectors to common database systems.

Key Features

  • WHL installation packages that enable installation with "pip install".
  • Supported for Python 3.10 or newer on Windows, Linux, and macOS.
  • Write and execute SQL queries to fetch data in PayPal.
  • Custom dialect class that enables SQLAlchemy 1.3 and 1.4 to use this connector.

Getting Started

See Getting Started to install the connector to your Python distribution and to create a basic connection to PayPal.

Using the Python Connector/Using from Tools

See Using the Connector for examples of executing basic SELECT, INSERT, UPDATE, DELETE, and EXECUTE queries with the module's provided classes.

See Using from Tools to connect PayPal data to tools such as Pandas or Petl.

SQLAlchemy ORM

SQLAlchemy can be leveraged to model the tables in PayPal with mapped classes. See From SQLAlchemy for instructions for configuring the Python connector with SQLAlchemy.

Pandas

Pandas' DataFrames can be used alongside the connector to generate analytical graphics. See From Pandas for a guide.

Schema Discovery

See Schema Discovery to query the provided system tables, which allows users to discover the available tables, views, and stored procedure, alongside additional information about their columns or parameters.

Advanced Features

Advanced Features details additional features supported by the connector, such as defining user defined views, ssl configuration, remoting, caching, firewall/proxy settings, and advanced logging.

SQL Compliance

See SQL Compliance for a syntax reference and code examples outlining the supported SQL.

Data Model

See Data Model for the available database objects. This section also provides more detailed information on querying specific PayPal entities.

Connection String Options

The Connection properties describe the various options that can be used to establish a connection.

CData Python Connector for PayPal

Getting Started

Connecting to PayPal

For information on the available WHL files for supported environments, and how to install the appropriate file for your Python distribution, see Package Installation.

For information on the module to import, and how to configure the necessary connection properties in a connection string, see Establishing a Connection.

Other available connection properties can be used to configure other aspects of the connector capabilities.

Python Version Support

The CData Python Connector for PayPal can be installed and used in Python 3.10 or newer.

PayPal Version Support

The connector uses the PayPal SOAP API to surface views of transactions and the REST API to surface all other views.

See Also

  • Using the Connector: Establish connections and query PayPal through Python code.
  • From SQLAlchemy: Use SQLAlchemy to establish a connection with dialect URL, and interact with PayPal data using mapped classes and Sessions.

CData Python Connector for PayPal

Package Installation

Dependencies

The Python connectors require that Python 3.10 or newer be installed.

Installation

The CData Python Connector for PayPal is available as a WHL file for Windows, Linux, and Mac. Each connector is built using the Python 3.10 Stable ABI (indicated by the abi3 tag in the filename), so a single wheel supports any Python 3.10 or newer installation — there is no need to match your exact Python minor version. Use the "pip install" command with the appropriate WHL file for your platform.

Windows:

pip install cdata_paypal_connector-26.0.9655-cp310-abi3-win_amd64.whl

Linux:

pip install cdata_paypal_connector-26.0.9655-cp310-abi3-linux_x86_64.whl

macOS:

pip install cdata_paypal_connector-26.0.9655-cp310-abi3-macosx_12_0_arm64.whl

The macOS wheel supports arm64 (Apple Silicon) architectures only on macOS 12 and newer.

Regardless of the environment, certain distributions might require that the "pip3 install" command be used instead, to differentiate from a Python 2 distribution that might exist already. After installation, confirm whether the connector is successfully installed by running the "pip list" command. If "cdata_paypal_connector" is present in the list output by the command, then the installation was successful.

Upgrading

When upgrading, "pip install" does not automatically clean up old JRE files. To avoid leftover files that could cause JVM errors, uninstall the previous version before installing the new one.

Licensing

After the installation is complete, a separate step is needed to activate a license for the connector. Among the CData assets in the distribution's site packages, there is an install-license tool that activates this license. From within the distribution's site-packages folder, after navigating to the "cdata/installlic_paypal" folder, simply use a command like the below to activate the license. Omitting the <key> argument activates a trial license:

  • Windows:
    ./install-license.exe <key>
  • Linux / Mac:
    ./install-license.sh <key>

Sometimes, file access issues may cause pip to install the connector in a fallback file path that is not the python distribution's main or primary site-packages location. This can make it difficult to find where the connector was installed, and from there, the license activator. In that event, this python script below will print out the full file path of the connector's native file. This file will be stored in the mentioned cdata folder, from which the installlic_paypal folder is trivial to find:

import os
import cdata.paypal
path = os.path.abspath(cdata.paypal.__file__)
print(path)

Uninstallation

If the connector needs to be uninstalled for any reason, do so by running the pip uninstall command, as in the example below:

pip uninstall cdata-paypal-connector

CData Python Connector for PayPal

Establishing a Connection

The objects available within our connector are accessible from the "cdata.paypal" module. To use the module's objects directly:

  1. Import the module as follows:
    import cdata.paypal as mod
  2. To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:
    mod.connect("Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;")

Connecting to PayPal

The provider surfaces tables from two PayPal APIs. Each API uses a different authentication method.
  • The SOAP API requires Signature API credentials. To authenticate to the SOAP API, you must set the AuthScheme to Basic, and set the Username, Password, and Signature properties. These API credentials are generated when you enable the SOAP API.
  • The REST API uses the OAuth authentication standard. To authenticate to the REST API, you must set the AuthScheme to OAuth, and set the OAuthClientId, and OAuthClientSecret properties.

To specify your preferred API, set the Schema property to either REST or SOAP. If no Schema is set, PayPal uses the SOAP schema.

For testing purposes, set UseSandbox to true and use Sandbox credentials.

SOAP API

DEPRECATED: The SOAP API is DEPRECATED. Use the REST API instead for better access to resources.

You can use the SOAP API to retrieve all transactions for the current account. The SOAP API uses the Signature API-credentials type, which has three credential values:

  • API Username
  • API Password
  • API Signature

To generate the API credentials:

  1. Log in to your PayPal business account and select Profile > My Selling Tools.
  2. In the Selling Online section, click Update for the API Access item.
  3. To generate the API signature, click Request API Credentials on the API Access page.
  4. Select Request API Signature and click Agree and Submit to generate the API signature.

After setting the following connection properties, you are ready to connect:

REST API

After setting the following connection properties, you are ready to connect:

When you connect, the connector completes the OAuth process.

  1. Exchanges the OAuthClientId and OAuthClientSecret for the OAuthAccessToken.
  2. Uses the access token to request data.
PayPal currently supports only client credentials flow of OAuth authentication for use with the REST API. To enable this authentication, you must set AuthScheme to OAuth, and you must create a custom OAuth application.

The following subsections describe how to authenticate to PayPal from two common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in PayPal, see Connection.

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

When you initiate connection using client credentials OAuth flow by providing your clientId and clientSecret, the connector obtains an access token from PayPal and uses it to request data.

Headless Machines

If you need to log in to a resource that resides on a headless machine, you must authenticate on another device that has an internet browser. You can do this by installing the connector on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow. Set the connection properties as described above in "Desktop Applications".

After completing the instructions in "Desktop Applications", the connector obtains an access token from PayPal and uses it to request data.

To connect to data via the headless machine, set the following connection properties:

When you are finished, configure the driver to automatically refresh the access token on the headless machine.

CData Python Connector for PayPal

Configuring JNI

Java Native Interface (JNI) is a standard programming interface for writing Java native methods and embedding the Java virtual machine into native applications.

The connector leverages the JNI for improved performance on Mac and Linux.

Configure the Config INI File

The Linux and Mac editions of the PayPal python connector are configured with an ini file. This file is used to set several parameters, including JNI behavior. This file is to be located in:

{path_to_distribution_site-packages}/cdata/config.ini

Ensure that any configuration properties you set in the ini file fall under the following section name (adjust the 311 number if you are using an different python version from 3.11):

  • For Linux:
    [paypal.cpython-311-x86_64-linux-gnu.so]
  • For Mac:
    [paypal.cpython-311-darwin.so]

Configure the JNI connector's behavior by editing the properties in the connector's config.ini file. The connector can be configured as follows:

  • LOGFILE: Set this the same way as the CDATA_LOGFILE envrionment variable below.
  • JAVA_HOME: Configure the path to the JVM library location used to launch the JVM.
  • CLASS_PATH: Use a colon-separated list to configure the paths to the third-party jar libraries.

Configure Environment Variables

Additionally, set the following environment variables:

  • CDATA_JAVA_HOME: Configure the path to the JVM library location used to launch the JVM.
  • CDATA_JVM_OPTIONS: Place JVM options here.
  • CDATA_LOGFILE: Set this in the following scheme: <SCHEME>://<TAG>[|<LEVEL>]

    • SCHEME: The options are STDOUT, FILE.
      • STDOUT: Both the native wrapper and odbc core log into stdout. The Logfile and Verbosity properties can override the behavior of ODBC core.
      • FILE: The native wrapper logs into <FILENAME> while the odbc core logs into <FILENAME>.driver.log. The Logfile and Verbosity properties can override the behavior of ODBC core.
    • TAG
      • For STDOUT, set this to 1. For FILE, set this to the filename.
    • LEVEL
      • Set to one of: FATAL | ERROR | WARNING | INFO | DEBUG

The following are some examples of this syntax:

  • STDOUT://1|DEBUG
  • FILE:///tmp/my_py.log|DEBUG

Custom Logger

The Python connector supports a custom logging mechanism for redirecting log output to any destination, such as a cloud storage service or logging framework. Use setCustomLoggerFactory() to register a factory function that creates a logger instance for each connection.

The factory function receives the context string from the Logfile connection property (the portion after CUSTOM://) and must return an object with a writeLog(verbosity, message) method.

To enable custom logging:

  1. Call setCustomLoggerFactory() with your factory function before opening connections.
  2. Set Logfile to CUSTOM:// followed by a context string to identify the connection.
  3. Set Verbosity to the desired log level.

The following example demonstrates a custom logger factory that creates a separate logger instance per connection:

import cdata.paypal as mod
import time

class MyLogger:
    def __init__(self, loggerId):
        self.loggerId = loggerId
    def writeLog(self, verbosity, message):
        print("[MyLogger " + self.loggerId + "] " + message)

def createLogger(context):
    return MyLogger(context[len("MyLoggerId="):])

mod.setCustomLoggerFactory(createLogger)

conn1 = mod.connect("...;Logfile=CUSTOM://MyLoggerId=1;Verbosity=2;")
# do something with conn1
time.sleep(1)  # Wait for logs to flush from conn1

conn2 = mod.connect("...;Logfile=CUSTOM://MyLoggerId=2;Verbosity=2;")
# do something with conn2
time.sleep(1)  # Wait for logs to flush from conn2

CData Python Connector for PayPal

Creating a Custom OAuth Application

Creating a Custom OAuth Application

A custom OAuth application is required to authenticate on Desktop applications, Web applications, or Headless machines while using the REST API.

To register an OAuth application and obtain the OAuth client credentials, the Client Id, and Client Secret:

  1. Log in to your PayPal developer account.
  2. Navigate to My Apps & Credentials (under Dashboard).
  3. Scroll to the REST API apps section.
  4. Click Create App.
  5. Specify a name for your application.
  6. From the drop down list, select the sandbox account from which data will be retrieved.

PayPal generates a set of sandbox and live OAuth keys for the application. The sandbox credentials display after the application has been created. To see the live credentials, select the Live option.

The sandbox credentials are used to get data only for the sandbox account you selected while creating the application. The Live credentials are used to get data only for the developer account that was used to create this application.

CData Python Connector for PayPal

Changelog

General Changes

DateVersionSourceCategoryTypeDescription
2026-05-2726.0.9643GeneralConnectionRemoved
  • Removed the deprecated ReplaceInvalidTypesWithNull connection property. Use the ReplaceInvalidValuesWithNull property instead.
2026-05-2226.0.9638PythonRemoved
  • Remove support for Intel x64 architecture on macOS
2026-05-1126.0.9627PayPalData ModelChanged
  • Added support for INSERT, UPDATE, and DELETE operations, changing driver behavior from read-only to read-write.
  • Added Create and Update operation support to the Plans and Products table.
  • Added Create, Update, and Delete operation support to the Invoices table.
  • Added five columns to the Products table that can be utilized for Create and Update operations: Category, Type, ImageUrl, HomeUrl, and UpdateTime.
  • Added an insertRequired aggregate column to the Plans table: BillingCycles.
2026-05-0826.0.9624PayPalData ModelAdded
  • Added PaymentSource columns to the OrderDetails view. The new columns expose individual fields from the payment_source object for PayPal, Card, Venmo, Apple Pay, Google Pay, and other payment methods.
2026-05-0826.0.9624PayPalData ModelDeprecated
  • Deprecated the following columns in the OrderDetails view: PayerId, PayerGivenName, PayerSurname, PayerEmail, PayerPhoneType, PayerPhoneNumber, PayerBirthDate, PayerTaxId, PayerTaxType, PayerAddressLine1, PayerAddressLine2, PayerAddressPostalCode, PayerAddressCountryCode, PayerAddressAdminArea1, and PayerAddressAdminArea2. Use the corresponding PaymentSourcePaypal columns instead.
2026-05-0726.0.9623GeneralData ModelAdded
  • Added the ColumnCapabilities column to the sys_tablecolumns system table. This column is a bit mask denoting the column's write capabilities.
2026-05-0726.0.9623PythonChanged
  • Updated embedded JRE to jre-17.0.19+10 (Linux x64 / MacOs x64).
2026-04-2826.0.9614PayPalData ModelRemoved
  • Removed the following columns from the Plans table in the REST Data Model: BillingCyclesVersion, BillingCyclesPricingModel, BillingCyclesFrequency, BillingCyclesTenureType, BillingCyclesSequence, and BillingCyclesTotalCycles.
2026-04-1626.0.9602PayPalData ModelRemoved
  • Removed the following deprecated columns from the PaymentTokens view: PaymentSourceCardVerificationNetworkTransactionId, PaymentSourceCardVerificationDate, PaymentSourceCardVerificationNetwork, and PaymentSourceCardVerificationTime.
2026-04-1526.0.9601GeneralQuery ExecChanged
  • String comparisons using GREATER, LESS, and CONTAINS operators are now case-insensitive by default.
2026-04-0826.0.9594PayPalSecurityChanged
  • TLS 1.3 is now supported by default for HTTP connections.
2026-03-2325.0.9578PayPalMetadataAdded
  • Added three new views: BalanceAndNetActivitySummary, PaymentResources, and TrackingInformation.
  • In the Plans view, added five new columns: IsAutoBillOutstanding, SetupFeeFailureAction, PaymentFailureThreshold, SetupFeeValue, and SetupFeeCurrencyCode
  • In the AuthorizationDetails and CaptureDetails views, added five new columns: PayeeEmailAddress, PayeeMerchantId, RelatedOrderId, RelatedAuthorizationId, and RelatedCaptureId.
  • In the REST schema, added a new stored procedure, Subscriptions.
2026-03-2325.0.9578PayPalConnectionChanged
  • The name of the AuthScheme "OAuth" parameter has been changed to "OAuthClient".
2026-01-1325.0.9509GeneralAdded
  • Added support for the REGEXP_REPLACE() string function.
2025-12-2125.0.9486PythonAdded
  • Added support for custom loggers in Python connectors on Linux and macOS.
2025-12-0525.0.9470GeneralAdded
  • Added support for the INSERT INTO SELECT statement, with driver-side execution for providers that do not support the operation natively.
2025-11-2825.0.9463PayPalAdded
  • Added the ability to use a composite key for the TransactionReports view: transaction_id + transaction_event_code.
2025-10-3025.0.9434PythonChanged
  • Updated embedded JRE to jre-17.0.17+10 (Linux x64 / MacOs x64).
2025-10-0625.0.9410GeneralAdded
  • Support for parsing datetime formats using ".S" and ",S" for milliseconds and nanoseconds.
2025-09-1225.0.9386GeneralAdded
  • Added the IsInsertable, IsUpdateable, and IsDeleteable columns to the sys_tables table.
2025-09-1025.0.9384GeneralChanged
  • All columns in statically defined Views are now reported as read-only.
2025-09-0325.0.9377GeneralChanged
  • Corrected the behavior when IN criteria with NULL values are used in the projection part. It now returns NULL instead of 0. For example, "NULL IN (1,2)" returns "NULL".
2025-09-0125.0.9375GeneralAdded
  • Added support for using the CAST function with infinity values. This function can cast "inf" and "-inf" to DOUBLE, FLOAT, or REAL.
2025-08-2125.0.9364GeneralChanged
  • Report behavior change:
    • Fixed inconsistent string value comparisons in non-table queries.
    • For example, "SELECT 'A' = 'a'" previously returned false, but it now returns true.
2025-08-1325.0.9356GeneralChanged
  • Changed the maximum number of pages held in memory from 15 to 5 for the page providers to decrease heap usage.
2025-08-0825.0.9351PayPalAdded
  • Added the Users and PartnerReferrals views.
2025-07-0925.0.9321PayPalAdded
  • Added support for the search invoices endpoint.
2025-07-0925.0.9321PayPalChanged
  • Changed the data type for both the InvoiceDate and DueDate columns from datetime to date in the Invoices view.
2025-07-0725.0.9319PythonRemoved
  • Removed the 32-bit version of Windows Python.
2025-07-0225.0.9314PythonRemoved
  • Removed support for Python 3.9.
2025-06-3025.0.9312PayPalChanged
  • Updated default schema to REST and marked SOAP as deprecated.
2025-06-2525.0.9307GeneralRemoved
  • Removed the "ADLS Gen 1" value from the ConnectionType property.
2025-06-2525.0.9307PythonAdded
  • Added support for Python 3.13 in Windows, Linux, and Mac editions.
2025-06-2525.0.9307PythonRemoved
  • Removed support for Python 3.8 as it is no longer supported.
2025-06-2025.0.9302GeneralAdded
  • Created the following functions:
    • TEXT_ENCODE: encodes a string into a different charset (UTF8 → UTF7 and returns a binary array as the result).
    • TEXT_DECODE: takes a binary array and decodes it back into a string when provided the charset.
    • BASE64_ENCODE: takes a binary array and encodes it as a base64 string (varchar).
    • BASE64_DECODE: takes a base 64-encoded string and decodes it into a binary array.
2025-06-2025.0.9302PayPalRemoved
  • Removed the RefreshOAuthToken stored procedure and the OAuthRefreshToken attribute from the GetOAuthAccessToken stored procedure because PayPal only uses the OAuth client credentials flow.
2025-06-1825.0.9300GeneralChanged
  • The internal code for exception handling has been refactored. Exception messages returned during certain error conditions may now have different wording or formatting.
2025-05-3025.0.9281PayPalAdded
  • Added the Id column to the SubscriptionTransactions view in the REST Data Model.
2025-05-2725.0.9278GeneralRemoved
  • Removed the "Proprietary" enum option from ProxyAuthscheme.
2025-05-1625.0.9267PayPalAdded
  • Added the Products and ProductDetails views.
2025-05-1625.0.9267PayPalChanged
  • Updated the maximum pagesize to 20 in the Payments view.
2025-05-1225.0.9263PythonChanged
  • Updated embedded JRE to jre-17.0.15+6 (Linux x64 / MacOS x64) and jre-17.0.15+6 (MacOS aarch64).
2025-04-2325.0.9244PayPalAdded
  • Created the CreateOrder stored procedure.
  • Added PaySource and PurchaseUnits columns to the OrderDetails view.
  • Added Items, MostRecentErrors, PaymentInstruction, SupplementaryData, and Payments columns to the OrderItems view.
  • Added PayerInfoPayerNameFullName column to the TransactionReports view.
2025-02-1524.0.9177GeneralAdded
  • Added support for converting unsigned integer types to the nearest signed data type that has enough precision to hold the unsigned value.This is done for JDBC only because it does not have support for unsigned data types.
2025-01-0524.0.9136PayPalAdded
  • Added the following views to the REST Schema: UserInfo, Templates, and PaymentTokens.
  • Added enum values for status and related columns across the following views in the REST Schema: OrderDetails, RefundDetails, Subscriptions, SubscriptionTransactions, TransactionReports, AuthorizationDetails, CaptureDetails, and Plans.
  • Added multiple new columns to the following views in the REST Schema: Disputes, DisputeTransactions, OrderDetails, RefundDetails, Subscriptions, SubscriptionTransactions, TransactionReports, TransactionReportsCartInfoItemDetails, PayoutDetails, PayoutItems, and PaymentTransactions.
2024-11-2724.0.9097GeneralAdded
  • Added ThreadId to LogModule output. Logfile lines now include the Thread ID associated with the action being performed.
2024-06-0524.0.8922PythonAdded
  • Added support for Python 3.12.
2024-05-0924.0.8895GeneralChanged
  • The ROUND function previously did not accept negative precision values. That feature has now been restored.
2024-03-1523.0.8840GeneralAdded
  • Created a new SQL function called STRING_COMPARE that provides java's String.compare() ability to SQL queries. Returns a number representative of the compared value of two strings
2023-11-2923.0.8733GeneralChanged
  • The ROUND function doesn't accept the negative precision values anymore.
2023-11-2923.0.8733GeneralChanged
  • The returning types of the FDMonth, FDQuarter, FDWeek, LDMonth, LDQuarter, LDWeek functions are changed from Timestamp to Date.
  • The return type of the ABS function will be consistent with the parameter value type.
2023-11-2823.0.8732GeneralAdded
  • Added the HMACSHA256 formatter to allow for secrets to be decoded if it is in base64 format
2023-08-2923.0.8641PythonAdded
  • Added support for SQLAlchemy 2.0.
2023-06-2023.0.8571GeneralAdded
  • Added the new sys_lastresultinfo system table.
2023-05-1923.0.8539PythonAdded
  • Added support for Python 3.11 on Windows, Linux and Mac.
2023-05-1623.0.8536PythonRemoved
  • Removed support for Python 3.7 on Windows and Linux
2023-04-2523.0.8515GeneralRemoved
  • Removed support for the SELECT INTO CSV statement. The core code doesn't support it anymore.
2023-01-1222.0.8412PayPalAdded
  • Added the Balances and CryptoBalances views in REST Schema.
2022-12-1422.0.8383GeneralChanged
  • Added the Default column to the sys_procedureparameters table.
2022-11-1522.0.8354PythonChanged
  • Updated embedded JRE to jre8u345-b01(Linux x64 / MacOS x64) and jre-17.0.5+8(MacOS aarch64).
2022-09-3022.0.8308GeneralChanged
  • Added the IsPath column to the sys_procedureparameters table.
2022-09-2022.0.8298PayPalAdded
  • Added the TransactionReports, TransactionReportsCartInfoItemDetails and TransactionReportsIncentiveDetails views.
2022-05-1822.0.8173PythonAdded
  • Added support for Python 3.10 on Windows, Linux, and Mac
  • Added support for Python 3.9 on Mac
  • Added support for Mac M1
2022-05-1822.0.8173PythonRemoved
  • Removed support for Python 3.6 on Windows and Linux
2021-09-0221.0.7915GeneralAdded
  • Added support for the STRING_SPLIT table-valued function in the CROSS APPLY clause.
2021-08-0721.0.7889GeneralChanged
  • Added the KeySeq column to the sys_foreignkeys table.
2021-08-0621.0.7888GeneralChanged
  • Added the new sys_primarykeys system table.
2021-07-2321.0.7874GeneralChanged
  • Updated the Literal Function Names for relative date/datetime functions. Previously, relative date/datetime functions resolved to a different value when used in the projection as opposed to the predicate. For example: SELECT LAST_MONTH() AS lm, Col FROM Table WHERE Col > LAST_MONTH(). Formerly, the two LAST_MONTH() methods would resolve to different datetimes. Now, they will match.
  • As a replacement for the previous behavior, the relative date/datetime functions in the criteria may have an 'L' appended to them. For example: WHERE col > L_LAST_MONTH(). This will continue to resolve to the same values that were previously calculated in the criteria. Note that the "L_" prefix will only work in the predicate - it not available for the projection.
2021-04-2521.0.7785GeneralAdded
  • Added support for handling client side formulas during insert / update. For example: UPDATE Table SET Col1 = CONCAT(Col1, " - ", Col2) WHERE Col2 LIKE 'A%'
2021-04-2321.0.7783GeneralChanged
  • Updated how display sizes are determined for varchar primary key and foreign key columns so they will match the reported length of the column.
2021-04-1621.0.7776GeneralAdded
  • Non-conditional updates between two columns is now available to all drivers. For example: UPDATE Table SET Col1=Col2
2021-04-1621.0.7776GeneralChanged
  • Reduced the length to 255 for varchar primary key and foreign key columns.
2021-04-1621.0.7776GeneralChanged
  • Updated implicit and metadata caching to improve performance and support for multiple connections. Old metadata caches are not compatible - you need to generate new metadata caches if you are currently using CacheMetadata.
2021-04-1621.0.7776GeneralChanged
  • Updated index naming convention to avoid duplicates.

CData Python Connector for PayPal

Using the Connector

This section provides a walk-through for writing PayPal data access code in Python script.

For more information on the available data source entities and how to query them with SQL, see Data Model. For the SQL syntax, see SQL Compliance.

Connecting from Code

For information on how to deploy the connector and configure the connection to PayPal, see Package Installation and Establishing a Connection.

For information on how to connect with the paypal.connector module and its related classes, see Connecting.

Executing SQL

The connection's cursor object is used to directly execute SQL queries. For information on how to execute SELECT statements and process the returned result sets, see Querying Data.

Executing Stored Procedures

You can call stored procedures by using the EXECUTE statement. For further information, see Calling Stored Procedures.

CData Python Connector for PayPal

Connecting

Connecting with the cdata.paypal Module:

The connector's module is used directly to establish a connection with the data source. It does this by using a connection string as its argument. For example:
import cdata.paypal as mod
conn = mod.connect("Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;")

Once the connection is created, you can use it to execute subsequent SQL queries.

CData Python Connector for PayPal

Querying Data

After connecting as described in Connecting, you can use the open connection to execute SQL statements.

Executing Queries

To execute SQL statements that return data, use the execute() method. Once a query is executed, the result set is fetched from the cursor. This result set can then be iterated over to process the records individually.

For example:

cur = conn.execute("SELECT Id, State FROM Payments")
rs = cur.fetchall()
for row in rs:
	print(row)

Parameterized Queries

Various Python collections, such as arrays and tuples, can act as additional arguments for the execute() method. This enables you to parameterize the queries executed and help to prevent SQL Injection.

For example:

cmd = "SELECT Id, State FROM Payments WHERE CreateTime > ?"
params = ["2016-01-15"]
cur = conn.execute(cmd, params)
rs = cur.fetchall()
for row in rs:
	print(row)

CData Python Connector for PayPal

Calling Stored Procedures

You can execute stored procedures using either the execute() or callproc() method of the connection.

Calling Stored Procedures Using Execute()

When you call stored procedures by issuing EXECUTE commands, the stored procedure arguments are parameterized. For example:
cmd = "EXECUTE SelectEntries ObjectName = ?"
params = ["Account"]
conn.execute(cmd, params)

Calling Stored Procedures Using Callproc()

When you call stored procedured by issuing the callproc() method, the stored procedure arguments are a procedure name and a list of parameters. For example:
cur = conn.cursor()
params = ["Account"]
cur.callproc("SelectEntries", params)

CData Python Connector for PayPal

Using from Tools

The connector is integrated with other tools and packages within Python.

Python Integration Guides

The following sections show how to create and use connections with the connector in common packages in Python:

Complete List of PayPal Integration Quickstarts

For information on connecting from other applications, see PayPal integration guides.

CData Python Connector for PayPal

From SQLAlchemy

The CData Python Connector for PayPal includes a Dialect class that enables integration with SQLAlchemy. Bear in mind that several aspects of connector functionality are not currently supported in SQLAlchemy 2.0 or above. If necessary, downgrade SQLAlchemy to version 1.4 or 1.3 before using this connector.

The following sections detail various aspects of this integration:

Connecting From SQLAlchemy

To construct a URL with which SQLAlchemy loads and uses the appropriate connector automatically, see Connecting

Reflecting Metadata With SQLAlchemy

To learn how to model PayPal tables with mapped classes, see Reflecting Metadata.

Querying Data From SQLAlchemy

To learn how to use mapped classes to query the associated tables, see Querying Data.

CData Python Connector for PayPal

Connecting

Connecting With a Dialect URL

Establishing a connection using SQLAlchemy requires a specific URL format.
from sqlalchemy import create_engine
engine = create_engine("paypal:///?Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;")

For SQLAlchemy 2.0, the dialect name is paypal_2. To establish a connection, use the following URL format:

from sqlalchemy import create_engine
engine = create_engine("paypal_2:///?Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;")

CData Python Connector for PayPal

Reflecting Metadata

SQLAlchemy can act as an Object-relational Map (ORM). This enables you to treat records of a database table as instantiable records. To leverage this functionality, you must reflect the underlying metadata in one of the following ways.

Note: The following examples employ SQLAlchemy 1.4.

Modeling Data Using a Mapping Class

Use "sqlalchemy.ext.declarative.declarative_base" to declare a mapping class for the table you wish to model in the ORM. A known table in the data model is modeled either partially or completely, as shown in the following example:
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class Payments(Base):
	__tablename__ = "Payments"
	Id = Column(String, primary_key=True)
	Id = Column(String)
	State = Column(String)

Automatically Reflecting Metadata

Rather than mapping tables manually, SQLAlchemy can discover the metadata for one or more tables automatically. To accomplish this across the entire data model, use automap_base:
from sqlalchemy import MetaData
from sqlalchemy.ext.automap import automap_base
meta = MetaData()
abase = automap_base(metadata=meta)
abase.prepare(autoload_with=engine)
Payments = abase.classes.Payments

You can also reflect a single table with an inspector. When reflecting this way, providing a list of specific columns to map is optional:

from sqlalchemy import MetaData, Table
from sqlalchemy import inspect
meta = MetaData()
insp = inspect(engine)
Payments_table = Table("Payments", meta)
insp.reflect_table(Payments_table, ["Id","State"])

CData Python Connector for PayPal

Querying Data

After you use the steps in Connecting to connect, and use one of the methods in Reflecting Metadata to reflect some of the metadata, you can use a session object to query data.

Querying Data Using the Query Method

If the mapping class has been prepared, use it with a session object to query the data source. After binding the engine to the session, provide the mapping class to the session's query method.

For example:

engine = create_engine("paypal:///?Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Payments).filter_by(CreateTime="2016-01-15"):
	print("Id: ", instance.Id)
	print("Id: ", instance.Id)
	print("State: ", instance.State)
	print("---------")

Querying Data Using the Execute Method

The session object can also run the query with the execute() method alongside the appropriate Table object. Assuming you have an active session, the following is just as viable:
Payments_table = Payments.metadata.tables["Payments"]
for instance in session.execute(Payments_table.select().where(Payments_table.c.CreateTime == "2016-01-15")):
	print("Id: ", instance.Id)
	print("FullName: ", instance.Name)
	print("City: ", instance.BillingCity)
	print("---------")

CData Python Connector for PayPal

Executing JOINs

Implicit Joining

If mapped classes of related PayPal objects have a singular foreign key relationship, the classes are implicitly joined. After importing the necessary objects, a relationship is established between your two mapped classes, as in the example below:
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, String, Integer, DateTime, ForeignKey
from sqlalchemy.orm import sessionmaker, relationship

Base = declarative_base()
class Contact(Base):
	__tablename__ = "Contact"
	Id = Column(Integer, primary_key=True)
	Name = Column(String)
	Email = Column(String)
	BirthDate = Column(DateTime)
	AccountId = Column(String, ForeignKey("Account.Id"))
	Account_Link = relationship("Account", back_populates="Contact_Link")

class Account(Base):
	__tablename__ = "Account"
	Id = Column(String, primary_key=True)
	Name = Column(String)
	BillingCity = Column(String)
	NumberOfEmployees = Column(Integer)
	Contact_Link = relationship("Contact", order_by=Contact.Id, back_populates="Account_Link")

Once the relationship is established, the tables are queried simultaneously using the session's query() method. For example:

rs = session.query(Account, Contact).filter(Account.Id == Contact.AccountId)
for Ac, Ct in rs:
  print("AccountId: ", Ac.Id)
  print("AccountName: ", Ac.Name)
  print("ContactId: ", Ct.Id)
  print("ContactName: ", Ct.Name)

Other Join Forms

In situations where mapped classes have either no foreign keys or multiple foreign keys, you may need different forms of the JOIN query to accommodate them. Using the earlier classes as examples, the following JOIN queries are possible as well:
  • Explicit condition (necessary if there are no foreign keys in your mapped classes):
    rs = session.query(Account, Contact).join(Contact, Account.Id == Contact.AccountId)
    for Ac, Ct in rs:
  • Left-to-right relationship:
    rs = session.query(Account, Contact).join(Account.Contact_Link)
    for Ac, Ct in rs:
  • Left-to-right relationship with explicit target:
    rs = session.query(Account, Contact).join(Contact, Account.Contact_Link)
    for Ac, Ct in rs:
  • String form of a left-to-right relationship:
    rs = session.query(Account, Contact).join("Contact_Link")
    for Ac, Ct in rs:

CData Python Connector for PayPal

Other SQL Clauses

SQLAlchemy ORM also exposes support for other clauses in SQL, such as ORDER BY, GROUP BY, LIMIT, and OFFSET. All of these are supported by this connector:

ORDER BY

The following example sorts by a specified column using the session object's query() method:
rs = session.query(Payments).order_by(Payments.AnnualRevenue)
for instance in rs:
	print("Id: ", instance.Id)
	print("Id: ", instance.Id)
	print("State: ", instance.State)
	print("---------")

You can also use the session object's execute() method perform an ORDER BY. For example:

rs = session.execute(Payments_table.select().order_by(Payments_table.c.AnnualRevenue))
for instance in rs:

GROUP BY

The following example uses the session object's query() method to group records with a specified column:
rs = session.query(func.count(Payments.Id).label("CustomCount"), Payments.Id).group_by(Payments.Id)
for instance in rs:
	print("Count: ", instance.CustomCount)
	print("Id: ", instance.Id)
	print("---------")

You can also use the session object's execute() method to perform a GROUP BY:

rs = session.execute(Payments_table.select().with_only_columns([func.count(Payments_table.c.Id).label("CustomCount"), Payments_table.c.Id]).group_by(Payments_table.c.Id))
for instance in rs:

LIMIT and OFFSET

The following example uses the session object's query() method to skip the first 100 records and fetch the following 25:
rs = session.query(Payments).limit(25).offset(100)
for instance in rs:
	print("Id: ", instance.Id)
	print("Id: ", instance.Id)
	print("State: ", instance.State)
	print("---------")

You can also use the session object's execute() method to set a LIMIT or OFFSET:

rs = session.execute(Payments_table.select().limit(25).offset(100))
for instance in rs:

CData Python Connector for PayPal

Aggregate Functions

Certain aggregate functions can also be used within SQLAlchemy by using the func module.

To import this module, execute:

from sqlalchemy.sql import func

Once func is imported, the following aggregate functions are available:

COUNT

The following example counts the number of records in a set of groups using the session object's query() method.
rs = session.query(func.count(Payments.Id).label("CustomCount"), Payments.Id).group_by(Payments.Id)
for instance in rs:
	print("Count: ", instance.CustomCount)
	print("Id: ", instance.Id)
	print("---------")

You can also execute COUNT using the session object's execute() method:

rs = session.execute(Payments_table.select().with_only_columns([func.count(Payments_table.c.Id).label("CustomCount"), Payments_table.c.Id])group_by(Payments_table.c.Id))
for instance in rs:

SUM

This example calculates the cumulative amount of a numeric column in a set of groups.

rs = session.query(func.sum(Payments.AnnualRevenue).label("CustomSum"), Payments.Id).group_by(Payments.Id)
for instance in rs:
	print("Sum: ", instance.CustomSum)
	print("Id: ", instance.Id)
	print("---------")

You can also invoke SUM using the session object's execute() method.

rs = session.execute(Payments_table.select().with_only_columns([func.sum(Payments_table.c.AnnualRevenue).label("CustomSum"), Payments_table.c.Id]).group_by(Payments_table.c.Id))
for instance in rs:

AVG

This example uses the session object's query() method to calculate the average amount of a numeric column in a set of groups:
rs = session.query(func.avg(Payments.AnnualRevenue).label("CustomAvg"), Payments.Id).group_by(Payments.Id)
for instance in rs:
	print("Avg: ", instance.CustomAvg)
	print("Id: ", instance.Id)
	print("---------")

You can also use the session object's execute() method to invoke AVG:

rs = session.execute(Payments_table.select().with_only_columns([func.avg(Payments_table.c.AnnualRevenue).label("CustomAvg"), Payments_table.c.Id]).group_by(Payments_table.c.Id))
for instance in rs:

MAX and MIN

This example finds the maximum value and minimum value of a numeric column in a set of groups.
rs = session.query(func.max(Payments.AnnualRevenue).label("CustomMax"), func.min(Payments.AnnualRevenue).label("CustomMin"), Payments.Id).group_by(Payments.Id)
for instance in rs:
	print("Max: ", instance.CustomMax)
	print("Min: ", instance.CustomMin)
	print("Id: ", instance.Id)
	print("---------")

You can also use the session object's execute() method to invoke MAX and MIN:

rs = session.execute(Payments_table.select().with_only_columns([func.max(Payments_table.c.AnnualRevenue).label("CustomMax"), func.min(Payments_table.c.AnnualRevenue).label("CustomMin"), Payments_table.c.Id]).group_by(Payments_table.c.Id))
for instance in rs:

CData Python Connector for PayPal

From Pandas

When combined with the connector, Pandas can be used to generate data frames that contain your PayPal data. Once created, a data frame can be passed to various other Python packages.

Connecting

Pandas relies on an SQLAlchemy engine to execute queries. Before you can use Pandas you must import it:
import pandas as pd
from sqlalchemy import create_engine
engine = create_engine("paypal:///?Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;")

Querying Data

In Pandas, SELECT queries are provided in a call to the read_sql() method, alongside a relevant connection object. Pandas executes the query on that connection, and returns the results in the form of a data frame, which can be used for a variety of purposes.
df = pd.read_sql("""
	SELECT
	   Id,
	   State,
     $exNumericCol;
	FROM Payments;""", engine)
print(df)

CData Python Connector for PayPal

From Matplotlib

Matplotlib contains a number of tools that can graphically model PayPal data after being fed a data frame From Pandas.

Using PyPlot

Before any Matplotlib tool, such as pyplot, can be used, it must be imported:
from matplotlib import pyplot as plt

Once a Pandas data frame is obtained, it can be used to create a plot visualizing PayPal data. For example, the following plot generates and displays a bar graph relating Id and AnnualRevenue values:

df.plot(kind="bar", x="Id", y=["AnnualRevenue"])
plt.show()

CData Python Connector for PayPal

From Petl

The connector can be used to create ETL applications and pipelines for CSV data in Python using Petl.

Install Required Modules

Install the Petl modules using the pip utility.
pip install petl

Connecting

After you import the modules, including the CData Python Connector for PayPal, you can use the connector's connect function to create a connection using a valid PayPal connection string. If you prefer not to use a direct connection, you can use a SQLAlchemy engine.
import petl as etl
import cdata.paypal as mod
cnxn = mod.connect("Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;")

Extract, Transform, and Load the PayPal Data

Create a SQL query string and store the query results in a DataFrame.
sql = "SELECT	Id, State FROM Payments "
table1 = etl.fromdb(cnxn,sql)

Loading Data

With the query results stored in a DataFrame, you can load your data into any supported Petl destination. The following example loads the data into a CSV file.
etl.tocsv(table1,'output.csv')

CData Python Connector for PayPal

Schema Discovery

The extension supports schema discovery by using SQL queries to available System Tables.

Using SQL

The following sections describe the discovery of metadata through several System Tables:

CData Python Connector for PayPal

Tables and Views

The connector possesses system tables that are used to discover the tables and views available in the data model. Of these system tables, "sys_tables" and "sys_views" are used to fetch information about the available tables and views respectively:

Tables


import cdata.paypal as mod
conn = mod.connect("Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_tables"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Views


import cdata.paypal as mod
conn = mod.connect("Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_views"
cur.execute(cmd, params)
rs = cur.fetchall()
for row in rs:
	print(row)

CData Python Connector for PayPal

Columns

The available columns for any given table are fetched from a system table called "sys_tablecolumns". A specific table name is provided in the WHERE criteria to restrict the table from which the column information is fetched:

import cdata.paypal as mod
conn = mod.connect("Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_tablecolumns WHERE TableName = 'Payments'"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

CData Python Connector for PayPal

Procedures

Procedures

A system table called "sys_procedures" is queried to obtain the available stored procedures that are executed:
import cdata.paypal as mod
conn = mod.connect("Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_procedures"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Parameters

The input parameters of any stored procedure are similarly obtained from the "sys_procedureparameters" system table:
import cdata.paypal as mod
conn = mod.connect("Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries'"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

CData Python Connector for PayPal

Advanced Features

This section details a selection of advanced features of the PayPal connector.

User Defined Views

The connector supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the connector for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Caching Data

Caching Data enables faster access to data and reduces the number of API calls, improving performance. The connector supports a simple caching model where multiple connections can also share the cache over time. When configuring the cache connection, you can specify automatic or explicit data caching.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to PayPal and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Exception Handling

For an overview of how exceptions are reported and the components of an exception, see Exception Handling.

CData Python Connector for PayPal

User Defined Views

The CData Python Connector for PayPal supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from a tool.

Use a user defined view to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

  • Create a JSON-formatted configuration file defining the views you want.
  • DDL statements.

Defining Views Using a Configuration File

User defined views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This user defined view configuration file is formatted so that each root element defines the name of a view, and includes a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Payments WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"

Defining Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.

Working with User Defined Views

For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

CData Python Connector for PayPal

SSL Configuration

Customizing the SSL Configuration

By default, the connector attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

CData Python Connector for PayPal

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Note: The connector uses the system proxy settings by default, without further configuration needed. If you want to connect to other proxies, set ProxyAutoDetect to False and read further.

To authenticate to an HTTP proxy, set the following:

  • ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
  • ProxyPort: the TCP port that the proxy server is running on.
  • ProxyAuthScheme: the authentication method the connector uses when authenticating to the proxy server.
  • ProxyUser: the username of a user account registered with the proxy server.
  • ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

CData Python Connector for PayPal

Caching Data

Caching Data

Caching data provides several benefits, including faster access to data and reducing the number of API calls, which improve performance. The connector supports a simple caching model where multiple connections can also share the cache over time. You can enable and configure caching features by setting the necessary connection properties.

Contents

The sections in this chapter detail the connector's caching functionality and link to the corresponding connection properties, as well as SQL statements.

Configuring the Cache Connection

Configuring the Cache Connection describes the properties that you can set when configuring the cache database.

Caching Metadata

Caching Metadata describes the CacheMetadata property. This property determines whether or not to cache the table metadata to a file store.

Automatically Caching Data

Automatically Caching Data describes how the connector automatically refreshes the cache when the AutoCache property is set.

Explicitly Caching Data

Explicitly Caching Data describes how you can decide what data is stored in the cache and when it is updated.

Data Type Mapping

Data Type Mapping shows the mappings between the data types configured in the schema and the data types in the database.

CData Python Connector for PayPal

Configuring the Cache Connection

Configuring the Caching Database

This section describes the properties for caching data to the persistent store of your choice.

CacheLocation

The CacheLocation property species the path to a file-system-based database. When caching is enabled, a file-system-based database is used by default. If CacheLocation is not specified, this database is stored at the path in Location. If neither of these connection properties are specified, the connector uses a platform-dependent default location.

CacheConnection

The CacheConnection property specifies a database driver and the connection string to the caching database.

CacheDriver and CacheProvider

Both the CacheDriver and CacheProvider properties are supported. Each specifies a database driver and the connection string to the caching database. CacheDriver is designed for Linux and MacOS; CacheProvider is Windows-based.

CData Python Connector for PayPal

Automatically Caching Data

Automatically caching data is useful when you do not want to rebuild the cache for each query. When you query data for the first time, the connector automatically initializes and builds a cache in the background. When AutoCache = true, the connector uses the cache for subsequent query executions, resulting in faster response times.

Configuring Automatic Caching

Caching the Payments Table

The following example caches the Payments table in the file specified by the CacheLocation property of the connection string.

SELECT Id, State FROM Payments WHERE CreateTime > '2016-01-15'

Common Use Case

A common use for automatically caching data is to improve driver performance when making repeated requests to a live data source, such as building a report or creating a visualization. With auto caching enabled, repeated requests to the same data may be executed in a short period of time, but within an allowable tolerance (CacheTolerance) of what is considered "live" data.

CData Python Connector for PayPal

Explicitly Caching Data

With explicit caching (AutoCache = false), you decide exactly what data is cached and when to query the cache instead of the live data. Explicit caching gives you full control over the cache contents by using CACHE Statements. This section describes some strategies to use the caching features offered by the connector.

Creating the Cache

To load data in the cache, issue the following statement.

CACHE SELECT * FROM tableName WHERE ...

Once the statement is issued, any matching data in tableName is loaded into the corresponding table.

Updating the Cache

This section describes two ways to update the cache.

Updating with the SELECT Statement

The following example shows a statement that can update modified rows and add missing rows in the cached table. However, this statement does not delete extra rows that are already in the cache. This statement only merges the new rows or updates the existing rows.

CACHE SELECT * FROM Payments WHERE CreateTime > '2016-01-15'

Updating with the TRUNCATE Statement

The following example shows a statement that can update modified rows and add missing rows in the cached table. This statement can also delete rows in the cache table that are not present in the live data source.

  CACHE WITH TRUNCATE SELECT * FROM Payments WHERE CreateTime > '2016-01-15'
  

Query the Data in Online or Offline Mode

This section describes how to query the data in online or offline mode.

Online: Select Cached Tables

You can use the tableName#CACHE syntax to explicitly execute queries to the cache while still online, as shown in the following example.

SELECT * FROM Payments#CACHE

Offline: Select Cached Tables

With Offline = true, SELECT statements always execute against the local cache database, regardless of whether you explicitly specify the cached table or not. Modification of the cache is disabled in Offline mode to prevent accidentally updating only the cached data. Executing a DELETE/UPDATE/INSERT statement while in Offline mode results in an exception.

The following example selects from the local cache but not the live data source because Offline = true.

SELECT * FROM Payments WHERE CreateTime='2016-01-15' ORDER BY State ASC

Delete Data from the Cache

You can delete data from the cache by building a direct connection to the database. Note that the connector does not support manually deleting data from the cache.

Common Use Case

A common use for caching is to have an application always query the cached data and only update the cache at set intervals, such as once every day or every two hours. There are two ways in which this can be implemented:

  • AutoCache = false and Offline = false. All queries issued by the application explicitly reference the tableName#CACHE table. When the cache needs to be updated, the application executes a tableName#CACHE ... statement to bring the cached data up to date.
  • Offline = true. Caching is transparent to the application. All queries are executed against the table as normal, so most application code does not need to be aware that caching is done. To update the cached data, simply create a separate connection with Offline = false and execute a tableName#CACHE ... statement.

CData Python Connector for PayPal

Data Type Mapping

The connector maps types from the data source to the corresponding data type available in the chosen cache database. The following table shows the mappings between the data types configured in the schema and the data types in the database. Some schema types have synonyms which are all listed in the Schema column.

Data Type Mapping

Note: String columns can map to different data types depending on their length.

Schema .NET JDBC SQL Server Derby MySQL Oracle SQLite Access
int, integer, int32 Int32 int int INTEGER INT NUMBER integer LONG
smallint, short, int16 Int16 short smallint SMALLINT SMALLINT NUMBER integer SHORT
double, float, real Double double float DOUBLE DOUBLE NUMBER double DOUBLE
date DateTime java.sql.Date date DATE DATE DATE date DATETIME
datetime, timestamp DateTime java.sql.Date datetime TIMESTAMP DATETIME TIMESTAMP datetime DATETIME
time, timespan TimeSpan java.sql.Time time TIME TIME TIMESTAMP datetime DATETIME
string, varchar String java.lang.String If length > 4000: nvarchar(max), Otherwise: nvarchar(length)If length > 32672: LONG VARCHAR, Otherwise VARCHAR(length)If length > 255: LONGTEXT, Otherwise: VARCHAR(length)If length > 4000: CLOB, Otherwise: VARCHAR2(length)nvarchar(length)If length > 255: LONGTEXT, Otherwise: VARCHAR(length)
long, int64, bigint Int64 long bigint BIGINT BIGINT NUMBER bigint LONG
boolean, bool Boolean boolean tinyint SMALLINT BIT NUMBER tinyint BIT
decimal, numeric Decimal java.math.BigDecimal decimal DECIMAL DECIMAL DECIMAL decimal CURRENCY
uuid Guid java.util.UUID nvarchar(length) VARCHAR(length)VARCHAR(length) VARCHAR2(length)nvarchar(length) VARCHAR(length)
binary, varbinary, longvarbinary byte[] byte[] binary(1000) or varbinary(max) after SQL Server 2000, image otherwise BLOB LONGBLOB BLOB BLOB LONGBINARY

CData Python Connector for PayPal

Query Processing

Query Processing

CData has a client-side SQL engine built into the connector library. This enables support for the full capabilities that SQL-92 offers, including filters, aggregations, functions, etc.

For sources that do not support SQL-92, the connector offloads as much of SQL statement processing as possible to PayPal and then processes the rest of the query in memory (client-side). This results in optimal performance.

For data sources with limited query capabilities, the connector handles transformations of the SQL query to make it simpler for the connector. The goal is to make smart decisions based on the query capabilities of the data source to push down as much of the computation as possible. The PayPal Query Evaluation component examines SQL queries and returns information indicating what parts of the query the connector is not capable of executing natively.

The PayPal Query Slicer component is used in more specific cases to separate a single query into multiple independent queries. The client-side Query Engine makes decisions about simplifying queries, breaking queries into multiple queries, and pushing down or computing aggregations on the client-side while minimizing the size of the result set.

There's a significant trade-off in evaluating queries, even partially, client-side. There are always queries that are impossible to execute efficiently in this model, and some can be particularly expensive to compute in this manner. CData always pushes down as much of the query as is feasible for the data source to generate the most efficient query possible and provide the most flexible query capabilities.

More Information

For a full discussion of how CData handles query processing, see CData Architecture: Query Execution.

CData Python Connector for PayPal

Logging

Logging

Capturing connector logging can be very helpful when diagnosing error messages or other unexpected behavior.

Basic Logging

To begin capturing connector logging, set these properties:

  • Logfile: A filepath that designates the name and location of the log file.
  • Verbosity: A numerical value (1-5) that determines the amount of detail in the log. See the page in the Connection Properties section for an explanation of the five levels.
  • MaxLogFileSize: When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.
  • MaxLogFileCount: A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. Minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Once these properties are set, the connector populates the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it is created.

Log Verbosity

The verbosity level determines the amount of detail that the connector reports to the Logfile. Supported Verbosity levels range from 1 to 5.

The following list describes each level:

1Setting Verbosity to 1 logs the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2Setting Verbosity to 2 logs everything included in Verbosity 1, cache queries, and additional information about the request.
3Setting Verbosity to 3 also logs HTTP headers, as well as the body of the request and the response.
4Setting Verbosity to 4 also logs transport-level communication with the data source. This includes SSL negotiation.
5Setting Verbosity to 5 also logs communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

For normal operations, Verbosity should not be set to greater than 1. At higher verbosities you can log substantial amounts of data, which can delay execution times.

To refine the logged content further by showing/hiding specific categories of information, see LogModules.

Sensitive Data

Verbosity levels of 3 and higher may capture information that you do not want shared outside of your organization. The following lists information of concern for each level:

  • Verbosity 3: The full body of the request and the response, which includes all the data returned by the connector
  • Verbosity 4: SSL certificates
  • Verbosity 5: Any extra transfer data not included at Verbosity 3, such as non human-readable binary transfer data

Note: Although we mask sensitive values, such as passwords, in the connection string and any request in the log, it is always best practice to review the logs for any sensitive information before sharing outside your organization.

Advanced Logging

You may want to refine the exact information that is recorded to the log file. This can be accomplished using the LogModules property. This property allows you to filter the logging using a semicolon-separated list of logging modules.

Example property value:

LogModules=INFO;EXEC;SSL;SQL;META;

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:

Module Name Module Description Submodules
INFO General Information. Includes the connection string, product version (build number), and initial connection messages.
  • Connec – Information related to creating or destroying connections.
  • Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
EXEC Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.
  • Messag – Messages pertaining to query execution. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance.
  • Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user).
  • Page – Messages related to query paging.
  • Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.
  • KERB – HTTP requests related to Kerberos.
  • Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product.
  • Res – Messages containing HTTP responses.
  • Req – Messages containing HTTP requests.
WSDL Messages pertaining to the generation of WSDL/XSD files.
SSL SSL certificate messages.
  • Certif – Messages pertaining to SSL certificates.
AUTH Authentication related failure/success messages.
  • Messag – Messages pertaining to authentication. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • OAuth – Messages related to OAuth authentication.
  • Krbros – Kerberos-related authentication messages.
SQL Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.
  • Bulk – Messages pertaining to bulk query execution.
  • Cache – Messages related to reading row data from and writing row data to the product's cache for better performance.
  • Messag – Messages pertaining to SQL transactions. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • ResSet – Query resultsets.
  • Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META Metadata cache and schema messages.
  • Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance.
  • Schema – Messages related to retrieving metadata from or modifying the service schema.
  • MemSto – Messages related to writing to or reading from in-memory metadata cache.
  • Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC Information related to executing SQL functions.
  • Errmsg – Error messages related to executing SQL functions.
TCP Incoming and outgoing raw bytes on TCP transport layer messages.
  • Send – Raw data sent via the TCP protocol.
  • Receiv – Raw data received via the TCP protocol.
FTP Messages pertaining to the File Transfer Protocol.
  • Info – Status messages related to communication in the FTP protocol.
  • Client – Messages related to actions taken by the FTP client (the product) during FTP communication.
  • Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP Messages pertaining to the Secure File Transfer Protocol.
  • Info – Status messages related to communication in the SFTP protocol.
  • To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication.
  • From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP Messages pertaining to data transferred via the Post Office Protocol.
  • Client – Messages related to actions taken by the POP client (the product) during POP communication.
  • Server – Messages related to actions taken by the POP server during POP communication.
  • Status – Status messages related to communication in the POP protocol.
SMTP Messages pertaining to data transferred via the Simple Mail Transfer Protocol.
  • Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication.
  • Server – Messages related to actions taken by the SMTP server during SMTP communication.
  • Status – Status messages related to communication in the SMTP protocol.
CORE Messages relating to various internal product operations not covered by other modules.
DEMN Messages related to SQL remoting.
CLJB Messages about bulk data uploads (cloud job).
  • Commit – Submissions for bulk data uploads.
SRCE Miscellaneous messages produced by the product that don't belong in any other module.
TRANCE Advanced messages concerning low-level product operations.

CData Python Connector for PayPal

Exception Handling

Exception Handling

Exceptions can be surfaced from either the API or the CData Python Connector for PayPal. Each exception will have an error code, an error message, and a SQL state.

Error Codes

The error code classifies the type of error.

0 NONE Used for unclassified errors and internally handled errors. This code also covers data source-specific errors that do not fit in any specific category.
65537 TCP_UNKNOWN_HOST Unable to resolve a hostname (DNS failure).
65538 TCP_CONNECTION_REFUSED Could not connect to the remote port.
65539 TCP_AUTH_FAILED Login failed when using a binary authentication protocol. Use this for auth errors when the protocol is not HTTP (LDAP, SASL, Kerberos, ...).
65540 TCP_TIMEOUT Did not receive a response after sending a request to the server.
65541 TCP_PROTOCOL For wire protocol drivers. Either the server sent a bad packet that we are unable to process, or we cannot construct a packet to send.
131073 TLS_SERVER_UNTRUSTED Could not verify SSL server certificate.
131074 TLS_CLIENT_UNTRUSTED Server did not accept the client certificate we sent.
196609 OAUTH_DECRYPT_FAILED OAuthEncryptKey did not decrypt the OAuthSettings file.
196610 OAUTH_MISSING_CLIENT_INFO OAuthClientId / OAuthClientSecret / OAuthJWTCert is missing.
196611 OAUTH_MISSING_PROP General OAuth property missing. OAUTH_MISSING_CLIENT_INFO is used for missing client ID/secret and JWT cert.
196612 OAUTH_NO_ACCESS_TOKEN Unable to retrieve access token. Only use this when getting a token in GetOAuthAccessToken / RefreshOAuthAccessToken.
196613 OAUTH_TOKEN_EXPIRED The access token expired. Normally used with a RefreshOAuth/OAuthException behavior.
196614 OAUTH_INVALID_PROP OAuth property has an invalid value. OAUTH_MISSING_CLIENT_INFO / OAUTH_MISSING_PROP is used if the value is not set.
262145 HTTP_REQUEST_TIMEOUT Did not receive a response from the HTTP server.
262146 HTTP_CLIENT_ERROR Generic HTTP 4xx error. Only use for 4xx errors not covered by other codes.
262147 HTTP_AUTH_FAILED HTTP 401 error.
262148 HTTP_LIMIT_EXCEEDED HTTP 429 error.
262149 HTTP_SERVER_ERROR HTTP 5xx error.
262150 HTTP_NOT_FOUND_ERROR HTTP 404 error.
327681 CORE_TIMEOUT General timeout. Not related to a specific network request.
327682 CORE_OP_NOT_ALLOWED Operation blocked by provider permissions.
327683 CORE_CONNECTION_CONFIG Connection configuration is not valid.
327684 CORE_SERIALIZE Failed to encode data into a specific format (XML, JSON, CSV, ...).
327685 CORE_DESERIALIZE Failed to decode data from a specific format (XML, JSON, CSV, ...).
393217 SQL_SYNTAX_ERROR Unable to parse a SQL query.
393218 SQL_MISSING_COLUMNS Query did not include required columns.
393219 SQL_MISSING_PARAMS Stored procedure call did not include required parameters.
393220 SQL_QUERY_NOT_SUPPORTED A part of the query is not allowed in the current context.
458753 SSH_SERVER_UNTRUSTED Could not verify SSH server.
524289 STORAGE_LIST_EXCEPTION Issue listing storage resources.
524290 STORAGE_RESOURCE_NOT_FOUND Issue finding storage resources.
524291 STORAGE_ROOT_RESOURCE_NOT_FOUND The root resource (bucket/share/drive) was not found; cannot create it in flat file drivers.
524292 STORAGE_RESOURCE_NOT_A_DIRECTORY Storage resource is not a directory.
524293 STORAGE_RESOURCE_NOT_A_FILE Storage resource is not a file.
524294 STORAGE_PERMISSIONS_DENIED Storage permissions denied.

SQL State

The SQL state is used when throwing generic provider errors to the wrapper and indicates the success or failure of a call.

Some of the common SQL states are listed below:

07007 REQUIRED_CLAUSE Class Code 07: Dynamic SQL Error.
08001 OPEN_CONNECTION Class Code 08: Connection Exception. The connection was unable to be established to the application server or other server.
08004 REJECT_CONNECTION The application server rejected establishment of the connection.
42501 PRIVILEGE_IDENTIFIED_OBJECT Class Code 42: Syntax Error or Access Rule Violation. The authorization ID does not have the privilege to perform the specified operation on the identified object.
42506 AUTH_FAILED Owner authorization failure occurred.
42601 SQL_SYNTAX A character, token, or clause is invalid or missing.

Error Message

The error message provides more detailed reasoning about why the error occurred. It provides an explanation of the issue, and may include steps on how to resolve it.

CData Python Connector for PayPal

SQL Compliance

SELECT Statements

See SELECT Statements for a syntax reference and examples.

See Data Model for information on the capabilities of the PayPal API.

CACHE Statements

CACHE statements allow granular control over the connector's caching functionality. For a syntax reference and examples, see CACHE Statements.

For more information on the caching feature, see Caching Data.

EXECUTE Statements

Use EXECUTE or EXEC statements to execute stored procedures. See EXECUTE Statements for a syntax reference and examples.

Names and Quoting

  • Table and column names are considered identifier names; as such, they are restricted to the following characters: [A-Z, a-z, 0-9, _:@].
  • To use a table or column name with characters not listed above, the name must be quoted using square brackets ([name]) in any SQL statement.
  • Parameter names can optionally start with the @ symbol (e.g., @p1 or @CustomerName) and cannot be quoted.
  • Strings must be quoted using single quotes (e.g., 'John Doe').

CData Python Connector for PayPal

SQL Functions

The connector provides functions that are similar to those that are available with most standard databases. These functions are implemented in the CData provider engine and thus are available across all data sources with the same consistent API. Three categories of functions are available: string, date, and math.

The connector interprets all SQL function inputs as either strings or column identifiers, so you need to escape all literals as strings, with single quotes. For example, contrast the SQL Server syntax and connector syntax for the DATENAME function:

  • SQL Server:
    SELECT DATENAME(yy,GETDATE())
  • connector:
    SELECT DATENAME('yy',GETDATE())

String Functions

These functions perform string manipulations and return a string value. See STRING Functions for more details.

Date Functions

These functions perform date and date time manipulations. See DATE Functions for more details.

Math Functions

These functions provide mathematical operations. See MATH Functions for more details.

CData Python Connector for PayPal

STRING Functions

ASCII(character_expression)

Returns the ASCII code value of the left-most character of the character expression.

  • character_expression: The character expression.

                      SELECT ASCII('0');
                      --  Result: 48
                    

BASE64_ENCODE(input_binary)

Returns the Base64-encoded string form of a binary input.

  • input_binary: The binary value to encode.

                        SELECT BASE64_ENCODE(BinaryData);
                    -- Result: 'QmFzZTY0RW5jb2RlZA=='
                    

BASE64_DECODE(input_string)

Returns the binary result of decoding a Base64-encoded string.

  • input_string: The Base64-encoded string.

                        SELECT BASE64_DECODE('QmFzZTY0RW5jb2RlZA==');
                    -- Result: (binary output)
                    

CHAR(integer_expression)

Converts the integer ASCII code to the corresponding character.

  • integer_expression: The integer from 0 through 255.

                      SELECT CHAR(48);
                      -- Result: '0'
                    

CHARINDEX(expressionToFind ,expressionToSearch [,start_location ])

Returns the starting position of the specified expression in the character string.

  • expressionToFind: The character expression to find.
  • expressionToSearch: The character expression, typically a column, to search.
  • start_location: An optional character position to start searching for expressionToFind in expressionToSearch.

                      SELECT CHARINDEX('456', '0123456');
                      -- Result: 4

                      SELECT CHARINDEX('456', '0123456', 5);
                      -- Result: -1
                    

CHAR_LENGTH(character_expression),

Returns the number of UTF-8 characters present in the expression.

  • character_expression: The set of characters to be evaluated for length.

				 SELECT CHAR_LENGTH('sample text') FROM Account LIMIT 1
				 -- Result: 11			
				

CONCAT(string_value1, string_value2, ..., string_valueN)

Returns the string that is the concatenation of two or more string values.

  • string_value1: The first string to be concatenated.
  • string_value2: The second string to be concatenated.
  • string_valueN: (optional) Any additional strings to be concatenated.

                      SELECT CONCAT('Hello, ', 'world!');
                      -- Result: 'Hello, world!'
                    

CONTAINS(expressionToSearch, expressionToFind)

Returns 1 if expressionToFind is found within expressionToSearch; otherwise, 0.

  • expressionToSearch: The character expression, typically a column, to search.
  • expressionToFind: The character expression to find.

                      SELECT CONTAINS('0123456', '456');
                      -- Result: 1

                      SELECT CONTAINS('0123456', 'Not a number');
                      -- Result: 0
                    

ENDSWITH(character_expression, character_suffix)

Returns 1 if character_expression ends with character_suffix; otherwise, 0.

  • character_expression: The character expression.
  • character_suffix: The character suffix to search for.

                      SELECT ENDSWITH('0123456', '456');
                      -- Result: 1

                      SELECT ENDSWITH('0123456', '012');
                      -- Result: 0
                    

FILESIZE(uri)

Returns the number of bytes present in the file at the specified file path.

  • uri: The path of the file from which to read the size.

				SELECT FILESIZE('C:/Users/User1/Desktop/myfile.txt');
				-- Result: 23684
				

FORMAT(value [, parseFormat], format )

Returns the value formatted with the specified format.

  • value: The string to format.
  • format: The string specifying the output syntax of the date or numeric format.
  • parseFormat: The string specifying the input syntax of the date value. Not applicable to numeric types.

                      SELECT FORMAT(12.34, '#');
                      -- Result: 12

                      SELECT FORMAT(12.34, '#.###');
                      -- Result: 12.34

                      SELECT FORMAT(1234, '0.000E0');
                      -- Result: 1.234E3
                      
                      SELECT FORMAT('2019/01/01', 'yyyy-MM-dd');
                      -- Result: 2019-01-01
                      
                      SELECT FORMAT('20190101', 'yyyyMMdd', 'yyyy-MM-dd');
                      -- Result: '2019-01-01'
                    

HASHBYTES(algorithm, value)

Returns the hash of the input value as a byte array using the given algorithm. The supported algorithms are MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, and SHA3_512.

  • algorithm: The algorithm to use for hashing. Must be one of MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, or SHA3_512.
  • value: The value to hash. Must be either a string or byte array.

                      SELECT HASHBYTES('MD5', 'Test');
                      -- Result (byte array): 0x0CBC6611F5540BD0809A388DC95A615B
                    

INDEXOF(expressionToSearch, expressionToFind [,start_location ])

Returns the starting position of the specified expression in the character string.

  • expressionToSearch: The character expression, typically a column, to search.
  • expressionToFind: The character expression to find.
  • start_location: An optional character position to start searching for expressionToFind in expressionToSearch.

                      SELECT INDEXOF('0123456', '456');
                      -- Result: 4

                      SELECT INDEXOF('0123456', '456', 5);
                      -- Result: -1
                    

ISALPHABETIC(character_expression)

Returns 1 if the character expression consists only of alphabetic characters; otherwise, 0.

  • character_expression: The string expression to evaluate.

                      SELECT ISALPHABETIC('Hello');
                      -- Result: 1

                      SELECT ISALPHABETIC('Hello123');
                      -- Result: 0

                      SELECT ISALPHABETIC('Hello!');
                      -- Result: 0
                    

ISALPHANUMERIC(character_expression)

Returns 1 if the character expression consists only of alphabetic and numeric characters; otherwise, 0.

  • character_expression: The string expression to evaluate.

                      SELECT ISALPHANUMERIC('Hello123');
                      -- Result: 1

                      SELECT ISALPHANUMERIC('123');
                      -- Result: 1

                      SELECT ISALPHANUMERIC('Hello.123');
                      -- Result: 0
                    

ISNUMERIC(character_expression)

Returns 1 if the character expression consists only of numeric digits and up to one decimal point; otherwise, 0.

  • character_expression: The string expression to evaluate.

                      SELECT ISNUMERIC('123');
                      -- Result: 1

                      SELECT ISNUMERIC('123.45');
                      -- Result: 1

                      SELECT ISNUMERIC('123.45.67');
                      -- Result: 0

                      SELECT ISNUMERIC('12a3');
                      -- Result: 0
                    

JSON_EXTRACT(json, jsonpath)

Selects any value in a JSON array or object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

  • json: The JSON document to extract.
  • jsonpath: The XPath used to select the nodes. The JSONPath must be a string constant. The values of the nodes selected will be returned in a token-separated list.

                      SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test');
                      -- Result: '{"data":1}'

                      SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test.data');
                      -- Result: 1

                      SELECT JSON_EXTRACT('{"test": {"data": [1, 2, 3]}}', '$.test.data[1]');
                      -- Result: 2
                    

LEFT ( character_expression , integer_expression )

Returns the specified number of characters counting from the left of the specified string.

  • character_expression: The character expression.
  • integer_expression: The positive integer that specifies how many characters will be returned counting from the left of character_expression.

                      SELECT LEFT('1234567890', 3);
                      -- Result: '123'
                    

LEN(string_expression)

Returns the number of characters of the specified string expression.

  • string_expression: The string expression.

                      SELECT LEN('12345');
                      -- Result: 5
                    

LOCATE(substring,string)

Returns an integer representing how many characters into the string the substring appears.

  • substring: The substring to find inside larger string.
  • string: The larger string that is searched for the substring.
  • start locations: An optional integer that sets the character position (offset) from which to start searching.

				SELECT LOCATE('sample','XXXXXsampleXXXXX');
				-- Result: 6

                SELECT LOCATE('sample', 'XXXXXsampleXXXXX', 7)
                -- Result: 0
				

LOWER ( character_expression )

Returns the character expression with the uppercase character data converted to lowercase.

  • character_expression: The character expression.

                      SELECT LOWER('MIXED case');
                      -- Result: 'mixed case'
                    

LTRIM(character_expression)

Returns the character expression with leading blanks removed.

  • character_expression: The character expression.

                      SELECT LTRIM('     trimmed');
                      -- Result: 'trimmed'
                    

MASK(string_expression, mask_character [, start_index [, end_index ]])

Replaces the characters between start_index and end_index with the mask_character within the string.

  • string_expression: The string expression to be searched.
  • mask_character: The character to mask with.
  • start_index: The optional number of characters to leave unmasked at beginning of string. Defaults to 0.
  • end_index: The optional number of characters to leave unmasked at end of string. Defaults to 0.

                        SELECT MASK('1234567890','*',);
                        -- Result: '**********'
                        SELECT MASK('1234567890','*', 4);
                        -- Result: '1234******'
                        SELECT MASK('1234567890','*', 4, 2);
                        -- Result: '1234****90'  
                    

NCHAR(integer_expression)

Returns the Unicode character with the specified integer code as defined by the Unicode standard.

  • integer_expression: The integer from 0 through 65535 (0 through xFFFF).

OCTET_LENGTH(character_expression),

Returns the number of bytes present in the expression.

  • character_expression: The set of characters to be be evaluated.

				 SELECT OCTET_LENGTH('text') FROM Account LIMIT 1
				 -- Result: 4
				

PATINDEX(pattern, expression)

Returns the starting position of the first occurrence of the pattern in the expression. Returns 0 if the pattern is not found.

  • pattern: The character expression that contains the sequence to be found. The wild-card character % can be used only at the start or end of the expression.
  • expression: The expression, typically a column, to search for the pattern.

                      SELECT PATINDEX('123%', '1234567890');
                      -- Result: 1

                      SELECT PATINDEX('%890', '1234567890');
                      -- Result: 8

                      SELECT PATINDEX('%456%', '1234567890');
                      -- Result: 4
                    

POSITION(expressionToFind IN expressionToSearch)

Returns the starting position of the specified expression in the character string.

  • expressionToFind: The character expression to find.
  • expressionToSearch: The character expression, typically a column, to search.

                      SELECT POSITION('456' IN '123456');
                      -- Result: 4

                      SELECT POSITION('x' IN '123456');
                      -- Result: 0
                    

QUOTENAME(character_string [, quote_character])

Returns a valid SQL Server-delimited identifier by adding the necessary delimiters to the specified Unicode string.

  • character_string: The string of Unicode character data. The string is limited to 128 characters. Inputs greater than 128 characters return null.
  • quote_character: An optional single character to be used as the delimiter. These include:
    • a single quotation mark (')
    • a left or right bracket ([])
    • a double quotation mark (")
    • a left or right parenthesis ( () )
    • a greater or less than sign (><)
    • a left or right brace ({})
    • a backtick (`)

    If quote_character is not specified brackets are used. If an unacceptable character is supplied, it returns NULL.


                      SELECT QUOTENAME('table_name');
                      -- Result: '[table_name]'

                      SELECT QUOTENAME('table_name', '"');
                      -- Result: '"table_name"'

                      SELECT QUOTENAME('table_name', '[');
                      -- Result: '[table_name]'
                    

REGEXP_REPLACE(expr, pattern [, replacement [, position [, occurrence [, match_type]]]])

Replaces occurrences of a regular expression pattern in the input string with a specified value and returns the resulting string.

  • expr: The string expression to be searched.
  • pattern: The regular expression pattern to match.
  • replacement: (optional) The string to replace each matched occurrence of pattern with. Supports backreferences \1 through \9 and escape sequences \n, \r, \t, and \\. By default, this argument is an empty string, meaning matched portions are removed from the output string.
  • position: (optional) The 1-based starting position used when searching for regular expression matches in expr. The default is 1. All characters prior to the starting position are included in the output string unaltered. Skipped characters are ignored when calculating regular expression matches, even if they match pattern.
  • occurrence: (optional) Specifies whether all occurrences of pattern,, or only a specific occurrence of pattern are replaced. The default is 0, which means all occurrences of pattern are replaced with replacement. Set to 1 to only replace the first instance of the pattern; 2 to replace the second; etc.
  • match_type: (optional) Modifiers used to customize matching behavior. Supported values are: 'c' (case-sensitive, default), 'i' (case-insensitive), 'm' (multiline), 'n' (dot matches newline), 'x' (extended mode). These can be freely combined by including the letters back to back. For example, 'im' applies the functionality of both 'i' and 'm'. The regular expression syntax used is that of the Extended mode ('x') ignores whitespace and allows inline comments. If the pattern needs to match a literal space, it must be explicitly escaped.

                      SELECT REGEXP_REPLACE('abc123def456', '\d+', 'NUM');
                      -- Result: 'abcNUMdefNUM'

                      SELECT REGEXP_REPLACE('Hello\nHELLO\nhello', '^hello', 'X', 1, 0, 'im');
                      -- Result: 'X\nX\nX'
                    

REPLACE(string_expression, string_pattern, string_replacement)

Replaces all occurrences of a string with another string.

  • string_expression: The string expression to be searched. This can be a character or binary data type.
  • string_pattern: The substring to be found. Cannot be an empty string.
  • string_replacement: The replacement string.

                      SELECT REPLACE('1234567890', '456', '|');
                      -- Result: '123|7890'

                      SELECT REPLACE('123123123', '123', '.');
                      -- Result: '...'

                      SELECT REPLACE('1234567890', 'a', 'b');
                      -- Result: '1234567890'
                    

REPLICATE ( string_expression ,integer_expression )

Repeats the string value the specified number of times.

  • string_expression: The string to replicate.
  • integer_expression: The repeat count.

                      SELECT REPLACE('x', 5);
                      -- Result: 'xxxxx'
                    

REVERSE ( string_expression )

Returns the reverse order of the string expression.

  • string_expression: The string.

                      SELECT REVERSE('1234567890');
                      -- Result: '0987654321'
                    

RIGHT ( character_expression , integer_expression )

Returns the right part of the string with the specified number of characters.

  • character_expression: The character expression.
  • integer_expression: The positive integer that specifies how many characters of the character expression will be returned.

                      SELECT RIGHT('1234567890', 3);
                      -- Result: '890'
                    

RTRIM(character_expression)

Returns the character expression after it removes trailing blanks.

  • character_expression: The character expression.

                      SELECT RTRIM('trimmed     ');
                      -- Result: 'trimmed'
                    

SOUNDEX(character_expression)

Returns the four-character Soundex code, based on how the string sounds when spoken.

  • character_expression: The alphanumeric expression of character data.

                      SELECT SOUNDEX('smith');
                      -- Result: 'S530'
                    

SPACE(repeatcount)

Returns the string that consists of repeated spaces.

  • repeatcount: The number of spaces.

                      SELECT SPACE(5);
                      -- Result: '     '
                    

SPLIT(string, delimiter, offset)

Returns a section of the string between to delimiters.

  • string: The string to split.
  • delimiter: The character to split the string with.
  • offset: The number of the split to return. Positive numbers are treated as offsets from the left, and negative numbers are treated as offsets from the right.

                      SELECT SPLIT('a/b/c/d', '/', 1);
                      -- Result: 'a'
                      SELECT SPLIT('a/b/c/d', '/', -2);
                      -- Result: 'c'
                    

STARTSWITH(character_expression, character_prefix)

Returns 1 if character_expression starts with character_prefix; otherwise, 0.

  • character_expression: The character expression.
  • character_prefix: The character prefix to search for.

                      SELECT STARTSWITH('0123456', '012');
                      -- Result: 1

                      SELECT STARTSWITH('0123456', '456');
                      -- Result: 0
                    

STR ( float_expression [ , integer_length [ , integer_decimal ] ] )

Returns the character data converted from the numeric data. For example, STR(123.45, 6, 1) returns 123.5.

  • float_expression: The float expression.
  • length: The optional total length to return. This includes decimal point, sign, digits, and spaces. The default is 10.
  • decimal: The optional number of places to the right of the decimal point. The decimal must be less than or equal to 16.

                      SELECT STR('123.456');
                      -- Result: '123'

                      SELECT STR('123.456', 2);
                      -- Result: '**'

                      SELECT STR('123.456', 10, 2);
                      -- Result: '123.46'
                    

STUFF(character_expression , integer_start , integer_length , replaceWith_expression)

Inserts a string into another string. It deletes the specified length of characters in the first string at the start position and then inserts the second string into the first string at the start position.

  • character_expression: The string expression.
  • start: The integer value that specifies the location to start deletion and insertion. If start or length is negative, null is returned. If start is longer than the string to be modified, character_expression, null is returned.
  • length: The integer that specifies the number of characters to delete. If length is longer than character_expression, deletion occurs up to the last character in replaceWith_expression.
  • replaceWith_expression: The expression of character data that will replace length characters of character_expression beginning at the start value.

                      SELECT STUFF('1234567890', 3, 2, 'xx');
                      -- Result: '12xx567890'
                    

SUBSTRING(string_value FROM start FOR length)

Returns the part of the string with the specified length; starts at the specified index.

  • string_value: The character string.
  • start: The positive integer that specifies the start index of characters to return.
  • length: Optional. The positive integer that specifies how many characters will be returned.

                      SELECT SUBSTRING('1234567890' FROM 3 FOR 2);
                      -- Result: '34'

                      SELECT SUBSTRING('1234567890' FROM 3);
                      -- Result: '34567890'
                    
You can also drop the FROM and FOR clauses:
                    SELECT SUBSTRING('1234567890', 3, 2)
                    --Result: '34'
                    SELECT SUBSTRING('1234567890', 3)
                    --Result: '34567890'
                    

TEXT_ENCODE(input_string, charset)

Returns binary output by encoding a string using the specified character set.

  • input_string: The plain text string.
  • charset: The character set to use, such as 'UTF-8', 'ISO-8859-1'.

                    SELECT TEXT_ENCODE('Café', 'UTF-8');
                    -- Result: (binary output)
                    

TEXT_DECODE(input_binary, charset)

Returns a string decoded from binary data using the specified character set.

  • input_binary: The binary value to decode.
  • charset: The character set used for decoding.

                    SELECT TEXT_DECODE(BinaryData, 'UTF-8');
                    -- Result: 'Café'
                    

TOSTRING(string_value1)

Converts the value of this instance to its equivalent string representation.

  • string_value1: The string to be converted.

                      SELECT TOSTRING(123);
                      -- Result: '123'

                      SELECT TOSTRING(123.456);
                      -- Result: '123.456'

                      SELECT TOSTRING(null);
                      -- Result: ''
                    

TRIM(trimspec trimchar FROM string_value)

Returns the character expression with leading and/or trailing blanks removed.

  • trimspec: Optional. If included must be one of the keywords BOTH, LEADING or TRAILING.
  • trimchar: Optional. If included should be a one-character string value.
  • string_value: The string value to trim.

                      SELECT TRIM('     trimmed     ');
                      -- Result: 'trimmed'

                      SELECT TRIM(LEADING FROM '     trimmed     ');
                      -- Result: 'trimmed     '

                      SELECT TRIM('-' FROM '-----trimmed-----');
                      -- Result: 'trimmed'

                      SELECT TRIM(BOTH '-' FROM '-----trimmed-----');
                      -- Result: 'trimmed'

                      SELECT TRIM(TRAILING '-' FROM '-----trimmed-----');
                      -- Result: '-----trimmed'
                    

UNICODE(ncharacter_expression)

Returns the integer value defined by the Unicode standard of the first character of the input expression.

  • ncharacter_expression: The Unicode character expression.

UPPER ( character_expression )

Returns the character expression with lowercase character data converted to uppercase.

  • character_expression: The character expression.

                      SELECT UPPER('MIXED case');
                      -- Result: 'MIXED CASE'
                    

XML_EXTRACT(xml, xpath [, separator])

Extracts an XML document using the specified XPath to flatten the XML. A comma is used to separate the outputs by default, but this can be changed by specifying the third parameter.

  • xml: The XML document to extract.
  • xpath: The XPath used to select the nodes. The nodes selected will be returned in a token-separated list.
  • separator: The optional token used to separate the items in the flattened response. If this is not specified, the separator will be a comma.

                      SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch');
                      -- Result: 'a,e,i,o,u'

                      SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch', ';');
                      -- Result: 'a;e;i;o;u'
                    

CData Python Connector for PayPal

MATH Functions

ABS ( numeric_expression )

Returns the absolute (positive) value of the specified numeric expression.

  • numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT ABS(15);
                      -- Result: 15

                      SELECT ABS(-15);
                      -- Result: 15
                    

ACOS ( float_expression )

Returns the arc cosine, the angle in radians whose cosine is the specified float expression.

  • float_expression: The float expression that specifies the cosine of the angle to be returned. Values outside the range from -1 to 1 return null.

                      SELECT ACOS(0.5);
                      -- Result: 1.0471975511966
                    

ASIN ( float_expression )

Returns the arc sine, the angle in radians whose sine is the specified float expression.

  • float_expression: The float expression that specifies the sine of the angle to be returned. Values outside the range from -1 to 1 return null.

                      SELECT ASIN(0.5);
                      -- Result: 0.523598775598299
                    

ATAN ( float_expression )

Returns the arc tangent, the angle in radians whose tangent is the specified float expression.

  • float_expression: The float expression that specifies the tangent of the angle to be returned.

                      SELECT ATAN(10);
                      -- Result: 1.47112767430373
                    

ATN2 ( float_expression1 , float_expression2 )

Returns the angle in radians between the positive x-axis and the ray from the origin to the point (y, x) where x and y are the values of the two specified float expressions.

  • float_expression1: The float expression that is the y-coordinate.
  • float_expression2: The float expression that is the x-coordinate.

                      SELECT ATN2(1, 1);
                      -- Result: 0.785398163397448
                    

CEILING ( numeric_expression ) or CEIL( numeric_expression )

Returns the smallest integer greater than or equal to the specified numeric expression.

  • numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT CEILING(1.3);
                      -- Result: 2

                      SELECT CEILING(1.5);
                      -- Result: 2

                      SELECT CEILING(1.7);
                      -- Result: 2
                    

COS ( float_expression )

Returns the trigonometric cosine of the specified angle in radians in the specified expression.

  • float_expression: The float expression of the specified angle in radians.

                      SELECT COS(1);
                      -- Result: 0.54030230586814
                    

COT ( float_expression )

Returns the trigonometric cotangent of the angle in radians specified by float_expression.

  • float_expression: The float expression of the angle in radians.

                      SELECT COT(1);
                      -- Result: 0.642092615934331
                    

DEGREES ( numeric_expression )

Returns the angle in degrees for the angle specified in radians.

  • numeric_expression: The angle in radians, an expression of an indeterminate numeric data type except for the bit data type.

                      SELECT DEGREES(3.1415926);
                      -- Result: 179.999996929531
                    

EXP ( float_expression )

Returns the exponential value of the specified float expression. For example, EXP(LOG(20)) is 20.

  • float_expression: The float expression.

                      SELECT EXP(2);
                      -- Result: 7.38905609893065
                    

EXPR ( expression )

Evaluates the expression.

  • expression: The expression. Operators allowed are +, -, *, /, ==, !=, >, <, >=, and <=.

                      SELECT EXPR('1 + 2 * 3');
                      -- Result: 7

                      SELECT EXPR('1 + 2 * 3 == 7');
                      -- Result: true
                    

FLOOR ( numeric_expression )

Returns the largest integer less than or equal to the numeric expression.

  • numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT FLOOR(1.3);
                      -- Result: 1

                      SELECT FLOOR(1.5);
                      -- Result: 1

                      SELECT FLOOR(1.7);
                      -- Result: 1
                    

GREATEST(int1,int2,....)

Returns the greatest of the supplied integers.

				SELECT GREATEST(3,5,8,10,1)
				-- Result: 10			
				

HEX(value)

Returns a the equivalent hex for the input value.

  • value: A string or numerical value to be converted into hex.

				SELECT HEX(866849198);
				-- Result: 33AB11AE
				
				SELECT HEX('Sample Text');
				-- Result: 53616D706C652054657874
				

JSON_AVG(json, jsonpath)

Computes the average value of a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

  • json: The JSON document to compute.
  • jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_AVG('[1,2,3,4,5]', '$[x]');
                      -- Result: 3

                      SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 3

                      SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 4.5
                    

JSON_COUNT(json, jsonpath)

Returns the number of elements in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

  • json: The JSON document to compute.
  • jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_COUNT('[1,2,3,4,5]', '$[x]');
                      -- Result: 5

                      SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 5

                      SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 2
                    

JSON_MAX(json, jsonpath)

Gets the maximum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

  • json: The JSON document to compute.
  • jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_MAX('[1,2,3,4,5]', '$[x]');
                      -- Result: 5

                      SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 5

                      SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[..3]');
                      -- Result: 4
                    

JSON_MIN(json, jsonpath)

Gets the minimum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

  • json: The JSON document to compute.
  • jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_MIN('[1,2,3,4,5]', '$[x]');
                      -- Result: 1

                      SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 1

                      SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 4
                    

JSON_SUM(json, jsonpath)

Computes the summary value in JSON according to the JSONPath expression. Return value is numeric or null.

  • json: The JSON document to compute.
  • jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_SUM('[1,2,3,4,5]', '$[x]');
                      -- Result: 15

                      SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 15

                      SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 9
                    

LEAST(int1,int2,....)

Returns the least of the supplied integers.

				SELECT LEAST(3,5,8,10,1)
				-- Result: 1			
				

LOG ( float_expression [, base ] )

Returns the natural logarithm of the specified float expression.

  • float_expression: The float expression.
  • base: The optional integer argument that sets the base for the logarithm.

                      SELECT LOG(7.3890560);
                      -- Result: 1.99999998661119
                    

LOG10 ( float_expression )

Returns the base-10 logarithm of the specified float expression.

  • float_expression: The expression of type float.

                      SELECT LOG10(10000);
                      -- Result: 4
                    

MOD(dividend,divisor)

Returns the integer value associated with the remainder when dividing the dividend by the divisor.

  • dividend: The number to take the modulus of.
  • divisor: The number to divide the dividend by when determining the modulus.

				SELECT MOD(10,3);
				-- Result: 1
				

NEGATE(real_number)

Returns the opposite to the real number input.

  • real_number: The real number to find the opposite of.

				SELECT NEGATE(10);
				-- Result: -10
				
				SELECT NEGATE(-12.4)
				--Result: 12.4
				

PI ( )

Returns the constant value of pi.

                  SELECT PI()
                  -- Result: 3.14159265358979 
                

POWER ( float_expression , y )

Returns the value of the specified expression raised to the specified power.

  • float_expression: The float expression.
  • y: The power to raise float_expression to.

                      SELECT POWER(2, 10);
                      -- Result: 1024

                      SELECT POWER(2, -2);
                      -- Result: 0.25
                    

RADIANS ( float_expression )

Returns the angle in radians of the angle in degrees.

  • float_expression: The degrees of the angle as a float expression.

                      SELECT RADIANS(180);
                      -- Result: 3.14159265358979
                    

RAND ( [ integer_seed ] )

Returns a pseudorandom float value from 0 through 1, exclusive.

  • seed: The optional integer expression that specifies the seed value. If seed is not specified, a seed value at random will be assigned.

                      SELECT RAND();
                      -- This result may be different, since the seed is randomized
                      -- Result: 0.873159630165044

                      SELECT RAND(1);
                      -- This result will always be the same, since the seed is constant
                      -- Result: 0.248668584157093
                    

ROUND ( numeric_expression [ ,integer_length] [ ,function ] )

Returns the numeric value rounded to the specified length or precision.

  • numeric_expression: The expression of a numeric data type.
  • length: The optional precision to round the numeric expression to. When this is omitted, the default behavior will be to round to the nearest whole number.
  • function: The optional type of operation to perform. When the function parameter is omitted or has a value of 0 (default), numeric_expression is rounded. When a value other than 0 is specified, numeric_expression is truncated.

                      SELECT ROUND(1.3, 0);
                      -- Result: 1

                      SELECT ROUND(1.55, 1);
                      -- Result: 1.6

                      SELECT ROUND(1.7, 0, 0);
                      -- Result: 2

                      SELECT ROUND(1.7, 0, 1);
                      -- Result: 1
                      
                      SELECT ROUND (1.24);
                      -- Result: 1.0
                    

SIGN ( numeric_expression )

Returns the positive sign (1), 0, or negative sign (-1) of the specified expression.

  • numeric_expression: The expression of an indeterminate data type except for the bit data type.

                      SELECT SIGN(0);
                      -- Result: 0

                      SELECT SIGN(10);
                      -- Result: 1

                      SELECT SIGN(-10);
                      -- Result: -1
                    

SIN ( float_expression )

Returns the trigonometric sine of the angle in radians.

  • float_expression: The float expression specifying the angle in radians.

                     SELECT SIN(1);
                     -- Result: 0.841470984807897
                    

SQRT ( float_expression )

Returns the square root of the specified float value.

  • float_expression: The expression of type float.

                      SELECT SQRT(100);
                      -- Result: 10
                    

SQUARE ( float_expression )

Returns the square of the specified float value.

  • float_expression: The expression of type float.

                      SELECT SQUARE(10);
                      -- Result: 100

                      SELECT SQUARE(-10);
                      -- Result: 100
                    

TAN ( float_expression )

Returns the tangent of the input expression.

  • float_expression: The expression of type float.

                      SELECT TAN(1);
                      -- Result: 1.5574077246549
                    

TRUNC(decimal_number,precision)

Returns the supplied decimal number truncated to have the supplied decimal precision.

  • decimal_number: The decimal value to truncate.
  • precision: The number of decimal places to truncate the decimal number to.

				SELECT TRUNC(10.3423,2);
				-- Result: 10.34
				

_ROW_NUMBER_()

Returns a row index as an additional column.

				SELECT ColumnName, _ROW_NUMBER_() FROM TableName
				-- Result: ColumnData, 0
				ColumnData2, 1
				ColumnData3, 2
				

CData Python Connector for PayPal

DATE Functions

CURRENT_DATE()

Returns the current date value.

                  SELECT CURRENT_DATE();
                  -- Result: 2018-02-01
                

CURRENT_TIMESTAMP()

Returns the current time stamp of the database system as a datetime value. This value is equal to GETDATE and SYSDATETIME, and is always in the local timezone.

                  SELECT CURRENT_TIMESTAMP();
                  -- Result: 2018-02-01 03:04:05
                

DATEADD (datepart , integer_number , date [, dateformat])

Returns the datetime value that results from adding the specified number (a signed integer) to the specified date part of the date.

  • datepart: The part of the date to add the specified number to. The valid values and abbreviations are
    • year (yy, yyyy)
    • quarter (qq, q)
    • month (mm, m)
    • week (wk, ww)
    • weekday (dw)
    • dayofyear (dy, y)
    • day (dd, d)
    • hour (hh)
    • minute (mi, n)
    • second (ss, s)
    • millisecond (ms)
  • number: The number to be added.
  • date: The expression of the datetime data type.
  • dateformat: The optional output date format.

                  SELECT DATEADD('d', 5, '2018-02-01');
                  -- Result: 2018-02-06

                  SELECT DATEADD('hh', 5, '2018-02-01 00:00:00');
                  -- Result: 2018-02-01 05:00:00
                

DATEDIFF ( datepart , startdate , enddate )

Returns the difference (a signed integer) of the specified time interval between the specified start date and end date.

  • datepart: The part of the date that is the time interval of the difference between the start date and end date. The valid values and abbreviations are:
    • Year (year, yyyy, yy)
    • Quarter (quarter, qq, q)
    • Month (month, mm, m)
    • Week (week, wk, ww)
    • Weekday (weekday, dw)
    • Dayofyear (dayofyear, dy, y)
    • Day (day, dd, d)
    • Hour (hour, hh)
    • Minute (minute, mi, n)
    • Second (second, ss, s)
    • Millisecond (millisecond, ms)
  • startdate: The datetime expression of the start date.
  • enddate: The datetime expression of the end date.

                  SELECT DATEDIFF('d', '2018-02-01', '2018-02-10');
                  -- Result: 9

                  SELECT DATEDIFF('hh', '2018-02-01 00:00:00', '2018-02-01 12:00:00');
                  -- Result: 12
                

DATE_FORMAT(date,format)

Returns the date or timestamp in the format specified. This function mirrors the MySQL DATE_FORMAT function.

  • date: A date or timestamp string.
  • format: The specifier string of the desired output format. The list of supported format specifiers comes from the MySQL DATE_FORMAT function (see link to MySQL documentation above).

					SELECT DATE_FORMAT('9/4/2021 3:11:53 AM','%h')
					-- Result: 03
				  

DATEFROMPARTS(integer_year, integer_month, integer_day)

Returns the datetime value for the specified year, month, and day.

  • year: The integer expression specifying the year.
  • month: The integer expression specifying the month.
  • day: The integer expression specifying the day.

                    SELECT DATEFROMPARTS(2018, 2, 1);
                    -- Result: 2018-02-01
                  

DATENAME(datepart , date)

Returns the character string that represents the specified date part of the specified date.

  • datepart: The part of the date to return. The valid values and abbreviations are year (yy, yyyy), quarter (qq, q), month (mm, m), dayofyear (dy, y), day (dd, d), week (wk, ww), weekday (dw), hour (hh), minute (mi, n), second (ss, s), millisecond (ms), microsecond (mcs), and nanosecond (ns).
  • date: The datetime expression.

                     SELECT DATENAME('yy', '2018-02-01');
                     -- Result: '2018'

                     SELECT DATENAME('dw', '2018-02-01');
                     -- Result: 'Thursday'
                   

DATEPART(datepart, date [,integer_datefirst])

Returns a character string that represents the specified date part of the specified date.

  • datepart: The part of the date to return. The valid values and abbreviations are year (yy, yyyy), quarter (qq, q), month (mm, m), dayofyear (dy, y), day (dd, d), week (wk, ww), weekday (dw), hour (hh), minute (mi, n), second (ss, s), millisecond (ms), microsecond (mcs), nanosecond (ns), ISODOW, ISO_WEEK (isoweek, isowk,isoww), and ISOYEAR.
  • date: The datetime string.
  • datefirst: The optional integer representing the first day of the week. The default is 7, Sunday.

                    SELECT DATEPART('yy', '2018-02-01');
                    -- Result: 2018

                    SELECT DATEPART('dw', '2018-02-01');
                    -- Result: 5
                  

DATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_milliseconds)

Returns the datetime value for the specified date parts.

  • year: The integer expression specifying the year.
  • month: The integer expression specifying the month.
  • day: The integer expression specifying the day.
  • hour: The integer expression specifying the hour.
  • minute: The integer expression specifying the minute.
  • seconds: The integer expression specifying the seconds.
  • milliseconds: The integer expression specifying the milliseconds.

                    SELECT DATETIMEFROMPARTS(2018, 2, 1, 1, 2, 3, 456);
                    -- Result: 2018-02-01 01:02:03.456
                  

DATETIME2FROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)

Returns the datetime value for the specified date parts.

  • year: The integer expression specifying the year.
  • month: The integer expression specifying the month.
  • day: The integer expression specifying the day.
  • hour: The integer expression specifying the hour.
  • minute: The integer expression specifying the minute.
  • seconds: The integer expression specifying the seconds.
  • fractions: The integer expression specifying the fractions of the second.
  • precision: The integer expression specifying the precision of the fraction.

				    SELECT DATETIME2FROMPARTS(2018, 2, 1, 1, 2, 3, 456, 3);
                    -- Result: 2018-02-01 01:02:03.456
                  

DATE_TRUNC(date, datepart)

Truncates the date to the precision of the given date part. Modeled after the Oracle TRUNC function.

  • date: The datetime string that specifies the date.
  • datepart: Refer to the Oracle documentation for valid datepart syntax.

				    SELECT DATE_TRUNC('05-04-2005', 'YY');
                    -- Result: '1/1/2005'
					
                    SELECT DATE_TRUNC('05-04-2005', 'MM');
                    -- Result: '5/1/2005'                    
                  

DATE_TRUNC2(datepart, date, [weekday])

Truncates the date to the precision of the given date part. Modeled after the PostgreSQL date_trunc function.

  • datepart: One of 'millennium', 'century', 'decade', 'year', 'quarter', 'month', 'week', 'day', 'hour', 'minute' or 'second'.
  • date: The datetime string that specifies the date.
  • weekday: The optional day of the week to use as the first day for 'week'. One of 'sunday', 'monday', etc.

                    SELECT DATE_TRUNC2('year', '2020-02-04');
                    -- Result: '2020-01-01'

                    SELECT DATE_TRUNC2('week', '2020-02-04', 'monday');
                    -- Result: '2020-02-02', which is the previous Monday
                  

DAY(date)

Returns the integer that specifies the day component of the specified date.

  • date: The datetime string that specifies the date.

                    SELECT DAY('2018-02-01');
                    -- Result: 1
                  

DAYNAME(date)

Returns the name of the day of the week of the specified date.

  • date: The datetime string that specifies the date.

                    SELECT DAYNAME('8/18/2021');
                    -- Result: Wednesday
                  

DAYOFMONTH(date)

Returns the day of the month of the given date part.
  • date: The datetime string that specifies the date.

				  SELECT DAYOFMONTH('04/15/2000');
				  -- Result: 15
				  

DAYOFWEEK(date)

Returns the day of the week of the given date part.
  • date: The datetime string that specifies the date.

				  SELECT DAYOFWEEK('04/15/2000');
				  -- Result: 7
				  

DAYOFYEAR(date)

Returns the day of the year of the given date part.
  • date: The datetime string that specifies the date.

				  SELECT DAYOFYEAR('04/15/2000');
				  -- Result: 106
				  

EOMONTH(date [, integer_month_to_add ]) or LAST_DAY(date)

Returns the last day of the month that contains the specified date with an optional offset.

  • date: The datetime expression specifying the date for which to return the last day of the month.
  • integer_month_to_add: The optional integer expression specifying the number of months to add to the date before calculating the end of the month.

                  SELECT EOMONTH('2018-02-01');
                  -- Result: 2018-02-28
                  
                  SELECT LAST_DAY('2018-02-01');
                  -- Result: 2018-02-28

                  SELECT EOMONTH('2018-02-01', 2);
                  -- Result: 2018-04-30
                

EXTRACT(date_part FROM date_column_name)

Returns the last day of the month that contains the specified date with an optional offset.

  • date_part: One of the following date components: YEAR, MONTH, DAY, HOUR, MINUTE, SECOND.
  • date_column_name: The name of a date column in a table.

                  SELECT EXTRACT(YEAR FROM DateColumn)
                  -- Result: 2021
                

FDWEEK(date)

Returns the first day of the week of the given date part.
  • date: The datetime string that specifies the date.
  • weeks to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the week.

				  SELECT FDWEEK('02-08-2018');
				  -- Result: 2/4/2018

          SELECT FDWEEK('02-08-2018', 1)
          --Result: 02/11/2018
				  

FDMONTH(date)

Returns the first day of the month of the given date part.
  • date: The datetime string that specifies the date.
  • month to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the month.

				  SELECT FDMONTH('02-08-2018');
				  -- Result: 2/1/2018

          SELECT FDMONTH('02-08-2018', 1) 
          --Result: 03/01/2018
				  

FDQUARTER(date)

Returns the first day of the quarter of the given date part.
  • date: The datetime string that specifies the date.
  • quarters to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the quarter.

				  SELECT FDQUARTER('05-08-2018');
				  -- Result: 4/1/2018

          SELECT FDQUARTER('05-08-2018',1)
          --Result: 07/01/2018
				  

FILEMODIFIEDTIME(uri)

Returns the time stamp associated with the Date Modified of the relevant file.

  • uri: An absolute path pointing to a file on the local file system.

				 SELECT FILEMODIFIEDTIME('C:/Documents/myfile.txt');
				 -- Result: 6/25/2019 10:06:58 AM
				 

FROM_DAYS(datevalue)

Returns a date derived from the number of days after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL FROM_DAYS function.

  • datevalue: A integer value representing the number of days since 1582-10-15.

				SELECT FROM_DAYS(736000);
				-- Result: 2/6/2015
				

FROM_UNIXTIME(time, issecond)

Returns a representation of the unix_timestamp argument as a value in YYYY-MM-DD HH:MM:SS expressed in the current time zone.

  • time: The time stamp value from epoch time. Milliseconds are accepted.
  • issecond: Indicates the time stamp value is milliseconds to epoch time.

                      SELECT FROM_UNIXTIME(1540495231, 1);
                      -- Result: 2018-10-25 19:20:31

                      SELECT FROM_UNIXTIME(1540495357385, 0);
                      -- Result: 2018-10-25 19:22:37
                    

GETDATE()

Returns the current time stamp of the database system as a datetime value. This value is equal to CURRENT_TIMESTAMP and SYSDATETIME, and is always in the local timezone.

                  SELECT GETDATE();
                  -- Result: 2018-02-01 03:04:05
                

GETUTCDATE()

Returns the current time stamp of the database system formatted as a UTC datetime value. This value is equal to SYSUTCDATETIME.

In addition, GETUTCDATE can take an optional second parameter, a date and time that are converted to UTC.

                  SELECT GETUTCDATE();
                  -- For example, if the local timezone is Eastern European Time (GMT+2)
                  -- Result: 2018-02-01 05:04:05

                  SELECT GETUTCDATE('2020/08/31 13:56:00')
                  --Result: '2020-08-31 17:56:00'
                

HOUR(date)

Returns the hour component from the provided datetime.

  • date: The datetime string that specifies the date.

				SELECT HOUR('02-02-2020 11:30:00');
				-- Result: 11
				

ISDATE(date, [date_format])

Returns 1 if the value is a valid date, time, or datetime value; otherwise, 0.

  • date: The datetime string.
  • date_format: The optional datetime format.

                      SELECT ISDATE('2018-02-01', 'yyyy-MM-dd');
                      -- Result: 1

                      SELECT ISDATE('Not a date');
                      -- Result: 0
                    

LAST_WEEK()

Returns a time stamp equivalent to exactly one week before the current date.

				SELECT LAST_WEEK();	//Assume the date is 3/17/2020	
			 -- Result: 3/10/2020 00:00:00
				

LAST_MONTH()

Returns a time stamp equivalent to exactly one month before the current date.

	
				SELECT LAST_MONTH(); //Assume the date is 3/17/2020
				-- Result: 2/17/2020 00:00:00
				

LAST_YEAR()

Returns a time stamp equivalent to exactly one year before the current date.

				SELECT LAST_YEAR();	//Assume the date is 3/17/2020	
				-- Result: 3/10/2019 00:00:00
				

LDWEEK(date)

Returns the last day of the provided week.

  • date: The datetime string.
  • weeks to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the week.

				SELECT LDWEEK('02-02-2020');
				-- Result: 2/8/2020
				

LDMONTH(date)

Returns the last day of the provided month.

  • date: The datetime string.
  • months to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the month.

				SELECT LDMONTH('02-02-2020');
				-- Result: 2/29/2020

        SELECT LDMONTH('02-08-2020', 1)
        --Result: 03/31/2020
				

LDQUARTER(date)

Returns the last day of the provided quarter.

  • date: The datetime string.
  • quarters to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the quarter.

				SELECT LDQUARTER('02-02-2020');
				-- Result: 3/31/2020

        SELECT LDQUARTER('02-02-2020',1)
        --Result: 06/30/2020
				

MAKEDATE(year, days)

Returns a date value from a year and a number of days.

  • year: The year
  • days: The number of days into the year. Value must be greater than 0.

          SELECT MAKEDATE(2020, 1);
          -- Result: 2020-01-01
        

MINUTE(date)

Returns the minute component from the provided datetime.

  • date: The datetime string that specifies the date.

				SELECT MINUTE('02-02-2020 11:15:00');
				-- Result: 15
				

MONTH(date)

Returns the month component from the provided datetime.

  • date: The datetime string that specifies the date.

				SELECT MONTH('02-02-2020');
				-- Result: 2
				

QUARTER(date)

Returns the quarter associated with the provided datetime.

  • date: The datetime string that specifies the date.

				SELECT QUARTER('02-02-2020');
				-- Result: 1
				

SECOND(date)

Returns the second component from the provided datetime.

  • date: The datetime string that specifies the date.

				SELECT SECOND('02-02-2020 11:15:23');
				-- Result: 23
				

SMALLDATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute)

Returns the datetime value for the specified date and time.

  • year: The integer expression specifying the year.
  • month: The integer expression specifying the month.
  • day: The integer expression specifying the day.
  • hour: The integer expression specifying the hour.
  • minute: The integer expression specifying the minute.

                      SELECT SMALLDATETIMEFROMPARTS(2018, 2, 1, 1, 2);
                      -- Result: 2018-02-01 01:02:00
                    

STRTODATE(string,format)

Parses the provided string value and returns the corresponding datetime.

  • string: The string value to be converted to datetime format.
  • format: A format string which describes how to interpret the first string input. A few special formats are available as well, including UNIX, UNIXMILIS, TICKS, and FILETICKS.

				SELECT STRTODATE('03*04*2020','dd*MM*yyyy');
				-- Result: 4/3/2020
				

SYSDATETIME()

Returns the current time stamp as a datetime value of the database system. It is equal to GETDATE and CURRENT_TIMESTAMP, and is always in the local timezone.

                  SELECT SYSDATETIME();
                  -- Result: 2018-02-01 03:04:05
                

SYSUTCDATETIME()

Returns the current system date and time as a UTC datetime value. It is equal to GETUTCDATE.

                  SELECT SYSUTCDATETIME();
                  -- For example, if the local timezone is Eastern European Time (GMT+2)
                  -- Result: 2018-02-01 05:04:05
                

TIMEFROMPARTS(integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)

Returns the time value for the specified time and with the specified precision.

  • hour: The integer expression specifying the hour.
  • minute: The integer expression specifying the minute.
  • seconds: The integer expression specifying the seconds.
  • fractions: The integer expression specifying the fractions of the second.
  • precision : The integer expression specifying the precision of the fraction.

                      SELECT TIMEFROMPARTS(1, 2, 3, 456, 3);
                      -- Result: 01:02:03.456
                    

TO_DAYS(date)

Returns the number of days since 0000-00-01. This will only return a value for dates on or after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL TO_DAYS function.

  • date: The datetime string that specifies the date.

				SELECT TO_DAYS('02-06-2015');
				-- Result: 736000
				

WEEK(date)

Returns the week (of the year) associated with the provided datetime.

  • date: The datetime string that specifies the date.

				SELECT WEEK('02-17-2020 11:15:23');
				-- Result: 8
				

YEAR(date)

Returns the integer that specifies the year of the specified date.

  • date: The datetime string.

                      SELECT YEAR('2018-02-01');
                      -- Result: 2018
                    

CData Python Connector for PayPal

Date Literal Functions

The following date literal functions can be used to filter date fields using relative intervals. Note that while the <, >, and = operators are supported for these functions, <= and >= are not.

L_TODAY()

The current day.

  SELECT * FROM MyTable WHERE MyDateField = L_TODAY()

L_YESTERDAY()

The previous day.

  SELECT * FROM MyTable WHERE MyDateField = L_YESTERDAY()

L_TOMORROW()

The following day.

  SELECT * FROM MyTable WHERE MyDateField = L_TOMORROW()

L_LAST_WEEK()

Every day in the preceding week.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_WEEK()

L_THIS_WEEK()

Every day in the current week.

  SELECT * FROM MyTable WHERE MyDateField = L_THIS_WEEK()

L_NEXT_WEEK()

Every day in the following week.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_WEEK()
Also available:
  • L_LAST/L_THIS/L_NEXT MONTH
  • L_LAST/L_THIS/L_NEXT QUARTER
  • L_LAST/L_THIS/L_NEXT YEAR

L_LAST_N_DAYS(n)

The previous n days, excluding the current day.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_DAYS(3)

L_NEXT_N_DAYS(n)

The following n days, including the current day.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_DAYS(3)
Also available:
  • L_LAST/L_NEXT_90_DAYS

L_LAST_N_WEEKS(n)

Every day in every week, starting n weeks before current week, and ending in the previous week.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_WEEKS(3)

L_NEXT_N_WEEKS(n)

Every day in every week, starting the following week, and ending n weeks in the future.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_WEEKS(3)
Also available:
  • L_LAST/L_NEXT_N_MONTHS(n)
  • L_LAST/L_NEXT_N_QUARTERS(n)
  • L_LAST/L_NEXT_N_YEARS(n)

CData Python Connector for PayPal

SELECT Statements

A SELECT statement can consist of the following basic clauses.

  • SELECT
  • INTO
  • FROM
  • JOIN
  • WHERE
  • GROUP BY
  • HAVING
  • UNION
  • ORDER BY
  • LIMIT

SELECT Syntax

The following syntax diagram outlines the syntax supported by the SQL engine of the connector:

SELECT {
  [ TOP <numeric_literal> | DISTINCT ]
  { 
    * 
    | { 
        <expression> [ [ AS ] <column_reference> ] 
        | { <table_name> | <correlation_name> } .* 
      } [ , ... ] 
  }
  { 
    FROM <table_reference> [ [ AS ] <identifier> ] 
  } [ , ... ]
  [ [  
      INNER | { { LEFT | RIGHT | FULL } [ OUTER ] } 
    ] JOIN <table_reference> [ ON <search_condition> ] [ [ AS ] <identifier> ] 
  ] [ ... ] 
  [ WHERE <search_condition> ]
  [ GROUP BY <column_reference> [ , ... ]
  [ HAVING <search_condition> ]
  [ UNION [ ALL ] <select_statement> ]
  [ 
    ORDER BY 
    <column_reference> [ ASC | DESC ] [ NULLS FIRST | NULLS LAST ]
  ]
  [ 
    LIMIT <expression>
    [ 
      { OFFSET | , }
      <expression> 
    ]
  ] 
}

<expression> ::=
  | <column_reference>
  | @ <parameter> 
  | ?
  | COUNT( * | { [ DISTINCT ] <expression> } )
  | { AVG | MAX | MIN | SUM | COUNT } ( <expression> ) 
  | NULLIF ( <expression> , <expression> ) 
  | COALESCE ( <expression> , ... ) 
  | CASE <expression>
      WHEN { <expression> | <search_condition> } THEN { <expression> | NULL } [ ... ]
    [ ELSE { <expression> | NULL } ]
    END 
  | {RANK() | DENSE_RANK()} OVER ([PARTITION BY <column_reference>] {ORDER BY <column_reference>})
  | <literal>
  | <sql_function> 

<search_condition> ::= 
  {
    <expression> { = | > | < | >= | <= | <> | != | LIKE | NOT LIKE | IN | NOT IN | IS NULL | IS NOT NULL | AND | OR | CONTAINS | BETWEEN | IS DISTINCT FROM | IS NOT DISTINCT FROM } [ <expression> ]
  } [ { AND | OR } ... ] 

Examples

  1. Return all columns:
    SELECT * FROM Payments
  2. Rename a column:
    SELECT [State] AS MY_State FROM Payments
  3. Cast a column's data as a different data type:
    SELECT CAST(AnnualRevenue AS VARCHAR) AS Str_AnnualRevenue FROM Payments
  4. Search data:
    SELECT * FROM Payments WHERE CreateTime > '2016-01-15'
  5. Return the number of items matching the query criteria:
    SELECT COUNT(*) AS MyCount FROM Payments 
  6. Return the number of unique items matching the query criteria:
    SELECT COUNT(DISTINCT State) FROM Payments 
  7. Return the unique items matching the query criteria:
    SELECT DISTINCT State FROM Payments 
  8. Sort a result set in ascending order:
    SELECT Id, State FROM Payments  ORDER BY State ASC
  9. Restrict a result set to the specified number of rows:
    SELECT Id, State FROM Payments LIMIT 10 
  10. Parameterize a query to pass in inputs at execution time. This enables you to create prepared statements and mitigate SQL injection attacks.
    SELECT * FROM Payments WHERE CreateTime = @param
See Explicitly Caching Data for information on using the SELECT statement in offline mode.

Pseudo Columns

Some input-only fields are available in SELECT statements. These fields, called pseudo columns, do not appear as regular columns in the results, yet may be specified as part of the WHERE clause. You can use pseudo columns to access additional features from PayPal.

    SELECT * FROM Payments WHERE Pseudo = '@Pseudo'
    

Aggregate Functions

For SELECT examples using aggregate functions, see Aggregate Functions.

JOIN Queries

See JOIN Queries for SELECT query examples using JOINs.

Date Literal Functions

Date Literal Functions contains SELECT examples with date literal functions.

Window Functions

See Window Functions for SELECT examples containing window functions.

Table-Valued Functions

See Table-Valued Functions for SELECT examples with table-valued functions.

CData Python Connector for PayPal

Aggregate Functions

COUNT

Returns the number of rows matching the query criteria.

SELECT COUNT(*) FROM Payments WHERE CreateTime = '2016-01-15'

COUNT(DISTINCT)

Returns the number of distinct, non-null field values matching the query criteria.

SELECT COUNT(DISTINCT Id) AS DistinctValues FROM Payments WHERE CreateTime > '2016-01-15'

AVG

Returns the average of the column values.

SELECT State, AVG(AnnualRevenue) FROM Payments WHERE CreateTime > '2016-01-15'  GROUP BY State

MIN

Returns the minimum column value.

SELECT MIN(AnnualRevenue), State FROM Payments WHERE CreateTime > '2016-01-15' GROUP BY State

MAX

Returns the maximum column value.

SELECT State, MAX(AnnualRevenue) FROM Payments WHERE CreateTime > '2016-01-15' GROUP BY State

SUM

Returns the total sum of the column values.

SELECT SUM(AnnualRevenue) FROM Payments WHERE CreateTime = '2016-01-15'

CData Python Connector for PayPal

JOIN Queries

The CData Python Connector for PayPal supports standard SQL joins like the following examples.

Inner Join

An inner join selects only rows from both tables that match the join condition:

SELECT SaleDetails.TotalAmount, Payments.State FROM Payments INNER JOIN SaleDetails ON SaleDetails.ParentPayment = Payments.Id

Left Join

A left join selects all rows in the FROM table and only matching rows in the JOIN table:

SELECT SaleDetails.TotalAmount, Payments.State FROM Payments LEFT JOIN SaleDetails ON SaleDetails.ParentPayment = Payments.Id

CData Python Connector for PayPal

Window Functions

Window functions allow you to create computed fields from a group of rows (a window) that return a result for each row, as opposed to one computed result for a set of rows, as is the case with aggregate functions. The connector supports the following window function syntax.

Note: Window function support is an experimental feature of the connector. This functionality extends beyond the connector's core scope of being SQL-92 compliant. As such, performance with window functions may not be optimal.

Window Function Clauses

OVER

The OVER clause defines the window over which window functions are performed.

SELECT A, B, <window function> OVER (<window frame>) FROM TableName

The <window function> refers to any supported window function clause, and the <window frame> refers to one or more clauses that specify the logic by which the window is defined.

PARTITION BY

The PARTITION BY clause subdivides a window into sub-windows called partitions. For each unique value in the column specified in the PARTITION BY clause, every record with that value collectively forms an individual partition.

SELECT A, B, <window function> OVER (PARTITION BY A ORDER BY B) From Payments

The <window function> refers to any supported window function clause.

Window Functions

The connector supports math, ranking, and analytic window functions.

Math

These window functions perform mathematical operations on the records within the window.

COUNT()

Calculates the number of records in each partition. The calculated column is of the data type "int".

In each partition, every record will display the total number of records in that partition.

SELECT Name, Role, Earnings, COUNT() OVER (PARTITION BY Role) FROM Employees

COUNT_BIG()

Calculates the number of records in each partition. The calculated column is of the data type "bigint".

In each partition, every record will display the total number of records in that partition.

SELECT Name, Role, Earnings, COUNT_BIG() OVER (PARTITION BY Role) FROM Employees

MIN(numeric_column)

Calculates the minimum value of a numerical column per partition.

In each partition, every record will display the minimum value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MIN(Earnings) OVER (PARTITION BY Role) FROM Employees

MAX(numeric_column)

Calculates the maximum value of a numerical column per partition.

In each partition, every record will display the maximum value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MAX(Earnings) OVER (PARTITION BY Role) FROM Employees

SUM(numeric_column)

Calculates the sum of a numerical column per partition.

In each partition, every record will display the sum of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, SUM(Earnings) OVER (PARTITION BY Role) FROM Employees

AVG(numeric_column)

Calculates the average value of a numerical column per partition.

In each partition, every record will display the average value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, AVG(Earnings) OVER (PARTITION BY Role) FROM Employees

MEDIAN(numeric_column)

Calculates the median value of a numerical column per partition.

In each partition, every record will display the median value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MEDIAN(Earnings) OVER (PARTITION BY Role) FROM Employees

STDEV(numeric_column)

Calculates the standard deviation of a numerical column per partition.

In each partition, every record will display the standard deviation of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, STDEV(Earnings) OVER (PARTITION BY Role) FROM Employees

STDEVP(numeric_column)

Calculates the population standard deviation of a numerical column per partition.

In each partition, every record will display the population standard deviation of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, STDEVP(Earnings) OVER (PARTITION BY Role) FROM Employees

VAR(numeric_column)

Calculates the statistical standard variance of a numerical column per partition.

In each partition, every record will display the statistical standard variance of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, VAR(Earnings) OVER (PARTITION BY Role) FROM Employees

VARP(numeric_column)

Calculates the variance population of a numerical column per partition.

In each partition, every record will display the variance population of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, VARP(Earnings) OVER (PARTITION BY Role) FROM Employees

Ranking

These window functions rank records that fall within the window and its partitions.

RANK()

Assigns a rank number to each record in a window based on the value of the column specified in the required ORDER BY clause.

If two or more records have an equal value in the in ranked column, they all receive the same rank number and the rank count increments internally, skipping ahead one rank number for each record with a duplicate value in the ORDER BY column.

SELECT Id, State, RANK() OVER (ORDER BY State) AS Rank FROM Payments

If you add a PARTITION BY clause, a separate set of ranks is calculated for each partition.

SELECT Id, State, RANK() OVER (PARTITION BY Id ORDER BY State) AS Rank FROM Payments

DENSE_RANK()

Operates like the RANK() function, but it doesn't increment the internal rank counter for each record with a duplicate value in the ranked column.

This means that, while records with identical values in the ORDER BY column still share a rank number, the function never skips a rank number.

SELECT Id, State, DENSE_RANK() OVER (PARTITION BY Id ORDER BY State) AS Rank FROM Payments

If you add a PARTITION BY clause, a separate set of ranks is calculated for each partition.

SELECT Id, State, DENSE_RANK() OVER (PARTITION BY Id ORDER BY State) AS Rank FROM Payments

ROW_NUMBER()

Calculates a row number for each record. An ORDER BY clause in the OVER clause is required.

SELECT Name, Role, Earnings, ROW_NUMBER() OVER (ORDER BY Role) FROM Employees
If you define multiple partitions with PARTITION BY, a new set of row numbers are calculated for each partition.
SELECT Name, Role, Earnings, ROW_NUMBER() OVER (PARTITION BY Role ORDER BY Earnings) FROM Employees

NTILE()

Distributes rows of an ordered partition into a specified number of approximately equal groups, or buckets. It assigns each group a bucket number starting from one. For each row in a group, the NTILE() function assigns a bucket number representing the group to which the row belongs.

The syntax of NTILE() is:

NTILE(buckets) OVER (
    [PARTITION BY partition_expression, ... ]
    ORDER BY sort_expression [ASC | DESC], ...
)
The following are paramaters that NTILE() supports:

  • buckets: The number of buckets into which the rows are divided. The buckets can be an expression or subquery that evaluates to a positive integer. It cannot be a window function.
  • PARTITION BY: distributes rows of a result set into partitions to which the NTILE() function is applied.
  • ORDER BY is clause that specifies the logical order of rows in each partition to which the NTILE() is applied.

If the number of rows is not divisible by the buckets, the NTILE() function returns groups of two sizes with the difference by one. The larger groups always precede the smaller group in the order set by ORDER BY in the OVER() clause.

If the total of rows is divisible by the number of buckets, the function divides the rows evenly among buckets. The following statement creates a new table named ntile_demo that stores 10 integers:

CREATE TABLE sales.ntile_demo (
	v INT NOT NULL
);
	
INSERT INTO sales.ntile_demo(v) 
VALUES(1),(2),(3),(4),(5),(6),(7),(8),(9),(10);	
	
SELECT * FROM sales.ntile_demo;
This statement uses the NTILE() function to divide ten rows into three groups:
SELECT 
	v, 
	NTILE (3) OVER (
		ORDER BY v
	) buckets
FROM 
	sales.ntile_demo;

Analytical

These window functions perform analytical operations on the records within the window.

PERCENT_RANK()

Calculates the relative rank SQL Percentile of each row. It returns values greater than zero, but the maximum value is one. It does not count any NULL values. This function is nondeterministic.

The syntax of PERCENT_RANK() is:

PERCENT_RANK() OVER (
      [PARTITION BY partition_expression, ... ]
      ORDER BY sort_expression [ASC | DESC], ...
  )
  
This syntax uses the following parameters.

  • PARTITION BY: By default, SQL Server treats the whole data set as a single set. You can specify the PARTITION BY clause to divide data into multiple sets. The Percent_Rank function performs the analytical calculations on each set. This parameter is optional.
  • ORDER BY: Sorts the data in either ascending or descending order. This parameter is required.

CData Python Connector for PayPal

Table-Valued Functions

Table-valued functions are functions that return a table (rowset).

Note: Table-valued function support is an experimental feature of the connector. This functionality extends beyond the connector's core scope of being SQL-92 compliant. As such, performance with these functions may not be optimal.

Table-Valued Function Clauses

CROSS APPLY

The CROSS APPLY operator is used to perform a subquery on each row of a table or resultset produced by a preceding table expression.

<table_expression_1> CROSS APPLY <table_expression_2>

The second table expression can reference results from the first table expression to create derived columns or an altered recordset via a table-valued function.

Each resulting record is an instance of the record it's splitting, with all the same column values, except for the column(s) containing the value split by the function.

WITH

The WITH clause is used alongside certain table-valued functions to match against constructs within the structure being split (keys, element names, attribute names, etc.) and/or to specify metadata for the columns generated from the function.
SELECT A.ColumnName, X.DerivedColumnName FROM TableName A CROSS APPLY <table-valued function> WITH (DerivedColumnName varchar(255)) AS X

Table-Valued Functions

STRING_SPLIT(input_text,delimiter)

Takes each record in the recordset of the preceding table expression, splits the column containing delimiters (input_text) into substrings separated by the delimiter, and returns one record per substring.

  • input_text: A column whose value you want to parse.
  • delimiter: The character used to split the value of the column specified in input_text.

Suppose there is a column called "SplitColumn" with the following content:

One-Two-Three
To unpack this value across multiple records:
SELECT A.ID, X.Value FROM [TableWithDelimitedStringField] A CROSS APPLY STRING_SPLIT(A.SplitColumn,'-') WITH (Value VARCHAR(255)) AS X

-- Results:
-----------
|ID|Value|
|1|One|
|1|Two|
|1|Three|

JSONTABLE(json_content,[jsonpath])

For each record in the recordset of the preceding table expression, returns one record for each instance of a key in a JSON array (json_content) that matches the key(s) specified in the WITH clause, at the scope specified by the "jsonpath" input.

  • json_content: A JSON "table" (array of objects). The contents can nest, but this must be a single JSON array, not any other JSON structure, at the root level.
    • The values of every instance of the key(s) provided in the WITH clause are retrievable only for substructures which are immediate children of the root-level JSON array.
  • jsonpath: An optional JSONPath query defining the scope, within the json_content array, that you want to pull content from. The JSON key(s) identified in the WITH clause must exist at the scope defined in this parameter. This defaults to the JSON root ($).

Consider a sample table with a single record, including an ID column and column with JSON content called "JSONColumn" with the following content:

[
	{
		"name": "Samuel",
		"email": "sam@gmail.com",
		"extrainfo": {
			"city": "Seattle"
		}
	},
	{
		"name": "Katherine",
		"email": "kat@gmail.com",
	},
	{
		"name": "George",
		"email": "george23@gmail.com",
	},
	{
		"name": "Carlos",
		"email": "carlos32@gmail.com",
	}
]

To extract all values for a certain key, specify the scope in the JSONTABLE function and provide the desired key(s) in the WITH clause.

SELECT A.ID, X.name FROM [TableWithJSONField] A CROSS APPLY JSONTABLE(A.JSONColumn) WITH (name VARCHAR(255)) AS X

-- Results: 
|ID|name|
---------
|1 |Samuel|
|1 |Katherine|
|1 |George|
|1 |Carlos|

XMLTABLE(xml_content,[xpath,child_type])

For each record in the resultset of the preceding table expression, returns one record for each of the elements and/or attributes in an XML structure (xml_content) that match the tag name(s) and/or attribute name(s) specified in the WITH clause, at the scope specified in the "xpath" input.

  • xml_content: A column containing an XML structure.
  • xpath: An optional XPath that specifies the scope within the XML structure at which the connector extracts content matching the tag/attribute name(s) specified in the WITH clause.
    • When extracting the content of sub-elements, the connector can retrieve all content from tags at the root level, (depth 0) immediate children of the root (depth 1), and children of those children (depth 2).
    • When extracting element attribute content, the connector can retrieve all content from tags containing the specified attribute at the root level (depth 0) and from immediate children of root-level elements (depth 1).
  • child_type: An optional parameter that specifies the part(s) of the parent element (specified in the xpath input) that the column(s) provided in the WITH clause are checked against to identify content.
    • You can supply the following values:
      • 0: The column(s) in the WITH clause are checked for matches against the parent element's attribute names and sub-element tag names.
      • 1: The column(s) in the WITH clause are checked for matches against the parent element's attribute names.
      • 2: The column(s) in the WITH clause are checked for matches against the parent element's sub-element tag names.
    • When not supplied, this defaults to 0.

Extracting Sub-Element Values

Consider a sample table with a single record, including an ID column and a column with XML content called "XMLContent" with the following content:
<shoppingList>
    <item>
        <name>Apples</name>
        <quantity>3</quantity>
        <unit>Kg</unit>
    </item>
    <item>
        <name>Bread</name>
        <quantity>2</quantity>
        <unit>Loaf</unit>
		<extrainfo>
			<Type>Whole-Grain</Type>
		</extrainfo>
    </item>
    <item>
        <name>Milk</name>
        <quantity>1</quantity>
        <unit>Carton</unit>
    </item>
    <item>
        <name>Eggs</name>
        <quantity>12</quantity>
        <unit></unit>
    </item>
</shoppingList>

To extract sub-element content, specify the scope in the XMLTABLE function and provide the desired element name(s) in the WITH clause. Note that this will not work if the XMLTABLE function's child_type input is set to 1.

SELECT A.ID, X.name FROM [TableWithXMLField] A CROSS APPLY XMLTABLE(A.XMLContent,'//*/item') WITH (name VARCHAR(255)) AS X

-- Results: 
|ID|name|
---------
|1|Apples|
|1|Bread|
|1|Milk|
|1|Eggs|

Extracting Values Using Element Tag Attributes

Suppose you have this sample table with a single record, including an ID column and a column with XML content called "XMLContent" with the following content:

<restaurant>
  <dish type="appetizer">
    <name lang="en">Caprese Salad</name>
    <chef>Chef Giovanni</chef>
    <price currency="USD">9.99</price>
  </dish>
  <dish type="main-course">
    <name lang="fr">Boeuf Bourguignon</name>
    <chef>Chef Marie</chef>
    <price currency="EUR">19.99</price>
  </dish>
  <dish type="dessert">
    <name lang="es">Tres Leches Cake</name>
    <chef>Chef Alejandro</chef>
    <price currency="MXN">89.99</price>
  </dish>
</restaurant>

To extract attribute content, specify the scope in the XMLTABLE function and provide the desired attribute name(s) in the WITH clause. Note that this will not work if the XMLTABLE function's child_type input is set to 2.

SELECT A.ID, X.type FROM [TableWithXMLField] A CROSS APPLY XMLTABLE(A.XMLContent,'//*/dish') WITH (type VARCHAR(255)) AS X

-- Results: 
|ID|type|
---------
|1|appetizer|
|1|main-course|
|1|dessert|

CSVTABLE(csv_content,[delimiter])

For each record in the resultset of the preceding table expression, reads from a column that contains a CSV table (csv_content) and for each record in that CSV table, returns one record containing the value of the CSV column(s) specified in the WITH clause.

  • csv_content: A column containing a CSV table.
  • delimiter: An optional custom delimiter (instead of a comma) which splits the CSV content contained in the csv_content input.

Consider a sample table with a single record, including an ID column and a column containing CSV table called "CSVContent" with the following content:

Name;Category;Price
Apple;Fruit;0.99
Spaghetti;Pasta;5.49
Chicken Breast;Meat;8.99
Broccoli;Vegetable;2.49

To select every value in the "Name" column and account for the custom delimiter (;):

SELECT A.ID, X.Name FROM [TableWithCSVField] A CROSS APPLY CSVTABLE(A.CSVContent,';') WITH (Name VARCHAR(255)) AS X

-- Results:
|ID|Name|
-----------
|1|Apple|
|1|Spaghetti|
|1|Chicken Breast|
|1|Broccoli|

CData Python Connector for PayPal

CACHE Statements

When caching is enabled, CACHE statements provide complete control over the data that is cached and the table to which it is cached. The CACHE statement executes the SELECT statement specified and caches its results to a table with the same name in the cache database or to table specified in <cached_table_name>. The connector updates or inserts rows to the cache depending on whether or not they already exist in the cache, so the primary key, which is used to identify existing rows, must be included in the selected columns.

See Caching Data for more information on different caching strategies.

CACHE Statement Syntax

The cache statement may include the following options that alter its behavior:

CACHE [ <cached_table_name> ] [ WITH TRUNCATE | AUTOCOMMIT | SCHEMA ONLY | DROP EXISTING | ALTER SCHEMA ] <select_statement> 

WITH TRUNCATE

If this option is set, the connector removes existing rows in the cache table before adding the selected rows. Use this option if you want to refresh the entire cache table but keep its existing schema.

AUTOCOMMIT

If this option is set, the connector commits each row individually. Use this option if you want to ignore the rows that could not be cached due to some reason. By default, the entire result set is cached as a single transaction.

DROP EXISTING

If this option is set, the connector drops the existing cache table before caching the new results. Use this option if you want to refresh the entire cache table, including its schema.

SCHEMA ONLY

If this option is set, the connector creates the cache table based on the SELECT statement without executing the query.

ALTER SCHEMA

If this option is set, the connector alters the schema of the existing table in the cache if it does not match the schema of the SELECT statement. This option results in new columns or dropped columns, if the schema of the SELECT statement does not match the cached table.

Common Queries

Use the following cache statement to cache all rows of a table:

CACHE SELECT * FROM Payments

Use the following cache statement to cache all rows of a table into the cache table CachedPayments:

CACHE CachedPayments SELECT * FROM Payments

Use the following cache statement for incremental caching. The DateModified column may not exist in all tables. The cache statement shows how incremental caching would work if there were such a column. Also, notice that, in this case, the WITH TRUNCATE and DROP EXISTING options are specifically omitted, which would have deleted all existing rows.

CACHE CachedPayments SELECT * FROM Payments WHERE DateModified > '2013-04-04'

Use the following cache statements to create a table with all available columns that will then cache only a few of them. The sequence of statements cache only Id and State even though the cache table CachedPayments has all the columns in Payments.

CACHE CachedPayments SCHEMA ONLY SELECT * FROM Payments
CACHE CachedPayments SELECT Id, State FROM Payments

CData Python Connector for PayPal

EXECUTE Statements

To execute stored procedures, you can use EXECUTE or EXEC statements.

EXEC and EXECUTE assign stored procedure inputs, referenced by name, to values or parameter names.

Stored Procedure Syntax

To execute a stored procedure as an SQL statement, use the following syntax:

 
{ EXECUTE | EXEC } <stored_proc_name> 
{
  [ @ ] <input_name> = <expression>
} [ , ... ]

<expression> ::=
  | @ <parameter> 
  | ?
  | <literal>

Example Statements

Reference stored procedure inputs by name:

EXECUTE my_proc @second = 2, @first = 1, @third = 3;

Execute a parameterized stored procedure statement:

EXECUTE my_proc second = @p1, first = @p2, third = @p3; 

CData Python Connector for PayPal

PIVOT and UNPIVOT

PIVOT and UNPIVOT can be used to change a table-valued expression into another table.

PIVOT

PIVOT rotates a table-value expression by turning unique values from one column into multiple columns in the output. PIVOT can run aggregations where required on any column value.
PIVOT Synax

 
"SELECT 'AverageCost' AS Cost_Sorted_By_Production_Days, [0], [1], [2], [3], [4]
FROM
(
SELECT DaysToManufacture, StandardCost
FROM Production.Product
) AS SourceTable
PIVOT
(
AVG(StandardCost)
FOR DaysToManufacture IN ([0], [1], [2], [3], [4])
) AS PivotTable;"

UNPIVOT

UNPIVOT carries out nearly the opposite to PIVOT by rotating columns of a table-valued expressions into column values.
UNPIVOT Sytax

 
"SELECT VendorID, Employee, Orders
FROM
(SELECT VendorID, Emp1, Emp2, Emp3, Emp4, Emp5
FROM pvt) p
UNPIVOT
(Orders FOR Employee IN
(Emp1, Emp2, Emp3, Emp4, Emp5)
)AS unpvt;"

For further information on PIVOT and UNPIVOT, see FROM clause plus JOIN, APPLY, PIVOT (Transact-SQL)

CData Python Connector for PayPal

Data Model

The CData Python Connector for PayPal models two PayPal APIs as relational databases, the REST API and the SOAP API. Set the Schema property and use the information in each section to select the proper API based on your project needs.

Using the REST API

The REST API is the newer API and is becoming more popular with PayPal users. However, the REST API lists only the transactions and actions made via the REST API and excludes the UI and the SOAP API.

See REST Data Model for the available entities in the REST API.

Using the SOAP API

The SOAP (Classic) API has full information on transactions, which includes transactions created from the UI, the REST API, and the SOAP API.

See SOAP Data Model for the available entities in the SOAP API.

CData Python Connector for PayPal

REST Data Model

The CData Python Connector for PayPal models the PayPal REST APIs as database views and stored procedures. These are defined in schema files, which are simple, text-based configuration files that make schemas easy to customize.

This section provides the API limitations and requirements for the REST data model.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to PayPal. They can be used to access other functionality in PayPal not surfaced in the Views.

PayPal REST API Limitations

There are some limitations in the PayPal REST API. For example, it provides no way to list all orders/payments, so to query the related views like OrderItems, OrderDetails, Payments you must know the respective ID and specify it.

CData Python Connector for PayPal

Tables

The connector models the data in PayPal as a list of tables in a relational database that can be queried using standard SQL statements.

CData Python Connector for PayPal Tables

Name Description
Invoices Returns invoices from PayPal.
Plans List the Billing Plans.
Products Retrieves the list of products, which are goods and services.

CData Python Connector for PayPal

Invoices

Returns invoices from PayPal.

Table-Specific Information

SELECT

Server-side processing is only supported for the '=' operator.

The following filters are supported by the PayPal API:

  • Id supports the '=' operator.
  • Status supports the '=' operator.
  • Reference supports the '=' operator.
  • Currency supports the '=' operator.
  • Memo supports the '=' operator.
  • InvoiceDate supports the '=,<,>,<=,>=' operators.
  • InvoiceNumber supports the '=' operator.
  • DueDate supports the '=,<,>,<=,>=' operators.
  • DueAmount supports the '=,<,>,<=,>=' operators.
  • CreatedTime supports the '=,<,>,<=,>=' operators.
  • InvoiceAmount supports the '=,<,>,<=,>=' operators.
  • InvoiceCurrency supports the '=' operator.
  • DueAmountCurrencyCode supports the '=' operator.
  • Archived supports the '=' operator.

SELECT * FROM Invoices WHERE Id = 'INV2-LV8Z-5XH2-L4Z6-7LQ4'

When filtering with InvoiceAmount and DueAmount, InvoiceCurrency and DueAmountCurrencyCode are required respectively.

SELECT * FROM Invoices WHERE InvoiceAmount = 100 AND InvoiceCurrency = 'USD'
SELECT * FROM Invoices WHERE InvoiceAmount > 100 AND InvoiceAmount < 150 AND InvoiceCurrency = 'USD'
SELECT * FROM Invoices WHERE InvoiceAmount >= 100 AND InvoiceAmount < 150 AND InvoiceCurrency = 'USD'
SELECT * FROM Invoices WHERE InvoiceAmount > 100 AND InvoiceAmount <= 150 AND InvoiceCurrency = 'USD'
SELECT * FROM Invoices WHERE InvoiceAmount >= 100 AND InvoiceAmount <= 150 AND InvoiceCurrency = 'USD'

The connector processes all other filters client-side.

When using the IncludeDetails property with an offset in the query, set the MaxThreads property to 1 to prevent asynchronous slicing and ensure consistent data retrieval for repeated executions of the same query.

INSERT

To insert an invoice, specify the Currency column. You can optionally include other non-required columns. For example:

INSERT INTO Invoices (Currency, Note) VALUES ('USD','Registration Money');

UPDATE

To update an invoice, specify the Id in the WHERE clause. The Currency column is required when you update invoices. You can update any column that is not read-only. For example:

UPDATE Invoices SET Note = 'Registration Money Received', Currency = 'USD' WHERE Id = 'INV2-EBNZ-C8TS-2FLX-9CAX';

DELETE

To delete an invoice, specify the Id in the WHERE clause. For example:

DELETE FROM Invoices WHERE Id = 'INV2-EBNZ-C8TS-2FLX-9CAX';

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The ID of the invoice.

ParentId String True

The parent ID to an invoice that defines the group invoice to which the invoice is related.

Status String True

The status of the invoice.

The allowed values are DRAFT, SENT, SCHEDULED, PAID, MARKED_AS_PAID, CANCELLED, REFUNDED, PARTIALLY_PAID, PARTIALLY_REFUNDED, MARKED_AS_REFUNDED, UNPAID, PAYMENT_PENDING.

Reference String False

The reference data. Includes a post office (PO) number.

Currency String False

The three-character ISO-4217 currency code that identifies the currency.

Note String False

A note to the invoice recipient. Also appears on the invoice notification email.

TermsAndConditions String False

The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.

Memo String False

A private bookkeeping memo for the user.

InvoiceDate Date False

The invoice date as specified by the sender, in Internet date and time format.

InvoiceNumber String False

A private bookkeeping memo for the user.

TermType String False

The payment term. Payment can be due upon receipt, a specified date, or in a set number of days.

DueDate Date False

The date when the invoice payment is due, in Internet date and time format.

DueAmount Decimal True

The due amount, which is the balance amount outstanding after payments.

Gratuity Decimal True

The amount paid by the payer as gratuity to the invoicer.

PaidAmount Decimal False

The aggregated payment amounts against this invoice.

RefundAmount Decimal False

The aggregated refund amounts.

CreatedTime Datetime True

The date and time when the resource was created, in Internet date and time format.

CreatedBy String True

The email address of the account that created the resource.

LastUpdatedTime Datetime True

The date and time when the resource was last edited, in Internet date and time format.

LastUpdatedBy String True

The email address of the account that last edited the resource.

CancelTime Datetime True

The date and time when the resource was canceled, in Internet date and time format.

CancelledBy String True

The actor who canceled the resource.

FirstSentTime Datetime True

The date and time when the resource was first sent, in Internet date and time format.

LastSentTime Datetime True

The date and time when the resource was last sent, in Internet date and time format.

LastSentBy String True

The email address of the account that last sent the resource.

CreatedByFlow String True

The flow variation that created this invoice.

RecipientViewUrl String True

The URL for the invoice payer view hosted on paypal.com.

InvoicerViewUrl String True

The URL for the invoice merchant view hosted on paypal.com.

InvoicerBusinessName String False

The business name of the party.

InvoicerPrefixName String False

The prefix, or title, to the party's name.

InvoicerFirstName String False

When the party is a person, the party's given, or first, name.

InvoicerMiddleName String False

When the party is a person, the party's middle name. Also used to store multiple middle names including the patronymic, or father's name.

InvoicerLastName String False

When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person.

InvoicerSuffixName String False

The suffix for the party's name.

InvoicerFullName String False

When the party is a person, the party's full name.

InvoicerAddressLine1 String False

The first line of the address. For example, number or street.

InvoicerAddressLine2 String False

The second line of the address. For example, suite or apartment number.

InvoicerAddressLine3 String False

The third line of the address, if needed.

InvoicerAddressPostalCode String False

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.

InvoicerAddressCountryCode String False

The two-character ISO 3166-1 code that identifies the country or region.

InvoicerAddressStreetNumber String False

The street number.

InvoicerAddressStreetName String False

The street name. Just Drury in Drury Lane.

InvoicerAddressStreetType String False

The street type. For example, avenue, boulevard, road, or expressway.

InvoicerAddressDeliveryService String False

The delivery service. Post office box, bag number, or post office name.

InvoicerAddressBuildingName String False

A named location that represents the premise. Usually a building name or number, or a collection of buildings with a common name or number.

InvoicerAddressSubBuilding String False

The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name.

InvoicerEmail String False

The invoicer email address, which must be listed in the user's PayPal profile.

InvoicerWebsite String False

The invoicer's website.

InvoicerTaxId String False

The invoicer's tax ID.

InvoicerAdditionalNotes String False

Any additional information. Includes business hours.

InvoicerLogoUrl String False

The full URL to an external logo image. The logo image must not be larger than 250 pixels wide by 90 pixels high.

TaxCalculatedAfterDiscount Boolean False

Indicates whether the tax is calculated before or after a discount.

TaxInclusive Boolean False

Indicates whether the unit price includes tax.

AllowTip Boolean False

Indicates whether the invoice enables the customer to enter a tip amount during payment.

TemplateId String False

The template ID. The template determines the layout of the invoice. Includes which fields to show and hide.

AllowPartialPayment Boolean False

Indicates whether the invoice allows a partial payment. If false, the invoice must be paid in full. If true, the invoice allows partial payments.

MinimumAmountDue String False

The minimum amount allowed for a partial payment. Valid only when allow_partial_payment is true.

InvoiceAmount Decimal False

The invoice amount summary of item total, discount, tax total and shipping.

InvoiceCurrency String False

The invoice amount summary of item total, discount, tax total and shipping.

ItemTotal Decimal False

The subtotal for all items. Must equal the sum of (quantity * price) for all items.

InvoiceDiscountPercentage String False

The discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.

InvoiceDiscountValue Decimal False

The invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places.

ItemDiscountValue Decimal False

The discount as an amount at item level.

TaxTotal Decimal False

The aggregated amount of the item and shipping taxes.

ShippingAmount Decimal False

The shipping fee for all items. Includes tax on shipping.

ShippingTaxAmount Decimal False

The calculated tax amount. The tax amount is added to the item total.

ShippingTaxPercentage String False

The tax rate. Value is from 0 to 100. Supports up to five decimal places.

ShippingTaxName String False

The name of the tax applied on the invoice items.

DueAmountCurrencyCode String True

The three-character ISO-4217 currency code that identifies the currency.

GratuityCurrencyCode String True

The three-character ISO-4217 currency code that identifies the currency.

PaidAmountCurrencyCode String False

The three-character ISO-4217 currency code that identifies the currency.

RefundAmountCurrencyCode String False

The three-character ISO-4217 currency code that identifies the currency.

MinimumAmountDueCurrencyCode String True

The three-character ISO-4217 currency code that identifies the currency.

ItemTotalCurrencyCode String False

The three-character ISO-4217 currency code that identifies the currency.

InvoiceDiscountCurrencyCode String False

The three-character ISO-4217 currency code that identifies the currency.

ItemDiscountCurrencyCode String False

The three-character ISO-4217 currency code that identifies the currency.

ShippingAmountCurrencyCode String False

The three-character ISO-4217 currency code that identifies the currency.

ShippingTaxAmountCurrencyCode String False

The three-character ISO-4217 currency code that identifies the currency.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Archived Boolean

Indicates whether to list merchant-archived invoices in the response.

CData Python Connector for PayPal

Plans

List the Billing Plans.

Table-Specific Information

SELECT

The connector uses the PayPal API to process WHERE clause conditions built with the following columns and operators. All other filters are processed client-side.

ColumnSupported Operators
Id=
ProductId=

For example, the connector processes the following queries server-side:

SELECT * FROM Plans WHERE Id = '1234'

SELECT * FROM Plans WHERE ProductId = '1234'

INSERT

To insert a plan, specify the ProductId, Name, and BillingCycles columns. You can optionally include other non-required columns. For example:

INSERT INTO Plans (ProductId, Name, BillingCycles) VALUES ('PROD-38M18689438500808', 'New Service Plan', '[{\"frequency\": {\"interval_unit\": \"MONTH\",\"interval_count\": 1},\"tenure_type\": \"REGULAR\",\"sequence\": 1,\"pricing_scheme\": {\"fixed_price\": {\"value\": \"100\",\n" +
              "                     \"currency_code\": \"USD\"\n" +
              "                    }\n" +
              "                  }\n" +
              "                }\n" +
              "              ]')

UPDATE

To update a plan, specify the Id in the WHERE clause. You can update any column that is not read-only. For example:

UPDATE Plans SET name = 'Updated Plan Name 01', Description = 'This is a sample billing plan 01'.

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The unique identifier for the billing plan generated by PayPal.

CreateTime Datetime True

The date and time when the plan was created.

Description String False

The detailed description of the plan.

Links String True

Contains the link to the plan object.

Name String False

The plan name.

ProductId String False

The Id of the product associated with the billing plan.

QuantitySupported Boolean False

Indicates whether you can subscribe to this plan by providing a quantity for the goods or service.

Status String False

The plan status.

The allowed values are CREATED, INACTIVE, ACTIVE.

TaxesInclusive Boolean False

Indicates whether the tax was already included in the billing amount.

TaxesPercentage String False

The tax percentage on the billing amount.

UpdateTime Datetime True

The date and time when the plan was last updated.

IsAutoBillOutstanding Boolean False

Indicates whether to automatically bill the outstanding amount in the next billing cycle.

The default value is true.

SetupFeeFailureAction String False

The action to take on the subscription if the initial payment for the setup fails.

The allowed values are CONTINUE, CANCEL.

The default value is CANCEL.

PaymentFailureThreshold Integer False

The maximum number of payment failures before a subscription is suspended.

The default value is 0.

SetupFeeValue Decimal False

The initial set-up fee value for the service.

SetupFeeCurrencyCode String False

The currency code for the initial setup fee.

BillingCycles String False

An array of billing cycles for trial billing and regular billing.

CData Python Connector for PayPal

Products

Retrieves the list of products, which are goods and services.

Table-Specific Information

SELECT

This view returns a list of products for the authenticated user.

The only filter supported by the PayPal API is Id. Server-side processing is only supported for the '=' operator.

The connector processes all other filters client-side.

For example, the connector processes the following queries server-side.

SELECT * FROM Products
SELECT * FROM Products WHERE Id = 'PP-D-12345'

INSERT

To insert a product, specify the Name column. You can optionally include other non-required columns. For example:

INSERT INTO Products (Name) VALUES ('Gaming Product')

UPDATE

To update a product, specify the Id in the WHERE clause. You can update any column that is not read-only. For example:

UPDATE Products SET Name = 'New Gaming Product' WHERE Id = 'PROD-09F625306742792Y'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The ID of the product.

CreateTime Datetime True

The date and time when the product was created, in Internet date and time format.

Description String False

The product description.

Name String False

The product name.

Category String False

The product category.

Type String False

The product type.

The allowed values are PHYSICAL, DIGITAL, SERVICE.

The default value is PHYSICAL.

ImageUrl String False

The image URL for the product.

HomeUrl String False

The home page URL for the product.

UpdateTime Datetime True

The date and time when the product was last updated, in Internet date and time format.

CData Python Connector for PayPal

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Python Connector for PayPal Views

Name Description
AuthorizationDetails Returns details about authorizations.
BalanceAndNetActivitySummary List all balance and net activity summary for each currency within a given date range.
Balances The list of non-cryptocurrency balances.
CaptureDetails Returns details about a captured payment.
CreditCardDetails Returns details about the funding instrument of the payer, such as a credit card or a token that represents a credit card.
CryptoBalances The list of cryptocurrency balances.
DisputeDetails Returns dispute information from the PayPal Disputes API, which merchants, partners, and external developers use to manage disputes.
Disputes Returns dispute information from the PayPal Disputes API, which merchants, partners, and external developers use to manage disputes.
DisputeTransactions Returns dispute information from the PayPal Disputes API, which merchants, partners, and external developers use to manage disputes.
Notifications Returns the list of event types that are subscribed to a Webhook.
OrderDetails Returns detailed information for an order.
OrderItems Returns the items in an order.
PartnerReferrals Shows details by ID for referral data that was shared by the partner or API caller.
PaymentResources Returns a paginated list of payment resources created by the authenticated merchant.
Payments Returns details about authorized payments.
PaymentTokens Returns merchant-created payment tokens with their associated details.
PaymentTransactions Returns transaction details including the amount and item details.
PayoutDetails Returns details about payouts.
PayoutItems Returns payout items from a payout.
ProductDetails Retrieve the list of product details.
RefundDetails Returns details about a specific refund.
SaleDetails Returns details about a sale transaction.
Subscriptions Get billing and subscription details.
SubscriptionTransactions Lists transactions for a subscription.
Templates Lists merchant-created templates with associated details.
TrackingInformation Query shipment tracking information including the tracking number, carrier, and status.
TransactionReports Lists PayPal transaction reports.
TransactionReportsCartInfoItemDetails Lists cart information for transaction reports.
TransactionReportsIncentiveDetails Lists incentive details of transaction reports.
UserInfo Shows OpenID Connect user profile information for standard claims.
Users Lists users.
Webhooks Returns the list of Webhooks.

CData Python Connector for PayPal

AuthorizationDetails

Returns details about authorizations.

View-Specific Information

SELECT

The only filter supported by the PayPal API is Id, which is required. The connector processes all other filters client-side.

For example, the connector processes the following queries server-side to retrieve details for a specific authorization.

SELECT * FROM AuthorizationDetails WHERE Id = '70K15739YA1955155'

SELECT * FROM AuthorizationDetails WHERE Id IN ('70K15739YA1955155', '70K15739YA1955156')

Columns

Name Type References Description
Id [KEY] String The PayPal-generated ID for the authorized payment.
Status String The status for the authorized payment.

The allowed values are CREATED, CAPTURED, DENIED, PARTIALLY_CAPTURED, VOIDED, PENDING.

StatusDetails String The details of the authorized order pending status.

The allowed values are PENDING_REVIEW, DECLINED_BY_RISK_FRAUD_FILTERS.

AmountTotal Decimal The amount for this authorized payment.
AmountCurrency String The currency of the amount.
InvoiceId String The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
CustomId String The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
SellerProtectionStatus String The level of protection offered as defined by PayPal Seller Protection for Merchants.

The allowed values are ELIGIBLE, PARTIALLY_ELIGIBLE, NOT_ELIGIBLE.

ExpirationTime Datetime The amount being charged for the handling fee. Only supported when the payment method is set to Paypal.
CreateTime Datetime The time of authorization.
UpdateTime Datetime The time that the resource was last updated.
PayeeEmailAddress String The email address of the payee.
PayeeMerchantId String The merchant ID of the payee.
RelatedOrderId String The ID of the order related to the resource.
RelatedAuthorizationId String The ID of the authorization related to the resource.
RelatedCaptureId String The ID of the capture related to the resource.

CData Python Connector for PayPal

BalanceAndNetActivitySummary

List all balance and net activity summary for each currency within a given date range.

View-Specific Information

SELECT

The following filters are supported by the PayPal API:

  • Locale
  • FromDate
  • ToDate

The filters only support the = operator.

The connector processes other filters client side within the connector.

For example, the following query is processed server side.

SELECT * FROM BalanceAndNetActivitySummary WHERE FromDate = '2026-02-03' AND ToDate = '2026-03-03' AND Locale = 'en_US'

Columns

Name Type References Description
LastRefreshDate Date The last refresh date for merchant/partner accounting data.
ReconciliationPassed Boolean Indicates whether the reconciliation of the merchant transaction data has passed.

The default value is true.

NetActivityColumns String Column names for net activity data.
NetActivityActivities String An array containing net-activity, fee, and record-type values.
NetActivityCurrencies String The list of currencies in the net activity summary.
BalanceSummaryColumns String Column names for balance summary.
BalanceSummaryData String An array containing array of strings depicting balance summaries data for each currency.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Locale String The locale of the client.
FromDate Date List balances from the provided date.
ToDate Date List balances until the provided date.

CData Python Connector for PayPal

Balances

The list of non-cryptocurrency balances.

View-Specific Information

SELECT

This view returns a list of disputes for the authenticated user.

The following filters are supported by the PayPal API:

  • Currency
  • AsOfTime

The filters only support the = operator.

The connector processes all other filters client-side.

For example, the connector processes the following queries server-side.

  • The following query retrieves details for a specific currency:
    SELECT * FROM Balances WHERE Currency = 'USD'
  • The following query returns details for Balance records created before the specified date time:
    SELECT * FROM Balances WHERE AsOfTime = '2022-01-09 20:59:59.0'

Columns

Name Type References Description
Currency [KEY] String Currency Code of the balances listed.
AccountId String The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties.
AvailableBalanceCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
AvailableBalanceValue String The value, which might be an integer or a decimal.
Primary Boolean Indicates whether the currency is the primary currency.
TotalBalanceCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TotalBalanceValue Decimal The value, which might be an integer or a decimal.
WithheldBalanceCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
WithheldBalanceValue String The value, which might be an integer or a decimal.
AsOfTime Datetime The requested date and time or the last date and time when the balances can be served.
LastRefreshTime Datetime The date and time when the balances were last refreshed.

CData Python Connector for PayPal

CaptureDetails

Returns details about a captured payment.

View-Specific Information

SELECT

The only filter supported by the PayPal API is Id, which is required. The connector processes all other filters client-side.

For example, the connector processes the following queries server-side to retrieve details for a specific capture.

SELECT * FROM CaptureDetails WHERE Id = '9G02572041588110H'

SELECT * FROM CaptureDetails WHERE Id IN ('9G02572041588110H', '9G02572041588111H')

Columns

Name Type References Description
Id [KEY] String The PayPal-generated ID for the captured payment.
Status String The status of the captured payment.

The allowed values are COMPLETED, DECLINED, PARTIALLY_CAPTURED, PENDING, REFUNDED, FAILED.

StatusDetails String The details of the captured payment status.

The allowed values are BUYER_COMPLAINT, CHARGEBACK, ECHECK, INTERNATIONAL_WITHDRAWAL, OTHER, PENDING_REVIEW, RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION, REFUNDED, TRANSACTION_APPROVED_AWAITING_FUNDING, UNILATERAL, VERIFICATION_REQUIRED, DECLINED_BY_RISK_FRAUD_FILTERS.

AmountValue Decimal The amount for this captured payment.
AmountCurrency String The currency of the amount for this captured payment.
InvoiceId String The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
CustomId String The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
SellerProtectionStatus String The level of protection offered as defined by PayPal Seller Protection for Merchants.

The allowed values are ELIGIBLE, PARTIALLY_ELIGIBLE, NOT_ELIGIBLE.

FinalCapture Boolean Indicates whether you can make additional captures against the authorized payment.
DisbursementMode String The funds that are held on behalf of the merchant.

The allowed values are INSTANT, DELAYED.

SellerGrossAmount Decimal The amount for this captured payment.
SellerPaypalFee Decimal The applicable fee for this captured payment.
SellerNetAmount Decimal The net amount that the payee receives for this captured payment in their PayPal account.
SellerReceivableAmount Decimal The net amount that is credited to the payee's PayPal account. Returned only when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds.
SellerExchangeRate Decimal The exchange rate that determines the amount that is credited to the payee's PayPal account. Returned when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds.
CreateTime Datetime The time of authorization.
UpdateTime Datetime The time that the resource was last updated.
PayeeEmailAddress String The email address of the payee.
PayeeMerchantId String The merchant ID of the payee.
RelatedOrderId String The ID of the order related to the resource.
RelatedAuthorizationId String The ID of the authorization related to the resource.
RelatedCaptureId String The ID of the capture related to the resource.

CData Python Connector for PayPal

CreditCardDetails

Returns details about the funding instrument of the payer, such as a credit card or a token that represents a credit card.

View-Specific Information

SELECT

This view returns a list of Credit Cards or details for a specific one.

The following filters are supported by the PayPal API:

  • Id
  • CreateTime
  • MerchantId
  • ExternalCardId
  • ExternalCustomerId

The CreateTime filter supports the >, >=, <, <=, and = operators, while the other filters only support the = operator.

The connector processes all other filters client-side.

For example, the connector processes the following queries server-side.

  • The following query retrieves details for a specific Credit Card. The last seven characters of the credit card ID are masked and therefore ignored by the API during validation when filtering by ID.
    SELECT * FROM CreditCardDetails WHERE Id  = 'CARD-19H02474E2775740PKZYWVVI'
  • The following query returns details for Credit Card records created after the specified date:
    SELECT * FROM CreditCardDetails WHERE CreateTime > '2016-01-01'

Columns

Name Type References Description
Id [KEY] String The Id of the credit card.
Number String The redacted credit card number.
Type String The credit card type. Valid types are: visa, mastercard, discover, amex.
ExpireMonth Integer The expiration month with no leading zero. Acceptable values are 1 through 12.
ExpireYear Integer The 4-digit expiration year.
FirstName String The first name of the cardholder.
LastName String The last name of the cardholder.
AddressLine1 String The billing address associated with the card. Line 1 of the address (for example, number, street, and so on).
AddressLine2 String The optional line 2 of the address (for example, suite or apartment number).
City String The city name.
CountryCode String The 2-letter country code.
PostalCode String The ZIP code or equivalent. Typically required for countries that have a postal code.
Phone String The phone number in E.123 format.
ExternalCustomerId String The unique identifier of the customer to whom this bank account belongs. Generated and provided by the facilitator.
MerchantId String The user-provided, optional field that functions as a unique identifier for the merchant holding the card. Note that this has no relation to PayPal merchant Id.
ExternalCardId String The unique identifier of the bank account resource. Generated and provided by the facilitator so it can be used to restrict the usage of the bank account to the specific merchant.
CreateTime Datetime The resource creation time in ISO8601 date-time format (for example, 1994-11-05T13:15:30Z).
UpdateTime Datetime The resource update time in ISO8601 date-time format (for example, 1994-11-05T13:15:30Z).
State String The state of the credit card funding instrument. Possible values areexpired andok.
ValidUntil Datetime The funding instrument expiration date.

CData Python Connector for PayPal

CryptoBalances

The list of cryptocurrency balances.

View-Specific Information

SELECT

This view returns a list of disputes for the authenticated user.

The following filters are supported by the PayPal API:

  • AsOfTime

The filters only support the = operator.

The connector processes all other filters client-side.

For example, the connector processes the following queries server-side.

  • The following query returns details for Balance records created before the specified date time:
    SELECT * FROM CryptoBalances WHERE AsOfTime = '2022-01-09 20:59:59.0'

Columns

Name Type References Description
AssetSymbol [KEY] String The Cryptocurrency ticker symbol / code as assigned by liquidity providers.
AccountId String The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties.
Quantity Decimal Quantity of a cryptocurrency asset.
AsOfTime Datetime The requested date and time or the last date and time when the balances can be served.
LastRefreshTime Datetime The date and time when the balances were last refreshed.

CData Python Connector for PayPal

DisputeDetails

Returns dispute information from the PayPal Disputes API, which merchants, partners, and external developers use to manage disputes.

View-Specific Information

SELECT

This view returns a list of disputes with detailed information for the authenticated user.

The following filter is supported by the PayPal API:

  • DisputeId

All other filters are processed client-side by the connector. For example, the following query is processed server-side.

Retrieve details for a specific dispute:

SELECT * FROM DisputeDetails WHERE DisputeId = 'PP-D-12345'

Columns

Name Type References Description
DisputeId [KEY] String The ID of the dispute.
CreatedTime Datetime The date and time when the dispute was created.
UpdatedTime Datetime The date and time when the dispute was updated.
Status String The status of the dispute.

The allowed values are OPEN, WAITING_FOR_BUYER_RESPONSE, WAITING_FOR_SELLER_RESPONSE, UNDER_REVIEW, RESOLVED, OTHER.

Reason String The reason for the item-level dispute.

The allowed values are MERCHANDISE_OR_SERVICE_NOT_RECEIVED, MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED, UNAUTHORISED, CREDIT_NOT_PROCESSED, DUPLICATE_TRANSACTION, INCORRECT_AMOUNT, PAYMENT_BY_OTHER_MEANS, CANCELED_RECURRING_BILLING, PROBLEM_WITH_REMITTANCE, OTHER.

DisputeState String The state of the dispute.

The allowed values are OPEN_INQUIRIES, REQUIRED_ACTION, REQUIRED_OTHER_PARTY_ACTION, UNDER_PAYPAL_REVIEW, APPEALABLE, RESOLVED.

DisputeCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
DisputeAmountValue Decimal The value of the amount.
ExternalReasonCode String The code that identifies the reason for the credit card chargeback.
DisputeOutcomeCode String The outcome of a resolved dispute.
DisputeOutcomeAmountRefundedCode String The three-character ISO-4217 currency code that identifies the currency.
DisputeOutcomeAmountRefundedValue Decimal The value of the amount.
DisputeLifecycleStage String The stage in the dispute lifecycle.
DisputeChannel String The channel where the customer created the dispute.
OfferType String The merchant-proposed offer type for the dispute.
BuyerRequestedAmountCode String The three-character ISO-4217 currency code that identifies the currency.
BuyerRequestedAmountValue Decimal The value of the amount.
BuyerResponseDueDate Datetime The date and time by when the customer must respond to the dispute.
SellerOfferedAmountCode String The three-character ISO-4217 currency code that identifies the currency.
SellerOfferedAmountValue Decimal The value of the amount.
SellerResponseDueDate Datetime The date and time by when the seller must respond to the dispute.
Email String The email address that is provided by the merchant where the customer can share evidence.
Note String The merchant provided notes that are visible to both the customer and PayPal.
TimePosted Datetime The date and time when the contact details were posted.
DisputeAssetSymbol String The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.
DisputeAssetQuantity String The quantity of a cryptocurrency asset.
DisputeAssetQuantityInSubunits String The quantity of a cryptocurrency asset in the currency's sub units.
DisputeOutcomeAssetRefundedSymbol String The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.
DisputeOutcomeAssetRefundedQuantity Decimal The quantity of a cryptocurrency asset.
RefundAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
RefundAmountValue Decimal The maximum refundable amount.

CData Python Connector for PayPal

Disputes

Returns dispute information from the PayPal Disputes API, which merchants, partners, and external developers use to manage disputes.

View-Specific Information

SELECT

This view returns a list of disputes for the authenticated user.

The following filters are supported by the PayPal API:

  • DisputeId supports the = comparison operator.
  • DisputeState supports the = comparison operator.
  • CreateTime supports the =, >, >=, <, <= comparison operators.

The connector processes other filters client-side within the connector.

The following queries are processed server-side.

Retrieve details for a specific dispute:

SELECT * FROM Disputes WHERE DisputeId = 'PP-D-12345'

Retrieve dispute records created after the specified date:

SELECT * FROM Disputes WHERE CreateTime > '2016-01-01'

Columns

Name Type References Description
DisputeId [KEY] String The ID of the dispute.
CreatedTime Datetime The date and time when the dispute was created.
UpdatedTime Datetime The date and time when the dispute was updated.
Status String The status of the dispute.

The allowed values are OPEN, WAITING_FOR_BUYER_RESPONSE, WAITING_FOR_SELLER_RESPONSE, UNDER_REVIEW, RESOLVED, OTHER.

Reason String The reason for the item-level dispute.

The allowed values are MERCHANDISE_OR_SERVICE_NOT_RECEIVED, MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED, UNAUTHORISED, CREDIT_NOT_PROCESSED, DUPLICATE_TRANSACTION, INCORRECT_AMOUNT, PAYMENT_BY_OTHER_MEANS, CANCELED_RECURRING_BILLING, PROBLEM_WITH_REMITTANCE, OTHER.

DisputeState String The state of the dispute.

The allowed values are OPEN_INQUIRIES, REQUIRED_ACTION, REQUIRED_OTHER_PARTY_ACTION, UNDER_PAYPAL_REVIEW, APPEALABLE, RESOLVED.

DisputeCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
DisputeAmountValue Decimal The value of the amount.
DisputeLifecycleStage String The stage in the dispute lifecycle.
DisputeChannel String The channel where the customer created the dispute.
BuyerResponseDueDate Datetime The date and time by when the customer must respond to the dispute.
SellerResponseDueDate Datetime The date and time by when the seller must respond to the dispute.

CData Python Connector for PayPal

DisputeTransactions

Returns dispute information from the PayPal Disputes API, which merchants, partners, and external developers use to manage disputes.

View-Specific Information

SELECT

This view returns a list of transactions with details for a specific dispute.

The following filters are supported by the PayPal API:

  • DisputeId

The connector processes all other filters client-side.

For example, the connector processes the following queries server-side.

  • The following query retrieves transaction details for a specific dispute:
    SELECT * FROM DisputeTransactions WHERE DisputeId = 'PP-D-12345'

Columns

Name Type References Description
DisputeId [KEY] String The ID of the dispute.
CreatedTime Datetime The date and time when the transaction was created.
TransactionStatus String The transaction status.
GrossAmountCode String The three-character ISO-4217 currency code that identifies the currency.
GrossAmountValue Decimal The value of the amount.
BuyerName String The customer's name.
BuyerTransactionId String The customer's transaction ID.
SellerEmail String The email address for the merchant's PayPal account.
SellerMerchantId String The PayPal account ID for the merchant.
SellerTransactionId String The ID, as seen by the merchant, for this transaction.
SellerName String The name of the merchant.
SellerProtectionEligible Boolean Indicator if the seller is eligible for protection.
Custom String A free-text field that is entered by the merchant during checkout.
InvoiceNumber String The ID of the invoice for the payment.
ReferenceId String The ID, as seen by the partner, for this transaction.

CData Python Connector for PayPal

Notifications

Returns the list of event types that are subscribed to a Webhook.

View-Specific Information

SELECT

The only filter supported by the PayPal API is WebhookId, which only supports the = operator. This is a required parameter. The connector processes all other filters client-side.

For example, the connector processes the following query server-side to retrieve the Notifications list for the specified Webhook.

SELECT * FROM Notifications WHERE WebhookId = '8BU398853V564980H'

Columns

Name Type References Description
Name String The unique event type name.
Description String The human-readable description of the event type.
WebhookId String Webhook Id.

CData Python Connector for PayPal

OrderDetails

Returns detailed information for an order.

View-Specific Information

SELECT

Note: PayPal REST API does not support listing all OrderIds. An OrderId must be specified. For scenarios that require listing transactions, use the Transactions and TransactionDetails views in the SOAP schema.

The only filter supported by the PayPal API is Id, which is required. The connector processes other filters client-side within the connector.

For example, the following queries are processed server-side and retrieve details for a specific order.

SELECT * FROM OrderDetails WHERE Id = 'O-1HE90236LH9332431'

SELECT * FROM OrderDetails WHERE Id IN ('O-1HE90236LH9332431', 'O-7D635956955612146')

Columns

Name Type References Description
Id [KEY] String The ID of the order.
Status String The order status. The possible values are: CREATED, SAVED, APPROVED, VOIDED, COMPLETED.
Intent String The intent to either capture payment immediately or authorize a payment for an order after order creation. The possible values are: CAPTURE, AUTHORIZE.
CreatedTime Datetime The date and time when the transaction occurred.
UpdatedTime Datetime The date and time when the transaction was last updated.
PayerId String Deprecated. Use the PaymentSourcePaypal fields instead. The ID of the customer who approves and pays for the order. The customer is also known as the payer.
PayerGivenName String Deprecated. Use the PaymentSourcePaypal fields instead. The name of the customer who approves and pays for the order. The customer is also known as the payer.
PayerSurname String Deprecated. Use the PaymentSourcePaypal fields instead. The last name of the customer who approves and pays for the order. The customer is also known as the payer.
PayerEmail String Deprecated. Use the PaymentSourcePaypal fields instead. The email of the customer who approves and pays for the order. The customer is also known as the payer.
PayerPhoneType String Deprecated. Use the PaymentSourcePaypal fields instead. The phone type.
PayerPhoneNumber String Deprecated. Use the PaymentSourcePaypal fields instead. The phone number, in its canonical international E.164 numbering plan format.
PayerBirthDate Date Deprecated. Use the PaymentSourcePaypal fields instead. The birth date of the payer in YYYY-MM-DD format.
PayerTaxId String Deprecated. Use the PaymentSourcePaypal fields instead. The customer's tax ID. Supported for the PayPal payment method only.
PayerTaxType String Deprecated. Use the PaymentSourcePaypal fields instead. The customer's tax ID type. Supported for the PayPal payment method only.

The allowed values are BR_CPF, BR_CNPJ.

PayerAddressLine1 String Deprecated. Use the PaymentSourcePaypal fields instead. The first line of the address. For example, number or street.
PayerAddressLine2 String Deprecated. Use the PaymentSourcePaypal fields instead. The second line of the address. For example, suite or apartment number.
PayerAddressPostalCode String Deprecated. Use the PaymentSourcePaypal fields instead. The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PayerAddressCountryCode String Deprecated. Use the PaymentSourcePaypal fields instead. The two-character ISO 3166-1 code that identifies the country or region.
PayerAddressAdminArea1 String Deprecated. Use the PaymentSourcePaypal fields instead. The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PayerAddressAdminArea2 String Deprecated. Use the PaymentSourcePaypal fields instead. A city, town, or village.
PurchaseUnits String An array of purchase units.
PaymentSourcePaypalAccountId String The PayPal-assigned ID for the payer.
PaymentSourcePaypalAccountStatus String The account status indicates whether the buyer has verified the financial details associated with their PayPal account.
PaymentSourcePaypalEmailAddress String The email address of the payer.
PaymentSourcePaypalGivenName String When the party is a person, the party's given, or first, name.
PaymentSourcePaypalNameSurname String When the party is a person, the party's surname or family name.
PaymentSourcePaypalPhoneType String The phone type.
PaymentSourcePaypalPhoneNumber String The national number, in its canonical international E.164 numbering plan format.
PaymentSourcePaypalBirthDate Date The birth date of the payer in YYYY-MM-DD format.
PaymentSourcePaypalBusinessName String The business name of the PayPal account holder (populated for business accounts).
PaymentSourcePaypalTaxInfoTaxId String The customer's tax ID value.
PaymentSourcePaypalTaxInfoTaxIdType String The customer's tax ID type.

The allowed values are BR_CPF, BR_CNPJ.

PaymentSourcePaypalAddressLine1 String The first line of the address. For example, number or street.
PaymentSourcePaypalAddressLine2 String The second line of the address. For example, suite or apartment number.
PaymentSourcePaypalAddressAdminArea1 String The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourcePaypalAddressAdminArea2 String A city, town, or village.
PaymentSourcePaypalAddressPostalCode String The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourcePaypalAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceCardName String The card holder's name as it appears on the card.
PaymentSourceCardLastDigits String The last digits of the payment card.
PaymentSourceCardAvailableNetworks String Array of brands or networks associated with the card.
PaymentSourceCardBrand String The card brand or network. Typically used in the response.
PaymentSourceCardType String The payment card type.
PaymentSourceCardExpiry String The card expiration year and month, in Internet date format.
PaymentSourceCardBinDetailsBin String The Bank Identification Number (BIN) signifies the number that is being used to identify the granular level details of the bank.
PaymentSourceCardBinDetailsIssuingBank String The issuer of the card instrument.
PaymentSourceCardBinDetailsBinCountryCode String The two-character ISO-3166-1 country code of the bank.
PaymentSourceCardBinDetailsProducts String The type of card product assigned to the BIN by the issuer.
PaymentSourceCardFromRequestExpiry String The year and month, in ISO-8601 YYYY-MM date format.
PaymentSourceCardFromRequestLastDigits String The last digits of the payment card.
PaymentSourceCardStoredCredentialPaymentInitiator String The person or entity who initiated or triggered the payment.
PaymentSourceCardStoredCredentialPaymentType String Indicates the type of the stored payment_source payment.
PaymentSourceCardStoredCredentialUsage String Indicates if this is a first or subsequent payment using a stored payment source.
PaymentSourceCardAuthenticationResultLiabilityShift String Liability shift indicator. The outcome of the issuer's authentication.
PaymentSourceCardAuthenticationResultThreeDSecureAuthStatus String The outcome of the issuer's authentication.
PaymentSourceCardAuthenticationResultThreeDSecureEnrollmentStatus String Status of authentication eligibility.
PaymentSourceVenmoEmailAddress String The email address of the payer.
PaymentSourceVenmoAccountId String The Venmo-assigned ID for the payer.
PaymentSourceVenmoUserName String The Venmo username, as chosen by the user.
PaymentSourceVenmoGivenName String When the party is a person, the party's given, or first, name.
PaymentSourceVenmoNameSurname String When the party is a person, the party's surname or family name.
PaymentSourceVenmoPhoneNumber String The national number, in its canonical international E.164 numbering plan format.
PaymentSourceVenmoAddressLine1 String The first line of the address. For example, number or street.
PaymentSourceVenmoAddressLine2 String The second line of the address. For example, suite or apartment number.
PaymentSourceVenmoAddressAdminArea1 String The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourceVenmoAddressAdminArea2 String A city, town, or village.
PaymentSourceVenmoAddressPostalCode String The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourceVenmoAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceApplePayId String ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple.
PaymentSourceApplePayToken String Encrypted ApplePay token, containing card information. This token would be base64encoded.
PaymentSourceApplePayName String Name on the wallet.
PaymentSourceApplePayEmailAddress String The email address of the account holder associated with this payment method.
PaymentSourceApplePayPhoneNumber String The national number, in its canonical international E.164 numbering plan format.
PaymentSourceApplePayCardName String The card holder's name as it appears on the card.
PaymentSourceApplePayCardLastDigits String The last digits of the payment card.
PaymentSourceApplePayCardAvailableNetworks String Array of brands or networks associated with the card.
PaymentSourceApplePayCardType String The payment card type.
PaymentSourceApplePayCardBrand String The card brand or network.
PaymentSourceApplePayCardExpiry String The card expiration year and month, in Internet date format.
PaymentSourceApplePayCardBillingAddressLine1 String The first line of the address. For example, number or street.
PaymentSourceApplePayCardBillingAddressLine2 String The second line of the address. For example, suite or apartment number.
PaymentSourceApplePayCardBillingAddressAdminArea1 String The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourceApplePayCardBillingAddressAdminArea2 String A city, town, or village.
PaymentSourceApplePayCardBillingAddressPostalCode String The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourceApplePayCardBillingAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceApplePayCounterfeitIndicator String The indicator to denote if the card is a counterfeit.
PaymentSourceGooglePayName String Name on the account holder associated with Google Pay.
PaymentSourceGooglePayEmailAddress String The email address of the account holder associated with Google Pay.
PaymentSourceGooglePayPhoneNumberCountryCode String The country calling code (CC), in its canonical international E.164 numbering plan format.
PaymentSourceGooglePayPhoneNumber String The national number, in its canonical international E.164 numbering plan format.
PaymentSourceGooglePayCardName String The card holder's name as it appears on the card.
PaymentSourceGooglePayLastDigits String The last digits of the payment card.
PaymentSourceGooglePayType String The payment card type.
PaymentSourceGooglePayBrand String The card brand or network.
PaymentSourceGooglePayBillingAddressLine1 String The first line of the address. For example, number or street.
PaymentSourceGooglePayBillingAddressLine2 String The second line of the address. For example, suite or apartment number.
PaymentSourceGooglePayBillingAddressAdminArea1 String The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourceGooglePayBillingAddressAdminArea2 String A city, town, or village.
PaymentSourceGooglePayBillingAddressPostalCode String The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourceGooglePayBillingAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceBancontactName String The name of the account holder associated with this payment method.
PaymentSourceBancontactCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceBancontactBic String The business identification code (BIC).
PaymentSourceBancontactIbanLastChars String The last characters of the IBAN used to pay.
PaymentSourceBancontactCardLastDigits String The last digits of the card used to fund the Bancontact payment.
PaymentSourceBlikName String The name of the account holder associated with this payment method.
PaymentSourceBlikCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceBlikEmail String The email address of the account holder associated with this payment method.
PaymentSourceBlikOneClickConsumerReference String The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.
PaymentSourceEpsName String The name of the account holder associated with this payment method.
PaymentSourceEpsCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceEpsBic String The business identification code (BIC).
PaymentSourceGiropayName String The name of the account holder associated with this payment method.
PaymentSourceGiropayCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceGiropayBic String The business identification code (BIC).
PaymentSourceIdealName String The name of the account holder associated with this payment method.
PaymentSourceIdealCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceIdealBic String The business identification code (BIC).
PaymentSourceIdealIbanLastChars String The last characters of the IBAN used to pay.
PaymentSourceMybankName String The name of the account holder associated with this payment method.
PaymentSourceMybankCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceMybankBic String The business identification code (BIC).
PaymentSourceMybankIbanLastChars String The last characters of the IBAN used to pay.
PaymentSourceP24Name String The name of the account holder associated with this payment method.
PaymentSourceP24Email String The email address of the account holder associated with this payment method.
PaymentSourceP24CountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceP24PaymentDescriptor String P24 generated payment description.
PaymentSourceP24MethodId Integer Numeric identifier of the payment scheme or bank used for the payment.
PaymentSourceP24MethodDescription String Friendly name of the payment scheme or bank used for the payment.
PaymentSourceSofortName String The name of the account holder associated with this payment method.
PaymentSourceSofortCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceSofortBic String The business identification code (BIC).
PaymentSourceSofortIbanLastChars String The last characters of the IBAN used to pay.
PaymentSourceTrustlyName String The name of the account holder associated with this payment method.
PaymentSourceTrustlyCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceTrustlyEmail String The email address of the account holder associated with this payment method.
PaymentSourceTrustlyBic String The business identification code (BIC).
PaymentSourceTrustlyIbanLastChars String The last characters of the IBAN used to pay.

CData Python Connector for PayPal

OrderItems

Returns the items in an order.

View-Specific Information

SELECT

Note: The PayPal REST API does not provide a way to list all OrderIds, so you must specify one. For scenarios that require listing transactions, use the Transactions and TransactionItems views in the SOAP schema. The only filter supported by the PayPal API is OrderId, which is required. The connector processes all other filters client-side.

For example, the connector processes the following queries server-side to retrieve details for a specific order.

SELECT * FROM OrderItems WHERE OrderId = 'O-1HE90236LH9332431'

SELECT * FROM OrderItems WHERE OrderId IN ('O-1HE90236LH9332431', 'O-7D635956955612146')

Columns

Name Type References Description
OrderId String The ID of the Order this Item belongs to.
Id String The PayPal-generated ID for the purchase unit. This ID appears in both the payer's transaction history and the emails that the payer receives.
ReferenceId String The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through PATCH.
Amount String The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
Description String The purchase description.
CustomId String The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
InvoiceId String The API caller-provided external invoice ID for this order.
SoftDescriptor String The payment descriptor on account transactions on the customer's credit card statement.
ShipperFullName String When the party is a person, the party's full name.
ShippingAddressLine1 String The first line of the address. For example, number or street.
ShippingAddressLine2 String The second line of the address. For example, suite or apartment number.
ShippingAddressPostalCode String The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
ShippingAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PayeeEmail String The email address of the merchant.
PayeeMerchantId String The encrypted PayPal account ID of the merchant.
DisbursementMode String The funds that are held on behalf of the merchant.
Items String An array of items that the customer purchases from the merchant.
MostRecentErrors String The error reason code and description that are the reason for the most recent order decline.
PaymentInstruction String Any additional payment instructions to be considered during payment processing.
SupplementaryData String Supplementary data about this payment.
Payments String The comprehensive history of payments for the purchase unit.

CData Python Connector for PayPal

PartnerReferrals

Shows details by ID for referral data that was shared by the partner or API caller.

View-Specific Information

SELECT

Note: The PartnerReferrals API does not provide a way to list all PartnerReferralIds, so you must specify one. The only filter supported by the PayPal API is Id, which is required. The connector processes all other filters client-side.

For example, the connector processes the following queries server-side to retrieve details for a specific partner referral.

SELECT * FROM PartnerReferrals WHERE Id = 'ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0='

Columns

Name Type References Description
Id [KEY] String The ID to access the customer's data shared by the partner with PayPal.
SubmitterPayerId String The payer ID of the partner who shared the referral data.
SubmitterClientId String The client ID of the partner who shared the referral data.
IndividualOwners String List of owners in the account.
BusinessNames String Name of the business.
BusinessEmails String Email addresses of the business.
BusinessWebsite String Website of the business.
BusinessAddresses String List of addresses associated with the business entity.
BusinessPhones String The list of phone numbers associated with the business.
BusinessDocuments String Business Party related Document data collected from the customer.
BusinessType String Type of business entity like corporation, sole prop, governmental.
BusinessSubtype String The sub classification of the business type.
BusinessIndustryCategory String The customer's business category code.
BusinessIndustryMccCode String The customer's business seller category code.
BusinessIndustrySubcategory String The customer's business subcategory code.
BusinessIncorporationCountryCode String The incorporation country code.
BusinessIncorporationDate Date Date of business incorporation.
BusinessOfficeBearers String The list of directors that are part of the business entity.
BusinessPurposeCode String The account's purpose code.
BusinessDescription String The business goals description. For example, a mission statement.
IndividualBeneficialOwners String The list of individual beneficial owners that are part of the entity.
BusinessBeneficialOwners String The list of business beneficial owners that are part of the entity.
AnnualSalesVolumeRangeMinAmountCurrencyCode String The minimum inclusive amount currency code of the range for the total annual sales volume of the business.
AnnualSalesVolumeRangeMinAmountValue Decimal The minimum inclusive amount value of the range for the total annual sales volume of the business.
AnnualSalesVolumeRangeMaxAmountCurrencyCode String The maximum inclusive amount currency code of the range for the total annual sales volume of the business.
AnnualSalesVolumeRangeMaxAmountValue Decimal The maximum inclusive amount value of the range for the total annual sales volume of the business.
AvgMonthlyVolumeRangeMinAmountCurrencyCode String The minimum inclusive amount currency code of the range for the average monthly volume of the business.
AvgMonthlyVolumeRangeMinAmountValue Decimal The minimum inclusive amount value of the range for the average monthly volume of the business.
AvgMonthlyVolumeRangeMaxAmountCurrencyCode String The maximum inclusive amount currency code of the range for the average monthly volume of the business.
AvgMonthlyVolumeRangeMaxAmountValue Decimal The maximum inclusive amount value of the range for the average monthly volume of the business.
TrackingId String The partner's unique identifier for this customer in their system which can be used to track user in PayPal.
Operations String An array of operations to perform for the customer while they share their data.
Products String An array of PayPal products to which the partner wants to onboard the customer.
Capabilities String An array of capabilities which the partner wants to enable for the selected products.
OutsideProcessDependencies String An array of dependent processes.
LegalConsents String An array of all consents that the partner has received from this seller.
Email String Email address of the customer used to create the account.
PreferredLanguageCode String The preferred locale code to use in the onboarding flow for the customer.
PartnerConfigReturnUrl String The URL to which to redirect the customer upon completion of the onboarding process.
PartnerConfigReturnUrlDescription String The description of the return URL.
PartnerConfigShowAddCreditCard Boolean Indicates whether to show an add credit card page.
FinancialInstrumentBanks String An array of banks attached to this managed account.
PayoutAttributesMarketplace Boolean Indicates whether the merchant or platform offers goods or services on behalf of third-party sellers.
PayoutAttributesKycRequired Boolean Indicates whether Know Your Customer (KYC) verification is required for the merchant.
PayoutAttributesCountryTransferMethodCurrency String Requested country, transfer method and currency.
LegalCountryCode String The legal country code.

CData Python Connector for PayPal

PaymentResources

Returns a paginated list of payment resources created by the authenticated merchant.

View-Specific Information

The connector uses the PayPal API to process WHERE clause conditions built with the following column and operator. All other filters are processed client-side.

SELECT

The only supported filter is Id.

Filters only support the = operator. The connector processes other filters client side within the connector.

For example, the following query is processed server side:

SELECT * FROM PaymentResources WHERE Id = 'PLB-MCDLCDGUD89Z'

Columns

Name Type References Description
Id [KEY] String The unique identifier for the payment resource.
IntegrationMode String Determines how the payment resource is presented to customers.
CreateTime Datetime The date and time that this payment resource was created.
UpdateTime Datetime The date and time that this payment resource was updated.
Status String Status of the payment resource.

The allowed values are ACTIVE, INACTIVE.

The default value is ACTIVE.

PaymentLink String The generated payment link URL for the transaction.
Type String The type of payment resource.
Reusable String Indicates whether the payment resource can be used multiple times or only once.
ReturnUrl String URL to which the customer is redirected after completing the transaction.

CData Python Connector for PayPal

Payments

Returns details about authorized payments.

View-Specific Information

SELECT

The only supported filters are Id and OrderId. Filters only supports the = operator The connector processes all other filters client-side.

For example, the connector processes the following query server-side to retrieve payments that were created after the specified date.

SELECT * FROM Payments WHERE Id > 'P-41250-2' AND OrderId =  'O-123550-05'

Columns

Name Type References Description
Id [KEY] String The PayPal-generated ID for the authorized payment.
Intent String The payment intent.
PayerPaymentMethod String The payment method.
PayerStatus String The status of payer's PayPal account.
PayerEmail String The payer's email address.
PayerSalutation String The payer's salutation.
PayerFirstName String The payer's first name.
PayerMiddleName String The payer's middle name.
PayerLastName String The payer's last name.
PayerSuffix String The payer's suffix.
PayerId String The PayPal-assigned encrypted payer ID.
PayerBirthDate Date The birth date of the payer, in Internet date format.
PayerTaxId String The payer's tax ID. Supported for the PayPal payment method only.
PayerTaxType String The payer's tax ID type. Supported for the PayPal payment method only.
PayerBillingAddressLine1 String The first line of the address. For example, number, street, and so on.
PayerBillingAddressLine2 String The second line of the address. For example, suite or apartment number.
PayerBillingAddressCity String The city name.
PayerBillingAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PayerBillingAddressPostalCode String The postal code, which is the zip code or equivalent.
PayerBillingAddressState String The code for a US state or the equivalent for other countries.
PayerBillingAddressPhone String The phone number, in E.123 format.
PayerBillingAddressNormalizationStatus String The address normalization status. Returned only for payers from Brazil.
PayerBillingAddressType String The type of address. For example, HOME_OR_WORK, GIFT, and so on.
PayerShippingAddressLine1 String The first line of the address. For example, number, street, and so on.
PayerShippingAddressLine2 String The second line of the address. For example, suite or apartment number.
PayerShippingAddressCity String The city name.
PayerShippingAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PayerShippingAddressPostalCode String The postal code, which is the zip code or equivalent.
PayerShippingAddressState String The code for a US state or the equivalent for other countries.
PayerShippingAddressPhone String The phone number, in E.123 format.
PayerShippingAddressNormalizationStatus String The address normalization status. Returned only for payers from Brazil.
PayerShippingAddressType String The type of address. For example, HOME_OR_WORK, GIFT, and so on.
State String The state of the payment, authorization, or order transaction.
ExperienceProfileId String The PayPal-generated ID for the merchant's payment experience profile.
NoteToPayer String A free-form field that clients can use to send a note to the payer.
FailureReason String The reason code for a payment failure.
ReturnUrl String The URL where the payer is redirected after approving the payment. Required for PayPal account payments.
CancelUrl String The URL where the payer is redirected after canceling the payment. Required for PayPal account payments.
BrandName String A label that overrides the business name in the merchant's PayPal account on the PayPal checkout pages.
Locale String The locale of pages that the PayPal payment experience displays.
LandingPage String The type of landing page to show on the PayPal site for customer checkout.
ShippingPreference String The shipping preference.
UserAction String The user action. Presents the customer with either the Continue or Pay Now checkout flow.
CreatedTime Datetime The date and time when the transaction occurred.
UpdatedTime Datetime The date and time when the payment was updated, in Internet date and time format.

CData Python Connector for PayPal

PaymentTokens

Returns merchant-created payment tokens with their associated details.

View-Specific Information

SELECT

The only filters supported by the PayPal API are Id and CustomerId. One of these filters is required to access this view. Server-side processing is only supported for the '=' operator.

SELECT * FROM PaymentTokens WHERE CustomerId = 'BygeLlrpZF'
SELECT * FROM PaymentTokens WHERE Id = 'PMUH786954'

The connector processes all other filters client-side.

Columns

Name Type References Description
Id [KEY] String The PayPal-generated ID for the vault token.
CustomerId String The unique ID for a customer in merchant's or partner's system of records.
MerchantCustomerId String Merchants and partners may already have a data store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer ID to your representation of a customer.
PaymentSourceCardName String The card holder's name as it appears on the card.
PaymentSourceCardLastDigits String The last digits of the payment card.
PaymentSourceCardVerificationAmountValue Decimal The amount used for card verification.
PaymentSourceCardVerificationAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
PaymentSourceCardVerificationProcessorResponseAvsCode String The address verification code for Visa, Discover, Mastercard, or American Express transactions.
PaymentSourceCardVerificationProcessorResponseCvvCode String The card verification value code for for Visa, Discover, Mastercard, or American Express.
PaymentSourceCardNetworkTransactionReferenceId String Transaction reference id returned by the scheme.
PaymentSourceCardNetworkTransactionReferenceDate Datetime The date that the transaction was authorized by the scheme.
PaymentSourceCardNetworkTransactionReferenceNetwork String Name of the card network through which the transaction was routed.
PaymentSourceCardNetworkTransactionReferenceTime Datetime The date and time when the instrument was verified.
PaymentSourceCardBrand String The card brand or network. Typically used in the response.
PaymentSourceCardExpiry String The card expiration year and month.
PaymentSourceCardAddressLine1 String The first line of the address. For example, number or street.
PaymentSourceCardAddressLine2 String The second line of the address. For example, suite or apartment number.
PaymentSourceCardAddressAdminArea1 String The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourceCardAddressAdminArea2 String A city, town, or village.
PaymentSourceCardAddressPostalCode String The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourceCardAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceCardAddressId String The resource ID of the address.
PaymentSourceCardAddressCompany String The name of the company or business associated to the address.
PaymentSourceCardAddressPhone String The phone number that can go on the mailing label with the address to track the shipping.
PaymentSourceCardAddressGivenName String When the party is a person, the party's given, or first, name.
PaymentSourceCardAddressNameSurname String When the party is a person, the party's surname or family name.
PaymentSourceCardAddressPhoneNumber String The national number.
PaymentSourceCardAddressPhoneNumberCountryCode String The country calling code (CC), in its canonical international format as defined by the E.164 numbering plan.
PaymentSourceCardVerificationStatus String The card verification status.
PaymentSourceCardType String The payment card type.
PaymentSourcePaypalEmailAddress String The email address of the payer.
PaymentSourcePaypalPayerId String The PayPal-assigned ID for the payer.
PaymentSourcePaypalGivenName String When the party is a person, the party's given, or first, name.
PaymentSourcePaypalNameSurname String When the party is a person, the party's surname or family name.
PaymentSourcePaypalPhoneNumber String The national number.
PaymentSourcePaypalPhoneType String The phone type.
PaymentSourcePaypalAddressLine1 String The first line of the address. For example, number or street.
PaymentSourcePaypalAddressLine2 String The second line of the address. For example, suite or apartment number.
PaymentSourcePaypalAddressAdminArea1 String The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourcePaypalAddressPostalCode String The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourcePaypalAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourcePaypalAccountId String The account identifier for a PayPal account.
PaymentSourceVenmoEmailAddress String The email address of the payer.
PaymentSourceVenmoPayerId String The PayPal-assigned ID for the payer.
PaymentSourceVenmoGivenName String When the party is a person, the party's given, or first, name.
PaymentSourceVenmoNameSurname String When the party is a person, the party's surname or family name.
PaymentSourceVenmoPhoneNumber String The national number.
PaymentSourceVenmoPhoneType String The phone type.
PaymentSourceVenmoAddressLine1 String The first line of the address. For example, number or street.
PaymentSourceVenmoAddressLine2 String The second line of the address. For example, suite or apartment number.
PaymentSourceVenmoAddressAdminArea1 String The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourceVenmoAddressAdminArea2 String A city, town, or village.
PaymentSourceVenmoAddressPostalCode String The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourceVenmoAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceVenmoUserName String The Venmo username, as chosen by the user.
PaymentSourceApplePayName String The card holder's name as it appears on the card.
PaymentSourceApplePayLastDigits String The last digits of the payment card.
PaymentSourceApplePayType String The payment card type.
PaymentSourceApplePayBrand String The card brand or network.
PaymentSourceApplePayAddressLine1 String The first line of the address. For example, number or street.
PaymentSourceApplePayAddressLine2 String The second line of the address. For example, suite or apartment number.
PaymentSourceApplePayAddressAdminArea1 String The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourceApplePayAddressAdminArea2 String A city, town, or village.
PaymentSourceApplePayAddressPostalCode String The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourceApplePayAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.

CData Python Connector for PayPal

PaymentTransactions

Returns transaction details including the amount and item details.

View-Specific Information

SELECT

The only filter supported by the PayPal API is PaymentId, which is required. The connector processes all other filters client-side.

By default, this view returns data only for completed payments. To retrieve transactions for payments that were just created, specify the PaymentId in the WHERE clause.

You can obtain the non-completed PaymentId by executing the CreatePayment stored procedure.

For example, the connector processes the following queries server-side to retrieve a list of transactions for the specified payment.

SELECT * FROM PaymentTransactions WHERE PaymentId = 'PAY-6SL93120VR4146201KZYWPVY'

SELECT * FROM PaymentTransactions WHERE PaymentId IN ('PAY-6SL93120VR4146201KZYWPVY', 'PAY-6SL93120VR0000201KZYWPVY')

Columns

Name Type References Description
PaymentId String

Payments.Id

The Id of the payment.
Amount Decimal The amount to collect.
Currency String The currency of the amount to collect.
PayeeEmail String The email address associated with the payee's PayPal account.
PayeeMerchantId String The PayPal account ID for the payee.
Description String The purchase description.
NoteToPayee String The note to the recipient of the funds in this transaction.
Custom String The free-form field for the client's use.
InvoiceNumber String The invoice number to track this payment.
SoftDescriptor String The soft descriptor to use to charge this funding source. If greater than the maximum allowed length, the API truncates the string.
NotifyUrl String The URL to send payment notifications.
AllowedPaymentMethod String The payment method for this transaction. This field does not apply to the credit card payment method.
RecipientName String The name of the recipient.
ShippingPhoneNumber String The shipping phone number, in its canonical international format as defined by the E.164 numbering plan.
ShippingAddressLine1 String The first line of the address. For example, number, street, and so on.
ShippingAddressLine2 String The second line of the address. For example, suite or apartment number.
ShippingAddressCity String The city name.
ShippingAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
ShippingAddressPostalCode String The postal code, which is the zip code or equivalent.
ShippingAddressState String The code for a US state or the equivalent for other countries.
ShippingAddressPhone String The phone number, in E.123 format.
ShippingAddressNormalizationStatus String The address normalization status. Returned only for payers from Brazil.
ShippingAddressType String The type of address. For example, HOME_OR_WORK, GIFT, and so on.
ShippingMethod String The shipping method used for this payment, such as USPS Parcel.

CData Python Connector for PayPal

PayoutDetails

Returns details about payouts.

View-Specific Information

SELECT

The only filter supported by the PayPal API is PayoutBatchId, which is required. The connector processes all other filters client-side.

For example, the connector processes the following query server-side to retrieve details for a specific payout.

SELECT * FROM PayoutDetails WHERE PayoutBatchId = 'HSY55UPD25KF2'

Columns

Name Type References Description
PayoutBatchId [KEY] String The ID of the payout for which to show details.
BatchStatus String The PayPal-generated payout status. If the payout passes preliminary checks, the status is PENDING.
TimeCreated Datetime The date and time when processing for the payout began
TimeCompleted Datetime The date and time when processing for the payout completed.
SenderBatchId String The sender-specified ID number. Tracks the payout in an accounting system.
SenderEmailSubject String The subject line for the email that PayPal sends when payment for a payout item completes. The subject line is the same for all recipients.
Amount Decimal The total amount,requested for the payouts.
Currency String The currency of the total amount
FeeAmount Decimal The amount of the total estimate for the applicable payouts fees. Initially, the fee is 0. The fee is populated after the payout moves to the PROCESSING state.
FeeCurrency String The currency for the applicable payouts fees.
TimeClosed Datetime The date and time when the payout was closed, in Internet date and time format.
SenderEmailMessage String The email message that PayPal sends when the payout item completes. The message is the same for all recipients.
SenderEmailRecipientType String The ID type that identifies the payment receiver.

The allowed values are EMAIL, PHONE, PAYPAL_ID.

FundingSource String The ID to differentiate a PayPal balance-funded transaction from a PayPal treasury-funded transaction.

CData Python Connector for PayPal

PayoutItems

Returns payout items from a payout.

View-Specific Information

SELECT

The filters supported by the PayPal API are PayoutBatchId and PayoutItemId. At least one filter is required to access the view. The connector processes all other filters client-side.

For example, the connector processes the following queries server-side.

SELECT * FROM PayoutItems WHERE PayoutBatchId = 'HSY55UPD25KF2'
SELECT * FROM PayoutItems WHERE PayoutItemId ='8AELMXH8UB2P8'

Columns

Name Type References Description
PayoutBatchId [KEY] String The ID of the payout for which to show payout items details.
PayoutItemId [KEY] String The ID for the payout item.
TransactionId String The PayPal-generated ID for the transaction.
TransactionStatus String The transaction status.
FeeAmount Decimal The amount for the applicable payout fee. Initially, the fee is 0. The fee is populated after the item moves to the PENDING state.
FeeCurrency String The currency for the applicable payout fee.
RecipientType String The recipient type.Value is: EMAIL, PHONE, PAYPAL_ID.
AmountValue Decimal The amount of payout item.
AmountCurrency String The currency of payout item.
Note String A sender-specified note for notifications.
Receiver String The receiver of the payment. Corresponds to the recipient_type value in the request.
SenderItemId String A sender-specified ID number. Tracks the payout in an accounting system.
TimeProcessed Datetime The date and time when this item was last processed.
ErrorsMessage String The message that describes the error, if any.
ErrorsName String The human-readable, unique name of the error, if any.
ErrorsDebugId String The PayPal internal ID. Used for correlation purposes.
ErrorsInformationLink String The information link, or URI, that shows detailed information about this error for the developer.
ActivityId String The unique PayPal-generated common ID that links the sender- and receiver-side transactions. Used for tracking.
SenderBatchId String A sender-specified ID. Tracks the payout in an accounting system.
RecipientNamePrefix String The prefix, or title, to the party's name.
RecipientGivenName String When the party is a person, the party's given, or first, name.
RecipientSurname String When the party is a person, the party's surname or family name. Also known as the last name.
RecipientMiddleName String When the party is a person, the party's middle name.
RecipientFullName String When the party is a person, the party's full name.
RecipientWallet String The recipient wallet.

The allowed values are PAYPAL, VENMO.

Purpose String The purpose of the transaction.

The allowed values are AWARDS, PRIZES, DONATIONS, GOODS, SERVICES, REBATES, CASHBACK, DISCOUNTS, NON_GOODS_OR_SERVICES.

CData Python Connector for PayPal

ProductDetails

Retrieve the list of product details.

View-Specific Information

SELECT

This view returns a list of product details for the authenticated user.

The only filter supported by the PayPal API is ProductId. Server-side processing is only supported for the '=' operator.

The connector processes all other filters client-side.

For example, the connector processes the following queries server-side.

SELECT * FROM ProductDetails
SELECT * FROM ProductDetails WHERE ProductId = 'PP-D-12345'

Columns

Name Type References Description
ProductId [KEY] String The ID of the product.
CreateTime Datetime The date and time when the product was created, in Internet date and time format.
UpdateTime Datetime The date and time when the product was updated, in Internet date and time format.
Description String The product description.
Name String The product name.
Type String The product type. Indicates whether the product is physical or digital goods, or a service.

The allowed values are PHYSICAL, DIGITAL, SERVICE.

Category String The product category.
ImageURL String The image URL for the product.
HomeURL String The home URL for the product.

CData Python Connector for PayPal

RefundDetails

Returns details about a specific refund.

View-Specific Information

SELECT

The only filter supported by the PayPal API is Id, which is required. The connector processes all other filters client-side.

For example, the connector processes the following queries server-side to retrieve details for a specific refund.

SELECT * FROM RefundDetails WHERE Id = '4W92068757818534U'

SELECT * FROM RefundDetails WHERE Id IN ('4W92068757818534U', '4W91234757818534U')

Columns

Name Type References Description
Id [KEY] String The PayPal-generated ID for the captured payment.
Status String The status of the captured payment.

The allowed values are CANCELLED, FAILED, PENDING, COMPLETED.

StatusDetails String The details of the captured payment status.
AmountValue Decimal The amount for this captured payment.
AmountCurrency String The currency of the amount for this captured payment.
InvoiceId String The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
NoteToPayer String The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.
SellerGrossAmount Decimal The amount for this captured payment.
SellerPaypalFee Decimal The applicable fee for this captured payment.
SellerNetAmount Decimal The net amount that the payee receives for this captured payment in their PayPal account.
TotalRefundedMoney Decimal The total amount refunded from the original capture to date.
CreateTime Datetime The time of authorization.
UpdateTime Datetime The time that the resource was last updated.
CustomId String The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions.
AcquirerReferenceNumber String Reference ID issued for the card transaction.
PayerEmailAddress String The email address of merchant.
PayerMerchantId String The encrypted PayPal account ID of the merchant.

CData Python Connector for PayPal

SaleDetails

Returns details about a sale transaction.

View-Specific Information

SELECT

The only filter supported by the PayPal API is Id, which is required. The connector processes all other filters client-side.

For example, the connector processes the following queries server-side to retrieve details for a specific sale.

SELECT * FROM SaleDetails WHERE Id = '6M2430095X488331A'

SELECT * FROM SaleDetails WHERE Id IN ('6M2430095X488331A', '6M2410805X488331A')

Columns

Name Type References Description
Id [KEY] String The Id of the sale transaction.
State String The state of the sale. One of the following: pending, completed, refunded, or partially_refunded.
Currency String The 3-letter currency code.
Subtotal Decimal The amount of the subtotal of the items.
TaxAmount Decimal The amount charged for tax.
ShippingAmount Decimal The amount charged for shipping.
ShippingDiscount Decimal The amount being discounted for the shipping fee. Only supported when the payment method is set to paypal.
HandlingFeeAmount Decimal The amount being charged for the handling fee. Only supported when the payment method is set to paypal.
InsuranceAmount Decimal The amount being charged for the insurance fee. Only supported when the payment method is set to paypal.
TotalAmount Decimal The total amount charged from the payer to the payee. In case of a refund, this is the refunded amount to the original payer from the payee.
ClearingTime Datetime The expected clearing time for e-check transactions. Only supported when the payment method is set to paypal.
CreateTime Datetime The time of sale.
Description String The description of the sale.
ExchangeRate String The exchange rate applied for this transaction. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
FmfDescription String The description of the filter.
FmfFilterId String The name of the fraud management filter. One of the following: MAXIMUM_TRANSACTION_AMOUNT (basic filter), UNCONFIRMED_ADDRESS (basic filter), COUNTRY_MONITOR (basic filter), AVS_NO_MATCH (address verification service no match -- advanced filter), AVS_PARTIAL_MATCH (address verification service partial match -- advanced filter), AVS_UNAVAILABLE_OR_UNSUPPORTED (address verification service unavailable or not supported -- advanced filter), CARD_SECURITY_CODE_MISMATCH (advanced filter), BILLING_OR_SHIPPING_ADDRESS_MISMATCH (advanced filter), RISKY_ZIP_CODE (high risk lists filter), SUSPECTED_FREIGHT_FORWARDER_CHECK (high risk lists filter), RISKY_EMAIL_ADDRESS_DOMAIN_CHECK (high risk lists filter), RISKY_BANK_IDENTIFICATION_NUMBER_CHECK (high risk lists filter), RISKY_IP_ADDRESS_RANGE (high risk lists filter), LARGE_ORDER_NUMBER (transaction data filter), TOTAL_PURCHASE_PRICE_MINIMUM (transaction data filter), IP_ADDRESS_VELOCITY (transaction data filter), and PAYPAL_FRAUD_MODEL (transaction data filter).
FmfFilterType String The type of the fraud management filter. One of the following: ACCEPT (an ACCEPT filter is triggered only for the TOTAL_PURCHASE_PRICE_MINIMUM filter setting and is returned only in direct credit card payments where payment is accepted), PENDING (triggers a PENDING filter action where you need to explicitly accept or deny the transaction), DENY (triggers a DENY action where payment is denied automatically), and REPORT (triggers the Flag testing mode where payment is accepted).
FmfName String The name of the filter.
ParentPayment String The Id of the payment resource on which this transaction is based.
PaymentMode String The payment mode of the transaction. Only supported when the payment method is set to paypal. One of the following: INSTANT_TRANSFER, MANUAL_BANK_TRANSFER, DELAYED_TRANSFER, or ECHECK.
PendingReason String The reason the transaction is in a pending state. Only supported when the payment method is set to paypal. One of the following: PAYER-SHIPPING-UNCONFIRMED, MULTI-CURRENCY, RISK-REVIEW, REGULATORY-REVIEW, VERIFICATION-REQUIRED , ORDER, or OTHER.
ProtectionEligibility String The level of seller protection in force for the transaction. Only supported when the payment method is set to paypal. One of the following: ELIGIBLE, PARTIALLY_ELIGIBLE, INELIGIBLE.
ProtectionEligibilityType String The kind of seller protection in force for the transaction. This property is returned only when the ProtectionEligibility property is set to ELIGIBLE or PARTIALLY_ELIGIBLE. Only supported when the payment method is set to paypal. One of the following: ITEM_NOT_RECEIVED_ELIGIBLE or UNAUTHORIZED_PAYMENT_ELIGIBLE. One or both of the allowed values can be returned.
ReasonCode String The reason code for the transaction state being Pending or Reversed. Only supported when the payment method is set to paypal. One of the following: CHARGEBACK, GUARANTEE, BUYER_COMPLAINT, REFUND, UNCONFIRMED_SHIPPING_ADDRESS, ECHECK, INTERNATIONAL_WITHDRAWAL, RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION, PAYMENT_REVIEW, REGULATORY_REVIEW, UNILATERAL, or VERIFICATION_REQUIRED.
ReceiptId String The 16-digit number payment identification number returned for guest users to identify the payment.
ReceivableAmount Decimal The receivable amount.
TransactionFee Decimal The transaction fee.
UpdateTime Datetime The time that the sale was last updated.

CData Python Connector for PayPal

Subscriptions

Get billing and subscription details.

View-Specific Information

SELECT

The only filter supported by the PayPal API is Id, which is required. The connector processes all other filters client-side.

SELECT * FROM Subscriptions WHERE Id = '1234'

Note: You can obtain the SubscriptionId by creating a subscription with the CreateSubscription stored procedure.

The connector processes all other filters client-side.

Columns

Name Type References Description
Id [KEY] String The PayPal-generated ID for the subscription.
BillingInfocycle_executions String The trial and regular billing executions.
BillingInfo_FailedPaymentsCount Integer The count of failed payments.
BillingInfo_LastPaymentAmountCurrencyCode String The last payment amount currency code.
BillingInfo_LastPaymentAmountValue String The last payment amount.
BillingInfo_LastPaymentTime Datetime The date and time when the last payment was made.
BillingInfo_NextBillingTime Datetime The next date and time for billing this subscription.
BillingInfo_OutstandingBalanceCurrencyCode String The total pending bill amount, to be paid by the subscriber.
BillingInfo_outstandingBalanceValue String The total pending bill amount, to be paid by the subscriber.
CreateTime Datetime The date and time when the subscription was created.
Links String Links for the subscription objects.
PlanId String The ID of the plan.
Quantity Integer The quantity of the product in the subscription.
ShippingAmountCurrencyCode String The currency for a financial transaction, such as a balance or payment due.
ShippingAmountValue String The amount for a financial transaction, such as a balance or payment due.
StartTime Datetime The start date and time of the subscription.
Status String The status of the subscription.

The allowed values are APPROVAL_PENDING, APPROVED, ACTIVE, SUSPENDED, CANCELLED, EXPIRED.

StatusUpdateTime Datetime The date and time when the status was updated.
SubscriberEmailAddress String The email address of the payer.
SubscriberName_GivenName String The given name of the payer.
SubscriberName_Surname String The surname of the payer.
SubscriberPayerId String The PayPal-assigned ID for the payer.
SubscriberShippingAddress_AddressAddressLine1 String Primary address of the payer.
SubscriberShippingAddress_AddressAddressLine2 String Secondary address of the payer.
SubscriberShippingAddress_AddressAdminArea1 String Primary address of the payer.
SubscriberShippingAddress_AddressAdminArea2 String Secondary address of the payer.
SubscriberShippingAddress_AddressCountryCode String Country code of the payer address.
SubscriberShippingAddress_AddressPostalCode String Postal code of the payer address.
SubscriberShippingAddress_NameFullName String Full name of the Payer.
UpdateTime Datetime The date and time when the subscription was updated.
SubscriberShippingAddress_Type String The method by which the payer wants to get their items from the payee, for example, shipping, in-person pickup.
SubscriberPhoneType String The phone type.
SubscriberPhoneNumber String The phone number, in its canonical international E.164 numbering plan format.
StatusChangeNote String The reason or notes for the status of the subscription.
CustomId String The custom id for the subscription. Can be invoice id.
PlanOverridden Boolean Indicates whether the subscription has overridden any plan attributes.
BillingInfo_LastPaymentStatus String The status of the captured payment.
BillingInfo_FinalPaymentTime Datetime The date and time when the final billing cycle occurs, in Internet date and time format.

CData Python Connector for PayPal

SubscriptionTransactions

Lists transactions for a subscription.

View-Specific Information

SELECT

This view returns a list of transactions with details for a specific subscription.

The following filters are supported by the PayPal API:

  • SubscriptionId
  • StartTime
  • EndTime

SELECT * FROM SubscriptionTransactions WHERE SubscriptionId = '1234'
SELECT * FROM SubscriptionTransactions WHERE SubscriptionId = '1234' AND StartTime = '2018-01-21T07:50:20.940Z' AND EndTime = '2018-08-21T07:50:20.940Z'

Note:

  • SubscriptionId, StartTime, and EndTime are required parameters for this view. If you do not specify StartTime and EndTime in the query, the connector assigns default values.
  • You can obtain the SubscriptionId by creating a subscription with the CreateSubscription stored procedure.

The connector processes all other filters client-side.

Columns

Name Type References Description
Id [KEY] String The ID of the transaction.
SubscriptionId String

Subscriptions.Id

The ID of the subscription.
AmountWithBreakdown_FeeAmountCurrencyCode String The fee details for the transaction.
AmountWithBreakdown_FeeAmountValue String The fee details for the transaction.
AmountWithBreakdown_GrossAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
AmountWithBreakdown_GrossAmountValue String The value of the currency.
AmountWithBreakdown_NetAmountCurrencyCode String The currency code of the net amount that the payee receives for this transaction in their PayPal account.
AmountWithBreakdown_NetAmountValue String The net amount that the payee receives for this transaction in their PayPal account.
PayerEmail String The email ID of the customer.
PayerNameGivenName String When the party is a person, the party's given, or first, name.
PayerNameSurname String When the party is a person, the party's surname or family name. Also known as the last name.
Status String The initial state of the plan.

The allowed values are COMPLETED, DECLINED, PARTIALLY_REFUNDED, PENDING, REFUNDED.

Time Datetime The date and time when the transaction was processed.
AmountWithBreakdown_TotalItemAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
AmountWithBreakdown_TotalItemAmountValue Decimal The item total for the transaction.
AmountWithBreakdown_ShippingAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
AmountWithBreakdown_ShippingAmountValue Decimal The shipping amount for the transaction.
AmountWithBreakdown_TaxAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
AmountWithBreakdown_TaxAmountValue Decimal The tax amount for the transaction.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
StartTime Datetime The start time of the range of transactions to list.
EndTime Datetime The end time of the range of transactions to list.

CData Python Connector for PayPal

Templates

Lists merchant-created templates with associated details.

View-Specific Information

SELECT

The only filter supported by the PayPal API is Id. Server-side processing is only supported for the '=' operator.

SELECT * FROM Templates WHERE Id = 'TEMP-3RK55758SK521635N'

The connector processes all other filters client-side.

Columns

Name Type References Description
Id [KEY] String The ID of the template.
Name String The template name.
DefaultTemplate Boolean Indicates whether this template is the default template.
StandardTemplate Boolean Indicates whether this template is an invoicer-created custom template. The system generates non-custom templates.
Links String An array of request-related HATEOAS links.
TemplateInfoDetailReference String The reference data. Includes a Purchase Order (PO) number.
TemplateInfoDetailNote String A note to the invoice recipient. Also appears on the invoice notification email.
TemplateInfoDetailTermsAndConditions String The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.
TemplateInfoDetailMemo String A private bookkeeping memo for the user.
TemplateInfoDetailCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoDetailPaymentTermType String The payment term. Payment can be due upon receipt, a specified date, or in a set number of days.
TemplateInfoMetadataCreatedBy String The email address of the account that created the resource.
TemplateInfoMetadataLastUpdatedBy String The email address of the account that last edited the resource.
TemplateInfoMetadataCreateTime Datetime The date and time, in Internet date and time format.
TemplateInfoMetadataLastUpdateTime Datetime The date and time, in Internet date and time format.
TemplateInfoInvoicerBusinessName String The business name of the party.
TemplateInfoInvoicerPrefixName String The prefix, or title, to the party's name.
TemplateInfoInvoicerFirstName String When the party is a person, the party's given, or first, name.
TemplateInfoInvoicerMiddleName String When the party is a person, the party's middle name. Also used to store multiple middle names including the patronymic, or father's name.
TemplateInfoInvoicerLastName String When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person.
TemplateInfoInvoicerSuffixName String The suffix for the party's name.
TemplateInfoInvoicerFullName String When the party is a person, the party's full name.
TemplateInfoInvoicerAddressLine1 String The first line of the address. For example, number or street.
TemplateInfoInvoicerAddressLine2 String The second line of the address. For example, suite or apartment number.
TemplateInfoInvoicerAddressLine3 String The third line of the address, if needed.
TemplateInfoInvoicerAddressAdminArea1 String The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
TemplateInfoInvoicerAddressAdminArea2 String A city, town, or village.
TemplateInfoInvoicerAddressAdminArea3 String A sub-locality, suburb, neighborhood, or district.
TemplateInfoInvoicerAddressAdminArea4 String The neighborhood, ward, or district.
TemplateInfoInvoicerAddressPostalCode String The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
TemplateInfoInvoicerAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
TemplateInfoInvoicerAddressStreetNumber String The street number.
TemplateInfoInvoicerAddressStreetName String The street name. Just Drury in Drury Lane.
TemplateInfoInvoicerAddressStreetType String The street type. For example, avenue, boulevard, road, or expressway.
TemplateInfoInvoicerAddressDeliveryService String The delivery service. Post office box, bag number, or post office name.
TemplateInfoInvoicerAddressBuildingName String A named location that represents the premise. Usually a building name or number, or a collection of buildings with a common name or number.
TemplateInfoInvoicerAddressSubBuilding String The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name.
TemplateInfoInvoicerPhones String An array of invoicer's phone numbers. The invoicer can choose to hide the phone number on the invoice.
TemplateInfoInvoicerWebsite String The invoicer's website.
TemplateInfoInvoicerTaxId String The invoicer's tax ID.
TemplateInfoInvoicerAdditionalNotes String Any additional information. Includes business hours.
TemplateInfoInvoicerLogoUrl String The full URL to an external logo image. The logo image must not be larger than 250 pixels wide by 90 pixels high.
TemplateInfoInvoicerEmail String The invoicer email address, which must be listed in the user's PayPal profile.
TemplateInfoConfigurationTaxCalculatedAfterDiscount Boolean Indicates whether the tax is calculated before or after a discount.
TemplateInfoConfigurationTaxInclusive Boolean Indicates whether the unit price includes tax.
TemplateInfoConfigurationAllowTip Boolean Indicates whether the invoice enables the customer to enter a tip amount during payment.
TemplateInfoConfigurationAllowPartialPayment Boolean Indicates whether the invoice allows a partial payment. If false, the invoice must be paid in full. If true, the invoice allows partial payments.
TemplateInfoConfigurationMinimumAmountDue Decimal The minimum amount allowed for a partial payment. Valid only when allow_partial_payment is true.
TemplateInfoConfigurationMinimumAmountDueCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountValue Decimal The invoice amount summary of item total, discount, tax total and shipping.
TemplateInfoAmountCurrencyCode String The invoice amount summary of item total, discount, tax total and shipping.
TemplateInfoAmountBreakdownItemTotalValue Decimal The amount for a financial transaction, such as a balance or payment due.
TemplateInfoAmountBreakdownItemTotalCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownInvoiceDiscountPercentage Decimal The discount as a percentage value. Value is from 0 to 100.
TemplateInfoAmountBreakdownInvoiceDiscountValue Decimal The invoice level discount amount.
TemplateInfoAmountBreakdownInvoiceDiscountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownItemDiscountValue Decimal The amount for a financial transaction, such as a balance or payment due.
TemplateInfoAmountBreakdownItemDiscountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownTaxTotalValue Decimal The amount for a financial transaction, such as a balance or payment due.
TemplateInfoAmountBreakdownTaxTotalCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownShippingAmountValue Decimal The shipping fee for all items. Includes tax on shipping.
TemplateInfoAmountBreakdownShippingAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownShippingTaxAmountValue Decimal The calculated tax amount. The tax amount is added to the item total.
TemplateInfoAmountBreakdownShippingTaxAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownShippingTaxPercentage Decimal The tax rate.
TemplateInfoAmountBreakdownShippingTaxName String The name of the tax applied on the invoice items.
TemplateInfoAmountBreakdownShippingTaxNote String The tax note used to track the tax related data.
TemplateInfoAmountBreakdownCustomLabel String The label to the custom amount of the invoice.
TemplateInfoAmountBreakdownCustomAmountValue Decimal The custom amount to apply to an invoice.
TemplateInfoAmountBreakdownCustomAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoDueAmountValue Decimal The amount for a financial transaction, such as a balance or payment due.
TemplateInfoDueAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
ItemSettings String The template item headers display preference.
SubtotalSettings String The template subtotal headers display preference.
UnitOfMeasure String The unit of measure for the invoiced item.

The allowed values are QUANTITY, HOURS, AMOUNT.

CData Python Connector for PayPal

TrackingInformation

Query shipment tracking information including the tracking number, carrier, and status.

View-Specific Information

SELECT

The only supported filters are TransactionId and AccountId.

Filters only support the = operator. The connector processes other filters client side within the connector.

TransactionId is a required column.

For example, the following queries are processed server side:

SELECT * FROM TrackingInformation WHERE TransactionId = '5AC260196F2986240'

SELECT * FROM TrackingInformation WHERE TransactionId = '5AC260196F2986240' AND AccountId = '23577833'

Columns

Name Type References Description
TransactionId [KEY] String The PayPal transaction ID.
TrackingNumber [KEY] String The tracking number for the shipment.
TrackingNumberType String The type of tracking number.

The allowed values are CARRIER_PROVIDED, E2E_PARTNER_PROVIDED.

AccountId String Encrypted PayPal Account ID of the buyer or seller.
Status String The status of the shipment.

The allowed values are SHIPPED, DELIVERED, CANCELLED, LOCAL_PICKUP, ON_HOLD.

Carrier String The carrier for the shipment.
CarrierNameOther String The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER.
PostagePaymentId String The postage payment ID.
NotifyBuyer Boolean If true , sends an email notification to the buyer of the PayPal transaction.

The default value is false.

Quantity Integer The quantity of items shipped.
TrackingNumberValidated Boolean Indicates whether the carrier validated the tracking number.
ShipmentDirection String To denote whether the shipment is sent forward to the receiver or returned back.

The allowed values are FORWARD, RETURN.

ShipmentUploader String To denote which party uploaded the shipment tracking info.

The allowed values are MERCHANT, CONSUMER, PARTNER.

ShipmentDate Date The Shipment Date.
TrackingUrl String Tracking Link of the shipment.
FulfillmentProvider String Indicates the fulfillment service used to deliver an order.
LastUpdatedTime Datetime Last Updated Time.

CData Python Connector for PayPal

TransactionReports

Lists PayPal transaction reports.

View-Specific Information

SELECT

The connector uses the PayPal API to process WHERE clause conditions that are built with the following filters.

  • StartDate
  • EndDate
  • TransactionId
  • PaymentInstrumentType
  • BalanceAffectingRecordsOnly
  • StoreId
  • TerminalId
  • TransactionAmount
  • TransactionCurrency
  • TransactionStatus
  • TransactionType

Server-side processing is only supported for the = operator. For example:

SELECT * FROM TransactionReports WHERE StartDate = '2021-09-06 12:12:12' AND EndDate = '2021-09-11 12:12:12'

When filtering by TransactionAmount, values must be specified in the smallest denominations. For example, to retrieve transactions from $6.00 to $10.05, use a range of 600 to 1005, where amounts are expressed in cents.

Supported operators include: =, <, <=, >, >=.

SELECT * FROM TransactionReports WHERE TransactionAmount > 600 AND TransactionAmount < 1005

The connector processes other filters client-side within the connector.

Columns

Name Type References Description
AccountNumber String The merchant account number.
LastRefreshedDatetime Datetime The date and time when the data was last refreshed, in Internet date and time format.
AuctionInfoAuctionBuyerId String The ID of the buyer who makes the purchase in the auction.
AuctionInfoAuctionClosingDate Datetime The date and time when the auction closes.
AuctionInfoAuctionItemSite String The auction site URL.
AuctionInfoAuctionSite String The name of the auction site.
PayerInfoAccountId String The PayPal customer account ID.
PayerInfoAddressStatus String The address status of the payer.
PayerInfoCountryCode String The two-character ISO 3166-1 code that identifies the country or region of the payer.
PayerInfoEmailAddress String The email address of the payer.
PayerInfoPayerNameAlternateFullName String The party's alternate name.
PayerInfoPayerNameGivenName String When the party is a person, the party's given, or first, name.
PayerInfoPayerNameSurname String When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Also used to store multiple surnames including the matronymic, or mother's, surname.
PayerInfoPayerStatus String The status of the payer. Value is Y or N.
ShippingInfoAddressCity String The city name.
ShippingInfoAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
ShippingInfoAddressLine1 String The first line of the address. For example, number or street.
ShippingInfoAddressLine2 String The second line of the address. For example, suite or apartment number.
ShippingInfoAddressPostalCode String The postal code, which is the zip code or equivalent.
ShippingInfoName String The recipient's name.
StoreInfoStoreId String The ID of a store for a merchant in the system of record.
StoreInfoTerminalId String The terminal ID for the checkout stand in a merchant store.
TransactionInfoCustomField String The merchant-provided custom text.
TransactionInfoFeeAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoFeeAmountValue String The value of fee.
TransactionInfoInsuranceAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoInsuranceAmountValue String The value of insurance amount.
TransactionInfoInvoiceId String The invoice ID that is sent by the merchant with the transaction.
TransactionInfoPaypalAccountId String The ID of the PayPal account of the counterparty.
TransactionInfoProtectionEligibility String Indicates whether the transaction is eligible for protection.
TransactionInfoShippingAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoShippingAmountValue String The value of shipping amount.
TransactionInfoShippingDiscountAmountCurrency_code String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoShippingDiscountAmountValue String The value of shipping discount amount.
TransactionInfoTransactionAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoTransactionAmountValue String The value of transaction amount.
TransactionInfoTransactionEventCode [KEY] String A five-digit transaction event code that classifies the transaction type based on money movement and debit or credit.
TransactionInfoTransactionId [KEY] String The PayPal-generated transaction ID.
TransactionInfoTransactionInitiationDate Datetime The date and time when work on a transaction began in the PayPal system, as expressed in the time zone of the account on this side of the payment.
TransactionInfoTransactionNote String A special note that the payer passes to the payee. Might contain special customer requests, such as shipping instructions.
TransactionInfoTransactionStatus String A code that indicates the transaction status.

The allowed values are D, P, S, V.

TransactionInfoTransactionSubject String The subject of the payment. The payer passes this value to the payee. The payer controls this data through the interface used to send the data.
TransactionInfoTransactionUpdatedDate Datetime The date and time when the transaction was last changed, as expressed in the time zone of the account on this side of the payment.
TransactionInfoAnnualPercentageRate Decimal The percentage, as a fixed-point, signed decimal number.
PayerInfoAddressLine1 String The first line of the address. For example, number or street.
PayerInfoAddressLine2 String The second line of the address. For example, suite or apartment number.
PayerInfoAddressCity String The city name.
PayerInfoAddressState String The code for a US state or the equivalent for other countries.
PayerInfoAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PayerInfoAddressPostalCode String The postal code, which is the zip code or equivalent.
ShippingInfoAddressState String The code for a US state or the equivalent for other countries.
ShippingInfoMethod String The shipping method that is associated with this order.
TransactionInfoPaypalReferenceId String The PayPal-generated base ID. PayPal exclusive.
TransactionInfoPaypalReferenceIdType String The PayPal reference ID type.

The allowed values are ODR, TXN, SUB, PAP.

TransactionInfoPaymentTrackingId String The payment tracking ID, which is a unique ID that partners specify to either get information about a payment or request a refund.
TransactionInfoBankReferenceId String The bank reference ID.
TransactionInfoCreditTerm String The credit term.
TransactionInfoPaymentMethodType String The payment method that was used for a transaction. Value is PUI, installment, or mEFT.
TransactionInfoInstrumentType String A high-level classification of the type of financial instrument that was used to fund a payment. The pattern is not provided because the value is defined by an external party.
TransactionInfoInstrumentSubType String A finer-grained classification of the financial instrument that was used to fund a payment.
TransactionInfoDiscountAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoDiscountAmountValue Decimal The amount for a financial transaction, such as a balance or payment due.
TransactionInfoSalesTaxAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoSalesTaxAmountValue Decimal The amount for a financial transaction, such as a balance or payment due.
TransactionInfoShippingTaxAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoShippingTaxAmountValue Decimal The amount for a financial transaction, such as a balance or payment due.
TransactionInfoOtherAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoOtherAmountValue Decimal The amount for a financial transaction, such as a balance or payment due.
TransactionInfoTipAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoTipAmountValue Decimal The amount for a financial transaction, such as a balance or payment due.
TransactionInfoEndingBalanceCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoEndingBalanceValue Decimal The amount for a financial transaction, such as a balance or payment due.
TransactionInfoAvailableBalanceCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoAvailableBalanceValue Decimal The amount for a financial transaction, such as a balance or payment due.
TransactionInfoCreditTransactionalFeeCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoCreditTransactionalFeeValue Decimal The amount for a financial transaction, such as a balance or payment due.
TransactionInfoCreditPromotionalFeeCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoCreditPromotionalFeeValue Decimal The amount for a financial transaction, such as a balance or payment due.
PayerInfoPayerNameFullName String The party's full name.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
StartDate Datetime The start date and time, in Internet date and time format.
EndDate Datetime The end date and time, in Internet date and time format.
TransactionId String The PayPal-generated transaction ID.
PaymentInstrumentType String Filters the transactions in the response by a payment instrument type.
BalanceAffectingRecordsOnly String Indicates whether the response includes only balance-impacting transactions or all transactions.

The allowed values are Y, N.

StoreId String Filters the transactions in the response by a store ID.
TerminalId String Filters the transactions in the response by a terminal ID.
TransactionAmount String Filters the transactions in the response by a gross transaction amount range. For example, to search for transactions from $5.00 to $10.05, specify [500 TO 1005].
TransactionCurrency String Filters the transactions in the response by a three-character ISO-4217 currency code for the PayPal transaction currency.
TransactionStatus String Filters the transactions in the response by a PayPal transaction status code.

The allowed values are D, P, S, V.

TransactionType String Filters the transactions in the response by a PayPal transaction event code.

CData Python Connector for PayPal

TransactionReportsCartInfoItemDetails

Lists cart information for transaction reports.

View-Specific Information

SELECT

The connector uses the PayPal API to process WHERE clause conditions that are built with the following filters.

  • StartDate
  • EndDate
  • TransactionId
  • PaymentInstrumentType
  • BalanceAffectingRecordsOnly
  • StoreId
  • TerminalId
  • TransactionAmount
  • TransactionCurrency
  • TransactionStatus
  • TransactionType

Server-side processing is only supported for the = operator. For example:

SELECT * FROM TransactionReportsCartInfoItemDetails WHERE StartDate = '2021-09-06 12:12:12' AND EndDate = '2021-09-11 12:12:12'

For the TransactionAmount filter, enter values in the smallest denomination. For example, to search for transactions from $6.00 to $10.05, use the range of 600 to 1005 (values are in cents).

Supported operators include: =, <, <=, >, >=.

SELECT * FROM TransactionReportsCartInfoItemDetails WHERE TransactionAmount > 600 AND TransactionAmount < 1005

The connector processes other filters client-side within the connector.

Columns

Name Type References Description
AccountNumber String The merchant account number.
LastRefreshedDatetime Datetime The date and time when the data was last refreshed, in Internet date and time format.
InvoiceNumber String The invoice number. An alphanumeric string that identifies a billing for a merchant.
ItemAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
ItemAmountValue String The value of item amount.
ItemCode String An item code that identifies a merchant's goods or service.
ItemDescription String The item description.
ItemName String The item name.
ItemQuantity String The number of purchased units of goods or a service.
ItemUnitPriceCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
ItemUnitPriceValue String The value of item unit price.
TaxAmounts String An array of tax amounts levied by a government on the purchase of goods or services.
TotalItemAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TotalItemAmountValue String The value of total item amount.
DiscountAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
DiscountAmountValue Decimal The amount for a financial transaction, such as a balance or payment due.
AdjustmentAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
AdjustmentAmountValue Decimal The amount for a financial transaction, such as a balance or payment due.
GiftWrapAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
GiftWrapAmountValue Decimal The amount for a financial transaction, such as a balance or payment due.
TaxPercentage Decimal The percentage, as a fixed-point, signed decimal number.
BasicShippingAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
BasicShippingAmountValue Decimal The amount for a financial transaction, such as a balance or payment due.
ExtraShippingAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
ExtraShippingAmountValue Decimal The amount for a financial transaction, such as a balance or payment due.
HandlingAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
HandlingAmountValue Decimal The amount for a financial transaction, such as a balance or payment due.
InsuranceAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
InsuranceAmountValue Decimal The amount for a financial transaction, such as a balance or payment due.
ItemOptions String The item options. Describes option choices on the purchase of the item in some detail.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
StartDate Datetime The start date and time, in Internet date and time format.
EndDate Datetime The end date and time, in Internet date and time format.
TransactionId String The PayPal-generated transaction ID.
PaymentInstrumentType String Filters the transactions in the response by a payment instrument type.
BalanceAffectingRecordsOnly String Indicates whether the response includes only balance-impacting transactions or all transactions.

The allowed values are Y, N.

StoreId String Filters the transactions in the response by a store ID.
TerminalId String Filters the transactions in the response by a terminal ID.
TransactionAmount String Filters the transactions in the response by a gross transaction amount range. For example, to search for transactions from $5.00 to $10.05, specify [500 TO 1005].
TransactionCurrency String Filters the transactions in the response by a three-character ISO-4217 currency code for the PayPal transaction currency.
TransactionStatus String Filters the transactions in the response by a PayPal transaction status code.

The allowed values are D, P, S, V.

TransactionType String Filters the transactions in the response by a PayPal transaction event code.

CData Python Connector for PayPal

TransactionReportsIncentiveDetails

Lists incentive details of transaction reports.

View-Specific Information

SELECT

The connector uses the PayPal API to process WHERE clause conditions that are built with the following filters.

  • StartDate
  • EndDate
  • TransactionId
  • PaymentInstrumentType
  • BalanceAffectingRecordsOnly
  • StoreId
  • TerminalId
  • TransactionAmount
  • TransactionCurrency
  • TransactionStatus
  • TransactionType

Server-side processing is only supported for the = operator. For example:

SELECT * FROM TransactionReportsIncentiveDetails WHERE StartDate = '2021-09-06 12:12:12' AND EndDate = '2021-09-11 12:12:12'

For the TransactionAmount filter, specify amounts in cents. For example, to search for transactions from $6.00 to $10.05, enter the range 600 to 1005.

Supported operators include: =, <, <=, >, >=.

SELECT * FROM TransactionReportsIncentiveDetails WHERE TransactionAmount > 600 AND TransactionAmount < 1005

The connector processes other filters client-side within the connector.

Columns

Name Type References Description
AccountNumber String The merchant account number.
LastRefreshedDatetime Datetime The date and time when the data was last refreshed, in Internet date and time format.
IncentiveAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
IncentiveAmountValue String The value of incentive amount.
IncentiveCode String The code that identifies an incentive, such as a coupon.
IncentiveProgramCode String The incentive program code that identifies a merchant loyalty or incentive program.
IncentiveType String The type of incentive, such as a special offer or coupon.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
StartDate Datetime The start date and time, in Internet date and time format.
EndDate Datetime The end date and time, in Internet date and time format.
TransactionId String The PayPal-generated transaction ID.
PaymentInstrumentType String Filters the transactions in the response by a payment instrument type.
BalanceAffectingRecordsOnly String Indicates whether the response includes only balance-impacting transactions or all transactions.

The allowed values are Y, N.

StoreId String Filters the transactions in the response by a store ID.
TerminalId String Filters the transactions in the response by a terminal ID.
TransactionAmount String Filters the transactions in the response by a gross transaction amount range. For example, to search for transactions from $5.00 to $10.05, specify [500 TO 1005].
TransactionCurrency String Filters the transactions in the response by a three-character ISO-4217 currency code for the PayPal transaction currency.
TransactionStatus String Filters the transactions in the response by a PayPal transaction status code.

The allowed values are D, P, S, V.

TransactionType String Filters the transactions in the response by a PayPal transaction event code.

CData Python Connector for PayPal

UserInfo

Shows OpenID Connect user profile information for standard claims.

View-Specific Information

SELECT

The connector processes all filters client-side.

SELECT * FROM UserInfo

Columns

Name Type References Description
UserId String The user ID of the user.
Sub String The subject ID for the end user at the issuer.
Name String The full name of the user.
GivenName String The given, or first, name of the user.
FamilyName String The surname or family name of the user. Also known as the last name.
MiddleName String The middle name of the user.
Picture String The URL of the profile picture of the user.
Email String The internationalized email address.
EmailVerified Boolean Indicates whether the user's email address is verified.
Gender String The user's gender.
Birthdate Datetime The user's birthday, in YYYY-MM-DD format.
ZoneInfo String The time zone of the user.
Locale String The locale of the user.
PhoneNumber String The preferred telephone number of the user.
StreetAddress String The full street address. Can include the house number and street name.
Locality String The city or locality.
Region String The state, province, prefecture, or region.
PostalCode String The zip code or postal code.
Country String The country.
VerifiedAccount Boolean Indicates whether the account is verified.
AccountType String The account type.

The allowed values are PERSONAL, BUSINESS, PREMIER.

AgeRange String The account holder's age range.

CData Python Connector for PayPal

Users

Lists users.

View-Specific Information

SELECT

The connector processes all filters client-side.

SELECT * FROM Users

Columns

Name Type References Description
Id [KEY] String The PayPal payer ID, which is a publicly-sharable masked version of the PayPal account number intended for use with third parties.
UserName String Unique identifier for the User, typically used by the user to directly authenticate to the service provider.
GivenName String The given, or first, name of the user.
FamilyName String The surname or family name of the user. Also known as the last name.
MiddleName String The middle name of the user.
ExternalId String A string identifier for the resource as defined by the external or third-party client.
Active Boolean The URL of the profile picture of the user.
Emails String Email addresses for the user.
PhoneNumbers String Phone numbers for the User.
Addresses String Addresses for the User.
Entitlements String A list of entitlements for the User that represent a thing the User has.
PreferredLanguage String The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions.
Timezone String The time zone, in IANA format.
Schemas String An array of identified schemas.
MetaResourceType String The name of the metadata resource type of the resource: User, Group, etc.
MetaLocation String The complete metadata target URL.
MetaCreated Datetime The created date and time of metadata, in Internet date and time format.
MetaLastModified Datetime The last modified date and time of metadata, in Internet date and time format.

CData Python Connector for PayPal

Webhooks

Returns the list of Webhooks.

View-Specific Information

SELECT

The PayPal API does not support any filters on this table. However, projections are supported. The connector processes all filters client-side.

Columns

Name Type References Description
Id [KEY] String The identifier of the webhook resource.
Url String The webhook notification endpoint URL.

CData Python Connector for PayPal

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with PayPal.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from PayPal, along with an indication of whether the procedure succeeded or failed.

CData Python Connector for PayPal Stored Procedures

Name Description
CreateDraftInvoice Creates a draft invoice.
CreateOrder Creates an order. Merchants and partners can add Level 2 and Level 3 data to payments to reduce risk and payment processing costs.
CreatePayment Creates a sale, an authorized payment to be captured later, or an order.
CreatePayouts Creates payouts in PayPal.
CreateSubscription Creates a subscription in PayPal.
DeleteInvoice Deletes a draft or scheduled invoice, by ID.
GetOAuthAccessToken Gets the OAuth access token from PayPal.
SendInvoice Sends an invoice, by Id, to a customer.

CData Python Connector for PayPal

CreateDraftInvoice

Creates a draft invoice.

Stored Procedure-Specific Information

The CreateDraftInvoice Stored Procedure requires following columns to execute:

  • InvoiceItems
  • DetailCurrencyCode

You can include additional fields to enhance the details in the draft invoice.

EXEC CreateDraftInvoice @DetailCurrencyCode = 'USD', @InvoiceItems = '[\n" +
              "    {\n" +
              "      \"name\": \"Yoga Mat\",\n" +
              "      \"description\": \"Elastic mat to practice yoga.\",\n" +
              "      \"quantity\": \"1\",\n" +
              "      \"unit_amount\": {\n" +
              "        \"currency_code\": \"USD\",\n" +
              "        \"value\": \"50.00\"\n" +
              "      },\n" +
              "      \"tax\": {\n" +
              "        \"name\": \"Sales Tax\",\n" +
              "        \"percent\": \"7.25\"\n" +
              "      },\n" +
              "      \"discount\": {\n" +
              "        \"percent\": \"5\"\n" +
              "      },\n" +
              "      \"unit_of_measure\": \"QUANTITY\"\n" +
              "    }]'

Input

Name Type Required Description
PrimaryRecipients String False A JSON aggregate that contains an array of individual primary recipients, including the billing and shipping information for each.
AdditionalRecipients String False An array of one or more CC: emails to which notifications are sent. If you omit this parameter, a notification is sent to all CC: email addresses that are part of the invoice.
InvoiceItems String True A JSON aggregate which contains an array of individual invoice line item information.
DetailReference String False The reference data. Includes a post office (PO) number.
DetailNote String False A note to the invoice recipient. Also appears on the invoice notification email.
DetailTermsAndConditions String False The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.
DetailMemo String False A private bookkeeping memo for the user.
DetailAttachments String False An array of PayPal IDs for the files that are attached to an invoice.
DetailCurrencyCode String True The three-character ISO-4217 currency code that identifies the currency.
DetailInvoiceNumber String False The invoice number. Default is the number that is auto-incremented number from the last number.
DetailInvoiceDate String False The stand-alone date, in Internet date and time format.
DetailPaymentTermType String False The payment term type of the invoice. Payment can be due upon receipt, a specified date, or in a set number of days.
DetailPaymentTermDueDate String False The stand-alone date, in Internet date and time format.
InvoicerBussinessName String False The business name of the party.
InvoicerName String False A JSON aggregate which contains the name of the party.
InvoicerAddress String False A JSON aggregate which contains the portable international postal address.
InvoicerPhones String False A JSON aggregate which contains an array of invoicer's phone numbers.
InvoicerWebsite String False The invoicer's website.
InvoicerTaxId String False The invoicer's tax ID.
InvoicerAdditionalNotes String False Any additional information. Includes business hours.
InvoicerLogoUrl String False The full URL to an external logo image.
InvoicerEmailAddress String False The internationalized email address with more restrictive rules.
ConfigurationTaxCalculatedAfterDiscount Boolean False Indicates whether the tax is calculated before or after a discount. If false, the tax is calculated before a discount. If true, the tax is calculated after a discount.
ConfigurationTaxInclusive Boolean False Indicates whether the unit price includes tax.
ConfigurationAllowTip Boolean False Indicates whether the invoice enables the customer to enter a tip amount during payment. If true, the invoice shows a tip amount field so that the customer can enter a tip amount. If false, the invoice does not show a tip amount field.
ConfigurationAllowPartialPayment Boolean False Indicates whether the invoice allows a partial payment. If false, the invoice must be paid in full. If true, the invoice allows partial payments.
ConfigurationPartialPaymentMinAmountDueCurrencyCode String False The three-character ISO-4217 currency code that identifies the currency.
ConfigurationPartialPaymentMinAmountDueValue String False The amount value for a financial transaction, such as a balance or payment due.
ConfigurationTemplateId String False The template ID. The template determines the layout of the invoice.
Amount String False A JSON aggregate which contains the breakdown of the amount. Includes total item amount, total tax amount, custom amount, and shipping and discounts, if any.
Payments String False A JSON aggregate which contains an array of payments registered against the invoice.
Refunds String False A JSON aggregate which contains the invoicing refund details. Includes the refund type, date, amount, and method.

Result Set Columns

Name Type Description
Id String The ID of the invoice.
Status String The PayPal-generated invoice status. If the draft invoice is created, the status is DRAFT.

CData Python Connector for PayPal

CreateOrder

Creates an order. Merchants and partners can add Level 2 and Level 3 data to payments to reduce risk and payment processing costs.

Stored Procedure-Specific Information

The CreateOrder Stored Procedure requires following columns to execute:

  • Intent
  • PurchaseUnits

EXEC CreateOrder @Intent = 'CAPTURE', @PurchaseUnits = ' [ {\n
              \"amount\": {\n
                \"currency_code\": \"USD\",\n
                \"value\": \"100.00\"\n
              }\n
            }]'

Input

Name Type Required Description
Intent String True The payment intent: capture, authorize.
PurchaseUnits String True An array of purchase units. Each purchase unit establishes a contract between a payer and the payee.
PaymentSource String False The payment source definition.
ApplicationContext String False Customizes the payer experience during the approval process for the payment with PayPal.

Result Set Columns

Name Type Description
Success Boolean Indicates whether the operation was successful.
Id String The PayPal-generated ID for the payment.

CData Python Connector for PayPal

CreatePayment

Creates a sale, an authorized payment to be captured later, or an order.

Stored Procedure-Specific Information

The CreatePayment Stored Procedure requires following columns to execute:

  • Intent
  • ReturnUrl
  • CancelUrl
  • PayerPaymentMethod
  • Transactions

EXEC CreatePayment @Intent = 'sale',  @ReturnUrl = 'https://example.com/return', @CancelUrl = 'https://example.com/cancel', @PayerPaymentMethod = 'paypal', @Transactions = '[\n" +
              "    {\n" +
              "      \"amount\": {\n" +
              "        \"total\": \"30.11\",\n" +
              "        \"currency\": \"USD\",\n" +
              "        \"details\": {\n" +
              "          \"subtotal\": \"30.00\",\n" +
              "          \"tax\": \"0.07\",\n" +
              "          \"shipping\": \"0.03\",\n" +
              "          \"handling_fee\": \"1.00\",\n" +
              "          \"shipping_discount\": \"-1.00\",\n" +
              "          \"insurance\": \"0.01\"\n" +
              "        }\n" +
              "      },\n" +
              "      \"description\": \"The payment transaction description.\",\n" +
              "      \"custom\": \"EBAY_EMS_90048630024435\",\n" +
              "      \"invoice_number\": \"48787589673\",\n" +
              "      \"payment_options\": {\n" +
              "        \"allowed_payment_method\": \"INSTANT_FUNDING_SOURCE\"\n" +
              "      },\n" +
              "      \"soft_descriptor\": \"ECHI5786786\",\n" +
              "      \"item_list\": {\n" +
              "        \"items\": [\n" +
              "          {\n" +
              "            \"name\": \"hat\",\n" +
              "            \"description\": \"Brown hat.\",\n" +
              "            \"quantity\": \"5\",\n" +
              "            \"price\": \"3\",\n" +
              "            \"tax\": \"0.01\",\n" +
              "            \"sku\": \"1\",\n" +
              "            \"currency\": \"USD\"\n" +
              "          },\n" +
              "          {\n" +
              "            \"name\": \"handbag\",\n" +
              "            \"description\": \"Black handbag.\",\n" +
              "            \"quantity\": \"1\",\n" +
              "            \"price\": \"15\",\n" +
              "            \"tax\": \"0.02\",\n" +
              "            \"sku\": \"product34\",\n" +
              "            \"currency\": \"USD\"\n" +
              "          }\n" +
              "        ],\n" +
              "        \"shipping_address\": {\n" +
              "          \"recipient_name\": \"Brian Robinson\",\n" +
              "          \"line1\": \"4th Floor\",\n" +
              "          \"line2\": \"Unit #34\",\n" +
              "          \"city\": \"San Jose\",\n" +
              "          \"country_code\": \"US\",\n" +
              "          \"postal_code\": \"95131\",\n" +
              "          \"phone\": \"011862212345678\",\n" +
              "          \"state\": \"CA\"\n" +
              "        }\n" +
              "      }\n" +
              "    }\n" +
              "  ]'

Input

Name Type Required Description
Intent String True The payment intent: sale, authorize, order.
Transactions String True A JSON aggregate which contains an array of payment-related transactions.
NoteToPayer String False A free-form field that clients can use to send a note to the payer.
ReturnUrl String True The URL where the payer is redirected after they approve the payment. Required for PayPal account payments.
CancelUrl String True The URL where the payer is redirected after they cancel the payment. Required for PayPal account payments.
PayerPaymentMethod String True The payment method.
PayerFundingInstruments String False An array of a single funding instrument for the current payment. Valid and required only for the credit card payment method.
PayerInfo String False The payer information.
ApplicationContext String False Use the application context resource to customize payment flow experience for your buyers.

Result Set Columns

Name Type Description
Success Boolean Indicates whether the operation was successful.
Id String The PayPal-generated ID for the payment.

CData Python Connector for PayPal

CreatePayouts

Creates payouts in PayPal.

Stored Procedure-Specific Information

Payout Items

You cannot create a payout without payout items. To create payout items, you must insert data either using a JSON aggregate or via temporary table called 'PayoutItem#TEMP'. Refer to the following examples for more information.

Example: Create payouts using JSON aggregate

EXECUTE CreatePayouts SenderBatchId = '1247', EmailSubject = 'You have a payout!', EmailMessage = 'You have received a payout! Thanks for using our service!', PayoutItem = '[{\n" +
          "\"recipient_type\": \"EMAIL\",\n" +
          "\"amount\": {\n" +
          "\"value\": \"0.0\",\n" +
          "\"currency\": \"USD\"\n" +
          "},\n" +
          "\"note\": \"Thanks for your patronage3333!\",\n" +
          "\"receiver\": \"receiver@example.com\",\n" +
          "\"sender_item_id\": \"201403140001\"\n" +
          "}, {\n" +
          "\"recipient_type\": \"PHONE\",\n" +
          "\"amount\": {\n" +
          "\"value\": \"0.0\",\n" +
          "\"currency\": \"USD\"\n" +
          "\t},\n" +
          "\"note\": \"Thanks for your support!\",\n" +
          "\"receiver\": \"91-734-234-1234\",\n" +
          "\"sender_item_id\": \"201403140002\"\n" +
          "}\n" +
          "]'

Example: Create payouts using temp table

You first need to insert into PayoutItem#TEMP to create payout items.

INSERT INTO PayoutItem#TEMP (RecipientType, AmountValue, AmountCurrency, Note, SenderItemId, Receiver) VALUES ('EMAIL', '3.2', 'USD', 'Thanks for your patronage!', '201403140001', 'receiver@example.com')
INSERT INTO PayoutItem#TEMP (RecipientType, AmountValue, AmountCurrency, Note, SenderItemId, Receiver) VALUES ('PHONE', '8.98', 'USD', 'Thanks for your support!', '201403140002', '91-734-234-1234')

EXECUTE

After creating at least one payout item, you can execute the stored procedure.

EXECUTE CreatePayouts SenderBatchId = '123', EmailSubject = 'You have a payout!', EmailMessage = 'You have received a payout! Thanks for using our service!'

The following columns are required to create a payout item:

  • RecipientType
  • AmountValue
  • AmountCurrency
  • SenderItemId
  • Receiver

Input

Name Type Required Description
SenderBatchId String True A sender-specified ID number. Tracks the payout in an accounting system.
EmailSubject String False The subject line for the email that PayPal sends when payment for a payout item completes. The subject line is the same for all recipients.
EmailMessage String False The email message that PayPal sends when the payout item completes. The message is the same for all recipients.
PayoutItems String False A JSON aggregate that contains an array of individual payout items.

Result Set Columns

Name Type Description
PayoutBatchId String The PayPal-generated ID for the payout.
BatchStatus String The PayPal-generated payout status. If the payout passes preliminary checks, the status is PENDING.

CData Python Connector for PayPal

CreateSubscription

Creates a subscription in PayPal.

Stored Procedure-Specific Information

The CreateSubscription Stored Procedure requires PlanId to create a Paypal Subscription.

EXECUTE CreateSubscription PlanId = 'P-5ML4271244454362WXNWU5NQ', StartTime = '2021-11-01T00:00:00Z', ShippingAmount = '{\n" +
          "    \"currency_code\": \"USD\",\n" +
          "    \"value\": \"10.00\"\n" +
          "  }', subscriber = '{\n" +
          "    \"name\": {\n" +
          "      \"given_name\": \"John\",\n" +
          "      \"surname\": \"Doe\"\n" +
          "    },\n" +
          "    \"email_address\": \"customer@example.com\",\n" +
          "    \"shipping_address\": {\n" +
          "      \"name\": {\n" +
          "        \"full_name\": \"John Doe\"\n" +
          "      },\n" +
          "      \"address\": {\n" +
          "        \"address_line_1\": \"2211 N First Street\",\n" +
          "        \"address_line_2\": \"Building 17\",\n" +
          "        \"admin_area_2\": \"San Jose\",\n" +
          "        \"admin_area_1\": \"CA\",\n" +
          "        \"postal_code\": \"95131\",\n" +
          "        \"country_code\": \"US\"\n" +
          "      }\n" +
          "    }\n" +
          "  }'

The following columns are required to create a subscription:

  • PlanId

Input

Name Type Required Description
PlanId String True The ID of the plan.
StartTime String False The date and time when the subscription started.
Quantity String False The quantity of the product in the subscription.
ShippingAmount String False A JSON aggregate that contains the shipping charges.
Subscriber String False A JSON aggregate that contains the subscriber request information.
ApplicationContext String False A JSON aggregate that contains the application context, which customizes the payer experience during the subscription approval process with PayPal.
CustomId String False The custom id for the subscription. Can be invoice id.
Plan String False A JSON aggregate that contains an inline plan object to customize the subscription.

Result Set Columns

Name Type Description
SubscriptionId String The PayPal-generated ID for the subscription.
Status String The PayPal-generated subscription status.

CData Python Connector for PayPal

DeleteInvoice

Deletes a draft or scheduled invoice, by ID.

Stored Procedure-Specific Information

The DeleteInvoice Stored Procedure requires InvoiceId to delete an invoice.

EXEC DeleteInvoice @InvoiceId = 'INV2-VSCV-SAZK-CMHP-AHGB'

Input

Name Type Required Description
InvoiceId String True The ID of the draft invoice to delete.

Result Set Columns

Name Type Description
Success Boolean Indicates whether the operation was successful.

CData Python Connector for PayPal

GetOAuthAccessToken

Gets the OAuth access token from PayPal.

Input

Name Type Required Description

Result Set Columns

Name Type Description
OAuthAccessToken String The OAuth token.
ExpiresIn String The remaining lifetime for the access token in seconds.

CData Python Connector for PayPal

SendInvoice

Sends an invoice, by Id, to a customer.

Input

Name Type Required Description
InvoiceId String True The Id of the invoice to send.
Subject String False The subject of the email that is sent as a notification to the recipient.
Note String False A note to the payer.
SendToInvoicer Boolean False Indicates whether to send a copy of the email to the merchant.
SendToRecipient Boolean False Indicates whether to send a copy of the email to the recipient.
AdditionalRecipients String False An array of one or more CC: emails to which notifications are sent. If you omit this parameter, a notification is sent to all CC: email addresses that are part of the invoice.

Result Set Columns

Name Type Description
Status String The PayPal-generated invoice status. If the draft invoice is sent, the status is SENT.

CData Python Connector for PayPal

SOAP Data Model

The CData Python Connector for PayPal models the PayPal SOAP APIs as database Views. Typically, read-only data are shown as views. These are defined in schema files, which are simple, text-based configuration files that make schemas easy to customize.

This section provides the API limitations and requirements for the SOAP data model.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views.

CData Python Connector for PayPal

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Python Connector for PayPal Views

Name Description
Balance View all the currencies of the account and their balances.
BalanceAffecting Query Transactions that affect the account balance.
BalanceTransfer Query Transactions involving Balance Transfers.
BillPay Query Transactions involving BillPay Transactions.
CurrencyConversions Query Transactions involving Currency Conversions.
Dividend Query Transactions involving Dividends.
ECheck Query Transactions involving eChecks.
Fee Query Transactions involving Fees.
FundsAdded Query Transactions generated when funds are added to the balance.
FundsWithdrawn Query Transactions generated when funds are withdrawn from the balance.
MassPay Query Mass Payments Transactions.
MoneyRequest Query Money Request Transactions.
Received Query payments-received Transactions.
Referral Query Transactions involving Referrals.
Refund Query Transactions involving Refunds.
Reversal Query Transactions involving BillPay Reversals.
Sent Query payments-sent Transactions.
Shipping Query Transactions involving UPS Shipping Fees.
Subscription Query Transactions involving Subscriptions.
TransactionDetails Query details about a specific Transaction using the GetTransactionDetails API.
TransactionItems Query details about a specific Transaction's items using the GetTransactionDetails API.
Transactions Query Transaction history using the TransactionSearch API.

CData Python Connector for PayPal

Balance

View all the currencies of the account and their balances.

Columns

Name Type References Description
CurrencyID String The currency of the balance.
Balance Double The balance of the associated currency.

CData Python Connector for PayPal

BalanceAffecting

Query Transactions that affect the account balance.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime Date and time that the transaction occurred. Character length and limitations: The date and time of the transaction.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by the invoice identification key, as set by you for the original transaction. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a nonprimary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

BalanceTransfer

Query Transactions involving Balance Transfers.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, or Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode field to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by the invoice identification key, as set by you for the original transaction. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by an alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a nonprimary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

BillPay

Query Transactions involving BillPay Transactions.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by the invoice identification key, as set by you for the original transaction. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

CurrencyConversions

Query Transactions involving Currency Conversions.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by the invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

Dividend

Query Transactions involving Dividends.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

ECheck

Query Transactions involving eChecks.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

Fee

Query Transactions involving Fees.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

FundsAdded

Query Transactions generated when funds are added to the balance.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String An alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

FundsWithdrawn

Query Transactions generated when funds are withdrawn from the balance.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

MassPay

Query Mass Payments Transactions.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

MoneyRequest

Query Money Request Transactions.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

Received

Query payments-received Transactions.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String An alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

Referral

Query Transactions involving Referrals.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

Refund

Query Transactions involving Refunds.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

Reversal

Query Transactions involving BillPay Reversals.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

Sent

Query payments-sent Transactions.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

Shipping

Query Transactions involving UPS Shipping Fees.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

Subscription

Query Transactions involving Subscriptions.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

TransactionDetails

Query details about a specific Transaction using the GetTransactionDetails API.

Table Specific Information

Select

The only filter supported by the PayPal API is TransactionId, which is required. The connector processes other filters client side within the connector.

For example, the following queries are processed server side and retrieve details for a specific Transaction.

Warning: Requesting all TransactionDetails for all transactions could take a long time depending on the number of transactions.

SELECT * FROM TransactionDetails WHERE TransactionId = '4W92068757818534U'

SELECT * FROM TransactionDetails WHERE TransactionId IN ('4W92068757818534U', '0TM835405G491863M')

SELECT * FROM TransactionDetails WHERE TransactionId IN (SELECT Id FROM Transactions)

Columns

Name Type References Description
TransactionId [KEY] String Unique transaction Id of the payment.
ReceiverBusiness String Details about a single transaction. This field is not applicable for point-of-sale transactions.
ReceiverEmail String Primary email address of the payment recipient (the merchant).
ReceiverId String Unique account Id of the payment recipient (the merchant). This value is the same as the value of the referral Id of the recipient.
PayerEmail String Email address of the buyer.
PayerId String Unique PayPal Customer Account identification number.
PayerStatus String Status of the buyer.
PayerFirstName String The first name of the buyer.
PayerMiddleName String The middle name of the buyer.
PayerLastName String The last name of the buyer.
PayerSuffix String The suffix of the buyer.
PayerCountry String The country of residence of the buyer in the form of ISO standard 3166 2-character country codes.
PayerBusiness String The business name of the buyer.
StreetAddress String The first street address.
City String The name of the city.
State String The state or province.
PostalCode String U.S. ZIP code or other country-specific postal code.
ShippingCountry String The expanded name of the country.
PayerPhone String The phone number.
ParentTransactionId String The parent or related transaction identification number.
TransactionType String The type of transaction.
PaymentType String Indicates whether the payment is instant or delayed.
PaymentDate Datetime The date-time stamp of the payment.
GrossAmount Decimal The final amount charged, including any shipping and taxes from your Merchant Profile.
FeeAmount Decimal The PayPal fee amount charged for the transaction.
SettleAmount Decimal The amount deposited in your PayPal account after a currency conversion.
TaxAmount Decimal The tax charged on the transaction.
ExchangeRate String The exchange rate if a currency conversion occurred. This is relevant only if you are billing in the non-primary currency of the buyer. If the buyer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the account of the buyer.
PaymentStatus String Status of the payment.
PendingReason String The reason the payment is pending.
ProtectionEligibility String Prior to version 64.4, the kind of seller protection in force for the transaction.
ProtectionEligibilityType String Since version 64.4, the kind of seller protection in force for the transaction.
StoreId String StoreId as entered in the transaction.
Subject String The value of the subject field entered by the buyer when making a payment.
InvoiceId String Invoice number you set in the original transaction.
Memo String Memo entered by your customer in the PayPal Website Payments note field.
SalesTax Decimal Amount of tax charged on payment.
AuctionBuyerId String The auction Id of the buyer.
AuctionClosingDate Datetime The close date of the auction.

CData Python Connector for PayPal

TransactionItems

Query details about a specific Transaction's items using the GetTransactionDetails API.

View Specific Information

Select

The only filter supported by the PayPal API is TransactionId, which is required. The connector processes other filters client side within the connector.

For example, the following queries are processed server side and retrieve details for a specific Transaction.

Warning: Requesting all TransactionItems for all transactions could take a long time depending on the number of transactions.

SELECT * FROM TransactionItems WHERE TransactionId = '4W92068757818534U'

SELECT * FROM TransactionItems WHERE TransactionId IN ('4W92068757818534U', '0TM835405G491863M')

SELECT * FROM TransactionItems WHERE TransactionId IN (SELECT Id FROM Transactions)

Columns

Name Type References Description
TransactionID String Unique transaction Id of the payment.
EbayItemTxnId String The eBay auction transaction Id of the item that you use to identify items that the buyer purchased.
ItemName String Item name set by you or entered by the customer.
ItemNumber Integer Item number set by you. If this was a shopping cart transaction, PayPal appends the number of the item to the HTML item_number variable, for example, item_number1, item_number2, and so forth.
ShippingAmount Decimal Shipping Amount.
HandlingAmount Decimal Handling Amount.
Quantity Integer Quantity set by you or entered by the buyer.
CouponId String Coupon identification number.
CouponAmount Decimal Amount (value) of the coupon.
ItemAmount Decimal Cost of the item.
CouponAmountCurrency String Currency of the coupon amount, e.g., a 3-character currency code.
SalesTax Decimal Amount of tax charged on payment for this item.

CData Python Connector for PayPal

Transactions

Query Transaction history using the TransactionSearch API.

Table Specific Information

Select

The following filters are supported by the PayPal API:

  • Id
  • Date
  • Receiver
  • ReceiptId
  • AuctionItemNumber
  • TransactionClass

The Date filter supports the >, >=, <, <=, and = operators while the other filters only support the = operator.

The connector processes other filters client side within the connector.

For example, the following query is processed server side and retrieves Transactions that were created after the specified Date.

SELECT * FROM Transactions WHERE Date > '2015-12-15T12:00:00' AND Amount = '11'

Other important filter you can execute client-side is the Type filter. You can use that column to retrive i.e: only the Orders.
After retrieving the IDs of transactions with type order, you can use these IDs to query TransactionItems and TransactionDetails views, to get more details.

SELECT * FROM Transactions WHERE Type = 'Order'

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction.
Date Datetime Date and time that the transaction occurred. Character length and limitations: Date and time are in UTC/GMT format; for example, 2013-08-24T05:38:48Z.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Order, Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String Search by the email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
TransactionClass String Search by the classification of the transaction. Some kinds of possible classes of transactions are not searchable with this field. You cannot search for bank transfer withdrawals, for example. This field has one of the following values: All, Sent, Received, MassPay, MoneyRequest, FundsAdded, FundsWithdrawn, Referral, Fee, Subscription, Dividend, Billpay, Refund, CurrencyConversions, BalanceTransfer, Reversal, Shipping, BalanceAffecting, or ECheck.

The allowed values are All, Sent, Received, MassPay, MoneyRequest, FundsAdded, FundsWithdrawn, Referral, Fee, Subscription, Dividend, Billpay, Refund, CurrencyConversions, BalanceTransfer, Reversal, Shipping, BalanceAffecting, ECheck.

Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by the invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String An alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

CData Python Connector for PayPal

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for PayPal:

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries

  • sys_identity: Returns information about batch operations or single updates.

CData Python Connector for PayPal

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String The database name.

CData Python Connector for PayPal

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

CData Python Connector for PayPal

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.
IsInsertable Boolean Whether the table can be inserted into.
IsDeleteable Boolean Whether rows can be deleted from the table.

CData Python Connector for PayPal

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Payments table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName = 'Payments' 

Columns

Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType String The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.
ColumnCapabilities Int32 A bit mask denoting the column's write capabilities. The value is the sum of the following: 1 if the column is required for INSERTs, 2 if the column is allowed for INSERTs, and 4 if the column is allowed for UPDATEs. A value of 0 indicates that the write capabilities of the column are unknown or that the column is read-only.

CData Python Connector for PayPal

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

CData Python Connector for PayPal

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName String The name of the data type.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.
Values String The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams Boolean Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath Boolean Whether the parameter is a target path for a schema creation operation.
Default String The value used for this parameter when no value is specified.
SpecificName String A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided Boolean Whether the procedure is added/implemented by CData, as opposed to being a native PayPal procedure.

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean Whether the output should include columns from the result set in addition to parameters. Defaults to False.

CData Python Connector for PayPal

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Payments table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Payments' 
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

CData Python Connector for PayPal

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

CData Python Connector for PayPal

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

CData Python Connector for PayPal

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

CData Python Connector for PayPal

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

CData Python Connector for PayPal

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

NameDescriptionPossible Values
AGGREGATE_FUNCTIONSSupported aggregation functions.AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTWhether COUNT function is supported.YES, NO
IDENTIFIER_QUOTE_OPEN_CHARThe opening character used to escape an identifier.[
IDENTIFIER_QUOTE_CLOSE_CHARThe closing character used to escape an identifier.]
SUPPORTED_OPERATORSA list of supported SQL operators.=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYWhether GROUP BY is supported, and, if so, the degree of support.NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESThe supported varieties of outer joins supported.NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINSWhether outer joins are supported.YES, NO
SUBQUERIESWhether subqueries are supported, and, if so, the degree of support.NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSSupported string functions.LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSSupported numeric functions.ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSSupported date/time functions.NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESIndicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNSA string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERNString value indicating what string is valid for an identifier.
SUPPORT_TRANSACTIONIndicates if the provider supports transactions such as commit and rollback.YES, NO
DIALECTIndicates the SQL dialect to use.
KEY_PROPERTIESIndicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMASIndicates if multiple schemas may exist for the provider.YES, NO
SUPPORTS_MULTIPLE_CATALOGSIndicates if multiple catalogs may exist for the provider.YES, NO
DATASYNCVERSIONThe CData Data Sync version needed to access this driver.Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYThe CData Data Sync category of this driver.Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLWhether enhanced SQL functionality beyond what is offered by the API is supported.TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSWhether batch operations are supported.YES, NO
SQL_CAPAll supported SQL capabilities for this driver.SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONSA string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERYIndicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.YES, NO
PSEUDO_COLUMNSA string array indicating the available pseudo columns.
MERGE_ALWAYSIf the value is true, The Merge Mode is forcibly executed in Data Sync.TRUE, FALSE
REPLICATION_MIN_DATE_QUERYA select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTIONAllows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATEAllows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERYA select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTIONAllows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATEA list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTIDIndicates whether the CheckCache statement should be done against the parent key column.TRUE, FALSE
CREATE_SCHEMA_PROCEDURESIndicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

CData Python Connector for PayPal

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String The database-generated Id returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

CData Python Connector for PayPal

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductStringThe name of the product.
VersionStringThe version number of the product.
DatasourceStringThe name of the datasource the product connects to.
NodeIdStringThe unique identifier of the machine where the product is installed.
HelpURLStringThe URL to the product's help documentation.
LicenseStringThe license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
LocationStringThe file path location where the product's library is stored.
EnvironmentStringThe version of the environment or rumtine the product is currently running under.
DataSyncVersionStringThe tier of CData Sync required to use this connector.
DataSyncCategoryStringThe category of CData Sync functionality (e.g., Source, Destination).

CData Python Connector for PayPal

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication


PropertyDescription
AuthSchemeSpecifies the type of authentication to use when connecting to PayPal.
UserSpecifies the authenticating user's user ID.
PasswordSpecifies the authenticating user's password.
SignatureThe signature required to use the SOAP API.
UseSandboxA Boolean value indicating if you are using a Sandbox account.

OAuth


PropertyDescription
InitiateOAuthSpecifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthAccessTokenSpecifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthSettingsLocationSpecifies the location of the settings file where OAuth values are saved.
CallbackURLIdentifies the URL users return to after authenticating to PayPal via OAuth (Custom OAuth applications only).
OAuthRefreshTokenSpecifies the OAuth refresh token used to request a new access token after the original has expired.
OAuthExpiresInSpecifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthTokenTimestampDisplays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.

SSL


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerIdentifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPortIdentifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserProvides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordSpecifies the password of the user specified in the ProxyUser connection property.
ProxySSLTypeSpecifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsSpecifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging


PropertyDescription
LogfileSpecifies the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details.
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
MaxLogFileSizeSpecifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name.
MaxLogFileCountSpecifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one.

Schema


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
SchemaThe type of schema to use.

Caching


PropertyDescription
AutoCacheSpecifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database.
CacheProviderThe namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations.
CacheDriverThe driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations.
CacheConnectionSpecifies the connection string for the specified cache database.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceNotes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True.
OfflineGets the data from the specified cache database instead of live PayPal data.
CacheMetadataDetermines whether the provider caches table metadata to a file-based cache database.

Miscellaneous


PropertyDescription
IncludeDetailsA Boolean value indicating if you will get extra details (for example, the ShippingAddress fields when querying the Invoices table).
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
CData Python Connector for PayPal

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.


PropertyDescription
AuthSchemeSpecifies the type of authentication to use when connecting to PayPal.
UserSpecifies the authenticating user's user ID.
PasswordSpecifies the authenticating user's password.
SignatureThe signature required to use the SOAP API.
UseSandboxA Boolean value indicating if you are using a Sandbox account.
CData Python Connector for PayPal

AuthScheme

Specifies the type of authentication to use when connecting to PayPal.

Possible Values

Basic, OAuthClient

Data Type

string

Default Value

"Basic"

Remarks

The driver supports two authentication schemes:

  • OAuthClient: Supports authentication via OAuth using the client credentials grant type.
  • Basic: Supports authentication using basic user/password/signature credentials.

CData Python Connector for PayPal

User

Specifies the authenticating user's user ID.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

CData Python Connector for PayPal

Password

Specifies the authenticating user's password.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

CData Python Connector for PayPal

Signature

The signature required to use the SOAP API.

Data Type

string

Default Value

""

Remarks

The signature required to use the SOAP API.

Along with Signature, User and Password are required to access the Transaction and TransactionDetails tables.

To create an API signature, you need a PayPal business account. To create the signature, log in and click Profile. Click My Selling Tools and, in the Selling Online section, click Update in the API Access section. On the resulting page, click Request API Credentials.

CData Python Connector for PayPal

UseSandbox

A Boolean value indicating if you are using a Sandbox account.

Data Type

bool

Default Value

false

Remarks

A Boolean value indicating if you are using a Sandbox account.

CData Python Connector for PayPal

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.


PropertyDescription
InitiateOAuthSpecifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthAccessTokenSpecifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthSettingsLocationSpecifies the location of the settings file where OAuth values are saved.
CallbackURLIdentifies the URL users return to after authenticating to PayPal via OAuth (Custom OAuth applications only).
OAuthRefreshTokenSpecifies the OAuth refresh token used to request a new access token after the original has expired.
OAuthExpiresInSpecifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthTokenTimestampDisplays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.
CData Python Connector for PayPal

InitiateOAuth

Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.

Possible Values

OFF, REFRESH, GETANDREFRESH

Data Type

string

Default Value

"OFF"

Remarks

OAuth is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. The OAuth flow defines the method to be used for:

  • Logging in users.
  • Exchanging user credentials for an OAuth access token to be used for authentication.
  • Providing limited access to applications.

The options for initiating and maintaining OAuth access are named for the parts of that flow that the connector handles:

OFF The connector provides no automatic OAuth flow initiation. The OAuth flow is handled entirely by the user.
This means that the user must refresh the token manually, and reconnect with an updated OAuthAccessToken property when the current token expires.
GETANDREFRESH The connector handles the entire OAuth flow (both GET and REFRESH). This means that if a token already exists, the connector refreshes it when necessary; if no token currently exists, the connector obtains it by prompting the user to login.
REFRESH The user obtains the OAuth Access Token and sets up the sequence for refreshing the OAuth Access Token. (The user is never prompted to log in to authenticate.) After the user logs in, the connector handles the refresh of the OAuth Access Token.

For more information on how to set up OAuth and use this property when configuring a connection, see Establishing a Connection.

CData Python Connector for PayPal

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

  • When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
  • If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the connector and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Python Connector for PayPal

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

  • This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
  • Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

CData Python Connector for PayPal

OAuthAccessToken

Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.

Data Type

string

Default Value

""

Remarks

OAuthAccessToken is a temporary credential that authorizes access to protected resources. It is typically returned by the identity provider after the user or client application completes an OAuth authentication flow. This property is most commonly used in automated workflows or custom OAuth implementations where you want to manage token handling outside of the driver.

The OAuth access token has a server-dependent timeout, limiting user access. The timeout is set using the OAuthExpiresIn property. However, it can be reissued between requests to keep access alive as long as the user keeps working.

If InitiateOAuth is set to REFRESH, we recommend that you also set both OAuthExpiresIn and OAuthTokenTimestamp. The connector uses these properties to determine when the token expires so it can refresh most efficiently. If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the connector refreshes the token immediately.

Note: Access tokens should be treated as sensitive credentials and stored securely. Avoid exposing them in logs, scripts, or configuration files that are not access-controlled.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Python Connector for PayPal

OAuthSettingsLocation

Specifies the location of the settings file where OAuth values are saved.

Data Type

string

Default Value

"%APPDATA%\\CData\\PayPal Data Provider\\OAuthSettings.txt"

Remarks

Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes.

You can store OAuth values in a central file for shared access to those values, in either of the following ways:

  • Set InitiateOAuth to either GETANDREFRESH or REFRESH and specify a filepath to the OAuth settings file.
  • Use memory storage to load the credentials into static memory.

The following sections provide more detail on each of these methods.

Specifying the OAuthSettingsLocation Filepath

The default OAuth setting location is %APPDATA%\\CData\\PayPal Data Provider\\OAuthSettings.txt, with %APPDATA% set to the user's configuration directory. Default values vary, depending on the user's operating system.

  • Windows (ODBC and Power BI): registry://%DSN%
  • Windows: %APPDATA%CDataPayPal Data Provider\OAuthSettings.txt
  • Mac: %APPDATA%/CData/PayPal Data Provider/OAuthSettings.txt
  • Linux: %APPDATA%/CData/PayPal Data Provider/OAuthSettings.txt

Loading Credentials Via Memory Storage

Memory locations are specified by using a value starting with memory://, followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose, but it should be unique to the user.

Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again.

To retrieve OAuth property values, query the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

Supported Storage Types

  • memory://: Stores OAuth tokens in-memory (unique identifier, shared within same process, etc.)
  • registry://: Only supported in the Windows ODBC and Power BI editions. Stores OAuth tokens in the registry under the DSN settings. Must end in a DSN name like registry://CData Python Connector for PayPal Data Source, or registry://%DSN%.
  • %DSN%: The name of the DSN you are connecting with.
  • Default (no prefix): Stores OAuth tokens within files. The value can be either an absolute path, or a path starting with %APPDATA% or %PROGRAMFILES%.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Python Connector for PayPal

CallbackURL

Identifies the URL users return to after authenticating to PayPal via OAuth (Custom OAuth applications only).

Data Type

string

Default Value

""

Remarks

If you created a custom OAuth application, the OAuth authorization server redirects the user to this URL during the authentication process. This value must match the callback URL you specified when you configured the custom OAuth application.

CData Python Connector for PayPal

OAuthRefreshToken

Specifies the OAuth refresh token used to request a new access token after the original has expired.

Data Type

string

Default Value

""

Remarks

The refresh token is used to obtain a new access token when the current one expires. It enables seamless authentication for long-running or automated workflows without requiring the user to log in again. This property is especially important in headless, CI/CD, or server-based environments where interactive authentication is not possible.

The refresh token is typically obtained during the initial OAuth exchange by calling the GetOAuthAccessToken stored procedure. After that, it can be set using this property to enable automatic token refresh, or passed to the RefreshOAuthAccessTokenproc; stored procedure if you prefer to manage the refresh manually.

When InitiateOAuth is set to REFRESH, the driver uses this token to retrieve a new access token automatically. After the first refresh, the driver saves updated tokens in the location defined by OAuthSettingsLocation, and uses those values for subsequent connections.

Note: The OAuthRefreshToken should be handled securely and stored in a trusted location. Like access tokens, refresh tokens can expire or be revoked depending on the identity provider’s policies.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Python Connector for PayPal

OAuthExpiresIn

Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.

Data Type

string

Default Value

""

Remarks

The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthExpiresIn is the number of seconds the token is valid from when it was created. For example, a token generated at 2024-01-29 20:00:00 UTC that expires at 2024-01-29 21:00:00 UTC (an hour later) would have an OAuthExpiresIn value of 3600, no matter what the current time is.

To determine how long the user has before the Access Token will expire, check OAuthTokenTimestamp.

CData Python Connector for PayPal

OAuthTokenTimestamp

Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.

Data Type

string

Default Value

""

Remarks

The OAuth access token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthTokenTimestamp is the Unix timestamp when the server created the token. For example, OAuthTokenTimestamp=1706558400 indicates the OAuthAccessToken was generated by the server at 2024-01-29 20:00:00 UTC.

CData Python Connector for PayPal

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
CData Python Connector for PayPal

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE-----
MIIChTCCAe4CAQAwDQYJKoZIhv......Qw==
-----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY-----
MIGfMA0GCSq......AQAB
-----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space- or colon-separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space- or colon-separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

CData Python Connector for PayPal

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.
CData Python Connector for PayPal

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Possible Values

NONE, TUNNEL, SOCKS4, SOCKS5

Data Type

string

Default Value

"NONE"

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the connector connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.

Protocol Default Port Description
TUNNEL 80 The port where the connector opens a connection to PayPal. Traffic flows back and forth via the proxy at this location.
SOCKS4 1080 The port where the connector opens a connection to PayPal. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5 1080 The port where the connector sends data to PayPal. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

CData Python Connector for PayPal

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Data Type

string

Default Value

""

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

CData Python Connector for PayPal

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Data Type

int

Default Value

0

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

CData Python Connector for PayPal

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Data Type

string

Default Value

""

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

CData Python Connector for PayPal

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Data Type

string

Default Value

""

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

CData Python Connector for PayPal

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerIdentifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPortIdentifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserProvides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordSpecifies the password of the user specified in the ProxyUser connection property.
ProxySSLTypeSpecifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsSpecifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
CData Python Connector for PayPal

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Data Type

bool

Default Value

true

Remarks

When this connection property is set to True, the connector checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. If you want to configure the connector to connect to a specific proxy server, set ProxyAutoDetect to False.

On Windows, the connector reads the proxy settings from the Internet Options in the registry, specifically the registry key HKCU\SOFTWARE\Microsoft\Windows\CurrentVersion\Internet Settings\. On Windows 10 and later, this corresponds to the Proxy Settings found in the Windows Settings.

Note that these settings apply only to the current user of the machine. If you're running an application as a service, the connector does not read your own user's settings. You must instead manually supply the proxy settings in the connector's connection properties.

On Mac, the connector reads proxy settings from the system-configured CFNetwork settings.

On Linux, this property is unsupported, and is set to False by default.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

CData Python Connector for PayPal

ProxyServer

Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.

Data Type

string

Default Value

""

Remarks

The connector only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the connector instead routes HTTP traffic through the proxy server specified in your system proxy settings.

CData Python Connector for PayPal

ProxyPort

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Data Type

int

Default Value

80

Remarks

The connector only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the connector instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

CData Python Connector for PayPal

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Possible Values

BASIC, DIGEST, NONE, NEGOTIATE, NTLM

Data Type

string

Default Value

"BASIC"

Remarks

Note: The connector only uses this ProxyAuthScheme when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the connector instead uses the authentication method specified in your system proxy settings.

Supported authentication types :

  • BASIC: The connector performs HTTP basic authentication.
  • DIGEST: The connector performs HTTP digest authentication.
  • NTLM: The connector retrieves an NTLM token.
  • NEGOTIATE: The connector retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • NONE: Signifies that the ProxyServer does not require authentication.

For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

CData Python Connector for PayPal

ProxyUser

Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.

Data Type

string

Default Value

""

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyUser
BASIC The username of a user registered with the proxy server.
DIGEST The username of a user registered with the proxy server.
NEGOTIATE The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE Do not set the ProxyPassword connection property.

Note: The connector only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the connector instead uses the username specified in your system proxy settings.

CData Python Connector for PayPal

ProxyPassword

Specifies the password of the user specified in the ProxyUser connection property.

Data Type

string

Default Value

""

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyPassword
BASIC The password associated with the proxy server user specified in ProxyUser.
DIGEST The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE The password associated with the Windows user account specified in ProxyUser.
NTLM The password associated with the Windows user account specified in ProxyUser.
NONE Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

Note: The connector only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the connector instead uses the password specified in your system proxy settings.

CData Python Connector for PayPal

ProxySSLType

Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Possible Values

AUTO, ALWAYS, NEVER, TUNNEL

Data Type

string

Default Value

"AUTO"

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTODefault setting. If ProxyServer is set to an HTTPS URL, the connector uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

CData Python Connector for PayPal

ProxyExceptions

Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Data Type

string

Default Value

""

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note: The connector uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

CData Python Connector for PayPal

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.


PropertyDescription
LogfileSpecifies the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details.
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
MaxLogFileSizeSpecifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name.
MaxLogFileCountSpecifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one.
CData Python Connector for PayPal

Logfile

Specifies the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details.

Data Type

string

Default Value

""

Remarks

This property specifies the location and name of the log file where the connector records its operations, including authentication events, query execution, and connection details. If the specified file does not exist, the connector creates it. Ensure that the user or the service running the connector has write access to the specified path or file. Without sufficient permissions, the log file is not created.

Sensitive information from the connection string, such as passwords and tokens, is automatically masked in the logs. However, sensitive information present in the data itself may not be masked.

If you specify a relative path for Logfile, and if the Location property is set, that directory is used as the base path for the log file.

Additional properties allow you to customize logging behavior:

CData Python Connector for PayPal

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the connector includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

CData Python Connector for PayPal

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Data Type

string

Default Value

""

Remarks

The connector writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual connector operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the connector to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:

Module Name Module Description Submodules
INFO General Information. Includes the connection string, product version (build number), and initial connection messages.
  • Connec – Information related to creating or destroying connections.
  • Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
EXEC Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.
  • Messag – Messages pertaining to query execution. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance.
  • Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user).
  • Page – Messages related to query paging.
  • Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.
  • KERB – HTTP requests related to Kerberos.
  • Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product.
  • Res – Messages containing HTTP responses.
  • Req – Messages containing HTTP requests.
WSDL Messages pertaining to the generation of WSDL/XSD files.
SSL SSL certificate messages.
  • Certif – Messages pertaining to SSL certificates.
AUTH Authentication related failure/success messages.
  • Messag – Messages pertaining to authentication. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • OAuth – Messages related to OAuth authentication.
  • Krbros – Kerberos-related authentication messages.
SQL Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.
  • Bulk – Messages pertaining to bulk query execution.
  • Cache – Messages related to reading row data from and writing row data to the product's cache for better performance.
  • Messag – Messages pertaining to SQL transactions. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
  • ResSet – Query resultsets.
  • Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META Metadata cache and schema messages.
  • Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance.
  • Schema – Messages related to retrieving metadata from or modifying the service schema.
  • MemSto – Messages related to writing to or reading from in-memory metadata cache.
  • Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC Information related to executing SQL functions.
  • Errmsg – Error messages related to executing SQL functions.
TCP Incoming and outgoing raw bytes on TCP transport layer messages.
  • Send – Raw data sent via the TCP protocol.
  • Receiv – Raw data received via the TCP protocol.
FTP Messages pertaining to the File Transfer Protocol.
  • Info – Status messages related to communication in the FTP protocol.
  • Client – Messages related to actions taken by the FTP client (the product) during FTP communication.
  • Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP Messages pertaining to the Secure File Transfer Protocol.
  • Info – Status messages related to communication in the SFTP protocol.
  • To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication.
  • From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP Messages pertaining to data transferred via the Post Office Protocol.
  • Client – Messages related to actions taken by the POP client (the product) during POP communication.
  • Server – Messages related to actions taken by the POP server during POP communication.
  • Status – Status messages related to communication in the POP protocol.
SMTP Messages pertaining to data transferred via the Simple Mail Transfer Protocol.
  • Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication.
  • Server – Messages related to actions taken by the SMTP server during SMTP communication.
  • Status – Status messages related to communication in the SMTP protocol.
CORE Messages relating to various internal product operations not covered by other modules.
DEMN Messages related to SQL remoting.
CLJB Messages about bulk data uploads (cloud job).
  • Commit – Submissions for bulk data uploads.
SRCE Miscellaneous messages produced by the product that don't belong in any other module.
TRANCE Advanced messages concerning low-level product operations.

CData Python Connector for PayPal

MaxLogFileSize

Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name.

Data Type

string

Default Value

"100MB"

Remarks

For values lower than 100 KB, the connector uses 100 KB as the minimum allowable size.

To control the total number of log files retained, use the MaxLogFileCount property in conjunction with this property. Together, these properties allow you to manage the size and retention of log files effectively.

CData Python Connector for PayPal

MaxLogFileCount

Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one.

Data Type

int

Default Value

-1

Remarks

Each log file name includes the date and time for easier identification.

This property accepts the following values:

  • A value of 2 or higher sets the maximum number of log files retained.
  • A value of 1 retains only one log file. When it reaches the maximum size, the file is deleted and replaced by a new one, leaving no history beyond the current log.
  • A value of 0 or negative indicates no limit on the number of log files, and logging continues indefinitely.

To manage log file size, use the MaxLogFileSize property. The two properties work together to control the size and retention of log files in the logging folder.

CData Python Connector for PayPal

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
SchemaThe type of schema to use.
CData Python Connector for PayPal

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Data Type

string

Default Value

"%APPDATA%\\CData\\PayPal Data Provider\\Schema"

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

Note: Since this connector supports multiple schemas, custom schema files for PayPal should be structured such that:

  • Each schema should have its own folder, named for that schema.
  • All schema folders should be contained in a parent folder.

Location should always be set to the parent folder, and not to an individual schema's folder.

If left unspecified, the default location is %APPDATA%\\CData\\PayPal Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

CData Python Connector for PayPal

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

CData Python Connector for PayPal

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Data Type

string

Default Value

""

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

CData Python Connector for PayPal

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Data Type

string

Default Value

""

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

CData Python Connector for PayPal

Schema

The type of schema to use.

Possible Values

REST, SOAP

Data Type

string

Default Value

"REST"

Remarks

The schemas available are REST (to use the REST API) and SOAP (to use the Classic API).

Note: The SOAP API is DEPRECATED. Use the REST API instead for better access to resources.

CData Python Connector for PayPal

Caching

This section provides a complete list of the Caching properties you can configure in the connection string for this provider.


PropertyDescription
AutoCacheSpecifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database.
CacheProviderThe namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations.
CacheDriverThe driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations.
CacheConnectionSpecifies the connection string for the specified cache database.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceNotes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True.
OfflineGets the data from the specified cache database instead of live PayPal data.
CacheMetadataDetermines whether the provider caches table metadata to a file-based cache database.
CData Python Connector for PayPal

AutoCache

Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database.

Data Type

bool

Default Value

false

Remarks

When this connection property is set to True, the connector automatically caches the contents of tables targeted by SELECT queries. The content of these tables is cached to the cache database specified by the CacheConnection and CacheProvider connection properties.

See Also

For additional information, see:

  • CacheMetadata: With CacheMetadata enabled, all retrieved metadata is mirrored in the cache database. This means that any subsequent attempts by the connector to discover metadata are much faster, as this metadata is then read directly from the cache database, without needing to spend time requesting metadata from PayPal.
  • Explicitly Caching Data: This topic provides examples for using AutoCache in Offline mode.
  • CACHE Statements: You can use the CACHE statement to explicitly cache the content of any table targeted by a SELECT query.

CData Python Connector for PayPal

CacheProvider

The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations.

Data Type

string

Default Value

""

Remarks

You can cache to ADO.NET providers saved in your ADO.NET global assembly cache (GAC).

CData ADO.NET providers automatically register themselves with the GAC during installation, so you don't need to do so manually.

Third-party ADO.NET providers may or may not automatically register themselves with the GAC during installation. If you want to cache to a third-party ADO.NET provider, consult the documentation for that provider to determine what steps (if any) you must take to register them with the GAC. Once they have been registered, you can supply their namespace in this connection property.

You must also set the CacheConnection connection property to provide a connection string for the specified ADO.NET provider.

The following sections show connection examples and address other requirements for several popular database providers. Refer to CacheConnection for more information on typical connection properties.

SQLite

You can use the Microsoft ADO.NET Provider for SQLite to cache to SQLite databases.

CacheProvider=Microsoft.Data.Sqlite;CacheConnection='DataSource=C:\\Users\\Public\\cache.db;'Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;

MySQL

To cache to MySQL, you can use the CData ADO.NET Provider for MySQL:
Cache Provider=System.Data.CData.MySQL;Cache Connection='Server=localhost;Port=3306;Database=cache;User=root;Password=123456';User=myUser;Password=myPassword;Security Token=myToken;

SQL Server

You can use the Microsoft .NET Framework Provider for SQL Server, included in the .NET Framework, to cache to SQL Server:

Cache Provider=System.Data.SqlClient;Cache Connection="Server=MyMACHINE\MyInstance;Database=SQLCACHE;User Id=root;Password=admin";Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;

Oracle

To cache to Oracle, you can use the Oracle Data Provider for .NET, as shown in the following example:

Cache Provider=Oracle.DataAccess.Client;Cache Connection='User Id=scott;Password=tiger;Data Source=ORCL';Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;

The Oracle Data Provider for .NET also requires the Oracle Database Client. When you download the Oracle Database Client, ensure that its bitness matches the bitness of your machine. When you install, select either the Runtime or Administrator installation type. The Instant Client is not sufficient.

PostgreSQL

To cache to PostgreSQL, you can use the CData ADO.NET Provider for PostgreSQL:
Cache Provider=System.Data.CData.PostgreSQL;Cache Connection='Server=localhost;Port=5432;Database=cache;User=postgres;Password=123456';User=myUser;Password=myPassword;Security Token=myToken;

CData Python Connector for PayPal

CacheDriver

The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations.

Data Type

string

Default Value

""

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

Note: You must add the JAR file of the specified JDBC driver to the classpath. For CData JDBC drivers, you can find this JAR file in the "lib" subfolder of that driver's installation directory.

You must also set the CacheConnection connection property to provide a connection string for the specified JDBC driver.

For Linux systems and macOS, you need to create a config.ini file on the installation path of the driver (site-packages/cdata). The config.ini file has the following format (the driver and the path of the JDBC driver):

[salesforce.cpython-38-x86_64-linux-gnu.so]
CLASSPATH = /home/usrname/Downloads/lib/cdata.jdbc.postgresql.jar

Examples

The following examples show how to cache to several major databases. For more information on the JDBC URL syntax and typical connection properties, see CacheConnection.

Derby and Java DB

Java DB is the Oracle distribution of Derby. You must add the Derby JDBC driver's JAR file, derbytools.jar, to your classpath to cache to Java DB.

The Derby JDBC driver's JAR file is bundled in db-derby-10.17.1.0-bin.zip, which you can download from this page. You can find derbytools.jar in the "lib" subfolder of this zip file.

After adding derbytools.jar to the classpath, you can cache to a Java DB database as follows:

jdbc:paypal:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:sample';Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;
To cache to an in-memory database, use a JDBC URL like the following:
jdbc:paypal:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;

SQLite

The following is a JDBC URL for the SQLite JDBC driver:

jdbc:paypal:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;

MySQL

The following is a JDBC URL for the CData JDBC Driver for MySQL:

  jdbc:paypal:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;
  

SQL Server

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:paypal:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;

Oracle

The following is a JDBC URL for the Oracle Thin Client:

jdbc:paypal:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;
NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .

PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:paypal:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;

CData Python Connector for PayPal

CacheConnection

Specifies the connection string for the specified cache database.

Data Type

string

Default Value

""

Remarks

The target cache database is determined by a combination of this connection property and the CacheProvider connection property. Both properties are required to use the specified cache database.

The connection string specified in this connection property is passed directly to the specified in the CacheProvider connection property. Consult the documentation for the specified for more information on its available connection properties.

Examples of common cache database settings can be found below.

SQLite

MySQL

The following are typical connection properties:

  • Server: The IP address or domain name of the server hosting the MySQL database that you want to cache to.
  • Port: The port on the specified server where your MySQL instance is running.
  • Database: The name of the MySQL database that you want to cache to. Must match the name of a MySQL database hosted on the specified server.
  • User: The username of a user registered with the selected MySQL database.
  • Password: The password associated with the specified MySQL user.

SQL Server

The following are typical SQL Server connection properties:

  • Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, specify the host name and the instance name, separated by a backslash.
  • Port: The port on the specified server where your SQL Server instance is running.
  • Database: The name of the SQL Server database you want to cache to. Must match the name of a SQL Server database hosted on the specified server.
  • Integrated Security: To use the current Windows account for authentication, set this option to True. To authenticate with User and Password instead, set this option to False.
  • User Id: The username of a user registered with the selected SQL Server database. This property is only needed if you are not using integrated security.
  • Password: The password associated with the specified SQL Server user. This property is only needed if you are not using integrated security.

Oracle

The following are typical connection properties:

  • Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).

  • User Id: The username of a user registered with the selected Oracle database.
  • Password: The password associated with the specified Oracle user.

PostgreSQL

The following are typical connection properties:

  • Host: The address of the server hosting the PostgreSQL database.
  • Port: The port on the specified host server where your PostgreSQL database is hosted.
  • Database: The name of the PostgreSQL database you want to cache to. Must match the name of a PostgreSQL database hosted on the specified server.
  • User name: The username of a user registered with the selected PostgreSQL database.
  • Password: The password associated with the specified user.

CData Python Connector for PayPal

CacheLocation

Specifies the path to the cache when caching to a file.

Data Type

string

Default Value

"%APPDATA%\\CData\\PayPal Data Provider"

Remarks

The CacheLocation is a simple, file-based cache.

If left unspecified, the default location is %APPDATA%\\CData\\PayPal Data Provider, where %APPDATA% is set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

See Also

  • AutoCache: Set to implicitly create and maintain a cache for later offline use.
  • CacheMetadata: Set to persist the PayPal catalog in CacheLocation.

CData Python Connector for PayPal

CacheTolerance

Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True.

Data Type

int

Default Value

600

Remarks

When you execute a query for tables in the cache, the connector checks the time elapsed since the last update to the cache.

If the last update to the cache is older than the value of this connection property (measured in seconds), the connector refreshes the cache.

Otherwise, the connector returns data directly from the cache.

CData Python Connector for PayPal

Offline

Gets the data from the specified cache database instead of live PayPal data.

Data Type

bool

Default Value

false

Remarks

When this connection property is set to True, all queries execute against the cache database instead of the live PayPal data.

In this mode, some SQL operations like INSERT, UPDATE, DELETE, and CACHE are disabled.

CData Python Connector for PayPal

CacheMetadata

Determines whether the provider caches table metadata to a file-based cache database.

Data Type

bool

Default Value

false

Remarks

When this connection property is set to True, as you execute queries, table metadata in the PayPal catalog is cached to the cache database specified by CacheConnection and CacheProvider, or, if those connection properties are not set, to the user's home directory.

The location of your home directory varies by platform:

PlatformHome Directory
Windows %APPDATA%\\CData\\PayPal Data Provider
Mac ~/Library/Application Support/CData/PayPal Data Provider
Unix ~/.config/CData/PayPal Data Provider

A table's metadata is retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

When there are a large number of PayPal tables and columns for the connector to retrieve during metadata discovery, the connector may take a while to list all table metadata.

You may experience slow metadata retrieval when:

  • Your PayPal instance naturally has a large table count.
  • The connector has been configured, via its connection properties, to discover more tables than it would under its default configuration.
  • You make many short-lived connections to the connector.
With CacheMetadata enabled, all retrieved metadata is mirrored in the cache database. This means that any subsequent attempts by the connector to discover metadata are much faster, as this metadata is then read directly from the cache database, without needing to spend time requesting metadata from PayPal.

When Not to Use CacheMetadata

The connector automatically persists metadata in memory for up to an hour when you first discover the metadata for a table or view, so CacheMetadata is generally not necessary.

CacheMetadata is not ideal in scenarios where you are working with volatile metadata. The first time you query a table, the connector caches its metadata to the cache database file. This cache is not dynamically updated to reflect updates to the table schema, so you must delete and rebuild the cache database file to pick up new, changed, or deleted columns.

CData Python Connector for PayPal

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
IncludeDetailsA Boolean value indicating if you will get extra details (for example, the ShippingAddress fields when querying the Invoices table).
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
CData Python Connector for PayPal

IncludeDetails

A Boolean value indicating if you will get extra details (for example, the ShippingAddress fields when querying the Invoices table).

Data Type

bool

Default Value

false

Remarks

A Boolean value indicating if you will get extra details (for example, the ShippingAddress fields when querying the Invoices table).

CData Python Connector for PayPal

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

CData Python Connector for PayPal

Other

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Data Type

string

Default Value

""

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.

Caching Configuration

PropertyDescription
CachePartial=TrueCaches only a subset of columns, which you can specify in your query.
QueryPassthrough=TruePasses the specified query to the cache database instead of using the SQL parser of the connector.

Integration and Formatting

PropertyDescription
DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=TrueConverts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

CData Python Connector for PayPal

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the connector exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

CData Python Connector for PayPal

RTK

Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.

Data Type

string

Default Value

""

Remarks

This property is typically unnecessary, as most configurations support a standard licensing mechanism.

Warning: The value of this property takes precedence over all existing licensing information. To avoid licensing errors, ensure the provided runtime key is correct.

CData Python Connector for PayPal

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

CData Python Connector for PayPal

UserDefinedViews

Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Data Type

string

Default Value

""

Remarks

UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the connector and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Payments WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json
When you specify a view in UserDefinedViews, the connector only sees that view.

For further information, see User Defined Views.

CData Python Connector for PayPal

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

AdoptOpenJDK / Adoptium Temurin JRE 17.0.18_8

Copyright (c) Eclipse Foundation AISBL. All Rights Reserved.

Apache License, Version 2.0

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

  1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
  2. You must cause any modified files to carry prominent notices stating that You changed the files; and
  3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
  4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

Eclipse Distribution License - v 1.0

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of the Eclipse Foundation, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Eclipse Public License - v 2.0

THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS "Contribution" means:

  • a) in the case of the initial Contributor, the initial content Distributed under this Agreement, and
  • b) in the case of each subsequent Contributor:
    • i) changes to the Program, and
    • ii) additions to the Program;
    where such changes and/or additions to the Program originate from and are Distributed by that particular Contributor. A Contribution "originates" from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include changes or additions to the Program that are not Modified Works.
"Contributor" means any person or entity that Distributes the Program. "Licensed Patents" mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions Distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement or any Secondary License (as applicable), including Contributors.

"Derivative Works" shall mean any work, whether in Source Code or other form, that is based on (or derived from) the Program and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship.

"Modified Works" shall mean any work in Source Code or other form that results from an addition to, deletion from, or modification of the contents of the Program, including, for purposes of clarity any new file in Source Code form that contains any contents of the Program. Modified Works shall not include works that contain only declarations, interfaces, types, classes, structures, or files of the Program solely in each case in order to link to, bind by name, or subclass the Program or Modified Works thereof.

"Distribute" means the acts of a) distributing or b) making available in any manner that enables the transfer of a copy.

"Source Code" means the form of a Program preferred for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Secondary License" means either the GNU General Public License, Version 2.0, or any later versions of that license, including any exceptions or additional permissions as identified by the initial Contributor.

2. GRANT OF RIGHTS

  • a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, Distribute and sublicense the Contribution of such Contributor, if any, and such Derivative Works.
  • b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in Source Code or other form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
  • c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to Distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
  • d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
  • e) Notwithstanding the terms of any Secondary License, no Contributor makes additional grants to any Recipient (other than those set forth in this Agreement) as a result of such Recipient's receipt of the Program under the terms of a Secondary License (if permitted under the terms of Section 3).

3. REQUIREMENTS 3.1 If a Contributor Distributes the Program in any form, then:

  • a) the Program must also be made available as Source Code, in accordance with section 3.2, and the Contributor must accompany the Program with a statement that the Source Code for the Program is available under this Agreement, and informs Recipients how to obtain it in a reasonable manner on or through a medium customarily used for software exchange; and
  • b) the Contributor may Distribute the Program under a license different than this Agreement, provided that such license:
    • i) effectively disclaims on behalf of all other Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
    • ii) effectively excludes on behalf of all other Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
    • iii) does not attempt to limit or alter the recipients' rights in the Source Code under section 3.2; and
    • iv) requires any subsequent distribution of the Program by any party to be under a license that satisfies the requirements of this section 3.
3.2 When the Program is Distributed as Source Code:
  • a) it must be made available under this Agreement, or if the Program (i) is combined with other material in a separate file or files made available under a Secondary License, and (ii) the initial Contributor attached to the Source Code the notice described in Exhibit A of this Agreement, then the Program may be made available under the terms of such Secondary Licenses, and
  • b) a copy of this Agreement must be included with each copy of the Program.
3.3 Contributors may not remove or alter any copyright, patent, trademark, attribution notices, disclaimers of warranty, or limitations of liability (‘notices') contained within the Program from any copy of the Program which they Distribute, provided that Contributors may add their own appropriate notices.

4. COMMERCIAL DISTRIBUTION Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. The Eclipse Foundation is the initial Agreement Steward. The Eclipse Foundation may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be Distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to Distribute the Program (including its Contributions) under the new version.

Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved. Nothing in this Agreement is intended to be enforceable by any entity that is not a Contributor or Recipient. No third-party beneficiary rights are created under this Agreement.

Exhibit A – Form of Secondary Licenses Notice "This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: {name license(s), version(s), and exceptions or additional permissions here}."

Simply including a copy of this Agreement, including this Exhibit A is not sufficient to license the Source Code under Secondary Licenses.

If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice.

You may add additional accurate notices of copyright ownership.

GNU Classpath

Classpath is distributed under the terms of the GNU General Public License with the following clarification and special exception.

Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination.

As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

As such, it can be used to run, create and distribute a large class of applications and applets. When GNU Classpath is used unmodified as the core class library for a virtual machine, compiler for the java languge, or for a program written in the java programming language it does not affect the licensing for distributing those programs directly.

OpenJDK Assembly Exception

The OpenJDK source code made available by Oracle America, Inc. (Oracle) at openjdk.java.net ("OpenJDK Code") is distributed under the terms of the GNU General Public License <http://www.gnu.org/copyleft/gpl.html> version 2 only ("GPL2"), with the following clarification and special exception.

Linking this OpenJDK Code statically or dynamically with other code is making a combined work based on this library. Thus, the terms and conditions of GPL2 cover the whole combination.

As a special exception, Oracle gives you permission to link this OpenJDK Code with certain code licensed by Oracle as indicated at http://openjdk.java.net/legal/exception-modules-2007-05-08.html ("Designated Exception Modules") to produce an executable, regardless of the license terms of the Designated Exception Modules, and to copy and distribute the resulting executable under GPL2, provided that the Designated Exception Modules continue to be governed by the licenses under which they were offered by Oracle.

As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code to build an executable that includes those portions of necessary code that Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 with the Classpath exception). If you modify or add to the OpenJDK code, that new GPL2 code may still be combined with Designated Exception Modules if the new code is made subject to this exception by its copyright holder.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9655