This page provides a guide to Establishing a Connection to PayPal in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to PayPal

Establishing a Connection shows how to authenticate to PayPal and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from PayPal through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to PayPal by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to PayPal

• 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:

• 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 Cloud completes the OAuth process. 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.

Automatic refresh of the OAuth access token:

To have the Cloud 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 Cloud 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.

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

Customizing the SSL Configuration

By default, the Cloud 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.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Cloud 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.

The CData Cloud 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 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.

CData Cloud - PayPal Views

Query details about Authorizations.

Table Specific Information

Select

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

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

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

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

Query details about a captured Payment.

Table Specific Information

Select

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

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

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

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

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

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

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

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

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

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

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

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

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

Columns

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

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

Query details about an Order.

Table Specific Information

Select

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

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

Get the items in an Order.

Table Specific Information

Select

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

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

Query details about authorized Payments.

Table Specific Information

Select

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

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

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

Columns

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

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

Retrieve details about Payouts.

Table Specific Information

Select

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

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

SELECT * FROM PayoutDetails WHERE PayoutBatchId = 'HSY55UPD25KF2'

Columns

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

For example, the following queries are processed server side.

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

Columns

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

Columns

Query details about a specific Refund.

Table Specific Information

Select

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

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

Query details about a Sale Transaction.

Table Specific Information

Select

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

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

Get billing and subscription details.

Table Specific Information

Select

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

SELECT * FROM Subscriptions WHERE Id = '1234'

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

The Cloud processes other filters client side within the Cloud.

Columns

Lists transactions for a subscription.

Table Specific Information

Select

This view returns a list of transactions with details for a specific subscription.

The following filters are supported by the PayPal API:

• SubscriptionId
• StartTime
• EndTime

SELECT * FROM SubscriptionTransactions WHERE SubscriptionId = '1234'
SELECT * FROM SubscriptionTransactions WHERE SubscriptionId = '1234' AND StartTime = '2018-01-21T07:50:20.940Z' AND EndTime = '2018-08-21T07:50:20.940Z'

NOTE: 1. SubscriptionId, StartTime and EndTime are the required parameters for this view and if StartTime and EndTime are not specified in the query the default values will be assigned from the code. 2. We can get get the SubscriptionId by creating the subscription using CreateSubscription Stored procedure.

The Cloud processes other filters client side within the Cloud.

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.

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

Columns

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

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.

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

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.

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.

Shows OpenID Connect user profile information for standard claims.

Table Specific Information

Select

The Cloud processes all filters client side within the Cloud.

SELECT * FROM UserInfo

Columns

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

Columns

Stored procedures are function-like interfaces that extend the functionality of the Cloud 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.

CData Cloud - PayPal Stored Procedures

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

Creates a sale, an authorized payment to be captured later, or an order.

Stored Procedure Specific Information

The CreatePayment Stored Procedure requires following columns to execute:

• Intent
• ReturnUrl
• CancelUrl
• PayerPaymentMethod
• Transactions

EXEC CreatePayment @Intent = 'sale',  @ReturnUrl = 'https://example.com/return', @CancelUrl = 'https://example.com/cancel', @PayerPaymentMethod = 'paypal', @Transactions = '[\n" +
              "    {\n" +
              "      \"amount\": {\n" +
              "        \"total\": \"30.11\",\n" +
              "        \"currency\": \"USD\",\n" +
              "        \"details\": {\n" +
              "          \"subtotal\": \"30.00\",\n" +
              "          \"tax\": \"0.07\",\n" +
              "          \"shipping\": \"0.03\",\n" +
              "          \"handling_fee\": \"1.00\",\n" +
              "          \"shipping_discount\": \"-1.00\",\n" +
              "          \"insurance\": \"0.01\"\n" +
              "        }\n" +
              "      },\n" +
              "      \"description\": \"The payment transaction description.\",\n" +
              "      \"custom\": \"EBAY_EMS_90048630024435\",\n" +
              "      \"invoice_number\": \"48787589673\",\n" +
              "      \"payment_options\": {\n" +
              "        \"allowed_payment_method\": \"INSTANT_FUNDING_SOURCE\"\n" +
              "      },\n" +
              "      \"soft_descriptor\": \"ECHI5786786\",\n" +
              "      \"item_list\": {\n" +
              "        \"items\": [\n" +
              "          {\n" +
              "            \"name\": \"hat\",\n" +
              "            \"description\": \"Brown hat.\",\n" +
              "            \"quantity\": \"5\",\n" +
              "            \"price\": \"3\",\n" +
              "            \"tax\": \"0.01\",\n" +
              "            \"sku\": \"1\",\n" +
              "            \"currency\": \"USD\"\n" +
              "          },\n" +
              "          {\n" +
              "            \"name\": \"handbag\",\n" +
              "            \"description\": \"Black handbag.\",\n" +
              "            \"quantity\": \"1\",\n" +
              "            \"price\": \"15\",\n" +
              "            \"tax\": \"0.02\",\n" +
              "            \"sku\": \"product34\",\n" +
              "            \"currency\": \"USD\"\n" +
              "          }\n" +
              "        ],\n" +
              "        \"shipping_address\": {\n" +
              "          \"recipient_name\": \"Brian Robinson\",\n" +
              "          \"line1\": \"4th Floor\",\n" +
              "          \"line2\": \"Unit #34\",\n" +
              "          \"city\": \"San Jose\",\n" +
              "          \"country_code\": \"US\",\n" +
              "          \"postal_code\": \"95131\",\n" +
              "          \"phone\": \"011862212345678\",\n" +
              "          \"state\": \"CA\"\n" +
              "        }\n" +
              "      }\n" +
              "    }\n" +
              "  ]'

Input

Result Set Columns

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\": \"[email protected]\",\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', '[email protected]')
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

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\": \"[email protected]\",\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

Deletes a draft or scheduled invoice, by ID.

Stored Procedure Specific Information

The DeleteInvoice Stored Procedure requires InvoiceId to delete an invoice.

EXEC DeleteInvoice @InvoiceId = 'INV2-VSCV-SAZK-CMHP-AHGB'

Input

Result Set Columns

Send an Invoice, by Id, to a customer.

Input

Result Set Columns

The CData Cloud 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 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.

CData Cloud - PayPal Views

View all the currencies of the account and their balances.

Columns

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.

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.

Query Transactions involving BillPay Transactions.

Columns