PayPal Connector for CData Sync

Build 23.0.8839
  • PayPal
    • 接続の確立
      • カスタムOAuth アプリケーションの作成
    • 高度な機能
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • REST データモデル
        • ビュー
          • AuthorizationDetails
          • Balances
          • CaptureDetails
          • CreditCardDetails
          • CryptoBalances
          • DisputeDetails
          • Disputes
          • DisputeTransactions
          • Invoices
          • Notifications
          • OrderDetails
          • OrderItems
          • Payments
          • PaymentTransactions
          • PayoutDetails
          • PayoutItems
          • Plans
          • RefundDetails
          • SaleDetails
          • Subscriptions
          • SubscriptionTransactions
          • TransactionReports
          • TransactionReportsCartInfoItemDetails
          • TransactionReportsIncentiveDetails
          • Webhooks
      • SOAP データモデル
        • ビュー
          • Balance
          • BalanceAffecting
          • BalanceTransfer
          • BillPay
          • CurrencyConversions
          • Dividend
          • ECheck
          • Fee
          • FundsAdded
          • FundsWithdrawn
          • MassPay
          • MoneyRequest
          • Received
          • Referral
          • Refund
          • Reversal
          • Sent
          • Shipping
          • Subscription
          • TransactionDetails
          • TransactionItems
          • Transactions
    • 接続文字列オプション
      • Authentication
        • User
        • Password
        • Signature
        • UseSandbox
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
        • Schema
      • Miscellaneous
        • IncludeDetails
        • MaxRows
        • Other
        • PseudoColumns
        • Timeout
        • UserDefinedViews

PayPal Connector for CData Sync

概要

CData Sync App は、PayPal データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。

PayPal コネクタはCData Sync アプリケーションから使用可能で、PayPal からデータを取得して、サポートされている任意の同期先に移動できます。

PayPal バージョンサポート

Sync App は、PayPal SOAP API を使用してトランザクションのビューを表示し、REST API を使用してその他すべてのビューを表示します。

PayPal Connector for CData Sync

接続の確立

PayPal への接続を追加

PayPal への接続を追加するには:

  1. アプリケーションコンソールで、接続ページに移動します。
  2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
  3. PayPal アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからPayPal コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

PayPal への接続

プロバイダーは2つのPayPal API のテーブルを表示します。これらのAPI は、それぞれ異なる認証方法を使用します。
  • SOAP API にはSignature API 認証情報が必要です。SOAP API を認証するには、AuthScheme をBasic に設定し、Username、Password、およびSignature プロパティを設定する必要があります。SOAP API を有効にすると、これらのAPI 認証情報が生成されます。
  • REST API はOAuth 認証標準を使用しています。REST API を認証するには、AuthScheme をOAuth に設定し、OAuthClientId およびOAuthClientSecret プロパティを設定する必要があります。

希望のAPI を指定するには、Schema プロパティをREST またはSOAP のいずれかに設定します。Schema が設定されていない場合、PayPal はSOAP スキーマを使用します。

テスト目的では、UseSandbox をtrue に設定してSandbox 認証情報を使用します。

SOAP API

SOAP API を使用して、現在の口座のすべての取引を取得できます。SOAP API は、3 つのクレデンシャル値を持つSignature API-credentials タイプを使用します。

  • API ユーザー名
  • API パスワード
  • API 署名

API 認証情報を生成するには:

  1. PayPal ビジネスアカウントにログインして、Profile -> My Selling Tools を選択します。
  2. Selling Online セクションで、API Access 項目のUpdate をクリックします。
  3. API 署名を生成するには、API Access ページでRequest API Credentials をクリックします。
  4. Request API Signature を選択し、Agree and Submit をクリックしてAPI 署名を生成します。

次の接続プロパティを設定して、接続してください。

  • User = API ユーザー名。
  • Password = API パスワード。
  • Signature = 署名。
  • UseSandbox = Sandbox の認証情報を利用している場合はtrue。

REST API

次の接続プロパティを設定して、接続してください。

  • OAuthClientId = アプリケーション設定のクライアントID。
  • OAuthClientSecret = アプリケーション設定のクライアントシークレット。
  • UseSandbox = Sandbox の認証情報を利用している場合はtrue。

接続すると、Sync App がOAuth プロセスを完了します。 PayPal は、REST API で使用するOAuth 認証のみをサポートします。この認証を有効にするには、すべてのOAuth フローでAuthScheme をOAuth に設定し、カスタムOAuth アプリケーションを作成する必要があります。

以下のサブセクションでは、3つの標準的な認証フローでのPayPal への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。PayPal で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

OAuth アクセストークンの自動リフレッシュ:

Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。

  1. はじめてデータに接続する前に、次の接続プロパティを設定します。
    • InitiateOAuth = REFRESH。
    • OAuthClientId = アプリケーション設定のクライアントId。
    • OAuthClientSecret = アプリケーション設定のクライアントシークレット。
    • OAuthAccessToken = GetOAuthAccessToken によって返されたアクセストークン。
    • OAuthSettingsLocation = Sync App がOAuth 値を保存する場所のパス。これは接続間で維持されます。
  2. その後のデータ接続では、以下を設定します。
    • InitiateOAuth
    • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ:

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

  1. ExpiresIn 期間(GetOAuthAccessToken が返す)が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
  2. 次の接続プロパティを設定します。

    • OAuthClientId = アプリケーション設定のクライアントId。
    • OAuthClientSecret = アプリケーション設定のクライアントシークレット。

  3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
  4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。Open は、新規接続を開きます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

完了後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにドライバーを設定します。

PayPal Connector for CData Sync

カスタムOAuth アプリケーションの作成

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.

PayPal Connector for CData Sync

高度な機能

このセクションでは、PayPal Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、PayPal にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。

PayPal Connector for CData Sync

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

PayPal Connector for CData Sync

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

PayPal Connector for CData Sync

データモデル

The CData Sync App 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 データモデル 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 データモデル for the available entities in the SOAP API.

PayPal Connector for CData Sync

REST データモデル

CData Sync App は、PayPal REST API をデータベースビューおよびストアドプロシージャとしてモデル化します。これらはスキーマファイルにて定義されます。スキーマファイルは、スキーマを簡単にカスタマイズできるシンプルなテキストベースのコンフィギュレーションファイルです。

このセクションでは、REST データモデルに関するAPI の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。

ビュー

ビュー は変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。

ストアドプロシージャ

ストアドプロシージャ は、PayPal のファンクションライクなインターフェースです。これらは、 ビュー に表示されない他のPayPal の機能にアクセスするために使用できます。

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.

PayPal Connector for CData Sync

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

PayPal Connector for CData Sync ビュー

Name Description
AuthorizationDetails Query details about Authorizations.
Balances List all non crypto balances.
CaptureDetails Query details about a captured Payment.
CreditCardDetails Query details about the funding instrument of the payer, such as a Credit Card or a token that represents a Credit Card.
CryptoBalances List all crypto balances.
DisputeDetails PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes.
Disputes PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes.
DisputeTransactions PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes.
Invoices Query Invoices in PayPal.
Notifications Query the list of event types that are subscribed to a Webhook.
OrderDetails Query details about an Order.
OrderItems Get the items in an Order.
Payments Query details about authorized Payments.
PaymentTransactions Query Transaction details including the amount and item details.
PayoutDetails Retrieve details about Payouts.
PayoutItems Retrieve payout items from a Payout.
Plans List the Billing Plans.
RefundDetails Query details about a specific Refund.
SaleDetails Query details about a Sale Transaction.
Subscriptions Get billing and subscription details.
SubscriptionTransactions Lists transactions for a subscription.
TransactionReports Lists transaction reports.
TransactionReportsCartInfoItemDetails List Cart Info of Transaction Reports.
TransactionReportsIncentiveDetails List Incentive Details of Transaction Reports.
Webhooks Query the list of Webhooks.

PayPal Connector for CData Sync

AuthorizationDetails

Query details about Authorizations.

Table Specific Information

Select

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

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

Name Type References Description
Id [KEY] String The PayPal-generated ID for the authorized payment.
Status String The status for the authorized payment.
StatusDetails String The details of the authorized order pending status.
AmountTotal Decimal The amount for this authorized payment.
AmountCurrency String The currency of the amount.
InvoiceId String The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
CustomId String The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
SellerProtectionStatus String The level of protection offered as defined by PayPal Seller Protection for Merchants.
ExpirationTime Datetime The amount being charged for the handling fee. Only supported when the payment method is set to paypal.
CreateTime Datetime The time of authorization.
UpdateTime Datetime The time that the resource was last updated.

PayPal Connector for CData Sync

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

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

Name Type References Description
Currency [KEY] String Currency Code of the balances listed.
AccountId String The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties.
AvailableBalanceCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
AvailableBalanceValue String The value, which might be an integer or a decimal.
Primary Boolean Optional field representing if the currency is primary currency or not.
TotalBalanceCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TotalBalanceValue Decimal The value, which might be:An integer or A decimal.
WithheldBalanceCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
WithheldBalanceValue String The value, which might be:An integer or A decimal.
AsOfTime Datetime The requested date and time or the last date and time when the balances can be served.
LastRefreshTime Datetime The date and time when the balances was last refreshed.

PayPal Connector for CData Sync

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

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

Name Type References Description
Id [KEY] String The PayPal-generated ID for the captured payment.
Status String The status of the captured payment.
StatusDetails String The details of the captured payment status.
AmountValue Decimal The amount for this captured payment.
AmountCurrency String The currency of the amount for this captured payment.
InvoiceId String The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
CustomId String The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
SellerProtectionStatus String The level of protection offered as defined by PayPal Seller Protection for Merchants.
FinalCapture Boolean Indicates whether you can make additional captures against the authorized payment.
DisbursementMode String The funds that are held on behalf of the merchant.
SellerGrossAmount Decimal The amount for this captured payment.
SellerPaypalFee Decimal The applicable fee for this captured payment.
SellerNetAmount Decimal The net amount that the payee receives for this captured payment in their PayPal account.
SellerReceivableAmount Decimal The net amount that is credited to the payee's PayPal account. Returned only when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds.
SellerExchangeRate Decimal The exchange rate that determines the amount that is credited to the payee's PayPal account. Returned when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds.
CreateTime Datetime The time of authorization.
UpdateTime Datetime The time that the resource was last updated.

PayPal Connector for CData Sync

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

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

Name Type References Description
Id [KEY] String The Id of the credit card.
Number String The redacted credit card number.
Type String The credit card type. Valid types are: visa, mastercard, discover, amex.
ExpireMonth Integer The expiration month with no leading zero. Acceptable values are 1 through 12.
ExpireYear Integer The 4-digit expiration year.
FirstName String The first name of the cardholder.
LastName String The last name of the cardholder.
AddressLine1 String The billing address associated with card. Line 1 of the address (e.g., number, street, etc.).
AddressLine2 String The optional line 2 of the Address (e.g., suite, apt number, etc.).
City String The city name.
CountryCode String The 2-letter country code.
PostalCode String The ZIP code or equivalent is usually required for countries that have them.
Phone String The phone number in E.123 format.
ExternalCustomerId String The unique identifier of the customer to whom this bank account belongs. Generated and provided by the facilitator.
MerchantId String The user-provided, optional field that functions as a unique identifier for the merchant holding the card. Note that this has no relation to PayPal merchant Id.
ExternalCardId String The unique identifier of the bank account resource. Generated and provided by the facilitator so it can be used to restrict the usage of the bank account to the specific merchant.
CreateTime Datetime The resource creation time in ISO8601 date-time format (e.g., 1994-11-05T13:15:30Z).
UpdateTime Datetime The resource update time in ISO8601 date-time format (e.g., 1994-11-05T13:15:30Z).
State String The state of the credit card funding instrument: expired or ok.
ValidUntil Datetime The funding instrument expiration date.

PayPal Connector for CData Sync

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

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

Name Type References Description
AssetSymbol [KEY] String The Cryptocurrency ticker symbol / code as assigned by liquidity providers.
AccountId String The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties.
Quantity Decimal Quantity of a cryptocurrency asset.
AsOfTime Datetime The requested date and time or the last date and time when the balances can be served.
LastRefreshTime Datetime The date and time when the balances were last refreshed.

PayPal Connector for CData Sync

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

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

Name Type References Description
DisputeId [KEY] String The ID of the dispute.
CreatedTime Datetime The date and time when the dispute was created.
UpdatedTime Datetime The date and time when the dispute was updated.
Status String The status of the dispute.

使用できる値は次のとおりです。OPEN, WAITING_FOR_BUYER_RESPONSE, WAITING_FOR_SELLER_RESPONSE, UNDER_REVIEW, RESOLVED, OTHER

Reason String The reason for the item-level dispute.

使用できる値は次のとおりです。MERCHANDISE_OR_SERVICE_NOT_RECEIVED, MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED, UNAUTHORISED, CREDIT_NOT_PROCESSED, DUPLICATE_TRANSACTION, INCORRECT_AMOUNT, PAYMENT_BY_OTHER_MEANS, CANCELED_RECURRING_BILLING, PROBLEM_WITH_REMITTANCE, OTHER

DisputeState String The state of the dispute.

使用できる値は次のとおりです。OPEN_INQUIRIES, REQUIRED_ACTION, REQUIRED_OTHER_PARTY_ACTION, UNDER_PAYPAL_REVIEW, APPEALABLE, RESOLVED

DisputeCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
DisputeAmountValue Decimal The value of the amount.
ExternalReasonCode String The code that identifies the reason for the credit card chargeback.
DisputeOutcomeCode String The outcome of a resolved dispute.
DisputeOutcomeAmountRefundedCode String The three-character ISO-4217 currency code that identifies the currency.
DisputeOutcomeAmountRefundedValue Decimal The value of the amount.
DisputeLifecycleStage String The stage in the dispute lifecycle.
DisputeChannel String The channel where the customer created the dispute.
OfferType String The merchant-proposed offer type for the dispute.
BuyerRequestedAmountCode String The three-character ISO-4217 currency code that identifies the currency.
BuyerRequestedAmountValue Decimal The value of the amount.
BuyerResponseDueDate Datetime The date and time by when the customer must respond to the dispute.
SellerOfferedAmountCode String The three-character ISO-4217 currency code that identifies the currency.
SellerOfferedAmountValue Decimal The value of the amount.
SellerResponseDueDate Datetime The date and time by when the seller must respond to the dispute.
Email String The email address that is provided by the merchant where the customer can share the evidences.
Note String The merchant provided notes that are visible to both the customer and PayPal.
TimePosted Datetime The date and time when the contact details were posted.

PayPal Connector for CData Sync

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

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

Name Type References Description
DisputeId [KEY] String The ID of the dispute.
CreatedTime Datetime The date and time when the dispute was created.
UpdatedTime Datetime The date and time when the dispute was updated.
Status String The status of the dispute.

使用できる値は次のとおりです。OPEN, WAITING_FOR_BUYER_RESPONSE, WAITING_FOR_SELLER_RESPONSE, UNDER_REVIEW, RESOLVED, OTHER

Reason String The reason for the item-level dispute.

使用できる値は次のとおりです。MERCHANDISE_OR_SERVICE_NOT_RECEIVED, MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED, UNAUTHORISED, CREDIT_NOT_PROCESSED, DUPLICATE_TRANSACTION, INCORRECT_AMOUNT, PAYMENT_BY_OTHER_MEANS, CANCELED_RECURRING_BILLING, PROBLEM_WITH_REMITTANCE, OTHER

DisputeState String The state of the dispute.

使用できる値は次のとおりです。OPEN_INQUIRIES, REQUIRED_ACTION, REQUIRED_OTHER_PARTY_ACTION, UNDER_PAYPAL_REVIEW, APPEALABLE, RESOLVED

DisputeCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
DisputeAmountValue Decimal The value of the amount.

PayPal Connector for CData Sync

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

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

Name Type References Description
DisputeId [KEY] String The ID of the dispute.
CreatedTime Datetime The date and time when the transaction was created.
TransactionStatus String The transaction status.
GrossAmountCode String The three-character ISO-4217 currency code that identifies the currency.
GrossAmountValue Decimal The value of the amount.
BuyerName String The customer's name.
BuyerTransactionId String The customer's transaction ID.
SellerEmail String The email address for the merchant's PayPal account.
SellerMerchantId String The PayPal account ID for the merchant.
SellerTransactionId String The ID, as seen by the merchant, for this transaction.
SellerName String The name of the merchant.
SellerProtectionEligible Boolean Indicator if the seller is eligible for protection.
Custom String A free-text field that is entered by the merchant during checkout.

PayPal Connector for CData Sync

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

Columns

Name Type References Description
Id [KEY] String The ID of the invoice.
ParentId String The parent ID to an invoice that defines the group invoice to which the invoice is related.
Status String The status of the invoice.
Reference String The reference data. Includes a post office (PO) number.
Currency String The three-character ISO-4217 currency code that identifies the currency.
Note String A note to the invoice recipient. Also appears on the invoice notification email.
TermsAndConditions String The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.
Memo String A private bookkeeping memo for the user.
InvoiceDate Datetime The invoice date as specificed by the sender, in Internet date and time format.
InvoiceNumber String A private bookkeeping memo for the user.
TermType String The payment term. Payment can be due upon receipt, a specified date, or in a set number of days.
DueDate Datetime The date when the invoice payment is due, in Internet date and time format.
DueAmount Decimal The due amount, which is the balance amount outstanding after payments.
Gratuity Decimal The amount paid by the payer as gratuity to the invoicer.
PaidAmount Decimal The aggregated payment amounts against this invoice.
RefundAmount Decimal The aggregated refund amounts.
CreatedTime Datetime The date and time when the resource was created, in Internet date and time format.
CreatedBy String The email address of the account that created the resource.
LastUpdatedTime Datetime The date and time when the resource was last edited, in Internet date and time format.
LastUpdatedBy String The email address of the account that last edited the resource.
CancelTime Datetime The date and time when the resource was canceled, in Internet date and time format.
CancelledBy String The actor who canceled the resource.
FirstSentTime Datetime The date and time when the resource was first sent, in Internet date and time format.
LastSentTime Datetime The date and time when the resource was last sent, in Internet date and time format.
LastSentBy String The email address of the account that last sent the resource.
CreatedByFlow String The flow variation that created this invoice.
RecipientViewUrl String The URL for the invoice payer view hosted on paypal.com.
InvoicerViewUrl String The URL for the invoice merchant view hosted on paypal.com.
InvoicerBusinessName String The business name of the party.
InvoicerPrefixName String The prefix, or title, to the party's name.
InvoicerFirstName String When the party is a person, the party's given, or first, name.
InvoicerMiddleName String When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
InvoicerLastName String When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person.
InvoicerSuffixName String The suffix for the party's name.
InvoicerFullName String When the party is a person, the party's full name.
InvoicerAddressLine1 String The first line of the address. For example, number or street.
InvoicerAddressLine2 String The second line of the address. For example, suite or apartment number.
InvoicerAddressLine3 String The third line of the address, if needed.
InvoicerAddressPostalCode String The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
InvoicerAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
InvoicerAddressStreetNumber String The street number.
InvoicerAddressStreetName String The street name. Just Drury in Drury Lane.
InvoicerAddressStreetType String The street type. For example, avenue, boulevard, road, or expressway.
InvoicerAddressDeliveryService String The delivery service. Post office box, bag number, or post office name.
InvoicerAddressBuildingName String A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number.
InvoicerAddressSubBuilding String The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name.
InvoicerEmail String The invoicer email address, which must be listed in the user's PayPal profile.
InvoicerWebsite String The invoicer's website.
InvoicerTaxId String The invoicer's tax ID.
InvoicerAdditionalNotes String Any additional information. Includes business hours.
InvoicerLogoUrl String The full URL to an external logo image. The logo image must not be larger than 250 pixels wide by 90 pixels high.
TaxCalculatedAfterDiscount Boolean Indicates whether the tax is calculated before or after a discount.
TaxInclusive Boolean Indicates whether the unit price includes tax.
AllowTip Boolean Indicates whether the invoice enables the customer to enter a tip amount during payment.
TemplateId String The template ID. The template determines the layout of the invoice. Includes which fields to show and hide.
AllowPartialPayment Boolean Indicates whether the invoice allows a partial payment. If false, the invoice must be paid in full. If true, the invoice allows partial payments.
MinimumAmountDue String The minimum amount allowed for a partial payment. Valid only when allow_partial_payment is true.
InvoiceAmount Decimal The invoice amount summary of item total, discount, tax total and shipping.
InvoiceCurrency String The invoice amount summary of item total, discount, tax total and shipping.
ItemTotal Decimal The subtotal for all items. Must equal the sum of (quantity * price) for all items.
InvoiceDiscountPercentage String The discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
InvoiceDiscountValue Decimal The invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places.
ItemDiscountValue Decimal The discount as an amount at item level.
TaxTotal Decimal The aggregated amount of the item and shipping taxes.
ShippingAmount Decimal The shipping fee for all items. Includes tax on shipping.
ShippingTaxAmount Decimal The calculated tax amount. The tax amount is added to the item total.
ShippingTaxPercentage String The tax rate. Value is from 0 to 100. Supports up to five decimal places.
ShippingTaxName String The name of the tax applied on the invoice items.

PayPal Connector for CData Sync

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

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

Name Type References Description
Name String The unique event type name.
Description String The human-readable description of the event type.
WebhookId String Webhook Id.

PayPal Connector for CData Sync

OrderDetails

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

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

Name Type References Description
Id [KEY] String The ID of the order.
Status String The order status. The possible values are: CREATED, SAVED, APPROVED, VOIDED, COMPLETED.
Intent String The intent to either capture payment immediately or authorize a payment for an order after order creation. The possible values are: CAPTURE, AUTHORIZE.
CreatedTime Datetime The date and time when the transaction occurred.
UpdatedTime Datetime The date and time when the transaction was last updated.
PayerId String The ID of the customer who approves and pays for the order. The customer is also known as the payer.
PayerGivenName String The name of the customer who approves and pays for the order. The customer is also known as the payer.
PayerSurname String The last name of the customer who approves and pays for the order. The customer is also known as the payer.
PayerEmail String The email of the customer who approves and pays for the order. The customer is also known as the payer.
PayerPhoneType String The phone type.
PayerPhoneNumber String The phone number, in its canonical international E.164 numbering plan format.
PayerBirthDate String The birth date of the payer in YYYY-MM-DD format.
PayerTaxId String The customer's tax ID. Supported for the PayPal payment method only.
PayerTaxType String The customer's tax ID type. Supported for the PayPal payment method only.
PayerAddressLine1 String The first line of the address. For example, number or street.
PayerAddressLine2 String The second line of the address. For example, suite or apartment number.
PayerAddressPostalCode String The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PayerAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.

PayPal Connector for CData Sync

OrderItems

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

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

Name Type References Description
OrderId String The ID of the Order this Item belongs to.
Id String The PayPal-generated ID for the purchase unit. This ID appears in both the payer's transaction history and the emails that the payer receives.
ReferenceId String The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through PATCH.
Amount String The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
Description String The purchase description.
CustomId String The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
InvoiceId String The API caller-provided external invoice ID for this order.
SoftDescriptor String The payment descriptor on account transactions on the customer's credit card statement.
ShipperFullName String When the party is a person, the party's full name.
ShippingAddressLine1 String The first line of the address. For example, number or street.
ShippingAddressLine2 String The second line of the address. For example, suite or apartment number.
ShippingAddressPostalCode String The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
ShippingAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PayeeEmail String The email address of merchant.
PayeeMerchantId String The encrypted PayPal account ID of the merchant.
DisbursementMode String The funds that are held on behalf of the merchant.

PayPal Connector for CData Sync

Payments

Query details about authorized Payments.

Table Specific Information

Select

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

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

Name Type References Description
Id [KEY] String The PayPal-generated ID for the authorized payment.
Intent String The payment intent.
PayerPaymentMethod String The payment method.
PayerStatus String The status of payer's PayPal account.
PayerEmail String The payer's email address.
PayerSalutation String The payer's salutation.
PayerFirstName String The payer's first name.
PayerMiddleName String The payer's middle name.
PayerLastName String The payer's last name.
PayerSuffix String The payer's suffix.
PayerId String The PayPal-assigned encrypted payer ID.
PayerBirthDate Date The birth date of the payer, in Internet date format.
PayerTaxId String The payer's tax ID. Supported for the PayPal payment method only.
PayerTaxType String The payer's tax ID type. Supported for the PayPal payment method only.
PayerBillingAddressLine1 String The first line of the address. For example, number, street, and so on.
PayerBillingAddressLine2 String The second line of the address. For example, suite or apartment number.
PayerBillingAddressCity String The city name.
PayerBillingAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PayerBillingAddressPostalCode String The postal code, which is the zip code or equivalent.
PayerBillingAddressState String The code for a US state or the equivalent for other countries.
PayerBillingAddressPhone String The phone number, in E.123 format.
PayerBillingAddressNormalizationStatus String The address normalization status. Returned only for payers from Brazil.
PayerBillingAddressType String The type of address. For example, HOME_OR_WORK, GIFT, and so on.
PayerShippingAddressLine1 String The first line of the address. For example, number, street, and so on.
PayerShippingAddressLine2 String The second line of the address. For example, suite or apartment number.
PayerShippingAddressCity String The city name.
PayerShippingAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
PayerShippingAddressPostalCode String The postal code, which is the zip code or equivalent.
PayerShippingAddressState String The code for a US state or the equivalent for other countries.
PayerShippingAddressPhone String The phone number, in E.123 format.
PayerShippingAddressNormalizationStatus String The address normalization status. Returned only for payers from Brazil.
PayerShippingAddressType String The type of address. For example, HOME_OR_WORK, GIFT, and so on.
State String The state of the payment, authorization, or order transaction.
ExperienceProfileId String The PayPal-generated ID for the merchant's payment experience profile. For information, see create web experience profile.
NoteToPayer String A free-form field that clients can use to send a note to the payer.
FailureReason String The reason code for a payment failure.
ReturnUrl String The URL where the payer is redirected after he or she approves the payment. Required for PayPal account payments.
CancelUrl String The URL where the payer is redirected after he or she cancels the payment. Required for PayPal account payments.
BrandName String A label that overrides the business name in the merchant's PayPal account on the PayPal checkout pages.
Locale String The locale of pages that the PayPal payment experience displays.
LandingPage String The type of landing page to show on the PayPal site for customer checkout.
ShippingPreference String The shipping preference.
UserAction String The user action. Presents the customer with either the Continue or Pay Now checkout flow.
CreatedTime Datetime The date and time when the transaction occurred.
UpdatedTime Datetime The date and time when the payment was updated, in Internet date and time format.

PayPal Connector for CData Sync

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

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

Name Type References Description
PaymentId String

Payments.Id

The Id of the payment.
Amount Decimal The amount to collect.
Currency String The currency of the amount to collect.
PayeeEmail String The email address associated with the payee's PayPal account.
PayeeMerchantId String The PayPal account ID for the payee.
Description String The purchase description.
NoteToPayee String The note to the recipient of the funds in this transaction.
Custom String The free-form field for the client's use.
InvoiceNumber String The invoice number to track this payment.
SoftDescriptor String The soft descriptor to use to charge this funding source. If greater than the maximum allowed length, the API truncates the string.
NotifyUrl String The URL to send payment notifications.
AllowedPaymentMethod String The payment method for this transaction. This field does not apply to the credit card payment method.
RecipientName String The name of the recipient.
ShippingPhoneNumber String The shipping phone number, in its canonical international format as defined by the E.164 numbering plan.
ShippingAddressLine1 String The first line of the address. For example, number, street, and so on.
ShippingAddressLine2 String The second line of the address. For example, suite or apartment number.
ShippingAddressCity String The city name.
ShippingAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
ShippingAddressPostalCode String The postal code, which is the zip code or equivalent.
ShippingAddressState String The code for a US state or the equivalent for other countries.
ShippingAddressPhone String The phone number, in E.123 format.
ShippingAddressNormalizationStatus String The address normalization status. Returned only for payers from Brazil.
ShippingAddressType String The type of address. For example, HOME_OR_WORK, GIFT, and so on.

PayPal Connector for CData Sync

PayoutDetails

Retrieve details about Payouts.

Table Specific Information

Select

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

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

SELECT * FROM PayoutDetails WHERE PayoutBatchId = 'HSY55UPD25KF2'

Columns

Name Type References Description
PayoutBatchId [KEY] String The ID of the payout for which to show details.
BatchStatus String The PayPal-generated payout status. If the payout passes preliminary checks, the status is PENDING.
TimeCreated Datetime The date and time when processing for the payout began
TimeCompleted Datetime The date and time when processing for the payout completed.
SenderBatchId String The sender-specified ID number. Tracks the payout in an accounting system.
SenderEmailSubject String The subject line for the email that PayPal sends when payment for a payout item completes. The subject line is the same for all recipients.
Amount Decimal The total amount,requested for the payouts.
Currency String The currency of the total amount
FeeAmount Decimal The amount of the total estimate for the applicable payouts fees. Initially, the fee is 0. The fee is populated after the payout moves to the PROCESSING state.
FeeCurrency String The currency for the applicable payouts fees.

PayPal Connector for CData Sync

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

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

Name Type References Description
PayoutBatchId [KEY] String The ID of the payout for which to show payout items details.
PayoutItemId [KEY] String The ID for the payout item
TransactionId String The PayPal-generated ID for the transaction.
TransactionStatus String The transaction status.
FeeAmount Decimal The amount for the applicable payout fee. Initially, the fee is 0. The fee is populated after the item moves to the PENDING state
FeeCurrency String The currency for the applicable payout fee
RecipientType String The recipient type.Value is: EMAIL, PHONE, PAYPAL_ID.
AmountValue Decimal The amount of payout item.
AmountCurrency String The currency of payout item.
Note String A sender-specified note for notifications.
Receiver String The receiver of the payment. Corresponds to the recipient_type value in the request.
SenderItemId String A sender-specified ID number. Tracks the payout in an accounting system.
TimeProcessed Datetime The date and time when this item was last processed.
ErrorsMessage String The message that describes the error, if any.

PayPal Connector for CData Sync

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

Columns

Name Type References Description
Id [KEY] String The unique PayPal-generated ID for the plan.
CreateTime Datetime The date and time when the plan was created
Description String The detailed description of the plan.
BillingCyclesVersion Integer The active pricing scheme for this billing cycle.
BillingCyclesPricingModel String The active pricing scheme for this billing cycle.
BillingCyclesFrequency String The frequency details for this billing cycle.
BillingCyclesTenureType String The tenure type of the billing cycle.
BillingCyclesSequence Integer The order in which this cycle is to run among other billing cycles.
BillingCyclesTotalCycles Integer The number of times this billing cycle gets executed.
Links String contains the link of plan object
Name String The plan name.
ProductId String The ID for the product.
QuantitySupported Boolean Indicates whether you can subscribe to this plan by providing a quantity for the goods or service..
Status String The plan status.
TaxesInclusive Boolean Indicates whether the tax was already included in the billing amount.
TaxesPercentage String The tax percentage on the billing amount.
UpdateTime Datetime The date and time when the plan was last updated.

PayPal Connector for CData Sync

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

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

Name Type References Description
Id [KEY] String The PayPal-generated ID for the captured payment.
Status String The status of the captured payment.
StatusDetails String The details of the captured payment status.
AmountValue Decimal The amount for this captured payment.
AmountCurrency String The currency of the amount for this captured payment.
InvoiceId String The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
NoteToPayer String The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.
SellerGrossAmount Decimal The amount for this captured payment.
SellerPaypalFee Decimal The applicable fee for this captured payment.
SellerNetAmount Decimal The net amount that the payee receives for this captured payment in their PayPal account.
TotalRefundedMoney Decimal The total amount refunded from the original capture to date.
CreateTime Datetime The time of authorization.
UpdateTime Datetime The time that the resource was last updated.

PayPal Connector for CData Sync

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

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

Name Type References Description
Id [KEY] String The Id of the sale transaction.
State String The state of the sale. One of the following: pending, completed, refunded, or partially_refunded.
Currency String The 3-letter currency code.
Subtotal Decimal The amount of the subtotal of the items.
TaxAmount Decimal The amount charged for tax.
ShippingAmount Decimal The amount charged for shipping.
ShippingDiscount Decimal The amount being discounted for the shipping fee. Only supported when the payment method is set to paypal.
HandlingFeeAmount Decimal The amount being charged for the handling fee. Only supported when the payment method is set to paypal.
InsuranceAmount Decimal The amount being charged for the insurance fee. Only supported when the payment method is set to paypal.
TotalAmount Decimal The total amount charged from the payer to the payee. In case of a refund, this is the refunded amount to the original payer from the payee.
ClearingTime Datetime The expected clearing time for e-check transactions. Only supported when the payment method is set to paypal.
CreateTime Datetime The time of sale.
Description String The description of the sale.
ExchangeRate String The exchange rate applied for this transaction. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
FmfDescription String The description of the filter.
FmfFilterId String The name of the fraud management filter. One of the following: MAXIMUM_TRANSACTION_AMOUNT (basic filter), UNCONFIRMED_ADDRESS (basic filter), COUNTRY_MONITOR (basic filter), AVS_NO_MATCH (address verification service no match -- advanced filter), AVS_PARTIAL_MATCH (address verification service partial match -- advanced filter), AVS_UNAVAILABLE_OR_UNSUPPORTED (address verification service unavailable or not supported -- advanced filter), CARD_SECURITY_CODE_MISMATCH (advanced filter), BILLING_OR_SHIPPING_ADDRESS_MISMATCH (advanced filter), RISKY_ZIP_CODE (high risk lists filter), SUSPECTED_FREIGHT_FORWARDER_CHECK (high risk lists filter), RISKY_EMAIL_ADDRESS_DOMAIN_CHECK (high risk lists filter), RISKY_BANK_IDENTIFICATION_NUMBER_CHECK (high risk lists filter), RISKY_IP_ADDRESS_RANGE (high risk lists filter), LARGE_ORDER_NUMBER (transaction data filter), TOTAL_PURCHASE_PRICE_MINIMUM (transaction data filter), IP_ADDRESS_VELOCITY (transaction data filter), and PAYPAL_FRAUD_MODEL (transaction data filter).
FmfFilterType String The type of the fraud management filter. One of the following: ACCEPT (an ACCEPT filter is triggered only for the TOTAL_PURCHASE_PRICE_MINIMUM filter setting and is returned only in direct credit card payments where payment is accepted), PENDING (triggers a PENDING filter action where you need to explicitly accept or deny the transaction), DENY (triggers a DENY action where payment is denied automatically), and REPORT (triggers the Flag testing mode where payment is accepted).
FmfName String The name of the filter.
ParentPayment String The Id of the payment resource on which this transaction is based.
PaymentMode String The payment mode of the transaction. Only supported when the payment method is set to paypal. One of the following: INSTANT_TRANSFER, MANUAL_BANK_TRANSFER, DELAYED_TRANSFER, or ECHECK.
PendingReason String The reason the transaction is in a pending state. Only supported when the payment method is set to paypal. One of the following: PAYER-SHIPPING-UNCONFIRMED, MULTI-CURRENCY, RISK-REVIEW, REGULATORY-REVIEW, VERIFICATION-REQUIRED , ORDER, or OTHER.
ProtectionEligibility String The level of seller protection in force for the transaction. Only supported when the payment method is set to paypal. One of the following: ELIGIBLE, PARTIALLY_ELIGIBLE, INELIGIBLE.
ProtectionEligibilityType String The kind of seller protection in force for the transaction. This property is returned only when the ProtectionEligibility property is set to ELIGIBLE or PARTIALLY_ELIGIBLE. Only supported when the payment method is set to paypal. One of the following: ITEM_NOT_RECEIVED_ELIGIBLE or UNAUTHORIZED_PAYMENT_ELIGIBLE. One or both of the allowed values can be returned.
ReasonCode String The reason code for the transaction state being Pending or Reversed. Only supported when the payment method is set to paypal. One of the following: CHARGEBACK, GUARANTEE, BUYER_COMPLAINT, REFUND, UNCONFIRMED_SHIPPING_ADDRESS, ECHECK, INTERNATIONAL_WITHDRAWAL, RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION, PAYMENT_REVIEW, REGULATORY_REVIEW, UNILATERAL, or VERIFICATION_REQUIRED.
ReceiptId String The 16-digit number payment identification number returned for guest users to identify the payment.
ReceivableAmount Decimal The receivable amount.
TransactionFee Decimal The transaction fee.
UpdateTime Datetime The time that the sale was last updated.

PayPal Connector for CData Sync

Subscriptions

Get billing and subscription details.

Table Specific Information

Select

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

SELECT * FROM Subscriptions WHERE Id = '1234'

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

The Sync App processes other filters client side within the Sync App.

Columns

Name Type References Description
Id [KEY] String The PayPal-generated ID for the subscription.
BillingInfocycle_executions String The trial and regular billing executions.
BillingInfo_FailedPaymentsCount Integer The Failed payments count.
BillingInfo_LastPaymentAmountCurrencyCode String The last payment amount currency code.
BillingInfo_LastPaymentAmountValue String The last payment amount.
BillingInfo_LastPaymentTime Datetime The date and time when the last payment was made.
BillingInfo_NextBillingTime Datetime The next date and time for billing this subscription.
BillingInfo_OutstandingBalanceCurrencyCode String The total pending bill amount, to be paid by the subscriber.
BillingInfo_outstandingBalanceValue String The total pending bill amount, to be paid by the subscriber.
CreateTime Datetime The date and time of subscription created.
Links String Links for the subscription objects.
PlanId String The ID of the plan.
Quantity Integer The quantity of the product in the subscription.
ShippingAmountCurrencyCode String The currency for a financial transaction, such as a balance or payment due.
ShippingAmountValue String The amount for a financial transaction, such as a balance or payment due.
StartTime Datetime The start date and time of the subscription.
Status String The status of the subscription.
StatusUpdateTime Datetime The date and time of status updated.
SubscriberEmailAddress String The email address of the payer.
SubscriberName_GivenName String The given name of the payer.
SubscriberName_Surname String The sur name of the payer.
SubscriberPayerId String The PayPal-assigned ID for the payer.
SubscriberShippingAddress_AddressAddressLine1 String Primary address of the payer.
SubscriberShippingAddress_AddressAddressLine2 String Secondary address of the payer.
SubscriberShippingAddress_AddressAdminArea1 String Primary address of the payer.
SubscriberShippingAddress_AddressAdminArea2 String Secondary address of the payer.
SubscriberShippingAddress_AddressCountryCode String Country code of the payer address.
SubscriberShippingAddress_AddressPostalCode String Postal code of the payer address.
SubscriberShippingAddress_NameFullName String Full name of the Payer.
UpdateTime Datetime The date and time of subscription updated.

PayPal Connector for CData Sync

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'

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

Columns

Name Type References Description
SubscriptionId String

Subscriptions.Id

The ID of the subscription.
AmountWithBreakdown_FeeAmountCurrencyCode String The fee details for the transaction.
AmountWithBreakdown_FeeAmountValue String The fee details for the transaction.
AmountWithBreakdown_GrossAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
AmountWithBreakdown_GrossAmountValue String The value of the currency.
AmountWithBreakdown_NetAmountCurrencyCode String The currency code of the net amount that the payee receives for this transaction in their PayPal account.
AmountWithBreakdown_NetAmountValue String The net amount that the payee receives for this transaction in their PayPal account.
PayerEmail String The email ID of the customer.
PayerNameGivenName String When the party is a person, the party's given, or first, name.
PayerNameSurname String When the party is a person, the party's surname or family name. Also known as the last name.
Status String The initial state of the plan.
Time Datetime The date and time when the transaction was processed.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
StartTime Datetime The start time of the range of transactions to list.
EndTime Datetime The end time of the range of transactions to list.

PayPal Connector for CData Sync

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

Columns

Name Type References Description
AccountNumber String The merchant account number.
LastRefreshedDatetime Datetime The date and time when the data was last refreshed, in Internet date and time format.
AuctionInfoAuctionBuyerId String The ID of the buyer who makes the purchase in the auction.
AuctionInfoAuctionClosingDate Datetime The date and time when the auction closes.
AuctionInfoAuctionItemSite String The auction site URL.
AuctionInfoAuctionSite String The name of the auction site.
PayerInfoAccountId String The PayPal customer account ID.
PayerInfoAddressStatus String The address status of the payer.
PayerInfoCountryCode String The two-character ISO 3166-1 code that identifies the country or region of the payer.
PayerInfoEmailAddress String The email address of the payer.
PayerInfoPayerNameAlternateFullName String The party's alternate name.
PayerInfoPayerNameGivenName String When the party is a person, the party's given, or first, name.
PayerInfoPayerNameSurname String When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
PayerInfoPayerStatus String The status of the payer. Value is Y or N.
ShippingInfoAddressCity String The city name.
ShippingInfoAddressCountryCode String The two-character ISO 3166-1 code that identifies the country or region.
ShippingInfoAddressLine1 String The first line of the address. For example, number or street.
ShippingInfoAddressLine2 String The second line of the address. For example, suite or apartment number.
ShippingInfoAddressPostalCode String The postal code, which is the zip code or equivalent.
ShippingInfoName String The recipient's name.
StoreInfoStoreId String The ID of a store for a merchant in the system of record.
StoreInfoTerminalId String The terminal ID for the checkout stand in a merchant store.
TransactionInfoCustomField String The merchant-provided custom text.
TransactionInfoFeeAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoFeeAmountValue String The value of fee.
TransactionInfoInsuranceAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoInsuranceAmountValue String The value of insurance amount.
TransactionInfoInvoiceId String The invoice ID that is sent by the merchant with the transaction.
TransactionInfoPaypalAccountId String The ID of the PayPal account of the counterparty.
TransactionInfoProtectionEligibility String Indicates whether the transaction is eligible for protection.
TransactionInfoShippingAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoShippingAmountValue String The value of shipping amount.
TransactionInfoShippingDiscountAmountCurrency_code String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoShippingDiscountAmountValue String The value of shipping discount amount.
TransactionInfoTransactionAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoTransactionAmountValue String The value of transaction amount.
TransactionInfoTransactionEventCode String A five-digit transaction event code that classifies the transaction type based on money movement and debit or credit.
TransactionInfoTransactionId String The PayPal-generated transaction ID.
TransactionInfoTransactionInitiationDate Datetime The date and time when work on a transaction began in the PayPal system, as expressed in the time zone of the account on this side of the payment.
TransactionInfoTransactionNote String A special note that the payer passes to the payee. Might contain special customer requests, such as shipping instructions.
TransactionInfoTransactionStatus String A code that indicates the transaction status.
TransactionInfoTransactionSubject String The subject of payment. The payer passes this value to the payee. The payer controls this data through the interface through which he or she sends the data.
TransactionInfoTransactionUpdatedDate Datetime The date and time when the transaction was last changed, as expressed in the time zone of the account on this side of the payment.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
StartDate Datetime The start date and time, in Internet date and time format.
EndDate Datetime The end date and time, in Internet date and time format.
TransactionId String The PayPal-generated transaction ID.
PaymentInstrumentType String Filters the transactions in the response by a payment instrument type.
BalanceAffectingRecordsOnly String Indicates whether the response includes only balance-impacting transactions or all transactions.

使用できる値は次のとおりです。Y, N

StoreId String Filters the transactions in the response by a store ID.
TerminalId String Filters the transactions in the response by a terminal ID.
TransactionAmount String Filters the transactions in the response by a gross transaction amount range. For example, to search for transactions from $5.00 to $10.05, specify [500 TO 1005].
TransactionCurrency String Filters the transactions in the response by a three-character ISO-4217 currency code for the PayPal transaction currency.
TransactionStatus String Filters the transactions in the response by a PayPal transaction status code.

使用できる値は次のとおりです。D, P, S, V

TransactionType String Filters the transactions in the response by a PayPal transaction event code.

PayPal Connector for CData Sync

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

Columns

Name Type References Description
AccountNumber String The merchant account number.
LastRefreshedDatetime Datetime The date and time when the data was last refreshed, in Internet date and time format.
InvoiceNumber String The invoice number. An alphanumeric string that identifies a billing for a merchant.
ItemAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
ItemAmountValue String The value of item amount.
ItemCode String An item code that identifies a merchant's goods or service.
ItemDescription String The item description.
ItemName String The item name.
ItemQuantity String The number of purchased units of goods or a service.
ItemUnitPriceCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
ItemUnitPriceValue String The value of item unit price.
TaxAmounts String An array of tax amounts levied by a government on the purchase of goods or services.
TotalItemAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
TotalItemAmountValue String The value of total item amount.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
StartDate Datetime The start date and time, in Internet date and time format.
EndDate Datetime The end date and time, in Internet date and time format.
TransactionId String The PayPal-generated transaction ID.
PaymentInstrumentType String Filters the transactions in the response by a payment instrument type.
BalanceAffectingRecordsOnly String Indicates whether the response includes only balance-impacting transactions or all transactions.

使用できる値は次のとおりです。Y, N

StoreId String Filters the transactions in the response by a store ID.
TerminalId String Filters the transactions in the response by a terminal ID.
TransactionAmount String Filters the transactions in the response by a gross transaction amount range. For example, to search for transactions from $5.00 to $10.05, specify [500 TO 1005].
TransactionCurrency String Filters the transactions in the response by a three-character ISO-4217 currency code for the PayPal transaction currency.
TransactionStatus String Filters the transactions in the response by a PayPal transaction status code.

使用できる値は次のとおりです。D, P, S, V

TransactionType String Filters the transactions in the response by a PayPal transaction event code.

PayPal Connector for CData Sync

TransactionReportsIncentiveDetails

List Incentive Details of Transaction Reports.

Columns

Name Type References Description
AccountNumber String The merchant account number.
LastRefreshedDatetime Datetime The date and time when the data was last refreshed, in Internet date and time format.
IncentiveAmountCurrencyCode String The three-character ISO-4217 currency code that identifies the currency.
IncentiveAmountValue String The value of incentive amount.
IncentiveCode String The code that identifies an incentive, such as a coupon.
IncentiveProgramCode String The incentive program code that identifies a merchant loyalty or incentive program.
IncentiveType String The type of incentive, such as a special offer or coupon.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
StartDate Datetime The start date and time, in Internet date and time format.
EndDate Datetime The end date and time, in Internet date and time format.
TransactionId String The PayPal-generated transaction ID.
PaymentInstrumentType String Filters the transactions in the response by a payment instrument type.
BalanceAffectingRecordsOnly String Indicates whether the response includes only balance-impacting transactions or all transactions.

使用できる値は次のとおりです。Y, N

StoreId String Filters the transactions in the response by a store ID.
TerminalId String Filters the transactions in the response by a terminal ID.
TransactionAmount String Filters the transactions in the response by a gross transaction amount range. For example, to search for transactions from $5.00 to $10.05, specify [500 TO 1005].
TransactionCurrency String Filters the transactions in the response by a three-character ISO-4217 currency code for the PayPal transaction currency.
TransactionStatus String Filters the transactions in the response by a PayPal transaction status code.

使用できる値は次のとおりです。D, P, S, V

TransactionType String Filters the transactions in the response by a PayPal transaction event code.

PayPal Connector for CData Sync

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 Sync App.

Columns

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

PayPal Connector for CData Sync

SOAP データモデル

CData Sync App は、PayPal SOAP API をデータベースビュー としてモデル化します。一般的に、読み取り専用のデータはビューとして表示されます。これらはスキーマファイルにて定義されます。スキーマファイルは、スキーマを簡単にカスタマイズできるシンプルなテキストベースのコンフィギュレーションファイルです。

このセクションでは、SOAP データモデルに関するAPI の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。

ビュー

ビュー は変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。

PayPal Connector for CData Sync

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

PayPal Connector for CData Sync ビュー

Name Description
Balance View all the currencies of the account and their balances.
BalanceAffecting Query Transactions that affect the account balance.
BalanceTransfer Query Transactions involving Balance Transfers.
BillPay Query Transactions involving BillPay Transactions.
CurrencyConversions Query Transactions involving Currency Conversions.
Dividend Query Transactions involving Dividends.
ECheck Query Transactions involving eChecks.
Fee Query Transactions involving Fees.
FundsAdded Query Transactions generated when funds are added to the balance.
FundsWithdrawn Query Transactions generated when funds are withdrawn from the balance.
MassPay Query Mass Payments Transactions.
MoneyRequest Query Money Request Transactions.
Received Query payments-received Transactions.
Referral Query Transactions involving Referrals.
Refund Query Transactions involving Refunds.
Reversal Query Transactions involving BillPay Reversals.
Sent Query payments-sent Transactions.
Shipping Query Transactions involving UPS Shipping Fees.
Subscription Query Transactions involving Subscriptions.
TransactionDetails Query details about a specific Transaction using the GetTransactionDetails API.
TransactionItems Query details about a specific Transaction's items using the GetTransactionDetails API.
Transactions Query Transaction history using the TransactionSearch API.

PayPal Connector for CData Sync

Balance

View all the currencies of the account and their balances.

Columns

Name Type References Description
CurrencyID String The currency of the balance.
Balance Double The balance of the associated currency.

PayPal Connector for CData Sync

BalanceAffecting

Query Transactions that affect the account balance.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime Date and time that the transaction occurred. Character length and limitations: The date and time of the transaction.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by the invoice identification key, as set by you for the original transaction. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a nonprimary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

BalanceTransfer

Query Transactions involving Balance Transfers.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, or Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode field to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by the invoice identification key, as set by you for the original transaction. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by an alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a nonprimary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

BillPay

Query Transactions involving BillPay Transactions.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by the invoice identification key, as set by you for the original transaction. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

CurrencyConversions

Query Transactions involving Currency Conversions.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by the invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

Dividend

Query Transactions involving Dividends.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

ECheck

Query Transactions involving eChecks.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

Fee

Query Transactions involving Fees.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

FundsAdded

Query Transactions generated when funds are added to the balance.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String An alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

FundsWithdrawn

Query Transactions generated when funds are withdrawn from the balance.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

MassPay

Query Mass Payments Transactions.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

MoneyRequest

Query Money Request Transactions.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

Received

Query payments-received Transactions.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String An alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

Referral

Query Transactions involving Referrals.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

Refund

Query Transactions involving Refunds.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

Reversal

Query Transactions involving BillPay Reversals.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

Sent

Query payments-sent Transactions.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

Shipping

Query Transactions involving UPS Shipping Fees.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

Subscription

Query Transactions involving Subscriptions.

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime The date and time that the transaction occurred.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

TransactionDetails

Query details about a specific Transaction using the GetTransactionDetails API.

Table Specific Information

Select

The only filter supported by the PayPal API is TransactionId, which is required. The Sync App processes other filters client side within the Sync App.

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

Warning: Requesting all TransactionDetails for all transactions could take a long time depending on the number of transactions.

SELECT * FROM TransactionDetails WHERE TransactionId = '4W92068757818534U'

SELECT * FROM TransactionDetails WHERE TransactionId IN ('4W92068757818534U', '0TM835405G491863M')

SELECT * FROM TransactionDetails WHERE TransactionId IN (SELECT Id FROM Transactions)

Columns

Name Type References Description
TransactionId [KEY] String Unique transaction Id of the payment.
ReceiverBusiness String Details about a single transaction. This field is not applicable for point-of-sale transactions.
ReceiverEmail String Primary email address of the payment recipient (the merchant).
ReceiverId String Unique account Id of the payment recipient (the merchant). This value is the same as the value of the referral Id of the recipient.
PayerEmail String Email address of the buyer.
PayerId String Unique PayPal Customer Account identification number.
PayerStatus String Status of the buyer.
PayerFirstName String The first name of the buyer.
PayerMiddleName String The middle name of the buyer.
PayerLastName String The last name of the buyer.
PayerSuffix String The suffix of the buyer.
PayerCountry String The country of residence of the buyer in the form of ISO standard 3166 2-character country codes.
PayerBusiness String The business name of the buyer.
StreetAddress String The first street address.
City String The name of the city.
State String The state or province.
PostalCode String U.S. ZIP code or other country-specific postal code.
ShippingCountry String The expanded name of the country.
PayerPhone String The phone number.
ParentTransactionId String The parent or related transaction identification number.
TransactionType String The type of transaction.
PaymentType String Indicates whether the payment is instant or delayed.
PaymentDate Datetime The date-time stamp of the payment.
GrossAmount Decimal The final amount charged, including any shipping and taxes from your Merchant Profile.
FeeAmount Decimal The PayPal fee amount charged for the transaction.
SettleAmount Decimal The amount deposited in your PayPal account after a currency conversion.
TaxAmount Decimal The tax charged on the transaction.
ExchangeRate String The exchange rate if a currency conversion occurred. This is relevant only if you are billing in the non-primary currency of the buyer. If the buyer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the account of the buyer.
PaymentStatus String Status of the payment.
PendingReason String The reason the payment is pending.
ProtectionEligibility String Prior to version 64.4, the kind of seller protection in force for the transaction.
ProtectionEligibilityType String Since version 64.4, the kind of seller protection in force for the transaction.
StoreId String StoreId as entered in the transaction.
Subject String The value of the subject field entered by the buyer when making a payment.
InvoiceId String Invoice number you set in the original transaction.
Memo String Memo entered by your customer in the PayPal Website Payments note field.
SalesTax Decimal Amount of tax charged on payment.
AuctionBuyerId String The auction Id of the buyer.
AuctionClosingDate Datetime The close date of the auction.

PayPal Connector for CData Sync

TransactionItems

Query details about a specific Transaction's items using the GetTransactionDetails API.

View Specific Information

Select

The only filter supported by the PayPal API is TransactionId, which is required. The Sync App processes other filters client side within the Sync App.

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

Warning: Requesting all TransactionItems for all transactions could take a long time depending on the number of transactions.

SELECT * FROM TransactionItems WHERE TransactionId = '4W92068757818534U'

SELECT * FROM TransactionItems WHERE TransactionId IN ('4W92068757818534U', '0TM835405G491863M')

SELECT * FROM TransactionItems WHERE TransactionId IN (SELECT Id FROM Transactions)

Columns

Name Type References Description
TransactionID String Unique transaction Id of the payment.
EbayItemTxnId String The eBay auction transaction Id of the item that you use to identify items that the buyer purchased.
ItemName String Item name set by you or entered by the customer.
ItemNumber Integer Item number set by you. If this was a shopping cart transaction, PayPal appends the number of the item to the HTML item_number variable, for example, item_number1, item_number2, and so forth.
ShippingAmount Decimal Shipping Amount.
HandlingAmount Decimal Handling Amount.
Quantity Integer Quantity set by you or entered by the buyer.
CouponId String Coupon identification number.
CouponAmount Decimal Amount (value) of the coupon.
ItemAmount Decimal Cost of the item.
CouponAmountCurrency String Currency of the coupon amount, e.g., a 3-character currency code.
SalesTax Decimal Amount of tax charged on payment for this item.

PayPal Connector for CData Sync

Transactions

Query Transaction history using the TransactionSearch API.

Table Specific Information

Select

The following filters are supported by the PayPal API:

  • Id
  • Date
  • Receiver
  • ReceiptId
  • AuctionItemNumber
  • TransactionClass

The Date filter supports the >, >=, <, <=, and = operators while the other filters only support the = operator.

The Sync App processes other filters client side within the Sync App.

For example, the following query is processed server side and retrieves Transactions that were created after the specified Date.

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

Other important filter you can execute client-side is the Type filter. You can use that column to retrive i.e: only the Orders.
After retrieving the IDs of transactions with type order, you can use these IDs to query TransactionItems and TransactionDetails views, to get more details.

SELECT * FROM Transactions WHERE Type = 'Order'

Columns

Name Type References Description
Id [KEY] String The Id of the transaction record of the merchant.
PayerDisplayName String The display name of the buyer.
NetAmount Decimal The net amount of the transaction.
FeeAmount Decimal The fee that PayPal charged for the transaction.
GrossAmount Decimal The total gross amount charged, including any profile shipping cost and taxes.
Status String The status of the transaction. It is one of the following values: Pending, Processing, Success, Denied, or Reversed.

使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed

Date Datetime Date and time that the transaction occurred. Character length and limitations: Date and time are in UTC/GMT format; for example, 2013-08-24T05:38:48Z.
Timezone String The time zone of the transaction. The value is always GMT.
Type String The type of the transaction. It is one of the following values: Order, Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
Payer String Search by the email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
TransactionClass String Search by the classification of the transaction. Some kinds of possible classes of transactions are not searchable with this field. You cannot search for bank transfer withdrawals, for example. This field has one of the following values: All, Sent, Received, MassPay, MoneyRequest, FundsAdded, FundsWithdrawn, Referral, Fee, Subscription, Dividend, Billpay, Refund, CurrencyConversions, BalanceTransfer, Reversal, Shipping, BalanceAffecting, or ECheck.

使用できる値は次のとおりです。All, Sent, Received, MassPay, MoneyRequest, FundsAdded, FundsWithdrawn, Referral, Fee, Subscription, Dividend, Billpay, Refund, CurrencyConversions, BalanceTransfer, Reversal, Shipping, BalanceAffecting, ECheck

Amount String Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol.
AuctionItemNumber String Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumber String Search by credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.
CurrencyCode String Search by the 3-character, ISO 4217 currency code.
InvoiceId String Search by the invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed.
ProfileId String An alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile.
ReceiptId String Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
Receiver String Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.
PayerName String Search by the name of the buyer.

PayPal Connector for CData Sync

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication


プロパティ説明
User認証で使用されるPayPal ユーザーアカウント。
Passwordユーザーの認証で使用されるパスワード。
SignatureThe signature required to use the SOAP API.
UseSandboxA Boolean value indicating if you are using a Sandbox account.

OAuth


プロパティ説明
OAuthClientIdOAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecretOAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall


プロパティ説明
FirewallTypeプロキシベースのファイアウォールで使われるプロトコル。
FirewallServerプロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPortプロキシベースのファイアウォールのTCP ポート。
FirewallUserプロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPasswordプロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy


プロパティ説明
ProxyAutoDetectこれは、システムプロキシ設定を使用するかどうかを示します。
ProxyServerHTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPortProxyServer プロキシが起動しているTCP ポート。
ProxyAuthSchemeProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUserProxyServer プロキシへの認証に使われるユーザー名。
ProxyPasswordProxyServer プロキシへの認証に使われるパスワード。
ProxySSLTypeProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptionsProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging


プロパティ説明
LogModulesログファイルに含めるコアモジュール。

Schema


プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
SchemaThe type of schema to use.

Miscellaneous


プロパティ説明
IncludeDetailsA Boolean value indicating if you will get extra details (for example, the ShippingAddress fields when querying the Invoices table).
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
PayPal Connector for CData Sync

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。


プロパティ説明
User認証で使用されるPayPal ユーザーアカウント。
Passwordユーザーの認証で使用されるパスワード。
SignatureThe signature required to use the SOAP API.
UseSandboxA Boolean value indicating if you are using a Sandbox account.
PayPal Connector for CData Sync

User

認証で使用されるPayPal ユーザーアカウント。

解説

このフィールドは、Password とともに、PayPal サーバーに対して認証をするために使われます。

PayPal Connector for CData Sync

Password

ユーザーの認証で使用されるパスワード。

解説

User およびPassword を一緒に使用してサーバーで認証を行います。

PayPal Connector for CData Sync

Signature

The signature required to use the SOAP API.

解説

The signature required to use the SOAP API.

Along with Signature, User and Password are required to access the Transaction and TransactionDetails tables.

To create an API signature, you need a PayPal business account. To create the signature, log in and click Profile. Click My Selling Tools and, in the Selling Online section, click Update in the API Access section. On the resulting page, click Request API Credentials.

PayPal Connector for CData Sync

UseSandbox

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

解説

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

PayPal Connector for CData Sync

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。


プロパティ説明
OAuthClientIdOAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecretOAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
PayPal Connector for CData Sync

OAuthClientId

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

PayPal Connector for CData Sync

OAuthClientSecret

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

PayPal Connector for CData Sync

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
PayPal Connector for CData Sync

SSLServerCert

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります:

説明 例
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

PayPal Connector for CData Sync

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。


プロパティ説明
FirewallTypeプロキシベースのファイアウォールで使われるプロトコル。
FirewallServerプロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPortプロキシベースのファイアウォールのTCP ポート。
FirewallUserプロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPasswordプロキシベースのファイアウォールへの認証に使われるパスワード。
PayPal Connector for CData Sync

FirewallType

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。

タイプ デフォルトポート 説明
TUNNEL 80 これが設定されている場合、Sync App はPayPal への接続を開き、プロキシを経由して通信が行われます。
SOCKS4 1080 これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5 1080 これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

PayPal Connector for CData Sync

FirewallServer

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

PayPal Connector for CData Sync

FirewallPort

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

PayPal Connector for CData Sync

FirewallUser

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

PayPal Connector for CData Sync

FirewallPassword

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

PayPal Connector for CData Sync

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。


プロパティ説明
ProxyAutoDetectこれは、システムプロキシ設定を使用するかどうかを示します。
ProxyServerHTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPortProxyServer プロキシが起動しているTCP ポート。
ProxyAuthSchemeProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUserProxyServer プロキシへの認証に使われるユーザー名。
ProxyPasswordProxyServer プロキシへの認証に使われるパスワード。
ProxySSLTypeProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptionsProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
PayPal Connector for CData Sync

ProxyAutoDetect

これは、システムプロキシ設定を使用するかどうかを示します。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

PayPal Connector for CData Sync

ProxyServer

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

PayPal Connector for CData Sync

ProxyPort

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

PayPal Connector for CData Sync

ProxyAuthScheme

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

  • BASIC: Sync App はHTTP BASIC 認証を行います。
  • DIGEST: Sync App はHTTP DIGEST 認証を行います。
  • NEGOTIATE: Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
  • PROPRIETARY: Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

PayPal Connector for CData Sync

ProxyUser

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

PayPal Connector for CData Sync

ProxyPassword

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

PayPal Connector for CData Sync

ProxySSLType

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。

AUTOデフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS接続は、常にSSL 有効となります。
NEVER接続は、SSL 有効になりません。
TUNNEL接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

PayPal Connector for CData Sync

ProxyExceptions

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

PayPal Connector for CData Sync

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
LogModulesログファイルに含めるコアモジュール。
PayPal Connector for CData Sync

LogModules

ログファイルに含めるコアモジュール。

解説

指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

PayPal Connector for CData Sync

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
SchemaThe type of schema to use.
PayPal Connector for CData Sync

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

Note: このSync App は複数のスキーマをサポートするため、PayPal カスタムスキーマファイルの構造は以下のようになります。

  • 各スキーマには、そのスキーマ名に対応するフォルダが作られます。
  • これらのスキーマフォルダは親フォルダに含まれています。
  • 親フォルダは、個々のスキーマのフォルダではなく、Location として設定する必要があります。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\PayPal Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:

Platform %APPDATA%
Windows APPDATA 環境変数の値
Linux ~/.config

PayPal Connector for CData Sync

BrowsableSchemas

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

PayPal Connector for CData Sync

Tables

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

PayPal Connector for CData Sync

Views

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

PayPal Connector for CData Sync

Schema

The type of schema to use.

解説

The schemas available are REST (to use the REST API) and SOAP (to use the Classic API).

PayPal Connector for CData Sync

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
IncludeDetailsA Boolean value indicating if you will get extra details (for example, the ShippingAddress fields when querying the Invoices table).
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
PayPal Connector for CData Sync

IncludeDetails

A Boolean value indicating if you will get extra details (for example, the ShippingAddress fields when querying the Invoices table).

解説

A Boolean value indicating if you will get extra details (for example, the ShippingAddress fields when querying the Invoices table).

PayPal Connector for CData Sync

MaxRows

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

PayPal Connector for CData Sync

Other

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

DefaultColumnSizeデータソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename基底のソケットデータ転送を指定のファイルに記録します。

PayPal Connector for CData Sync

PseudoColumns

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

PayPal Connector for CData Sync

Timeout

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

PayPal Connector for CData Sync

UserDefinedViews

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

  • 各ルートエレメントはビューの名前を定義します。
  • 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Payments WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}
UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
指定されたパスは引用符で囲まれていないことに注意してください。

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839