Connection String OptionsBack To Top

User
Password
Signature
UseSandbox
InitiateOAuth
OAuthClientId
OAuthClientSecret
OAuthAccessToken
OAuthSettingsLocation
CallbackURL
OAuthVerifier
OAuthRefreshToken
OAuthExpiresIn
OAuthTokenTimestamp
SSLServerCert
FirewallType
FirewallServer
FirewallPort
FirewallUser
FirewallPassword
ProxyAutoDetect
ProxyServer
ProxyPort
ProxyAuthScheme
ProxyUser
ProxyPassword
ProxySSLType
ProxyExceptions
Logfile
Verbosity
LogModules
MaxLogFileSize
MaxLogFileCount
Location
BrowsableSchemas
Tables
Views
Schema
AutoCache
CacheDriver
CacheConnection
CacheLocation
CacheTolerance
Offline
CacheMetadata
BatchSize
ConnectionLifeTime
ConnectOnOpen
IncludeDetails
MaxRows
Other
PoolIdleTimeout
PoolMaxSize
PoolMinSize
PoolWaitTime
PseudoColumns
RTK
SupportEnhancedSQL
Timeout
UseConnectionPooling

User

Data Type

string

Default Value

Remarks

Together with Password, this field is used to authenticate against the PayPal server.

Password

Data Type

string

Default Value

Remarks

The User and Password are together used to authenticate with the server.

Signature

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.

UseSandbox

Data Type

bool

Default Value

false

Remarks

A Boolean value indicating if you are using a Sandbox account.

InitiateOAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the driver. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

Data Type

string

Default Value

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

Data Type

string

Default Value

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

Data Type

string

Default Value

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\PayPal Data Provider\\OAuthSettings.txt"

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes.

Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.

If left unspecified, the default location is "%APPDATA%\\CData\\PayPal Data Provider\\OAuthSettings.txt" with %APPDATA% being set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Mac	~/Library/Application Support
Linux	~/.config

CallbackURL

Data Type

string

Default Value

Remarks

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

OAuthVerifier

Data Type

string

Default Value

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See Establishing a Connection to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the driver exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

Data Type

string

Default Value

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

Data Type

string

Default Value

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

Data Type

string

Default Value

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSLServerCert

Data Type

string

Default Value

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

FirewallType

Data Type

string

Default Value

"NONE"

Remarks

This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default, the driver connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.


Type	Default Port	Description
TUNNEL	80	When this is set, the driver opens a connection to PayPal and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your 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.

FirewallServer

Data Type

string

Default Value

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

FirewallPort

Data Type

int

Default Value

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

FirewallUser

Data Type

string

Default Value

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

FirewallPassword

Data Type

string

Default Value

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

ProxyAutoDetect

Data Type

bool

Default Value

false

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

NOTE: When this property is set to True, the proxy used is determined as follows:

A search from the JVM properties (http.proxy, https.proxy, socksProxy, etc.) is performed.
In the case that the JVM properties don't exist, a search from java.home/lib/net.properties is performed.
In the case that java.net.useSystemProxies is set to True, a search from the SystemProxy is performed.
In Windows only, an attempt is made to retrieve these properties from the Internet Options in the registry.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

Data Type

string

Default Value

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

ProxyPort

Data Type

int

Default Value

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

ProxyAuthScheme

Data Type

string

Default Value

"BASIC"

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

BASIC: The driver performs HTTP BASIC authentication.
DIGEST: The driver performs HTTP DIGEST authentication.
NEGOTIATE: The driver retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
PROPRIETARY: The driver does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

Data Type

string

Default Value

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain

domain\user

ProxyPassword

Data Type

string

Default Value

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

ProxySSLType

Data Type

string

Default Value

"AUTO"

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:


AUTO	Default setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

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 that the driver uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Logfile

Data Type

string

Default Value

Remarks

Once this property is set, the driver will populate 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 will be created.

Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.

If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.

For more control over what is written to the log file, you can adjust the Verbosity property.

Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.

To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.

If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.

Java Logging

Java logging is also supported. To enable Java logging, set Logfile to:

Logfile=JAVALOG://myloggername

As in the above sample, JAVALOG:// is a required prefix to use Java logging, and you will substitute your own Logger.

The supplied Logger's getLogger method is then called, using the supplied value to create the Logger instance. If a logging instance already exists, it will reference the existing instance.

When Java logging is enabled, the Verbosity will now correspond to specific logging levels.

Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

LogModules

Data Type

string

Default Value

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

MaxLogFileSize

Data Type

string

Default Value

"100MB"

Remarks

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.

Adjust the maximum number of logfiles generated with MaxLogFileCount.

MaxLogFileCount

Data Type

int

Default Value

-1

Remarks

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.

The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Adjust the maximum size of the logfiles generated with MaxLogFileSize.

Location

Data Type

string

Default Value

"%APPDATA%\\CData\\PayPal Data Provider\\Schema"

Remarks

The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

Note: Given that this driver supports multiple schemas, the structure for PayPal custom schema files is as follows:

Each schema is given a folder corresponding to that schema name.
These schema folders are contained in a parent folder.
The parent folder should be set as the Location, not an individual schema's folder.

If left unspecified, the default location is "%APPDATA%\\CData\\PayPal Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Mac	~/Library/Application Support
Linux	~/.config

BrowsableSchemas

Data Type

string

Default Value

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

Data Type

string

Default Value

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the driver.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Data Type

string

Default Value

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the driver.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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`.

Schema

Data Type

string

Default Value

"SOAP"

Remarks

The schemas available are REST (to use the REST API) and SOAP (to use the Classic API).

AutoCache

Data Type

bool

Default Value

false

Remarks

When AutoCache = true, the driver automatically maintains a cache of your table's data in the database of your choice.

Setting the Caching Database

When AutoCache = true, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

CacheLocation: Specifies the path to the file store.
CacheDriver and CacheConnection: Specifies a driver to a database and the connection string.

CacheDriver

Data Type

string

Default Value

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.

Note that you must also add the CacheDriver JAR file to the classpath.

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR file is shipped in the JDK. You can find the JAR file, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath:

jdbc:paypal:CacheLocation='c:/Temp/cachedir';Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientId=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;

To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, 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 included 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;

CacheConnection

Data Type

string

Default Value

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properties are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.

Derby and Java DB

The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.

Alternatively, you can configure the connection to Derby manually using CacheDriver and CacheConnection. The following is the Derby JDBC URL syntax:

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]

For example, to cache to an in-memory database, use the following:

jdbc:derby:memory

SQLite

To cache to SQLite, you can use the SQLite JDBC driver. The following is the syntax of the JDBC URL:

jdbc:sqlite:dataSource

Data Source: The path to an SQLite database file. Or, use a value of :memory to cache in memory.

MySQL

The installation includes the CData JDBC Driver for MySQL. The following is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache

The following are typical connection properties:

Server: The IP address or domain name of the server you want to connect to.
Port: The port that the server is running on.
User: The user name provided for authentication to the database.
Password: The password provided for authentication to the database.
Database: The name of the database.

SQL Server

The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]

For example:

jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true

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, this property can be used to specify the host name and the instance, separated by a backslash.
Port: The port SQL Server is running on.
Database: The name of the SQL Server database.
Integrated Security: Set this option to true to use the current Windows account for authentication. Set this option to false if you are setting the User and Password in the connection.
To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.
User Id: The user name provided for authentication with SQL Server. This property is only needed if you are not using integrated security.
Password: The password provided for authentication with SQL Server. This property is only needed if you are not using integrated security.

Oracle

The following is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]

For example:

jdbc:oracle:thin:scott/tiger@myhost:1521:orcl

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).
Password: The password provided for authentication with the Oracle database.
User Id: The user Id provided for authentication with the Oracle database.

PostgreSQL

The following is the JDBC URL syntax for the official PostgreSQL JDBC driver:

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]

For example, the following connection string connects to a database on the default host (localhost) and port (5432):

jdbc:postgresql:postgres

The following are typical connection properties:

Host: The address of the server hosting the PostgreSQL database.
Port: The port used to connect to the server hosting the PostgreSQL database.
Database: The name of the database.
User name: The user Id provided for authentication with the PostgreSQL database. You can specify this in the JDBC URL with the "user" parameter.
Password: The password provided for authentication with the PostgreSQL database.

CacheLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\PayPal Data Provider"

Remarks

The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR file to the classpath. The JAR file, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

If left unspecified, the default location is "%APPDATA%\\CData\\PayPal Data Provider" with %APPDATA% being set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Mac	~/Library/Application Support
Linux	~/.config

CacheTolerance

Data Type

int

Default Value

600

Remarks

The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.

Offline

Data Type

bool

Default Value

false

Remarks

When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.

CacheMetadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the PayPal catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.

When Not to Use CacheMetadata

When you are working with volatile metadata: Metadata for a table is only retrieved the first time the connection to the table is made. To pick up new, changed, or deleted columns, you would need to delete and rebuild the metadata cache. Therefore, it is best to rely on the in-memory caching for cases where metadata changes often.
When you are caching to a database: CacheMetadata can only be used with CacheLocation. If you are caching to another database with the CacheDriver and CacheConnection properties, use AutoCache to cache implicitly. Or, use CACHE Statements to cache explicitly.

BatchSize

Data Type

int

Default Value

Remarks

When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.

Setting BatchSize to 0 will submit the entire batch as specified.

ConnectionLifeTime

Data Type

int

Default Value

Remarks

The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.

ConnectOnOpen

Data Type

bool

Default Value

false

Remarks

When set to true, a connection will be made to PayPal when the connection is opened. This property enables the Test Connection feature available in various database tools.

This feature acts as a NOOP command as it is used to verify a connection can be made to PayPal and nothing from this initial connection is maintained.

Setting this property to false may provide performance improvements (depending upon the number of times a connection is opened).

IncludeDetails

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).

MaxRows

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other

Data Type

string

Default Value

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Caching Configuration


CachePartial=True	Caches only a subset of columns, which you can specify in your query.
QueryPassthrough=True	Passes the specified query to the cache database instead of using the SQL parser of the driver.

Integration and Formatting


DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

PoolIdleTimeout

Data Type

int

Default Value

Remarks

The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.

PoolMaxSize

Data Type

int

Default Value

100

Remarks

The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.

PoolMinSize

Data Type

int

Default Value

Remarks

The minimum number of connections in the pool. The default is 1.

PoolWaitTime

Data Type

int

Default Value

Remarks

The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.

PseudoColumns

Data Type

string

Default Value

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

RTK

Data Type

string

Default Value

Remarks

The RTK property may be used to license a build. See the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

SupportEnhancedSQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL = true, the driver offloads as much of the SELECT statement processing as possible to PayPal and then processes the rest of the query in memory. In this way, the driver can execute unsupported predicates, joins, and aggregation.

When SupportEnhancedSQL = false, the driver limits SQL execution to what is supported by the PayPal API.

Execution of Predicates

The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.

Execution of Joins

The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.

Execution of Aggregates

The driver retrieves all rows necessary to process the aggregation in memory.

Timeout

Data Type

int

Default Value

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the driver throws an exception.

UseConnectionPooling

Data Type

bool

Default Value

false

Remarks

This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.

ViewsBack To Top

AuthorizationDetails
CaptureDetails
CreditCardDetails
DisputeDetails
Disputes
DisputeTransactions
Invoices
Notifications
OrderDetails
OrderItems
Payments
PaymentTransactions
PayoutDetails
PayoutItems
Plans
RefundDetails
SaleDetails
Subscriptions
SubscriptionTransactions
Webhooks

AuthorizationDetails

Query details about Authorizations.

Table Specific Information

Select

The only filter supported by the PayPal API is Id, which is required. The driver processes other filters client side within the driver.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side and 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.
StatusDetails	String		The details of the authorized order pending status.
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.
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.

CaptureDetails

Query details about a captured Payment.

Table Specific Information

Select

The only filter supported by the PayPal API is Id, which is required. The driver processes other filters client side within the driver.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side and 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.
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.
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.
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.
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.

CreditCardDetails

Query details about the funding instrument of the payer, such as a Credit Card or a token that represents a Credit Card.

Table 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 driver processes other filters client side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side.

The following query retrieves details for a specific Credit Card:

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 card. Line 1 of the address (e.g., number, street, etc.).
AddressLine2	String		The optional line 2 of the Address (e.g., suite, apt number, etc.).
City	String		The city name.
CountryCode	String		The 2-letter country code.
PostalCode	String		The ZIP code or equivalent is usually required for countries that have them.
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 (e.g., 1994-11-05T13:15:30Z).
UpdateTime	Datetime		The resource update time in ISO8601 date-time format (e.g., 1994-11-05T13:15:30Z).
State	String		The state of the credit card funding instrument: expired or ok.
ValidUntil	Datetime		The funding instrument expiration date.

DisputeDetails

PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes.

Table Specific Information

Select

This view returns a list of disputes with detailed information for the authenticated user.

The following filters are supported by the PayPal API:

DisputeId

The driver processes other filters client side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side.

The following query retrieves 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 the evidences.
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.

Disputes

PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes.

Table Specific Information

Select

This view returns a list of disputes for the authenticated user.

The following filters are supported by the PayPal API:

DisputeId
DisputeState
CreateTime

The CreateTime filter supports the >, >=, <, <=, and = operators, while the other filters only support the = operator.

The driver processes other filters client side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side.

The following query retrieves details for a specific dispute:
```
SELECT * FROM Disputes WHERE DisputeId = 'PP-D-12345'
```
The following query returns details for 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.

DisputeTransactions

PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes.

Table 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 driver processes other filters client side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed 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.

Invoices

Query Invoices in PayPal.

Table Specific Information

Select

The only filter supported by the PayPal API is Id. Server-side processing is only supported for the '=' operator.

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

The driver processes other filters client side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the invoice.
ParentId	String		The parent ID to an invoice that defines the group invoice to which the invoice is related.
Status	String		The status of the invoice.
Reference	String		The reference data. Includes a post office (PO) number.
Currency	String		The three-character ISO-4217 currency code that identifies the currency.
Note	String		A note to the invoice recipient. Also appears on the invoice notification email.
TermsAndConditions	String		The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.
Memo	String		A private bookkeeping memo for the user.
InvoiceDate	Datetime		The invoice date as specificed by the sender, in Internet date and time format.
InvoiceNumber	String		A private bookkeeping memo for the user.
TermType	String		The payment term. Payment can be due upon receipt, a specified date, or in a set number of days.
DueDate	Datetime		The date when the invoice payment is due, in Internet date and time format.
DueAmount	Decimal		The due amount, which is the balance amount outstanding after payments.
Gratuity	Decimal		The amount paid by the payer as gratuity to the invoicer.
PaidAmount	Decimal		The aggregated payment amounts against this invoice.
RefundAmount	Decimal		The aggregated refund amounts.
CreatedTime	Datetime		The date and time when the resource was created, in Internet date and time format.
CreatedBy	String		The email address of the account that created the resource.
LastUpdatedTime	Datetime		The date and time when the resource was last edited, in Internet date and time format.
LastUpdatedBy	String		The email address of the account that last edited the resource.
CancelTime	Datetime		The date and time when the resource was canceled, in Internet date and time format.
CancelledBy	String		The actor who canceled the resource.
FirstSentTime	Datetime		The date and time when the resource was first sent, in Internet date and time format.
LastSentTime	Datetime		The date and time when the resource was last sent, in Internet date and time format.
LastSentBy	String		The email address of the account that last sent the resource.
CreatedByFlow	String		The flow variation that created this invoice.
RecipientViewUrl	String		The URL for the invoice payer view hosted on paypal.com.
InvoicerViewUrl	String		The URL for the invoice merchant view hosted on paypal.com.
InvoicerBusinessName	String		The business name of the party.
InvoicerPrefixName	String		The prefix, or title, to the party's name.
InvoicerFirstName	String		When the party is a person, the party's given, or first, name.
InvoicerMiddleName	String		When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
InvoicerLastName	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.
InvoicerSuffixName	String		The suffix for the party's name.
InvoicerFullName	String		When the party is a person, the party's full name.
InvoicerAddressLine1	String		The first line of the address. For example, number or street.
InvoicerAddressLine2	String		The second line of the address. For example, suite or apartment number.
InvoicerAddressLine3	String		The third line of the address, if needed.
InvoicerAddressPostalCode	String		The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
InvoicerAddressCountryCode	String		The two-character ISO 3166-1 code that identifies the country or region.
InvoicerAddressStreetNumber	String		The street number.
InvoicerAddressStreetName	String		The street name. Just Drury in Drury Lane.
InvoicerAddressStreetType	String		The street type. For example, avenue, boulevard, road, or expressway.
InvoicerAddressDeliveryService	String		The delivery service. Post office box, bag number, or post office name.
InvoicerAddressBuildingName	String		A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number.
InvoicerAddressSubBuilding	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.
InvoicerEmail	String		The invoicer email address, which must be listed in the user's PayPal profile.
InvoicerWebsite	String		The invoicer's website.
InvoicerTaxId	String		The invoicer's tax ID.
InvoicerAdditionalNotes	String		Any additional information. Includes business hours.
InvoicerLogoUrl	String		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		Indicates whether the tax is calculated before or after a discount.
TaxInclusive	Boolean		Indicates whether the unit price includes tax.
AllowTip	Boolean		Indicates whether the invoice enables the customer to enter a tip amount during payment.
TemplateId	String		The template ID. The template determines the layout of the invoice. Includes which fields to show and hide.
AllowPartialPayment	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.
MinimumAmountDue	String		The minimum amount allowed for a partial payment. Valid only when allow_partial_payment is true.
InvoiceAmount	Decimal		The invoice amount summary of item total, discount, tax total and shipping.
InvoiceCurrency	String		The invoice amount summary of item total, discount, tax total and shipping.
ItemTotal	Decimal		The subtotal for all items. Must equal the sum of (quantity * price) for all items.
InvoiceDiscountPercentage	String		The discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
InvoiceDiscountValue	Decimal		The invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places.
ItemDiscountValue	Decimal		The discount as an amount at item level.
TaxTotal	Decimal		The aggregated amount of the item and shipping taxes.
ShippingAmount	Decimal		The shipping fee for all items. Includes tax on shipping.
ShippingTaxAmount	Decimal		The calculated tax amount. The tax amount is added to the item total.
ShippingTaxPercentage	String		The tax rate. Value is from 0 to 100. Supports up to five decimal places.
ShippingTaxName	String		The name of the tax applied on the invoice items.

Notifications

Query the list of event types that are subscribed to a Webhook.

Table Specific Information

Select

The only filter supported by the PayPal API is WebhookId, which only supports the = operator. This is a required parameter.The driver processes other filters client side within the driver.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following query is processed server side and retrieves 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.

OrderDetails

Query details about an Order.

Table Specific Information

Select

Note: PayPal REST API does not give us a way to list all OrderId-s, so you must specify it. If you need such use case, it's recommended to use the Transactions and TransactionDetails views in SOAP schema.
The only filter supported by the PayPal API is Id, which is required. The driver processes other filters client side within the driver.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

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		The ID of the customer who approves and pays for the order. The customer is also known as the payer.
PayerGivenName	String		The name of the customer who approves and pays for the order. The customer is also known as the payer.
PayerSurname	String		The last name of the customer who approves and pays for the order. The customer is also known as the payer.
PayerEmail	String		The email of the customer who approves and pays for the order. The customer is also known as the payer.
PayerPhoneType	String		The phone type.
PayerPhoneNumber	String		The phone number, in its canonical international E.164 numbering plan format.
PayerBirthDate	String		The birth date of the payer in YYYY-MM-DD format.
PayerTaxId	String		The customer's tax ID. Supported for the PayPal payment method only.
PayerTaxType	String		The customer's tax ID type. Supported for the PayPal payment method only.
PayerAddressLine1	String		The first line of the address. For example, number or street.
PayerAddressLine2	String		The second line of the address. For example, suite or apartment number.
PayerAddressPostalCode	String		The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PayerAddressCountryCode	String		The two-character ISO 3166-1 code that identifies the country or region.

OrderItems

Get the items in an Order.

Table Specific Information

Select

Note: PayPal REST API does not give us a way to list all OrderId-s, so you must specify it. If you need such use case, it's recommended to use the Transactions and TransactionItems views in SOAP schema.
The only filter supported by the PayPal API is OrderId, which is required. The driver processes other filters client side within the driver.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side and 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 merchant.
PayeeMerchantId	String		The encrypted PayPal account ID of the merchant.
DisbursementMode	String		The funds that are held on behalf of the merchant.

Payments

Query details about authorized Payments.

Table Specific Information

Select

The only supported filters are Id and OrderId. Filters only supports the = operator The driver processes other filters client side within the driver.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following query is processed server side and retrieves 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. For information, see create web 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 he or she approves the payment. Required for PayPal account payments.
CancelUrl	String		The URL where the payer is redirected after he or she cancels 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.

PaymentTransactions

Query Transaction details including the amount and item details.

Table Specific Information

Select

The only filter supported by the PayPal API is PaymentId, which is required. The driver processes other filters client side within the driver.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side and 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.

PayoutDetails

Retrieve details about Payouts.

Table Specific Information

Select

The only filter supported by the PayPal API is PayoutBatchId, which is required. The driver processes other filters client side within the driver.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following query is processed server side and retrieves 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.

PayoutItems

Retrieve payout items from a Payout.

Table Specific Information

Select

The only filter supported by the PayPal API is PayoutBatchId, which is required. The driver processes other filters client side within the driver.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following query is processed server side and retrieves all payout items for a specific Payout.

SELECT * FROM PayoutItems WHERE PayoutBatchId = 'HSY55UPD25KF2'

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.

Plans

List the Billing Plans.

Table Specific Information

Select

This view returns a list of subscription plans for the authenticated user.

The following filters are supported by the PayPal API:

Id
ProductId

SELECT * FROM Plans

SELECT * FROM Plans WHERE Id='1234'

SELECT * FROM Plans WHERE ProductId='1234'

The driver processes other filters client side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

Columns


Name	Type	References	Description
Id [KEY]	String		The unique PayPal-generated ID for the plan.
CreateTime	Datetime		The date and time when the plan was created
Description	String		The detailed description of the plan.
BillingCyclesVersion	Integer		The active pricing scheme for this billing cycle.
BillingCyclesPricingModel	String		The active pricing scheme for this billing cycle.
BillingCyclesFrequency	String		The frequency details for this billing cycle.
BillingCyclesTenureType	String		The tenure type of the billing cycle.
BillingCyclesSequence	Integer		The order in which this cycle is to run among other billing cycles.
BillingCyclesTotalCycles	Integer		The number of times this billing cycle gets executed.
Links	String		contains the link of plan object
Name	String		The plan name.
ProductId	String		The ID for the product.
QuantitySupported	Boolean		Indicates whether you can subscribe to this plan by providing a quantity for the goods or service..
Status	String		The plan status.
TaxesInclusive	Boolean		Indicates whether the tax was already included in the billing amount.
TaxesPercentage	String		The tax percentage on the billing amount.
UpdateTime	Datetime		The date and time when the plan was last updated.

RefundDetails

Query details about a specific Refund.

Table Specific Information

Select

The only filter supported by the PayPal API is Id, which is required. The driver processes other filters client side within the driver.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side and 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.
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.

SaleDetails

Query details about a Sale Transaction.

Table Specific Information

Select

The only filter supported by the PayPal API is Id, which is required. The driver processes other filters client side within the driver.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

For example, the following queries are processed server side and 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.

Subscriptions

Get billing and subscription details.

Table Specific Information

Select

The only filter supported by the PayPal API is Id, which is required. The driver processes other filters client side within the driver.

SELECT * FROM Subscriptions WHERE Id='1234'

NOTE: We can get get the SubscriptionId by creating the subscription using CreateSubscription Stored procedure.

The driver processes other filters client side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

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 Failed payments count.
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 of subscription 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.
StatusUpdateTime	Datetime		The date and time of status updated.
SubscriberEmailAddress	String		The email address of the payer.
SubscriberName_GivenName	String		The given name of the payer.
SubscriberName_Surname	String		The sur name 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 of subscription updated.

SubscriptionTransactions

Lists transactions for a subscription.

Table 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: 1. SubscriptionId, StartTime and EndTime are the required parameters for this view and if StartTIme and EndTime are not specified in the query the default values will be assigned from the code. 2. We can get get the SubscriptionId by creating the subscription using CreateSubscription Stored procedure.

The driver processes other filters client side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

Columns


Name	Type	References	Description
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.
Time	Datetime		The date and time when the transaction was processed.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are 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.

Webhooks

Query the list of Webhooks.

Table Specific Information

Select

The PayPal API does not support any filters on this table. However, projections are supported. All filters are processed client side within the driver.

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false.

Columns


Name	Type	References	Description
Id [KEY]	String		The identifier of the webhook resource.
Url	String		The webhook notification endpoint URL.

Matillion Data Model for PayPalVersion - 21.0.8137.0

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Authentication on Headless Machines

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Matillion Data Model for PayPal
Version - 21.0.8137.0