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 は廃止予定です。より優れたリソースアクセスのため、REST 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 認証のクライアントクレデンシャルフローのみをサポートしています。この認証を有効にするには、AuthScheme をOAuth に設定し、カスタムOAuth アプリケーションを作成する必要があります。

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

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

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 Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

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

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

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.

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

このセクションでは、REST データモデルに関するAPI の制限および要件について説明します。

ビュー

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

ストアドプロシージャ

ストアドプロシージャ は、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 ビュー

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	Returns detailed information for an order.
OrderItems	Gets the items in an Order.
PartnerReferrals	Shows details by ID for referral data that was shared by the partner or API caller.
Payments	Query details about authorized Payments.
PaymentTokens	Lists merchant-created templates with associated details.
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.
ProductDetails	Retrieve the list of product details.
Products	Retrieves the list of products, which are goods and services.
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.
Templates	Lists merchant-created templates with associated details.
TransactionReports	Lists PayPal transaction reports.
TransactionReportsCartInfoItemDetails	Lists cart information for transaction reports.
TransactionReportsIncentiveDetails	Lists incentive details of transaction reports.
UserInfo	Shows OpenID Connect user profile information for standard claims.
Users	Lists users.
Webhooks	Query the list of Webhooks.

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. 使用できる値は次のとおりです。CREATED, CAPTURED, DENIED, PARTIALLY_CAPTURED, VOIDED, PENDING
StatusDetails	String		The details of the authorized order pending status. 使用できる値は次のとおりです。PENDING_REVIEW, DECLINED_BY_RISK_FRAUD_FILTERS
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. 使用できる値は次のとおりです。ELIGIBLE, PARTIALLY_ELIGIBLE, NOT_ELIGIBLE
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.

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.

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. 使用できる値は次のとおりです。COMPLETED, DECLINED, PARTIALLY_CAPTURED, PENDING, REFUNDED, FAILED
StatusDetails	String		The details of the captured payment status. 使用できる値は次のとおりです。BUYER_COMPLAINT, CHARGEBACK, ECHECK, INTERNATIONAL_WITHDRAWAL, OTHER, PENDING_REVIEW, RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION, REFUNDED, TRANSACTION_APPROVED_AWAITING_FUNDING, UNILATERAL, VERIFICATION_REQUIRED, DECLINED_BY_RISK_FRAUD_FILTERS
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. 使用できる値は次のとおりです。ELIGIBLE, PARTIALLY_ELIGIBLE, NOT_ELIGIBLE
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. 使用できる値は次のとおりです。INSTANT, DELAYED
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.

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. The last seven characters of the credit card ID are masked and therefore ignored by the API during validation when filtering by ID.
  

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

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

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

Columns

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.

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 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 filter is supported by the PayPal API:

• DisputeId

All other filters are processed client-side by the Sync App. For example, the following query is processed server-side.

Retrieve 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.
DisputeAssetSymbol	String		The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.
DisputeAssetQuantity	String		The quantity of a cryptocurrency asset.
DisputeAssetQuantityInSubunits	String		The quantity of a cryptocurrency asset in the currency's sub units.
DisputeOutcomeAssetRefundedSymbol	String		The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.
DisputeOutcomeAssetRefundedQuantity	Decimal		The quantity of a cryptocurrency asset.
RefundAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
RefundAmountValue	Decimal		The maximum refundable amount.

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 supports the = comparison operator.
• DisputeState supports the = comparison operator.
• CreateTime supports the =, >, >=, <, <= comparison operators.

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

The following queries are processed server-side.

Retrieve details for a specific dispute:

SELECT * FROM Disputes WHERE DisputeId = 'PP-D-12345'

Retrieve 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.
DisputeLifecycleStage	String		The stage in the dispute lifecycle.
DisputeChannel	String		The channel where the customer created the dispute.
BuyerResponseDueDate	Datetime		The date and time by when the customer must respond to the dispute.
SellerResponseDueDate	Datetime		The date and time by when the seller must respond to the dispute.

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.
InvoiceNumber	String		The ID of the invoice for the payment.
ReferenceId	String		The ID, as seen by the partner, for this transaction.

Query Invoices in PayPal.

Table Specific Information

Select

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

The following filters are supported by the PayPal API:

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

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

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

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

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

When using the IncludeDetails property with an offset in the query, set the MaxThreads property to 1 to prevent asynchronous slicing and ensure consistent data retrieval for repeated executions of the same query.

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. 使用できる値は次のとおりです。DRAFT, SENT, SCHEDULED, PAID, MARKED_AS_PAID, CANCELLED, REFUNDED, PARTIALLY_PAID, PARTIALLY_REFUNDED, MARKED_AS_REFUNDED, UNPAID, PAYMENT_PENDING
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	Date		The invoice date as specified 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	Date		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. Also used to store multiple middle names including the patronymic, or father's 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.
DueAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
GratuityCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
PaidAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
RefundAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
MinimumAmountDueCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
ItemTotalCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
InvoiceDiscountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
ItemDiscountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
ShippingAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
ShippingTaxAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.

Pseudo-Columns

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

Name	Type	Description
Archived	Boolean		Indicates whether to list merchant-archived invoices in the response.

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.

Returns detailed information for an order.

Table Specific Information

Select

Note: PayPal REST API does not support listing all OrderIds. An OrderId must be specified. For scenarios that require listing transactions, use the Transactions and TransactionDetails views in the 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. 使用できる値は次のとおりです。BR_CPF, BR_CNPJ
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.
PayerAddressAdminArea1	String		The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PayerAddressAdminArea2	String		A city, town, or village.
PaymentSource	String		The payment source used to fund the payment.
PurchaseUnits	String		An array of purchase units.

Gets 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 the merchant.
PayeeMerchantId	String		The encrypted PayPal account ID of the merchant.
DisbursementMode	String		The funds that are held on behalf of the merchant.
Items	String		An array of items that the customer purchases from the merchant.
MostRecentErrors	String		The error reason code and description that are the reason for the most recent order decline.
PaymentInstruction	String		Any additional payment instructions to be consider during payment processing.
SupplementaryData	String		Supplementary data about this payment.
Payments	String		The comprehensive history of payments for the purchase unit.

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

Table Specific Information

Select

Note: PartnerReferrals API does not give us a way to list all PartnerReferralId-s, so you must specify it.
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 Partner Referral.

SELECT * FROM PartnerReferrals where id= 'ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0='

Columns

Name	Type	References	Description
Id [KEY]	String		The ID to access the customer's data shared by the partner with PayPal.
SubmitterPayerId	String		The payer ID of the partner who shared the referral data.
SubmitterClientId	String		The client ID of the partner who shared the referral data.
IndividualOwners	String		List of owners in the account.
BusinessNames	String		Name of the business.
BusinessEmails	String		Email addresses of the business.
BusinessWebsite	String		Website of the business.
BusinessAddresses	String		List of addresses associated with the business entity.
BusinessPhones	String		List of phone number associated with the business.
BusinessDocuments	String		Business Party related Document data collected from the customer.
BusinessType	String		Type of business entity like corporation, sole prop, governmental.
BusinessSubtype	String		The sub classification of the business type.
BusinessIndustryCategory	String		The customer's business category code.
BusinessIndustryMccCode	String		The customer's business seller category code.
BusinessIndustrySubcategory	String		The customer's business subcategory code.
BusinessIncorporationCountryCode	String		The incorporation country code.
BusinessIncorporationDate	Date		Date of business incorporation.
BusinessOfficeBearers	String		List of Directors present as part of the business entity.
BusinessPurposeCode	String		The account's purpose code.
BusinessDescription	String		The business goals description. For example, a mission statement.
IndividualBeneficialOwners	String		List of Individual beneficial owners part of the entity.
BusinessBeneficialOwners	String		List of Business beneficial owners part of the entity.
AnnualSalesVolumeRangeMinAmountCurrencyCode	String		The minimum inclusive amount currency code of the range for the total annual sales volume of the business.
AnnualSalesVolumeRangeMinAmountValue	Decimal		The minimum inclusive amount value of the range for the total annual sales volume of the business.
AnnualSalesVolumeRangeMaxAmountCurrencyCode	String		The maximum inclusive amount currency code of the range for the total annual sales volume of the business.
AnnualSalesVolumeRangeMaxAmountValue	Decimal		The maximum inclusive amount value of the range for the total annual sales volume of the business.
AvgMonthlyVolumeRangeMinAmountCurrencyCode	String		The minimum inclusive amount currency code of the range for the average monthly volume of the business.
AvgMonthlyVolumeRangeMinAmountValue	Decimal		The minimum inclusive amount value of the range for the average monthly volume of the business.
AvgMonthlyVolumeRangeMaxAmountCurrencyCode	String		The maximum inclusive amount currency code of the range for the average monthly volume of the business.
AvgMonthlyVolumeRangeMaxAmountValue	Decimal		The maximum inclusive amount value of the range for the average monthly volume of the business.
TrackingId	String		The partner's unique identifier for this customer in their system which can be used to track user in PayPal.
Operations	String		An array of operations to perform for the customer while they share their data.
Products	String		An array of PayPal products to which the partner wants to onboard the customer.
Capabilities	String		An array of capabilities which the partner wants to enable for the selected products.
OutsideProcessDependencies	String		An array of dependent processes.
LegalConsents	String		An array of all consents that the partner has received from this seller.
Email	String		Email address of the customer used to create the account.
PreferredLanguageCode	String		The preferred locale code to use in the onboarding flow for the customer.
PartnerConfigReturnUrl	String		The URL to which to redirect the customer upon completion of the onboarding process.
PartnerConfigReturnUrlDescription	String		The description of the return URL.
PartnerConfigShowAddCreditCard	Boolean		Indicates whether to show an add credit card page.
FinancialInstrumentBanks	String		An array of banks attached to this managed account.
PayoutAttributesMarketplace	Boolean		If true, specifies that the merchant or platform is offering goods or services on behalf of 3rd party sellers.
PayoutAttributesKycRequired	Boolean		If true, specifies that the Kyc is required for the merchant.
PayoutAttributesCountryTransferMethodCurrency	String		Requested country, transfer method and currency.
LegalCountryCode	String		Legal Country Code.

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.

Lists merchant-created templates with associated details.

Table Specific Information

Select

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

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

The 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 vault token.
CustomerId	String		The unique ID for a customer in merchant's or partner's system of records.
MerchantCustomerId	String		Merchants and partners may already have a data store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer ID to your representation of a customer.
PaymentSourceCardName	String		The card holder's name as it appears on the card.
PaymentSourceCardLastDigits	String		The last digits of the payment card.
PaymentSourceCardVerificationNetworkTransactionId	String		Transaction Identifier as given by the network to indicate a previously executed CIT authorization.
PaymentSourceCardVerificationDate	Datetime		The date that the transaction was authorized by the scheme.
PaymentSourceCardVerificationNetwork	String		Name of the card network through which the transaction was routed.
PaymentSourceCardVerificationTime	String		The date and time when the instrument was verified.
PaymentSourceCardVerificationAmountValue	Decimal		The amount used for card verification.
PaymentSourceCardVerificationAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
PaymentSourceCardVerificationProcessorResponseAvsCode	String		The address verification code for Visa, Discover, Mastercard, or American Express transactions.
PaymentSourceCardVerificationProcessorResponseCvvCode	String		The card verification value code for for Visa, Discover, Mastercard, or American Express.
PaymentSourceCardNetworkTransactionReferenceId	String		Transaction reference id returned by the scheme.
PaymentSourceCardNetworkTransactionReferenceDate	Datetime		The date that the transaction was authorized by the scheme.
PaymentSourceCardNetworkTransactionReferenceNetwork	String		Name of the card network through which the transaction was routed.
PaymentSourceCardNetworkTransactionReferenceTime	Datetime		The date and time when the instrument was verified.
PaymentSourceCardBrand	String		The card brand or network. Typically used in the response.
PaymentSourceCardExpiry	String		The card expiration year and month.
PaymentSourceCardAddressLine1	String		The first line of the address. For example, number or street.
PaymentSourceCardAddressLine2	String		The second line of the address. For example, suite or apartment number.
PaymentSourceCardAddressAdminArea1	String		The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourceCardAddressAdminArea2	String		A city, town, or village.
PaymentSourceCardAddressPostalCode	String		The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourceCardAddressCountryCode	String		The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceCardAddressId	String		The resource ID of the address.
PaymentSourceCardAddressCompany	String		The name of the company or business associated to the address.
PaymentSourceCardAddressPhone	String		The phone number that can go on the mailing label with the address to track the shipping.
PaymentSourceCardAddressGivenName	String		When the party is a person, the party's given, or first, name.
PaymentSourceCardAddressNameSurname	String		When the party is a person, the party's surname or family name.
PaymentSourceCardAddressPhoneNumber	String		The national number.
PaymentSourceCardAddressPhoneNumberCountryCode	String		The country calling code (CC), in its canonical international
PaymentSourceCardVerificationStatus	String		Card verification status
PaymentSourceCardType	String		The payment card type.
PaymentSourcePaypalEmailAddress	String		The email address of the payer.
PaymentSourcePaypalPayerId	String		The PayPal-assigned ID for the payer.
PaymentSourcePaypalGivenName	String		When the party is a person, the party's given, or first, name.
PaymentSourcePaypalNameSurname	String		When the party is a person, the party's surname or family name.
PaymentSourcePaypalPhoneNumber	String		The national number.
PaymentSourcePaypalPhoneType	String		The phone type.
PaymentSourcePaypalAddressLine1	String		The first line of the address. For example, number or street.
PaymentSourcePaypalAddressLine2	String		The second line of the address. For example, suite or apartment number.
PaymentSourcePaypalAddressAdminArea1	String		The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourcePaypalAddressPostalCode	String		The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourcePaypalAddressCountryCode	String		The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourcePaypalAccountId	String		The account identifier for a PayPal account.
PaymentSourceVenmoEmailAddress	String		The email address of the payer.
PaymentSourceVenmoPayerId	String		The PayPal-assigned ID for the payer.
PaymentSourceVenmoGivenName	String		When the party is a person, the party's given, or first, name.
PaymentSourceVenmoNameSurname	String		When the party is a person, the party's surname or family name.
PaymentSourceVenmoPhoneNumber	String		The national number.
PaymentSourceVenmoPhoneType	String		The phone type.
PaymentSourceVenmoAddressLine1	String		The first line of the address. For example, number or street.
PaymentSourceVenmoAddressLine2	String		The second line of the address. For example, suite or apartment number.
PaymentSourceVenmoAddressAdminArea1	String		The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourceVenmoAddressAdminArea2	String		A city, town, or village.
PaymentSourceVenmoAddressPostalCode	String		The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourceVenmoAddressCountryCode	String		The two-character ISO 3166-1 code that identifies the country or region.
PaymentSourceVenmoUserName	String		The Venmo username, as chosen by the user.
PaymentSourceApplePayName	String		The card holder's name as it appears on the card.
PaymentSourceApplePayLastDigits	String		The last digits of the payment card.
PaymentSourceApplePayType	String		The payment card type.
PaymentSourceApplePayBrand	String		The card brand or network.
PaymentSourceApplePayAddressLine1	String		The first line of the address. For example, number or street.
PaymentSourceApplePayAddressLine2	String		The second line of the address. For example, suite or apartment number.
PaymentSourceApplePayAddressAdminArea1	String		The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
PaymentSourceApplePayAddressAdminArea2	String		A city, town, or village.
PaymentSourceApplePayAddressPostalCode	String		The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
PaymentSourceApplePayAddressCountryCode	String		The two-character ISO 3166-1 code that identifies the country or region.

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.

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

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

For example, the following queries are processed server side and retrieve a list of Transactions for the specified Payment.

SELECT * FROM PaymentTransactions WHERE PaymentId = 'PAY-6SL93120VR4146201KZYWPVY'

SELECT * FROM PaymentTransactions WHERE PaymentId IN ('PAY-6SL93120VR4146201KZYWPVY', 'PAY-6SL93120VR0000201KZYWPVY')

Columns

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.
ShippingMethod	String		The shipping method used for this payment, such as USPS Parcel.

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.
TimeClosed	Datetime		The date and time when the payout was closed, in Internet date and time format.
SenderEmailMessage	String		The email message that PayPal sends when the payout item completes. The message is the same for all recipients.
SenderEmailRecipientType	String		The ID type that identifies the payment receiver. 使用できる値は次のとおりです。EMAIL, PHONE, PAYPAL_ID
FundingSource	String		The ID to differentiate a PayPal balance-funded transaction from a PayPal treasury-funded transaction.

Retrieve payout items from a Payout.

Table Specific Information

Select

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

For example, the following queries are processed server side.

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

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.
ErrorsName	String		The human-readable, unique name of the error, if any.
ErrorsDebugId	String		The PayPal internal ID. Used for correlation purposes.
ErrorsInformationLink	String		The information link, or URI, that shows detailed information about this error for the developer.
ActivityId	String		The unique PayPal-generated common ID that links the sender- and receiver-side transactions. Used for tracking.
SenderBatchId	String		A sender-specified ID. Tracks the payout in an accounting system.
RecipientNamePrefix	String		The prefix, or title, to the party's name.
RecipientGivenName	String		When the party is a person, the party's given, or first, name.
RecipientSurname	String		When the party is a person, the party's surname or family name. Also known as the last name.
RecipientMiddleName	String		When the party is a person, the party's middle name.
RecipientFullName	String		When the party is a person, the party's full name.
RecipientWallet	String		The recipient wallet. 使用できる値は次のとおりです。PAYPAL, VENMO
Purpose	String		The purpose of the transaction. 使用できる値は次のとおりです。AWARDS, PRIZES, DONATIONS, GOODS, SERVICES, REBATES, CASHBACK, DISCOUNTS, NON_GOODS_OR_SERVICES

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. 使用できる値は次のとおりです。REGULAR, TRIAL
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 to the 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. 使用できる値は次のとおりです。CREATED, INACTIVE, ACTIVE
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.

Retrieve the list of product details.

Table Specific Information

Select

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

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

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

For example, the following queries are processed server side.

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

Columns

Name	Type	References	Description
ProductId [KEY]	String		The ID of the product.
CreateTime	Datetime		The date and time when the product was created, in Internet date and time format.
UpdateTime	Datetime		The date and time when the product was updated, in Internet date and time format.
Description	String		The product description.
Name	String		The product name.
Type	String		The product type. Indicates whether the product is physical or digital goods, or a service. 使用できる値は次のとおりです。PHYSICAL, DIGITAL, SERVICE
Category	String		The product category.
ImageURL	String		The image URL for the product.
HomeURL	String		The home URL for the product.

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

Table Specific Information

Select

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

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

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

For example, the following queries are processed server side.

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

Columns

Name	Type	References	Description
Id [KEY]	String		The ID of the product.
CreateTime	Datetime		The date and time when the product was created, in Internet date and time format.
Description	String		The product description.
Name	String		The product name.

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. 使用できる値は次のとおりです。CANCELLED, FAILED, PENDING, COMPLETED
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.
CustomId	String		The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions.
AcquirerReferenceNumber	String		Reference ID issued for the card transaction.
PayerEmailAddress	String		The email address of merchant.
PayerMerchantId	String		The encrypted PayPal account ID of the merchant.

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.

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. 使用できる値は次のとおりです。APPROVAL_PENDING, APPROVED, ACTIVE, SUSPENDED, CANCELLED, EXPIRED
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 surname 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.
SubscriberShippingAddress_Type	String		The method by which the payer wants to get their items from the payee, for example, shipping, in-person pickup.
SubscriberPhoneType	String		The phone type.
SubscriberPhoneNumber	String		The phone number, in its canonical international E.164 numbering plan format.
StatusChangeNote	String		The reason or notes for the status of the subscription.
CustomId	String		The custom id for the subscription. Can be invoice id.
PlanOverridden	Boolean		Indicates whether the subscription has overridden any plan attributes.
BillingInfo_LastPaymentStatus	String		The status of the captured payment.
BillingInfo_FinalPaymentTime	Datetime		The date and time when the final billing cycle occurs, in Internet date and time format.

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
Id [KEY]	String		The ID of the transaction.
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. 使用できる値は次のとおりです。COMPLETED, DECLINED, PARTIALLY_REFUNDED, PENDING, REFUNDED
Time	Datetime		The date and time when the transaction was processed.
AmountWithBreakdown_TotalItemAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
AmountWithBreakdown_TotalItemAmountValue	Decimal		The item total for the transaction.
AmountWithBreakdown_ShippingAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
AmountWithBreakdown_ShippingAmountValue	Decimal		The shipping amount for the transaction.
AmountWithBreakdown_TaxAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
AmountWithBreakdown_TaxAmountValue	Decimal		The tax amount for the transaction.

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.

Lists merchant-created templates with associated details.

Table Specific Information

Select

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

Select * from Templates where Id = 'TEMP-3RK55758SK521635N'

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

Columns

Name	Type	References	Description
Id [KEY]	String		The ID of the template.
Name	String		The template name.
DefaultTemplate	Boolean		Indicates whether this template is the default template.
StandardTemplate	Boolean		Indicates whether this template is a invoicer-created custom template. The system generates non-custom templates.
Links	String		An array of request-related HATEOAS links.
TemplateInfoDetailReference	String		The reference data. Includes a Purchase Order (PO) number.
TemplateInfoDetailNote	String		A note to the invoice recipient. Also appears on the invoice notification email.
TemplateInfoDetailTermsAndConditions	String		The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.
TemplateInfoDetailMemo	String		A private bookkeeping memo for the user.
TemplateInfoDetailCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoDetailPaymentTermType	String		The payment term. Payment can be due upon receipt, a specified date, or in a set number of days.
TemplateInfoMetadataCreatedBy	String		The email address of the account that created the resource.
TemplateInfoMetadataLastUpdatedBy	String		The email address of the account that last edited the resource.
TemplateInfoMetadataCreateTime	Datetime		The date and time, in Internet date and time format.
TemplateInfoMetadataLastUpdateTime	Datetime		The date and time, in Internet date and time format.
TemplateInfoInvoicerBusinessName	String		The business name of the party.
TemplateInfoInvoicerPrefixName	String		The prefix, or title, to the party's name.
TemplateInfoInvoicerFirstName	String		When the party is a person, the party's given, or first, name.
TemplateInfoInvoicerMiddleName	String		When the party is a person, the party's middle name. Also used to store multiple middle names including the patronymic, or father's name.
TemplateInfoInvoicerLastName	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.
TemplateInfoInvoicerSuffixName	String		The suffix for the party's name.
TemplateInfoInvoicerFullName	String		When the party is a person, the party's full name.
TemplateInfoInvoicerAddressLine1	String		The first line of the address. For example, number or street.
TemplateInfoInvoicerAddressLine2	String		The second line of the address. For example, suite or apartment number.
TemplateInfoInvoicerAddressLine3	String		The third line of the address, if needed.
TemplateInfoInvoicerAddressAdminArea1	String		The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
TemplateInfoInvoicerAddressAdminArea2	String		A city, town, or village.
TemplateInfoInvoicerAddressAdminArea3	String		A sub-locality, suburb, neighborhood, or district.
TemplateInfoInvoicerAddressAdminArea4	String		The neighborhood, ward, or district.
TemplateInfoInvoicerAddressPostalCode	String		The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
TemplateInfoInvoicerAddressCountryCode	String		The two-character ISO 3166-1 code that identifies the country or region.
TemplateInfoInvoicerAddressStreetNumber	String		The street number.
TemplateInfoInvoicerAddressStreetName	String		The street name. Just Drury in Drury Lane.
TemplateInfoInvoicerAddressStreetType	String		The street type. For example, avenue, boulevard, road, or expressway.
TemplateInfoInvoicerAddressDeliveryService	String		The delivery service. Post office box, bag number, or post office name.
TemplateInfoInvoicerAddressBuildingName	String		A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number.
TemplateInfoInvoicerAddressSubBuilding	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.
TemplateInfoInvoicerPhones	String		An array of invoicer's phone numbers. The invoicer can choose to hide the phone number on the invoice.
TemplateInfoInvoicerWebsite	String		The invoicer's website.
TemplateInfoInvoicerTaxId	String		The invoicer's tax ID.
TemplateInfoInvoicerAdditionalNotes	String		Any additional information. Includes business hours.
TemplateInfoInvoicerLogoUrl	String		The full URL to an external logo image. The logo image must not be larger than 250 pixels wide by 90 pixels high.
TemplateInfoInvoicerEmail	String		The invoicer email address, which must be listed in the user's PayPal profile.
TemplateInfoConfigurationTaxCalculatedAfterDiscount	Boolean		Indicates whether the tax is calculated before or after a discount.
TemplateInfoConfigurationTaxInclusive	Boolean		Indicates whether the unit price includes tax.
TemplateInfoConfigurationAllowTip	Boolean		Indicates whether the invoice enables the customer to enter a tip amount during payment.
TemplateInfoConfigurationAllowPartialPayment	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.
TemplateInfoConfigurationMinimumAmountDue	Decimal		The minimum amount allowed for a partial payment. Valid only when allow_partial_payment is true.
TemplateInfoConfigurationMinimumAmountDueCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountValue	Decimal		The invoice amount summary of item total, discount, tax total and shipping.
TemplateInfoAmountCurrencyCode	String		The invoice amount summary of item total, discount, tax total and shipping.
TemplateInfoAmountBreakdownItemTotalValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
TemplateInfoAmountBreakdownItemTotalCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownInvoiceDiscountPercentage	Decimal		The discount as a percentage value. Value is from 0 to 100.
TemplateInfoAmountBreakdownInvoiceDiscountValue	Decimal		The invoice level discount amount.
TemplateInfoAmountBreakdownInvoiceDiscountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownItemDiscountValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
TemplateInfoAmountBreakdownItemDiscountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownTaxTotalValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
TemplateInfoAmountBreakdownTaxTotalCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownShippingAmountValue	Decimal		The shipping fee for all items. Includes tax on shipping.
TemplateInfoAmountBreakdownShippingAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownShippingTaxAmountValue	Decimal		The calculated tax amount. The tax amount is added to the item total.
TemplateInfoAmountBreakdownShippingTaxAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoAmountBreakdownShippingTaxPercentage	Decimal		The tax rate.
TemplateInfoAmountBreakdownShippingTaxName	String		The name of the tax applied on the invoice items.
TemplateInfoAmountBreakdownShippingTaxNote	String		The tax note used to track the tax related data.
TemplateInfoAmountBreakdownCustomLabel	String		The label to the custom amount of the invoice.
TemplateInfoAmountBreakdownCustomAmountValue	Decimal		The custom amount to apply to an invoice.
TemplateInfoAmountBreakdownCustomAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TemplateInfoDueAmountValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
TemplateInfoDueAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
ItemSettings	String		The template item headers display preference.
SubtotalSettings	String		The template subtotal headers display preference.
UnitOfMeasure	String		The unit of measure for the invoiced item. 使用できる値は次のとおりです。QUANTITY, HOURS, AMOUNT

Lists PayPal transaction reports.

Table Specific Information

Select

The Sync App uses the PayPal API to process WHERE clause conditions that are built with the following filters.

• StartDate
• EndDate
• TransactionId
• PaymentInstrumentType
• BalanceAffectingRecordsOnly
• StoreId
• TerminalId
• TransactionAmount
• TransactionCurrency
• TransactionStatus
• TransactionType

Server-side processing is only supported for the = operator. For example:

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

When filtering by TransactionAmount, values must be specified in the smallest denominations. For example, to retrieve transactions from $6.00 to $10.05, use a range of 600 to 1005, where amounts are expressed in cents.

Supported operators include: =, <, <=, >, >=.

SELECT * FROM TransactionReports WHERE TransactionAmount > 600 AND TransactionAmount < 1005

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. Also used 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 [KEY]	String		A five-digit transaction event code that classifies the transaction type based on money movement and debit or credit.
TransactionInfoTransactionId [KEY]	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. 使用できる値は次のとおりです。D, P, S, V
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.
TransactionInfoAnnualPercentageRate	Decimal		The percentage, as a fixed-point, signed decimal number.
PayerInfoAddressLine1	String		The first line of the address. For example, number or street.
PayerInfoAddressLine2	String		The second line of the address. For example, suite or apartment number.
PayerInfoAddressCity	String		The city name.
PayerInfoAddressState	String		The code for a US state or the equivalent for other countries.
PayerInfoAddressCountryCode	String		The two-character ISO 3166-1 code that identifies the country or region.
PayerInfoAddressPostalCode	String		The postal code, which is the zip code or equivalent.
ShippingInfoAddressState	String		The code for a US state or the equivalent for other countries.
ShippingInfoMethod	String		The shipping method that is associated with this order.
TransactionInfoPaypalReferenceId	String		The PayPal-generated base ID. PayPal exclusive.
TransactionInfoPaypalReferenceIdType	String		The PayPal reference ID type. 使用できる値は次のとおりです。ODR, TXN, SUB, PAP
TransactionInfoPaymentTrackingId	String		The payment tracking ID, which is a unique ID that partners specify to either get information about a payment or request a refund.
TransactionInfoBankReferenceId	String		The bank reference ID.
TransactionInfoCreditTerm	String		The credit term.
TransactionInfoPaymentMethodType	String		The payment method that was used for a transaction. Value is PUI, installment, or mEFT.
TransactionInfoInstrumentType	String		A high-level classification of the type of financial instrument that was used to fund a payment. The pattern is not provided because the value is defined by an external party.
TransactionInfoInstrumentSubType	String		A finer-grained classification of the financial instrument that was used to fund a payment.
TransactionInfoDiscountAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoDiscountAmountValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
TransactionInfoSalesTaxAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoSalesTaxAmountValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
TransactionInfoShippingTaxAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoShippingTaxAmountValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
TransactionInfoOtherAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoOtherAmountValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
TransactionInfoTipAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoTipAmountValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
TransactionInfoEndingBalanceCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoEndingBalanceValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
TransactionInfoAvailableBalanceCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoAvailableBalanceValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
TransactionInfoCreditTransactionalFeeCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoCreditTransactionalFeeValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
TransactionInfoCreditPromotionalFeeCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
TransactionInfoCreditPromotionalFeeValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
PayerInfoPayerNameFullName	String		The party's full name.

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.

Lists cart information for transaction reports.

Table Specific Information

Select

The Sync App uses the PayPal API to process WHERE clause conditions that are built with the following filters.

• StartDate
• EndDate
• TransactionId
• PaymentInstrumentType
• BalanceAffectingRecordsOnly
• StoreId
• TerminalId
• TransactionAmount
• TransactionCurrency
• TransactionStatus
• TransactionType

Server-side processing is only supported for the = operator. For example:

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

For the TransactionAmount filter, enter values in the smallest denomination. For example, to search for transactions from $6.00 to $10.05, use the range of 600 to 1005 (values are in cents).

Supported operators include: =, <, <=, >, >=.

SELECT * FROM TransactionReportsCartInfoItemDetails WHERE TransactionAmount > 600 AND TransactionAmount < 1005

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.
DiscountAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
DiscountAmountValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
AdjustmentAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
AdjustmentAmountValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
GiftWrapAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
GiftWrapAmountValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
TaxPercentage	Decimal		The percentage, as a fixed-point, signed decimal number.
BasicShippingAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
BasicShippingAmountValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
ExtraShippingAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
ExtraShippingAmountValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
HandlingAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
HandlingAmountValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
InsuranceAmountCurrencyCode	String		The three-character ISO-4217 currency code that identifies the currency.
InsuranceAmountValue	Decimal		The amount for a financial transaction, such as a balance or payment due.
ItemOptions	String		The item options. Describes option choices on the purchase of the item in some detail.

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.

Lists incentive details of transaction reports.

Table Specific Information

Select

The Sync App uses the PayPal API to process WHERE clause conditions that are built with the following filters.

• StartDate
• EndDate
• TransactionId
• PaymentInstrumentType
• BalanceAffectingRecordsOnly
• StoreId
• TerminalId
• TransactionAmount
• TransactionCurrency
• TransactionStatus
• TransactionType

Server-side processing is only supported for the = operator. For example:

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

For the TransactionAmount filter, specify amounts in cents. For example, to search for transactions from $6.00 to $10.05, enter the range 600 to 1005.

Supported operators include: =, <, <=, >, >=.

SELECT * FROM TransactionReportsIncentiveDetails WHERE TransactionAmount > 600 AND TransactionAmount < 1005

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

Shows OpenID Connect user profile information for standard claims.

Table Specific Information

Select

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

SELECT * FROM UserInfo

Columns

Name	Type	References	Description
UserId	String		The user ID of the user.
Sub	String		The subject ID for the end user at the issuer.
Name	String		The full name of the user.
GivenName	String		The given, or first, name of the user.
FamilyName	String		The surname or family name of the user. Also known as the last name.
MiddleName	String		The middle name of the user.
Picture	String		The URL of the profile picture of the user.
Email	String		The internationalized email address.
EmailVerified	Boolean		Indicates whether the user's email address is verified.
Gender	String		The user's gender.
Birthdate	Datetime		The user's birthday, in YYYY-MM-DD format.
ZoneInfo	String		The time zone of the user.
Locale	String		The locale of the user.
PhoneNumber	String		The preferred telephone number of the user.
StreetAddress	String		The full street address. Can include the house number and street name.
Locality	String		The city or locality.
Region	String		The state, province, prefecture, or region.
PostalCode	String		The zip code or postal code.
Country	String		The country.
VerifiedAccount	Boolean		Indicates whether the account is verified.
AccountType	String		The account type. 使用できる値は次のとおりです。PERSONAL, BUSINESS, PREMIER
AgeRange	String		The account holder's age range.

Lists users.

Table Specific Information

Select

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

SELECT * FROM Users

Columns

Name	Type	References	Description
Id [KEY]	String		The PayPal payer ID, which is a publicly-sharable of the PayPal account number intended for use with third parties.
UserName	String		Unique identifier for the User, typically used by the user to directly authenticate to the service provider.
GivenName	String		The given, or first, name of the user.
FamilyName	String		The surname or family name of the user. Also known as the last name.
MiddleName	String		The middle name of the user.
ExternalId	String		A String that is an identifier for the resource as defined by the external or 3rd party client.
Active	Boolean		The URL of the profile picture of the user.
Emails	String		Email addresses for the user.
PhoneNumbers	String		Phone numbers for the User.
Addresses	String		Addresses for the User.
Entitlements	String		A list of entitlements for the User that represent a thing the User has.
PreferredLanguage	String		The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions.
Timezone	String		The time zone, in IANA format.
Schemas	String		An array of identified schemas.
MetaResourceType	String		The name of the metadata resource type of the resource: User, Group, etc.
MetaLocation	String		The complete metadata target URL.
MetaCreated	Datetime		The created date and time of metadata, in Internet date and time format.
MetaLastModified	Datetime		The last modified date and time of metadata, in Internet date and time format.

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 の単純なSELECT 処理にとどまらずSync App の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにPayPal から関連するレスポンスデータを返します。

PayPal Connector for CData Sync ストアドプロシージャ

Name	Description
CreateDraftInvoice	Creates a draft invoice.
CreateOrder	Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs.
CreatePayment	Creates a sale, an authorized payment to be captured later, or an order.
CreatePayouts	Makes payouts in Paypal.
CreateSubscription	Create a subscription for Paypal.
DeleteInvoice	Deletes a draft or scheduled invoice, by ID.
SendInvoice	Send an Invoice, by Id, to a customer.

Creates a draft invoice.

Stored Procedure Specific Information

The CreateDraftInvoice Stored Procedure requires following columns to execute:

• InvoiceItems
• DetailCurrencyCode

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

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

Input

Name	Type	Required	Description
PrimaryRecipients	String	False	A JSON aggregate which contains an array of individual PrimaryRecipients which includes the billing and shipping information of each primary recipient.
AdditionalRecipients	String	False	An array of one or more CC: emails to which notifications are sent. If you omit this parameter, a notification is sent to all CC: email addresses that are part of the invoice.
InvoiceItems	String	True	A JSON aggregate which contains an array of individual invoice line item information.
DetailReference	String	False	The reference data. Includes a post office (PO) number.
DetailNote	String	False	A note to the invoice recipient. Also appears on the invoice notification email.
DetailTermsAndConditions	String	False	The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.
DetailMemo	String	False	A private bookkeeping memo for the user.
DetailAttachments	String	False	An array of PayPal IDs for the files that are attached to an invoice.
DetailCurrencyCode	String	True	The three-character ISO-4217 currency code that identifies the currency.
DetailInvoiceNumber	String	False	The invoice number. Default is the number that is auto-incremented number from the last number.
DetailInvoiceDate	String	False	The stand-alone date, in Internet date and time format.
DetailPaymentTermType	String	False	The payment term type of the invoice. Payment can be due upon receipt, a specified date, or in a set number of days.
DetailPaymentTermDueDate	String	False	The stand-alone date, in Internet date and time format.
InvoicerBussinessName	String	False	The business name of the party.
InvoicerName	String	False	A JSON aggregate which contains the name of the party.
InvoicerAddress	String	False	A JSON aggregate which contains the portable international postal address.
InvoicerPhones	String	False	A JSON aggregate which contains an array of invoicer's phone numbers.
InvoicerWebsite	String	False	The invoicer's website.
InvoicerTaxId	String	False	The invoicer's tax ID.
InvoicerAdditionalNotes	String	False	Any additional information. Includes business hours.
InvoicerLogoUrl	String	False	The full URL to an external logo image.
InvoicerEmailAddress	String	False	The internationalized email address with more restrictive rules.
ConfigurationTaxCalculatedAfterDiscount	Boolean	False	Indicates whether the tax is calculated before or after a discount. If false, the tax is calculated before a discount. If true, the tax is calculated after a discount.
ConfigurationTaxInclusive	Boolean	False	Indicates whether the unit price includes tax.
ConfigurationAllowTip	Boolean	False	Indicates whether the invoice enables the customer to enter a tip amount during payment. If true, the invoice shows a tip amount field so that the customer can enter a tip amount. If false, the invoice does not show a tip amount field.
ConfigurationAllowPartialPayment	Boolean	False	Indicates whether the invoice allows a partial payment. If false, the invoice must be paid in full. If true, the invoice allows partial payments.
ConfigurationPartialPaymentMinAmountDueCurrencyCode	String	False	The three-character ISO-4217 currency code that identifies the currency.
ConfigurationPartialPaymentMinAmountDueValue	String	False	The amount value for a financial transaction, such as a balance or payment due.
ConfigurationTemplateId	String	False	The template ID. The template determines the layout of the invoice.
Amount	String	False	A JSON aggregate which contains the breakdown of the amount. Includes total item amount, total tax amount, custom amount, and shipping and discounts, if any.
Payments	String	False	A JSON aggregate which contains an array of payments registered against the invoice.
Refunds	String	False	A JSON aggregate which contains the invoicing refund details. Includes the refund type, date, amount, and method.

Result Set Columns

Name	Type	Description
Id	String	The ID of the invoice.
Status	String	The PayPal-generated invoice status. If the draft invoice is created, the status is DRAFT.

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

Stored Procedure Specific Information

The CreateOrder Stored Procedure requires following columns to execute:

• Intent
• PurchaseUnits

EXEC CreateOrder @Intent = 'CAPTURE', @PurchaseUnits = ' [ {\n
              \"amount\": {\n
                \"currency_code\": \"USD\",\n
                \"value\": \"100.00\"\n
              }\n
            }]'

Input

Name	Type	Required	Description
Intent	String	True	The payment intent: capture, authorize.
PurchaseUnits	String	True	An array of purchase units. Each purchase unit establishes a contract between a payer and the payee.
PaymentSource	String	False	The payment source definition.
ApplicationContext	String	False	Customizes the payer experience during the approval process for the payment with PayPal.

Result Set Columns

Name	Type	Description
Success	Boolean	Indicates whether the operation was successful.
Id	String	The PayPal-generated ID for the payment.

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

Stored Procedure Specific Information

The CreatePayment Stored Procedure requires following columns to execute:

• Intent
• ReturnUrl
• CancelUrl
• PayerPaymentMethod
• Transactions

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

Input

Name	Type	Required	Description
Intent	String	True	The payment intent: sale, authorize, order.
Transactions	String	True	A JSON aggregate which contains an array of payment-related transactions.
NoteToPayer	String	False	A free-form field that clients can use to send a note to the payer.
ReturnUrl	String	True	The URL where the payer is redirected after they approve the payment. Required for PayPal account payments.
CancelUrl	String	True	The URL where the payer is redirected after they cancel the payment. Required for PayPal account payments.
PayerPaymentMethod	String	True	The payment method.
PayerFundingInstruments	String	False	An array of a single funding instrument for the current payment. Valid and required only for the credit card payment method.
PayerInfo	String	False	The payer information.
ApplicationContext	String	False	Use the application context resource to customize payment flow experience for your buyers.

Result Set Columns

Name	Type	Description
Success	Boolean	Indicates whether the operation was successful.
Id	String	The PayPal-generated ID for the payment.