PayPal Data Model

Connection String Options

  1. Auto Cache
  2. Cache Connection
  3. Cache Driver
  4. Cache Location
  5. Cache Metadata
  6. Cache Query Result
  7. Callback URL
  8. Connect On Open
  9. Firewall Password
  10. Firewall Port
  11. Firewall Server
  12. Firewall Type
  13. Firewall User
  14. Initiate OAuth
  15. Location
  16. Logfile
  17. Max Log File Size
  18. OAuth Access Token
  19. OAuth Client Id
  20. OAuth Client Secret
  21. OAuth Refresh Token
  22. OAuth Settings Location
  23. Offline
  24. Other
  25. Password
  26. Proxy Auth Scheme
  27. Proxy Auto Detect
  28. Proxy Password
  29. Proxy Port
  30. Proxy Server
  31. Proxy SSL Type
  32. Proxy User
  33. Pseudo Columns
  34. Query Cache
  35. RTK
  36. Schema
  37. Signature
  38. SSL Server Cert
  39. Support Enhanced SQL
  40. Tables
  41. Timeout
  42. Username
  43. Use Sandbox
  44. Verbosity
  45. Views

Auto Cache

Data Type

bool

Default Value

false

Remarks

When AutoCache is set, the driver maintains a cache in the background. The driver can update the cache when you execute a SELECT query to the remote PayPal data.

This functionality gives you the option to query a persistent, up-to-date cache or execute real-time queries with a failover solution for connectivity loss.

Caching on Every SELECT

 

CacheQueryResult is a way to query PayPal in real time while maintaining a cache for offline use. Set CacheQueryResult to update the cache whenever you execute a SELECT statement. When you execute a SELECT statement with AutoCache and CacheQueryResult set, the driver executes the query to the remote data and persists the results; rows that already exist are overwritten. That is, SELECT statements are used to create and refresh the cache, not to query it. Data manipulation commands are executed to the remote data as well.

To query the cached data, set the Offline property. If you need to query the cached data in an online connection, you can append #CACHE to the table name. For example:

SELECT * FROM [Payments#CACHE]

 

 

Setting the Caching Database

 

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

 

 

See Also

 

 

  • Caching: Best Practices: This section provides more examples of using AutoCache with Offline, as well as information on determining a caching strategy.
  • QueryCache: In addition to backup, you can also use a local copy of data as a shortcut that minimizes network transit.

    When this property is set, the driver builds a temporary, in-memory dataset that caches the results of the queries you execute. Result sets for subsequent queries are extracted from this dataset, if possible.

    This property is useful in BI, analytics, and other tools that generate queries for you. In these tools, explicit cache queries with the #CACHE syntax may not be an option.

  • CacheMetadata: This property reduces the amount of metadata that crosses the network by persisting table schemas retrieved from the PayPal metadata. Metadata then needs to be retrieved only once instead of every connection.
  • CACHE Statements: You can use the CACHE statement to persist any SELECT query, as well as manage the cache; for example, refreshing schemas.

 

 

 

Cache Connection

Data Type

string

Default Value

""

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. You will need at least the following information to connect to one of the caching databases below. To load the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. The documentation for the underlying JDBC driver will have all of the available properties.

 

Derby and Java DB

 

In most caching scenarios, you need to set only the following:

 

For other Java DB configurations, you will need to use CacheDriver and CacheConnection. Below 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. Below 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. Below is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
Below 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 username 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
Below are typical SQL Server connection properties:
  • Port: The port SQL Server is running on.
  • 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.
  • Database: The name of the SQL Server database.
  • Integrated Security: Set this option to true to use Windows authentication. Set this option to false to use forms-based authentication.

    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: The username provided for authentication with SQL Server, if you are using forms authentication.
  • Password: The password provided for authentication with SQL Server, if you are using forms authentication.
Oracle

 

Below 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
Below 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

 

Below 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
Below 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.
  • Username: 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.

 

 

Cache Driver

Data Type

string

Default Value

""

Remarks

You can cache to any database that you have a JDBC driver for, 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 would like to use to cache data.

Note that you must also add the CacheDriver JAR 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 Java DB configuration. Java DB is the Oracle distribution of Derby. The JAR is shipped in the JDK. You can find the JAR, 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 Java DB JDBC URL, use CacheProvider 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

 

Below 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

 

Below 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;
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for PayPal 2016 installation directory.
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

 

Below is a JDBC URL for the Oracle Thin Client:

jdbc:paypal:Cache Driver=oracle.jdbc.driver.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientID=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;
PostgreSQL

 

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:paypal:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';Schema=REST;InitiateOAuth=GETANDREFRESH;OAuthClientID=ClientId;OAuthClientSecret=ClientSecret; UseSandbox=true;

 

 

Cache Location

Data Type

string

Default Value

""

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 to the classpath. The JAR, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

CacheLocation defaults to the directory specified by the Location setting.

See Also

 

 

  • AutoCache: Set this to implicitly create and maintain a cache for later offline use.
  • QueryCache: Set this to use a temporary, in-memory cache.
  • CacheMetadata: Set this to persist the PayPal catalog in CacheLocation.

 

 

Cache Metadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, the relevant system tables in the PayPal catalog are cached to the file store specified by CacheLocation.

Setting CacheMetadata and CacheLocation will retrieve metadata only once over multiple connections. For example, metadata will be retrieved only when a connection pool is initialized.

When to Use CacheMetadata

 

The driver automatically caches metadata in memory when you open a connection, so within the same connection schema discovery is only expensive on the first query. QueryCache only becomes useful when retrieving the system catalog on every connection open becomes expensive. For example, when you are working with large amounts of metadata or when you have many simultaneous, short-lived connections.

When Not to Use CacheMetadata

 

 

  • When you are working with volatile metadata: To pick up new, changed, or deleted columns, you need to delete and rebuild the metadata cache. In this case, if the default in-memory cache is insufficient, consider a caching solution that will allow you to maintain the cache with CACHE Statements statements. See Caching Data for more information on selecting a caching solution.
  • 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.

 

 

Cache Query Result

Data Type

bool

Default Value

false

Remarks

When CacheQueryResult and AutoCache is set, the entire result of every SELECT query is cached in the cache database. Note that the performance can be significantly impacted when using AutoCache when the PayPal API does not support the REPLICATE Statements statement.

 

Callback URL

Data Type

string

Default Value

""

Remarks

This value is the URL that PayPal redirects to during the authentication process.

 

Connect On Open

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

 

Firewall Password

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.

 

Firewall Port

Data Type

string

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.

 

Firewall Server

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.

 

Firewall Type

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.

 

 

Firewall User

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 type specified in FirewallType.

 

Initiate OAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. 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.
  3. 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.

 

 

Location

Data Type

string

Default Value

""

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 Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files used in your application must be deployed with other assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

 

Logfile

Data Type

string

Default Value

""

Remarks

For more control over what is written to the log file, take a look at Verbosity.

 

Max Log File Size

Data Type

string

Default Value

""

Remarks

A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. There is no limit by default. Values lower than 100kB will use 100kB as the value instead.

 

OAuth Access Token

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 username and password. The access token protects your credentials by keeping them on the server.

 

OAuth Client Id

Data Type

string

Default Value

""

Remarks

OAuth requires you to register your application. As part of the registration, you will receive a client Id, sometimes also called a consumer key, and a client secret. You must specify both the OAuthClientId and OAuthClientSecret to connect to an OAuth server.

 

OAuth Client Secret

Data Type

string

Default Value

""

Remarks

OAuth requires you to register your application. As part of the registration you will receive a client Id and a client secret, sometimes also called a consumer secret. You must specify both the OAuthClientId and OAuthClientSecret to connect to an OAuth server.

 

OAuth Refresh Token

Data Type

string

Default Value

""

Remarks

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

 

OAuth Settings Location

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 a settings file to avoid requiring the user to manually enter OAuth connection properties. The default OAuthSettingsLocation is a settings file located in the %AppData%\CData folder.

This property is useful for connecting to multiple PayPal accounts at once: Set OAuthSettingsLocation to a file unique to the connection.

 

Offline

Data Type

bool

Default Value

false

Remarks

When Offline is set to 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.

 

Other

Data Type

string

Default Value

""

Remarks

The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.

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

 

   
SupportAccessLinkedMode In Access' linked mode, it is generally a good idea to always use a cache as most data sources do not support multiple Id queries. However if you want to use the driver in Access but not in linked mode, this property must be set to False to avoid using a cache of a SELECT * query for the given table.
ConvertDateTimeToGMT 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.
ClientCulture This property can be used to specify the format of data (e.g., currency values) that is accepted by the client application. This property can be used when the client application does not support the machine's culture settings. For example, Microsoft Access requires 'en-US'.
Culture This setting can be used to specify culture settings that determine how the driver interprets certain data types that are passed into the driver. For example, setting Culture='de-DE' will output German formats even on an American machine.

 

 

Password

Data Type

string

Default Value

""

Remarks

The password required to use the SOAP API. Along with Password, Username and Signature are required to access the Transaction and TransactionDetails views.

 

Proxy Auth Scheme

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.

 

 

Proxy Auto Detect

Data Type

bool

Default Value

true

Remarks

By default, the driver uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see ProxyServer.

For other proxies, such as SOCKS or tunneling, see FirewallType.

 

Proxy Password

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.

 

Proxy Port

Data Type

string

Default Value

"80"

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.

 

Proxy Server

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.

 

Proxy SSL Type

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.

 

 

Proxy User

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 username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a username in one of the following formats:

user@domain
domain\user

 

 

Pseudo Columns

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; i.e., "*=*".

 

Query Cache

Data Type

string

Default Value

""

Remarks

The QueryCache property allows you to cache the results of a query in memory and use them until the cache expires. The cache expires after the seconds specified in this property. The in-memory query cache is shared across connections, so it can help with performance even if more than one connection is being used.

How QueryCache Works

 

The cache manager for QueryCache will not only use the cache for exactly the same query, but also use the cache for queries that represent a subset of data in the cached query. For example, in the following queries, the cache created while executing Query A will be used to obtain the results for both Query B and Query C.

SELECT * FROM Account; // Query A
SELECT * FROM Account WHERE Name LIKE '%John'; // Query B
SELECT Id, Name FROM Account LIMIT 10; // Query C

 

 

When to Use QueryCache

 

Setting the QueryCache property can improve performance in the following scenarios:

  • When you need to execute the same or similar queries from multiple connections: With this property set, all connections share the same temporary cache instead of each executing a query to PayPal. This can be useful in connection pooling.

  •  

    When you need to query cached data with generated queries: Data access wizards and dashboard designers generate an underlying SQL query, which you may have a limited ability to modify. Typically, to pass through SQL to query a cache, you need to set Offline. Offline queries may be unacceptable if your BI and analytics need to reflect changes to the data in real time. But, slow networks or servers can result in reports with unacceptable lag.

    QueryCache enables you to execute standard SQL against a local cache while remaining online to periodically refresh the cache.

    Note that Offline and QueryCache do not provide an ad-hoc way to select a cached table or a remote table after opening a connection; the properties allow access to only one or the other. The #CACHE SQL syntax enables you to explicitly select a cached table, without going offline. Refer to Caching Explicitly for more information.

When Not to Use QueryCache

 

 

  • When you need the most efficient queries possible: By default, the driver offloads as much processing as possible to the server. This results in the least amount of data crossing the network. ; even if a query is not supported and needs some in-memory processing, the driver still leverages the API's capabilities. QueryCache is only desirable when the default functionality is not possible or when there are overriding constraints; for example, even API-optimized queries can be expensive against a slow server.

 

 

RTK

Data Type

string

Default Value

""

Remarks

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

 

Schema

Data Type

string

Default Value

"SOAP"

Remarks

The schemas available are REST (to use PayPal's REST API) and SOAP (to use PayPal's Classic API).

 

Signature

Data Type

string

Default Value

""

Remarks

The signature required to use the SOAP API. Along with Signature, Username 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 first 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.

 

SSL Server Cert

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 will be rejected.

This property can take the 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 will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

 

Support Enhanced SQL

Data Type

bool

Default Value

true

Remarks

Use QueryCache to cache memory for a given time in seconds or to disable in-memory caching.

Use QueryCache to cache in memory for a given time in seconds or to disable in-memory caching.

 

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.

 

Timeout

Data Type

string

Default Value

"60"

Remarks

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

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

 

Username

Data Type

string

Default Value

""

Remarks

The username required to use the SOAP API. Along with Password, Username and Signature are required to access the Transaction and TransactionDetails views.

 

Use Sandbox

Data Type

bool

Default Value

false

Remarks

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

 

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 described below:

 

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

The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.

 

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.




 

Views

  1. AuthorizationDetails
  2. CaptureDetails
  3. CreditCardDetails
  4. Invoices
  5. Notifications
  6. OrderDetails
  7. Payments
  8. PaymentTransactions
  9. RefundDetails
  10. SaleDetails
  11. TransactionDetails
  12. Transactions
  13. Webhooks

AuthorizationDetails

Query details about Authorizations.

 

Table Specific Information
Select

 

PayPal supports only a limited subset of columns as filter criteria. The only supported column is Id, which is required.

The following query retrieves details for a specific Authorization.

SELECT * FROM AuthorizationDetails WHERE Id = '70K15739YA1955155'
Columns

 

 

 

   
Name Type References Description
Id [KEY] String   The Id of the authorization transaction.
Currency String   The 3-letter currency code of the amount being collected.
Subtotal Double   The amount of the subtotal of the items.
TaxAmount Double   The amount charged for the tax.
ShippingAmount Double   The amount charged for the shipping.
ShippingDiscount Double   The amount being discounted for the shipping fee.
HandlingFeeAmount Double   The amount being charged for the handling fee.
InsuranceAmount Double   The amount being charged for the insurance fee.
TotalAmount Double   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.
PaymentMode String   The payment mode of the transaction.
CreateTime Datetime   The time of the authorization.
UpdateTime Datetime   The time that the authorization record was last updated.
State String   The state of the authorization.
ReasonCode String   The reason code for a transaction state of pending.
ParentPayment String   The Id of the payment on which this transaction is based.
ValidUntil Datetime   The authorization expiration time and date.
ClearingTime Datetime   The expected clearing time for e-check transactions.
ProtectionEligibility String   The level of seller protection in force for the transaction. This column has one of the following values: ELIGIBLE (The merchant is protected by the Seller Protection Policy for unauthorized payments and item Not Received), PARTIALLY_ELIGIBLE (the merchant is protected by the Seller Protection Policy for items not received or unauthorized payments), and INELIGIBLE (merchant is not protected under the Seller Protection Policy).
ProtectionEligibilityType String   The protection eligibility type of the payer.
FmfFilterType String   The type of the fraud management filter. The ACCEPT type is returned in direct credit card payments where payment is accepted and where the value of the FmfFilterId column is TOTAL_PURCHASE_PRICE_MINIMUM. The PENDING type is returned for a payment that requires you to explicitly accept or deny the transaction. The DENY type is returned for a payment that was denied automatically. The REPORT type is returned for a payment accepted through the Flag testing mode.
FmfFilterId String   The name of the fraud management filter.
FmfName String   The name of the fraud management filter.
FmfDescription String   The description of the fraud management filter.

 

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
Rows@Next String   This is used to page through multiple pages of results and should not be set manually.

 

 

 

CaptureDetails

Query details about a captured Payment.

 

Table Specific Information
Select

 

The only supported column is Id, which is required.

The following query retrieves details for a specific capture.

SELECT * From CaptureDetails WHERE Id = '9G02572041588110H'
Table Specific Information
Columns

 

 

 

   
Name Type References Description
Id [KEY] String   The Id of the capture transaction.
State String   The state of the capture.
CreateTime Datetime   The time of the capture.
UpdateTime Datetime   The time that the record was last updated.
Currency String   The 3-letter currency code of the amount being collected.
Subtotal Double   The amount of the subtotal of the items.
TaxAmount Double   The amount charged for tax.
ShippingAmount Double   The amount charged for shipping.
ShippingDiscount Double   The amount being discounted for the shipping fee.
HandlingFeeAmount Double   The amount being charged for the handling fee.
InsuranceAmount Double   The amount being charged for the insurance fee.
TotalAmount Double   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.
IsFinalCapture Boolean   If set to true, all remaining funds held by the authorization will be released in the funding instrument. The default is false.
ParentPayment String   The Id of the payment on which this transaction is based.
TransactionFeeCurrency String   The 3-letter currency code of the transaction fee applicable for this payment.
TransactionFeeValue Double   The transaction fee applicable for this payment.

 

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
Rows@Next String   This is used to page through multiple pages of results and should not be set manually.

 

 

 

CreditCardDetails

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

 

Table Specific Information
Select

 

PayPal supports only a limited subset of columns as filter criteria. The only supported columns are Id, CreateTime, MerchantId, ExternalCardId, and ExternalCustomerId. The CreateTime filter supports the >, >=, <, <=, and = operators while the others support only the = operator.

This view returns a list of Credit Cards or details for a specific one.

The following query retrieves details for a specific Credit Card.

SELECT * FROM CreditCardDetails WHERE Id  = 'CARD-19H02474E2775740PKZYWVVI'
 
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. Numeric characters only with no spaces or punctuation.
Type String   The credit card type.
ExpireMonth Integer   The expiration month.
ExpireYear Integer   The 4-digit expiration year.
Cvv2 String   The 3-4-digit card validation code.
FirstName String   The first name of the cardholder.
LastName String   The last name of the cardholder.
AddressLine1 String   Line 1 of the address.
AddressLine2 String   Line 2 of the address.
City String   The name of the city of the address.
CountryCode String   The 2-letter country code.
PostalCode String   The ZIP code or equivalent.
Phone String   The phone number in the E.123 format.
ExternalCustomerId String   The unique identifier of the customer to whom this bank account belongs.
MerchantId String   A user-provided field that functions as a unique identifier for the merchant holding the card. Note that this has no relation to the PayPal merchant Id.
ExternalCardId String   The unique identifier of the bank account of the merchant.
CreateTime Datetime   The creation time of the record.
UpdateTime Datetime   The time the record was last updated.
State String   The state of the credit card funding instrument.
ValidUntil Datetime   The funding instrument expiration date.

 

 

 

Invoices

Query Invoices in PayPal.

 

Table Specific Information
Select

 

PayPal supports only a limited subset of columns as filter criteria. The supported filters are Id, Email, RecipientFirstName, RecipientLastName, Status, TotalAmount, StartInvoiceDate, EndInvoiceDate, and Archived. Only the = operator is supported.

You can use StartInvoiceDate and EndInvoiceDate to specify a range. Note that if you want to specify a range, both must be specified.

The following query retrieves Invoices between the specified time.

SELECT * FROM Invoices WHERE StartInvoiceDate = '2015-12-15' AND EndInvoiceDate = '2015-12-17'
Columns

 

 

 

   
Name Type References Description
Id [KEY] String   The unique invoice identifier.
Number String   The unique number that appears on the invoice. If left blank, the number is autoincremented from the last number.
Status String   The status of the invoice. You can specify multiple status values to search for invoices based on what types of invoices are required to be returned. Separate values with a comma. Allowed values are the following: DRAFT, SENT, PAID, MARKED_AS_PAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, and MARKED_AS_REFUNDED.
TotalAmountCurrency String   The 3-letter currency code of the total amount of the invoice.
TotalAmount Double   The total amount of the invoice.
MerchantCity String   The city name of the merchant address.
MerchantCountryCode String   The 2-letter country code of the merchant address.
MerchantAddressLine1 String   Line 1 of the address.
MerchantAddressLine2 String   Line 2 of the address.
MerchantAddressPhone String   The phone number in E.123 format.
MerchantPostalCode String   The ZIP code or equivalent.
MerchantState String   The 2-letter code for U.S. states or the equivalent for other countries.
MerchantBusinessName String   The company business name of the merchant.
MerchantEmail String   The email address of the merchant who is sending the invoice.
MerchantFaxCountryCode String   The E.164 country code of the fax number of the merchant.
MerchantFaxNationalNumber String   The E.164 in-country phone number of the fax number of the merchant.
MerchantFirstName String   The first name of the merchant.
MerchantLastName String   The last name of the merchant.
MerchantPhoneCountryCode String   The E.164 country code of the phone number of the merchant.
MerchantPhoneNationalNumber String   The E.164 in-country phone number.
MerchantTaxId String   The tax Id of the merchant.
MerchantWebsite String   The website of the merchant.
MerchantMemo String   A bookkeeping memo that is private to the merchant.
BillingAddressCity String   The city name of the billing address.
BillingAddressCountryCode String   The 2-letter country code of the billing address.
BillingAddressLine1 String   Line 1 of the address of the invoice recipient.
BillingAddressLine2 String   Line 2 of the address of the invoice recipient.
BillingPhone String   The E.123 phone number of the billing address.
BillingPostalCode String   The ZIP code or equivalent.
BillingState String   The 2-letter code for U.S. states and the equivalent for other countries.
BillingBusinessName String   The company business name of the invoice recipient.
BillingEmail String   The email address of the invoice recipient.
BillingFirstName String   The first name of the invoice recipient.
BillingLanguage String   The language of the bill sent to the invoice recipient. Will only be used if the payer does not have a PayPal account.
BillingLastName String   The last name of the invoice recipient.
ShippingCostCurrency String   The 3-letter currency code of the shipping cost.
ShippingCostAmount String   The shipping cost.
ShippingCostTaxCurrency String   The currency of the tax. 3-letter currency code as defined by ISO 4217.
ShippingCostTaxAmount String   The tax with the ISO 4217 currency code.
ShippingCostTaxID String   The unique identifier of the shipping cost tax.
ShippingCostTaxName String   The name of the tax.
ShippingCostTaxPercent Double   The rate of the specified tax.
ShippingAddressCity String   The name of the city in the shipping address.
ShippingAddressCountryCode String   The 2-letter country code.
ShippingAddressLine1 String   Line 1 of the address of the invoice recipient.
ShippingAddressLine2 String   Line 2 of the address.
ShippingAddressPhone String   The E.123 phone number.
ShippingAddressPostalCode String   The ZIP code or equivalent.
ShippingAddressState String   The 2-letter code for U.S. states and the equivalent for other countries.
ShippingBusinessName String   The company business name of the invoice recipient.
ShippingFirstName String   The first name of the invoice recipient on the shipping address.
ShippingLastName String   The last name of the invoice recipient on the shipping address.
Items String   The list of items included in the invoice.
InvoiceDate Datetime   The date on which the invoice was enabled.
PaymentTermDueDate Datetime   The date on which the invoice payment is due.
PaymentTermType String   The terms by which the invoice payment is due.
DiscountAmountCurrency String   The 3-letter currency code of the discount.
DiscountAmount String   The discount.
DiscountPercent Integer   The invoice level discount as a percent.
CustomAmountCurrency String   The 3-letter currency code of the custom amount applied on the invoice.
CustomAmount String   The custom amount applied on the invoice.
CustomLabel String   The label of the custom amount applied on the invoice.
TaxCalculatedAfterDiscount Boolean   Indicates whether tax is calculated before or after a discount.
TaxInclusive Boolean   A flag indicating whether the unit price includes tax. Default is false.
Terms String   The terms of the invoice.
Note String   The note to the payer.
LogoUrl String   The full URL of an external image to use as the logo.
Payments String   A list of payment details for the invoice.
Refunds String   A list of refund details for the invoice.

 

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
Email String   The initial letters of the email address.
RecipientFirstName String   The initial letters of the first name of the recipient.
RecipientLastName String   The initial letters of the last name of the recipient.
StartInvoiceDate Datetime   The invoice date.
EndInvoiceDate Datetime   The invoice due date.
Archived String   A flag indicating whether to search invoices archived by the merchant. By default, all invoices are returned.
Rows@Next String   This is used to page through multiple pages of results and should not be set manually.

 

 

 

Notifications

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

 

Table Specific Information
Select

 

PayPal supports only a limited subset of columns as filter criteria. The only supported column is WebhookId, which supports only the = operator. WebhookId is a required parameter.

The following query retrieves a 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   A human-readable description of the event type assigned in the response.
WebhookId String   The webhook Id.

 

 

 

OrderDetails

Query details about an Order in PayPal.

 

Table Specific Information
Select

 

PayPal supports only a limited subset of columns as filter criteria. The only supported column is Id, which is required.

The following query retrieves details for a specific Order.

SELECT * From OrderDetails WHERE Id = 'O-1HE90236LH9332431'
Columns

 

 

 

   
Name Type References Description
Id [KEY] String   The identifier of the order transaction.
State String   The state of the order transaction.
Currency String   The 3-letter currency code of the amount being collected.
Subtotal Double   The amount of the subtotal of the items.
TaxAmount Double   The amount charged for tax.
ShippingAmount Double   The amount charged for the shipping fee.
ShippingDiscount Double   The amount being discounted for the shipping fee. This is only returned when the payment method is PayPal.
HandlingFeeAmount Double   The amount being charged for the handling fee. This is only returned when the payment method is PayPal.
InsuranceAmount Double   The amount being charged for the insurance fee. This is only returned when the payment method is PayPal.
TotalAmount Double   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.
ReasonCode String   The reason code for the transaction state being Pending or Reversed.
PendingReason String   The reason the transaction is in pending state.
CreateTime Datetime   The time the record was created.
UpdateTime Datetime   The time that the record was last updated.
ProtectionEligibility String   The level of seller protection in force for the transaction. This column has one of the following values: ELIGIBLE (The merchant is protected by the Seller Protection Policy for unauthorized payments and item Not Received), PARTIALLY_ELIGIBLE (the merchant is protected by the Seller Protection Policy for items not received or unauthorized payments), and INELIGIBLE (merchant is not protected under the Seller Protection Policy).
ProtectionEligibilityType String   The kind of seller protection in force for the transaction.

 

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
Rows@Next String   This is used to page through multiple pages of results and should not be set manually.

 

 

 

Payments

Query details about Payments.

 

Table Specific Information
Select

 

PayPal supports only a limited subset of columns as filter criteria. The only supported columns are Id and CreateTime. The CreateTime filter supports the >, >=, <, <=, and = operators while the Id column supports only the = operator.

The following query retrieves Payments that were created after the specified date.

SELECT * From Payments WHERE CreateTime > 2016-08-03
Columns

 

 

 

   
Name Type References Description
Id [KEY] String   The Id of the payment transaction.
Intent String   The payment intent. A value of SALE indicates immediate payment; A value of AUTHORIZE indicates a payment authorized for later capture.
State String   The payment state.
CreateTime Datetime   The time of the payment.
UpdateTime Datetime   The time that the record was last updated.
PaymentMethod String   The payment method used. The column value must be either credit_card or paypal.
PayerFundingInstruments String   A list of funding instruments for the current payment.
PayerEmail String   The email address representing the payer.
PayerSalutation String   The salutation of the payer.
PayerFirstName String   The first name of the payer.
PayerMiddleName String   The middle name of the payer.
PayerLastName String   The last name of the payer.
PayerSuffix String   The suffix of the payer.
PayerId String   The PayPal-assigned payer Id.
PayerPhone String   The phone number representing the payer.
PayerCountryCode String   The two-letter country code of the payer.
ShippingAddressRecipientName String   The name of the recipient at this address.
ShippingAddressType String   The type of the shipping address.
ShippingAddressLine1 String   Line 1 of the shipping address.
ShippingAddressLine2 String   Line 2 of the shipping address.
ShippingAddressCity String   The city name of the shipping address.
ShippingAddressCountryCode String   The 2-letter country code.
ShippingAddressPostalCode String   The ZIP code or equivalent.
ShippingAddressState String   The 2-letter code for U.S. states or the equivalent for other countries.
ShippingAddressPhone String   The E.123 phone number.
PayerTaxId String   The tax Id of the payer. Only supported when the PaymentMethod is set to paypal.
PayererTaxIdType String   The tax Id type of the payer. This column value is only returned when the PaymentMethod column is set to paypal.
PayerStatus String   The status of the PayPal account of the payer. This column value is only returned when the PaymentMethod column is set to paypal.
ExperienceProfileId String   The identifier for the payment experience.

 

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
Rows@Next String   This is used to page through multiple pages of results and should not be set manually.

 

 

 

PaymentTransactions

Query transactional details including details about the amount and item.

 

Table Specific Information
Select

 

PayPal supports only a limited subset of columns as filter criteria. The only supported column is PaymentId, which is required.

The following query retrieves a list of Transactions for the specified Payment.

SELECT * FROM PaymentTransactions WHERE PaymentId='PAY-6SL93120VR4146201KZYWPVY'
Columns

 

 

 

   
Name Type References Description
PaymentId [KEY] String

Payments.Id

The Id of the payment.
TransactionId [KEY] String   The identifier of the sale transaction.
TransactionType String   The type of the sale transaction.
State String   The state of the transaction.
Currency String   The 3-letter currency code of the amount being collected.
Subtotal Double   The amount of the subtotal of the items.
TotalAmount Double   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.
CreateTime Datetime   The time the transaction was created.
UpdateTime Datetime   The last time the transaction was updated.

 

 

 

RefundDetails

Query details about a specific Refund.

 

Table Specific Information
Select

 

PayPal supports only a limited subset of columns as filter criteria. The only supported column is Id, which is required.

The following query retrieves details for a specific Refund.

SELECT * FROM RefundDetails WHERE Id = '4W92068757818534U
Columns

 

 

 

   
Name Type References Description
Id [KEY] String   The Id of the refund transaction.
State String   The state of the refund.
Description String   The description of the sale.
SaleId String   The sale Id.
CaptureId String   The Id of the transaction.
ParentPayment String   The Id of the payment on which this transaction is based.
CreateTime Datetime   The time of the refund.
UpdateTime Datetime   The time that the record was last updated.
Currency String   The 3-letter currency code of the amount being collected.
Subtotal Double   The amount of the subtotal of the items.
TaxAmount Double   The amount charged for tax.
ShippingAmount Double   The amount charged for shipping.
ShippingDiscount Double   The amount being discounted for the shipping fee. This column value is only returned when the payment method is PayPal.
HandlingFeeAmount Double   The amount being charged for the handling fee. This column value is only returned when the payment method is PayPal.
InsuranceAmount Double   The amount being charged for the insurance fee. This column value is only returned the payment method is PayPal.
TotalAmount Double   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.

 

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
Rows@Next String   This is used to page through multiple pages of results and should not be set manually.

 

 

 

SaleDetails

Query details about a Sale transaction.

 

Table Specific Information
Select

 

PayPal supports only a limited subset of columns as filter criteria. The only supported column is Id, which is required.

The following query retrieves details for a specific Sale.

SELECT * FROM SaleDetails WHERE Id = '6M2430095X488331A'
Columns

 

 

 

   
Name Type References Description
ID [KEY] String   The Id of the sale transaction.
State String   The state of the sale.
Currency String   The 3-letter country code of the amount being collected.
Subtotal Double   The amount of the subtotal of the items.
TaxAmount Double   The amount charged for tax.
ShippingAmount Double   The amount charged for shipping.
ShippingDiscount Double   The amount being discounted for the shipping fee. This is only supported when the payment method is PayPal.
HandlingFeeAmount Double   The amount being charged for the handling fee. This is only supported when the payment method is PayPal.
InsuranceAmount Double   The amount being charged for the insurance fee. This is only supported when the payment method is PayPal.
TotalAmount Double   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. This is only supported when the payment method is PayPal.
CreateTime Datetime   The time of the sale as defined.
Description String   The description of the sale.
ExchangeRate String   The exchange rate applied for this transaction.
FmfDescription String   The description of the filter.
FmfFilterId String   The name of the fraud management filter.
FmfFilterType String   The type of the fraud management filter. A value of ACCEPT indicates that the transaction is a direct credit card payment where payment was accepted and the value of the FmfFilterId column is TOTAL_PURCHASE_PRICE_MINIMUM. A value of PENDING indicates that the transaction must be explicitly accepted or denied. A value of DENY indicates that payment was denied automatically. A value of REPORT indicates that the payment was accepted through the Flag testing mode.
FmfName String   The name of the filter. This property is reserved for future use.
ParentPayment String   The Id of the payment record on which this transaction is based.
PaymentMode String   The payment mode of the transaction. This is only supported when the PaymentMethod is set to paypal. This column has one of the following values: INSTANT_TRANSFER, MANUAL_BANK_TRANSFER, DELAYED_TRANSFER, or ECHECK.
PendingReason String   The reason the transaction is in a pending state. This column value is only returned when the payment method is PayPal.
ProtectionEligibility String   The level of seller protection in force for the transaction. This column has one of the following values: ELIGIBLE (The merchant is protected by the Seller Protection Policy for unauthorized payments and item Not Received), PARTIALLY_ELIGIBLE (the merchant is protected by the Seller Protection Policy for items not received or unauthorized payments), and INELIGIBLE (merchant is not protected under the Seller Protection Policy).
ProtectionEligibilityType String   The kind of seller protection in force for the transaction.
ReasonCode String   The reason code for a transaction state being pending or reversed.
ReceiptId String   The identification number that guest users can use to identify the payment.
ReceivableAmount Double   The amount of the sale.
TransactionFee Double   The transaction fee.
UpdateTime Datetime   The time that the transaction was last updated.

 

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
Rows@Next String   This is used to page through multiple pages of results and should not be set manually.

 

 

 

TransactionDetails

Query details about a specific Transaction, using the SOAP API.

 

Table Specific Information
Select

 

PayPal supports only a limited subset of columns as filter criteria. The only supported column is Id, which is required.

The following query retrieves details for a specific Transaction.

SELECT * FROM TransactionDetails WHERE Id='4W92068757818534U'
Columns

 

 

 

   
Name Type References Description
Id [KEY] String   The unique transaction Id of the payment.
ReceiverBusiness String   The business of the merchant.
ReceiverEmail String   The primary email address of the the merchant.
ReceiverId String   The unique account Id of the merchant. This value is the same as the value of the referral Id of the recipient.
PayerEmail String   The email address of the buyer.
PayerId String   The unique PayPal customer account identification number.
PayerStatus String   The 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 code of the residence of the buyer.
PayerBusiness String   The business name of the buyer.
StreetAddress String   The street address.
City String   The name of the city of the address.
State String   The state or province.
PostalCode String   The U.S. ZIP code or other country-specific postal code.
ShippingCountry String   The expanded name of the country.
PayerPhone String   The phone number of the buyer.
ParentTransactionId String   The parent or related transaction identification number.
TransactionType String   The type of the transaction.
PaymentType String   Indicates whether the payment is instant or delayed.
PaymentDate Datetime   The date-time stamp of the payment.
GrossAmount Double   The final amount charged, including any shipping and taxes from your merchant profile.
FeeAmount Double   The PayPal fee amount charged for the transaction.
SettleAmount Double   The amount deposited in your PayPal account after a currency conversion.
TaxAmount Double   The tax charged on the transaction.
ExchangeRate String   The exchange rate if a currency conversion occurred.
PaymentStatus String   The 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   The store Id as entered in the transaction.
Subject String   The subject field value entered by the buyer when making a payment.
InvoiceId String   The invoice number.
Memo String   The memo entered by your customer in the PayPal Website Payments note field.
SalesTax Double   The amount of tax charged on payment.
EbayItemTxnId String   The eBay auction transaction Id of the item that you use to identify items that the buyer purchased.
ItemName String   The item name.
ItemNumber String   The item number.
ShippingAmount Double   The shipping amount.
HandlingAmount Double   The handling amount.
Quantity String   The quantity.
CouponId String   The coupon identification number.
CouponAmount Double   The amount of the coupon.
CouponAmountCurrency String   The currency code of the coupon amount.
ItemAmount Double   The cost of the item.
AuctionBuyerId String   The auction Id of the buyer.
AuctionClosingDate Datetime   The close date of the auction.

 

 

 

Transactions

Query Transaction history, using the SOAP API.

 

Table Specific Information
Select

 

PayPal supports only a limited subset of columns as filter criteria. The only columns supported in filters are Id, Date, Receiver, ReceiptId, AuctionItemNumber, and TransactionClass. The Date column supports the >, >=, <, <=, and = operators while the others support only the = operator.

The following query retrieves Transactions that are created after the specified date.

SELECT * FROM Transactions WHERE Date > '2015-12-15T12:00:00' AND Amount='11'
Columns

 

 

 

   
Name Type References Description
Id [KEY] String   The unique identifier of the transaction. The returned results are from the transaction records 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.
Timestamp Datetime   The date and time that the transaction occurred.
Timezone String   Time zone of the transaction.
Type String   The type of the transaction.
Payer String   The email address of the buyer.

 

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
TransactionClass String   The classification of the transaction. The available transaction classes are All, Sent, Received, MassPay, MoneyRequest, FundsAdded, FundsWithdrawn, Referral, Fee, Subscription, Dividend, Billpay, Refund, CurrencyConversions, BalanceTransfer, Reversal, Shipping, BalanceAffecting, and ECheck.
Amount String   The currency code of the transaction amount.
AuctionItemNumber String   The auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String   The credit card number, as set by you for the original transaction.
CurrencyCode String   The currency code.
InvoiceId String   The invoice identification key.
ProfileId String   An alphanumeric string that uniquely identifies a recurring profile.
ReceiptId String   The receipt Id of the PayPal account.
Receiver String   The email address of the receiver.
Date Datetime   The date at which to search.
PayerName String   The name of the buyer.

 

 

 

Webhooks

Query the list of Webhooks.

 

Table Specific Information
Select

 

PayPal does not support filters for this table.

SELECT * FROM Webhooks
Columns

 

 

 

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