PayPal Connection Details

Introduction

Connector Version

This documentation is based on version 25.0.9368 of the connector.

Get Started

PayPal Version Support

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

Establish a Connection

Connect to PayPal

The provider surfaces tables from two PayPal APIs. Each API uses a different authentication method.

• The SOAP API requires Signature API credentials. To authenticate to the SOAP API, you must set the AuthScheme to Basic, and set the Username, Password, and Signature properties. These API credentials are generated when you enable the SOAP API.
• The REST API uses the OAuth authentication standard. To authenticate to the REST API, you must set the AuthScheme to OAuth, and set the OAuthClientId, and OAuthClientSecret properties.

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

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

SOAP API

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

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

• API Username
• API Password
• API Signature

To generate the API credentials:

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

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

• User = the API Username.
• Password = the API Password.
• Signature = the Signature.
• UseSandbox = true if you are using sandbox credentials.

REST API

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

• InitiateOAuth = GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
• OAuthClientId = the Client ID in your app settings.
• OAuthClientSecret = the Client Secret in your app settings.
• UseSandbox = true if you are using sandbox credentials.

When you connect, the connector completes the OAuth process.

1. Exchanges the OAuthClientId and OAuthClientSecret for the OAuthAccessToken.
2. Uses the access token to request data.

PayPal currently supports only client credentials flow of OAuth authentication for use with the REST API. To enable this authentication, you must set AuthScheme to OAuth, and you must create a custom OAuth application.

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

Desktop Applications

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

Get and refresh the OAuth access token:

• InitiateOAuth = GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
• OAuthClientId = the client ID assigned when you registered your application.
• OAuthClientSecret = the client secret that was assigned when you registered your application.
• CallbackURL = the redirect URI that was defined when you registered your application.

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

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

Create a Custom OAuth Application

Create a Custom OAuth Application

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

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

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

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

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

Important Notes

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

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

User Defined Views

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

SSL Configuration

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

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

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

For further information, see Query Processing.

Log

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

User Defined Views

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

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

There are two ways to create user defined views:

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

Define Views Using a Configuration File

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

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

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

For example:

{
    "MyView": {
        "query": "SELECT * FROM Payments WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

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

Create a View

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

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

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

Alter a View

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

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

The view is then updated in the JSON configuration file.

Drop a View

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

DROP LOCAL VIEW [MyViewName]

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

Schema for User Defined Views

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

Work with User Defined Views

For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Data Model

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

Using the REST API

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

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

Using the SOAP API

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

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

REST Data Model

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

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

Views

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

Stored Procedures

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

PayPal REST API Limitations

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

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

PayPal Connector Views

AuthorizationDetails

Query details about Authorizations.

Table Specific Information

Select

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

For example, the following queries are processed server side and retrieve details for a specific Authorization.

SELECT * FROM AuthorizationDetails WHERE Id = '70K15739YA1955155'

SELECT * FROM AuthorizationDetails WHERE ID IN ('70K15739YA1955155', '70K15739YA1955156')

Columns

Balances

List all non crypto balances.

Table Specific Information

Select

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

The following filters are supported by the PayPal API:

• Currency
• AsOfTime

The filters only support the = operator.

The connector processes other filters client side within the connector.

For example, the following queries are processed server side.

• The following query retrieves details for a specific currency:

  SELECT * FROM Balances WHERE Currency = 'USD'
  

• The following query returns details for Balance records created before the specified date time:

  SELECT * FROM Balances WHERE AsOfTime = '2022-01-09 20:59:59.0'
  

Columns

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 connector processes other filters client side within the connector.

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

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 connector processes other filters client side within the connector.

For example, the following queries are processed server side.

• The following query retrieves details for a specific Credit Card. The last seven characters of the credit card ID are masked and therefore ignored by the API during validation when filtering by ID.

  SELECT * FROM CreditCardDetails WHERE ID  = 'CARD-19H02474E2775740PKZYWVVI'
  

• The following query returns details for Credit Card records created after the specified date:

  SELECT * FROM CreditCardDetails WHERE CreateTime > '2016-01-01'
  

Columns

CryptoBalances

List all crypto balances.

Table Specific Information

Select

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

The following filters are supported by the PayPal API:

• AsOfTime

The filters only support the = operator.

The connector processes other filters client side within the connector.

For example, the following queries are processed server side.

• The following query returns details for Balance records created before the specified date time:

  SELECT * FROM CryptoBalances WHERE AsOfTime = '2022-01-09 20:59:59.0'
  

Columns

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 connector processes other filters client side within the connector.

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

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 connector processes other filters client side within the connector.

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

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 connector processes other filters client side within the connector.

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

Invoices

Query Invoices in PayPal.

Table Specific Information

Select

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

The following filters are supported by the PayPal API:

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

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

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

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

The connector processes other filters client side within the connector.

Columns

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.

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 connector processes other filters client side within the connector.

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

OrderDetails

Query details about an Order.

Table Specific Information

Select

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

For example, the following queries are processed server side and retrieve details for a specific Order.

SELECT * FROM OrderDetails WHERE Id = 'O-1HE90236LH9332431'

SELECT * FROM OrderDetails WHERE ID IN ('O-1HE90236LH9332431', 'O-7D635956955612146')

Columns

OrderItems

Get the items in an Order.

Table Specific Information

Select

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

For example, the following queries are processed server side and retrieve details for a specific Order.

SELECT * FROM OrderItems WHERE OrderId = 'O-1HE90236LH9332431'

SELECT * FROM OrderItems WHERE OrderId IN ('O-1HE90236LH9332431', 'O-7D635956955612146')

Columns

PartnerReferrals

Shows details by ID for referral data that was shared by the partner or API caller.

Table Specific Information

Select

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

For example, the following queries are processed server side and retrieve details for a specific Partner Referral.

SELECT * FROM PartnerReferrals where id= 'ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0='

Columns

Payments

Query details about authorized Payments.

Table Specific Information

Select

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

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

PaymentTokens

Lists merchant-created templates with associated details.

Table Specific Information

Select

The only filters supported by the PayPal API are ID and CustomerId. One of these filters is required to access this view. Server-side processing is only supported for the '=' operator.

Select * from PaymentTokens where CustomerId = 'BygeLlrpZF'
Select * from PaymentTokens where ID = 'PMUH786954'

The connector processes other filters client side within the connector.

Columns

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 connector processes other filters client side within the connector.

By default, this view will only provide the data for payments that are completed, to get the transaction of the payments that are just created, the user will have to provide the PaymentId in WHERE clause.

The user can get the non completed PaymentId after excuting the CreatePayment SP.

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

PayoutDetails

Retrieve details about Payouts.

Table Specific Information

Select

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

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

SELECT * FROM PayoutDetails WHERE PayoutBatchId = 'HSY55UPD25KF2'

Columns

PayoutItems

Retrieve payout items from a Payout.

Table Specific Information

Select

The filters supported by the PayPal API are PayoutBatchId and PayoutItemId. Atleast one filter is required to access the view. The connector processes other filters client side within the connector.

For example, the following queries are processed server side.

SELECT * FROM PayoutItems WHERE PayoutBatchId = 'HSY55UPD25KF2'
SELECT * FROM PayoutItems WHERE PayoutItemId ='8AELMXH8UB2P8'

Columns

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 WHERE Id = '1234'
SELECT * FROM Plans WHERE ProductId = '1234'

The connector processes other filters client side within the connector.

Columns

ProductDetails

Retrieve the list of product details.

Table Specific Information

Select

This view returns a list of product details for the authenticated user.

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

The connector processes other filters client side within the connector.

For example, the following queries are processed server side.

SELECT * FROM ProductDetails
SELECT * FROM ProductDetails WHERE ProductId = 'PP-D-12345'

Columns

Products

Retrieves the list of products, which are goods and services.

Table Specific Information

Select

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

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

The connector processes other filters client side within the connector.

For example, the following queries are processed server side.

SELECT * FROM Products
SELECT * FROM Products WHERE ID = 'PP-D-12345'

Columns

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 connector processes other filters client side within the connector.

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

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 connector processes other filters client side within the connector.

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

Subscriptions

Get billing and subscription details.

Table Specific Information

Select

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

SELECT * FROM Subscriptions WHERE ID = '1234'

The connector processes other filters client side within the connector.

Columns

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'

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

The connector processes other filters client side within the connector.

Columns

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.

Templates

Lists merchant-created templates with associated details.

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 Templates where ID = 'TEMP-3RK55758SK521635N'

The connector processes other filters client side within the connector.

Columns

TransactionReports

Lists transaction reports.

Table Specific Information

Select

The filters supported by the PayPal API are StartDate, EndDate, TransactionId, PaymentInstrumentType, BalanceAffectingRecordsOnly, StoreId, TerminalId, TransactionAmount, TransactionCurrency, TransactionStatus, TransactionType. Server-side processing is only supported for the '=' operator.

SELECT * FROM TransactionReports WHERE StartDate = '2021-09-06 12:12:12' AND EndDate = '2021-09-11 12:12:12'

The connector processes other filters client side within the connector.

Columns

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.

TransactionReportsCartInfoItemDetails

List Cart Info of Transaction Reports.

Table Specific Information

Select

The filters supported by the PayPal API are StartDate, EndDate, TransactionId, PaymentInstrumentType, BalanceAffectingRecordsOnly, StoreId, TerminalId, TransactionAmount, TransactionCurrency, TransactionStatus, TransactionType. Server-side processing is only supported for the '=' operator.

SELECT * FROM TransactionReportsCartInfoItemDetails WHERE StartDate = '2021-09-06 12:12:12' AND EndDate = '2021-09-11 12:12:12'

The connector processes other filters client side within the connector.

Columns

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.

TransactionReportsIncentiveDetails

List Incentive Details of Transaction Reports.

Columns

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.

UserInfo

Shows OpenID Connect user profile information for standard claims.

Table Specific Information

Select

The connector processes all filters client side within the connector.

SELECT * FROM UserInfo

Columns

Users

Lists users.

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 Users where ID = '7KXKZ3UWSTXNJ'

The connector processes other filters client side within the connector.

Columns

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

Columns

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with PayPal.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from PayPal, along with an indication of whether the procedure succeeded or failed.

PayPal Connector Stored Procedures

CreateDraftInvoice

Creates a draft invoice.

Stored Procedure Specific Information

The CreateDraftInvoice Stored Procedure requires following columns to execute:

• InvoiceItems
• DetailCurrencyCode

You can include additional fields to enhance the details in the draft invoice.

EXEC CreateDraftInvoice @DetailCurrencyCode = 'USD', @InvoiceItems = '[\n" +
              "    {\n" +
              "      \"name\": \"Yoga Mat\",\n" +
              "      \"description\": \"Elastic mat to practice yoga.\",\n" +
              "      \"quantity\": \"1\",\n" +
              "      \"unit_amount\": {\n" +
              "        \"currency_code\": \"USD\",\n" +
              "        \"value\": \"50.00\"\n" +
              "      },\n" +
              "      \"tax\": {\n" +
              "        \"name\": \"Sales Tax\",\n" +
              "        \"percent\": \"7.25\"\n" +
              "      },\n" +
              "      \"discount\": {\n" +
              "        \"percent\": \"5\"\n" +
              "      },\n" +
              "      \"unit_of_measure\": \"QUANTITY\"\n" +
"    }]'

Input

Result Set Columns

CreateOrder

Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs.

Stored Procedure Specific Information

The CreateOrder Stored Procedure requires following columns to execute:

• Intent
• PurchaseUnits