Ready to get started?

Download a free trial of the PayPal Driver to get started:

 Download Now

Learn more:

PayPal Icon PayPal JDBC Driver

Easy-to-use PayPal client enables Java-based applications to easily consume PayPal Transactions, Orders, Sales, Invoices, etc.

Connect to PayPal Data in CloverDX (formerly CloverETL)



Transfer PayPal data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for PayPal enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with PayPal as sources. In this article, you will use the JDBC Driver for PayPal to set up a simple transfer into a flat file. The CData JDBC Driver for PayPal enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with PayPal as sources. In this article, you will use the JDBC Driver for PayPal to set up a simple transfer into a flat file.

Connect to PayPal as a JDBC Data Source

  1. Create the connection to PayPal data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.paypal.jar file.
  3. Enter the JDBC URL.

    The provider surfaces tables from two PayPal APIs. The APIs use different authentication methods.

    • The REST API uses the OAuth standard. To authenticate to the REST API, you will need to set the OAuthClientId, OAuthClientSecret, and CallbackURL properties.
    • The Classic API requires Signature API credentials. To authenticate to the Classic API, you will need to obtain an API username, password, and signature.

    See the "Getting Started" chapter of the help documentation for a guide to obtaining the necessary API credentials.

    To select the API you want to work with, you can set the Schema property to REST or SOAP. By default the SOAP schema will be used.

    For testing purposes you can set UseSandbox to true and use sandbox credentials.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the PayPal JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.paypal.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    A typical JDBC URL is below:

    jdbc:paypal:Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;InitiateOAuth=GETANDREFRESH

Query PayPal Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the PayPal JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT Date, GrossAmount FROM Transactions

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Transactions table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.