PayPal Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8804 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¶

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. Refreshes the access token when it expires.
3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

PayPal supports only OAuth authentication for use with the REST API. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth, and you must create a custom OAuth application.

The following subsections describe how to authenticate to PayPal from three 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 connect, the connector opens PayPal's OAuth endpoint in your default browser. Log in and grant permissions to the application.

After you grant permissions to the application, the connector then completes the OAuth process:

1. The connector obtains an access token from PayPal and uses it to request data.
2. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the connector refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the connector automatically refresh the OAuth access token, do the following:

1. Before connecting to data for the first time, set the following connection parameters:
   • InitiateOAuth = REFRESH.
   • OAuthClientId = the client ID in your application settings.
   • OAuthClientSecret = the client secret in your application settings.
   • OAuthAccessToken = the access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation = the path where you want the connector to save the OAuth values, which persist across connections.
2. On subsequent data connections, set the following:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set the following connection properties:
   • OAuthClientId = the Client ID in your application settings.
   • OAuthClientSecret = the Client Secret in your application settings.
3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

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 Harmony 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 allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

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

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

User Defined Views¶

The PayPal connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used 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 as follows:

• Each root element defines the name of a view.
• Each root element contains 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¶

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting 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 SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

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; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

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:

  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

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

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

The connector processes other filters client side within the connector.

Columns¶

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¶

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¶

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.

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 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 all payout items for a specific Payout.

SELECT * FROM PayoutItems WHERE PayoutBatchId = 'HSY55UPD25KF2'

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¶

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.

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.

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¶

CreatePayouts¶

Makes payouts in PayPal.

Table Specific Information¶

Payout Items

You cannot create a payout without payout items. To create payout items, you must insert data either using a JSON aggregate or via temporary table called 'PayoutItem#TEMP'. Refer to the following examples for more information.

Example: Create payouts using JSON aggregate

EXECUTE CreatePayouts SenderBatchId = '1247', EmailSubject = 'You have a payout!', EmailMessage = 'You have received a payout! Thanks for using our service!', PayoutItem = '[{\n" +
          "\"recipient_type\": \"EMAIL\",\n" +
          "\"amount\": {\n" +
          "\"value\": \"0.0\",\n" +
          "\"currency\": \"USD\"\n" +
          "},\n" +
          "\"note\": \"Thanks for your patronage3333!\",\n" +
          "\"receiver\": \"receiver@example.com\",\n" +
          "\"sender_item_id\": \"201403140001\"\n" +
          "}, {\n" +
          "\"recipient_type\": \"PHONE\",\n" +
          "\"amount\": {\n" +
          "\"value\": \"0.0\",\n" +
          "\"currency\": \"USD\"\n" +
          "\t},\n" +
          "\"note\": \"Thanks for your support!\",\n" +
          "\"receiver\": \"91-734-234-1234\",\n" +
          "\"sender_item_id\": \"201403140002\"\n" +
          "}\n" +

"]'

Example: Create payouts using temp table

You first need to insert into PayoutItem#TEMP to create payout items.

INSERT INTO PayoutItem#TEMP (RecipientType, AmountValue, AmountCurrency, Note, SenderItemId, Receiver) VALUES ('EMAIL', '3.2', 'USD', 'Thanks for your patronage!', '201403140001', 'receiver@example.com')
INSERT INTO PayoutItem#TEMP (RecipientType, AmountValue, AmountCurrency, Note, SenderItemId, Receiver) VALUES ('PHONE', '8.98', 'USD', 'Thanks for your support!', '201403140002', '91-734-234-1234')

Execute

After creating at least one payout item, you can execute the stored procedure.

EXECUTE CreatePayouts SenderBatchId = '123', EmailSubject = 'You have a payout!', EmailMessage = 'You have received a payout! Thanks for using our service!'

The following columns are required to create a payout item:

• RecipientType
• AmountValue
• AmountCurrency
• SenderItemId
• Receiver

Input

Result Set Columns

CreateSubscription¶

Create a subscription for PayPal.

Stored Procedure Specific Information¶

The CreateSubscription Stored Procedure requires PlanId to create a PayPal Subscription.

EXECUTE CreateSubscription PlanId = 'P-5ML4271244454362WXNWU5NQ', StartTime = '2021-11-01T00:00:00Z', ShippingAmount = '{\n" +
          "    \"currency_code\": \"USD\",\n" +
          "    \"value\": \"10.00\"\n" +
          "  }', subscriber = '{\n" +
          "    \"name\": {\n" +
          "      \"given_name\": \"John\",\n" +
          "      \"surname\": \"Doe\"\n" +
          "    },\n" +
          "    \"email_address\": \"customer@example.com\",\n" +
          "    \"shipping_address\": {\n" +
          "      \"name\": {\n" +
          "        \"full_name\": \"John Doe\"\n" +
          "      },\n" +
          "      \"address\": {\n" +
          "        \"address_line_1\": \"2211 N First Street\",\n" +
          "        \"address_line_2\": \"Building 17\",\n" +
          "        \"admin_area_2\": \"San Jose\",\n" +
          "        \"admin_area_1\": \"CA\",\n" +
          "        \"postal_code\": \"95131\",\n" +
          "        \"country_code\": \"US\"\n" +
          "      }\n" +
          "    }\n" +
"  }'

The following columns are required to create a subscription:

• PlanId

Input

Result Set Columns

GetOAuthAccessToken¶

Gets the OAuth access token from PayPal.

Result Set Columns¶

RefreshOAuthAccessToken¶

Refreshes the OAuth access token used for authentication with various PayPal services.

Result Set Columns¶

SendInvoice¶

Send an Invoice, by Id, to a customer.

Input¶

SOAP Data Model¶

The PayPal connector models the PayPal SOAP APIs as database Views. Typically, read-only data are shown as views. These are defined in schema files, which are simple, text-based configuration files that make schemas easy to customize.

This section provides the API limitations and requirements for the SOAP data model; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Views¶

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

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¶

Balance¶

View all the currencies of the account and their balances.

Columns¶

BalanceAffecting¶

Query Transactions that affect the account balance.

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.

BalanceTransfer¶

Query Transactions involving Balance Transfers.

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.

BillPay¶

Query Transactions involving BillPay Transactions.

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.

CurrencyConversions¶

Query Transactions involving Currency Conversions.

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.

Dividend¶

Query Transactions involving Dividends.

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.

ECheck¶

Query Transactions involving eChecks.

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.

Fee¶

Query Transactions involving Fees.

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.

FundsAdded¶

Query Transactions generated when funds are added to the balance.

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.

FundsWithdrawn¶

Query Transactions generated when funds are withdrawn from the balance.

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.

MassPay¶

Query Mass Payments Transactions.

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.

MoneyRequest¶

Query Money Request Transactions.

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.

Received¶

Query payments-received Transactions.

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.

Referral¶

Query Transactions involving Referrals.

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.

Refund¶

Query Transactions involving Refunds.

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.

Reversal¶

Query Transactions involving BillPay Reversals.

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.

Sent¶

Query payments-sent Transactions.

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.

Shipping¶

Query Transactions involving UPS Shipping Fees.

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.