CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるPayPal へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してPayPal に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、PayPal への接続を標準化し、構成することができます。
このページでは、CData Cloud でのPayPal への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのPayPal への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してPayPal からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、PayPal に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
希望のAPI を指定するには、Schema プロパティをREST またはSOAP のいずれかに設定します。Schema が設定されていない場合、PayPal はSOAP スキーマを使用します。
テスト目的では、UseSandbox をtrue に設定してSandbox 認証情報を使用します。
SOAP API を使用して、現在の口座のすべての取引を取得できます。SOAP API は、3 つのクレデンシャル値を持つSignature API-credentials タイプを使用します。
API 認証情報を生成するには:
次の接続プロパティを設定して、接続してください。
次の接続プロパティを設定して、接続してください。
接続すると、Cloud がOAuth プロセスを完了します。 PayPal は、REST API で使用するOAuth 認証のみをサポートします。この認証を有効にするには、すべてのOAuth フローでAuthScheme をOAuth に設定し、カスタムOAuth アプリケーションを作成する必要があります。
以下のサブセクションでは、3つの標準的な認証フローでのPayPal への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。PayPal で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。
OAuth アクセストークンの自動リフレッシュ:
Cloud がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。
OAuth アクセストークンの手動リフレッシュ:
OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。
OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
完了後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにドライバーを設定します。
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:
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.
デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
The CData Cloud models two PayPal APIs as relational databases, the REST API and the SOAP API. Set the Schema property and use the information in each section to select the proper API based on your project needs.
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.
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 Cloud は、PayPal REST API をデータベースビューおよびストアドプロシージャとしてモデル化します。これらはスキーマファイルにて定義されます。スキーマファイルは、スキーマを簡単にカスタマイズできるシンプルなテキストベースのコンフィギュレーションファイルです。
このセクションでは、REST データモデルに関するAPI の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
ビュー は変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。
ストアドプロシージャ は、PayPal のファンクションライクなインターフェースです。これらは、 ビュー に表示されない他のPayPal の機能にアクセスするために使用できます。
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.
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
AuthorizationDetails | Query details about Authorizations. |
Balances | List all non crypto balances. |
CaptureDetails | Query details about a captured Payment. |
CreditCardDetails | Query details about the funding instrument of the payer, such as a Credit Card or a token that represents a Credit Card. |
CryptoBalances | List all crypto balances. |
DisputeDetails | PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes. |
Disputes | PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes. |
DisputeTransactions | PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes. |
Invoices | Query Invoices in PayPal. |
Notifications | Query the list of event types that are subscribed to a Webhook. |
OrderDetails | Query details about an Order. |
OrderItems | Get the items in an Order. |
Payments | Query details about authorized Payments. |
PaymentTransactions | Query Transaction details including the amount and item details. |
PayoutDetails | Retrieve details about Payouts. |
PayoutItems | Retrieve payout items from a Payout. |
Plans | List the Billing Plans. |
RefundDetails | Query details about a specific Refund. |
SaleDetails | Query details about a Sale Transaction. |
Subscriptions | Get billing and subscription details. |
SubscriptionTransactions | Lists transactions for a subscription. |
TransactionReports | Lists transaction reports. |
TransactionReportsCartInfoItemDetails | List Cart Info of Transaction Reports. |
TransactionReportsIncentiveDetails | List Incentive Details of Transaction Reports. |
Webhooks | Query the list of Webhooks. |
Query details about Authorizations.
The only filter supported by the PayPal API is Id, which is required. The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side and retrieve details for a specific Authorization.
SELECT * FROM AuthorizationDetails WHERE Id = '70K15739YA1955155' SELECT * FROM AuthorizationDetails WHERE Id IN ('70K15739YA1955155', '70K15739YA1955156')
Name | Type | References | Description |
Id [KEY] | String | The PayPal-generated ID for the authorized payment. | |
Status | String | The status for the authorized payment. | |
StatusDetails | String | The details of the authorized order pending status. | |
AmountTotal | Decimal | The amount for this authorized payment. | |
AmountCurrency | String | The currency of the amount. | |
InvoiceId | String | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | |
CustomId | String | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. | |
SellerProtectionStatus | String | The level of protection offered as defined by PayPal Seller Protection for Merchants. | |
ExpirationTime | Datetime | The amount being charged for the handling fee. Only supported when the payment method is set to paypal. | |
CreateTime | Datetime | The time of authorization. | |
UpdateTime | Datetime | The time that the resource was last updated. |
List all non crypto balances.
This view returns a list of disputes for the authenticated user.
The following filters are supported by the PayPal API:
The filters only support the = operator.
The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side.
SELECT * FROM Balances WHERE Currency = 'USD'
SELECT * FROM Balances WHERE AsOfTime = '2022-01-09 20:59:59.0'
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.
The only filter supported by the PayPal API is Id, which is required. The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side and retrieve details for a specific Capture.
SELECT * FROM CaptureDetails WHERE Id = '9G02572041588110H' SELECT * FROM CaptureDetails WHERE Id IN ('9G02572041588110H', '9G02572041588111H')
Name | Type | References | Description |
Id [KEY] | String | The PayPal-generated ID for the captured payment. | |
Status | String | The status of the captured payment. | |
StatusDetails | String | The details of the captured payment status. | |
AmountValue | Decimal | The amount for this captured payment. | |
AmountCurrency | String | The currency of the amount for this captured payment. | |
InvoiceId | String | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | |
CustomId | String | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. | |
SellerProtectionStatus | String | The level of protection offered as defined by PayPal Seller Protection for Merchants. | |
FinalCapture | Boolean | Indicates whether you can make additional captures against the authorized payment. | |
DisbursementMode | String | The funds that are held on behalf of the merchant. | |
SellerGrossAmount | Decimal | The amount for this captured payment. | |
SellerPaypalFee | Decimal | The applicable fee for this captured payment. | |
SellerNetAmount | Decimal | The net amount that the payee receives for this captured payment in their PayPal account. | |
SellerReceivableAmount | Decimal | The net amount that is credited to the payee's PayPal account. Returned only when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds. | |
SellerExchangeRate | Decimal | The exchange rate that determines the amount that is credited to the payee's PayPal account. Returned when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds. | |
CreateTime | Datetime | The time of authorization. | |
UpdateTime | Datetime | The time that the resource was last updated. |
Query details about the funding instrument of the payer, such as a Credit Card or a token that represents a Credit Card.
This view returns a list of Credit Cards or details for a specific one.
The following filters are supported by the PayPal API:
The CreateTime filter supports the >, >=, <, <=, and = operators, while the other filters only support the = operator.
The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side.
SELECT * FROM CreditCardDetails WHERE Id = 'CARD-19H02474E2775740PKZYWVVI'
SELECT * FROM CreditCardDetails WHERE CreateTime > '2016-01-01'
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.
This view returns a list of disputes for the authenticated user.
The following filters are supported by the PayPal API:
The filters only support the = operator.
The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side.
SELECT * FROM CryptoBalances WHERE AsOfTime = '2022-01-09 20:59:59.0'
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.
This view returns a list of disputes with detailed information for the authenticated user.
The following filters are supported by the PayPal API:
The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side.
SELECT * FROM DisputeDetails WHERE DisputeId = 'PP-D-12345'
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. | |
String | The email address that is provided by the merchant where the customer can share the evidences. | ||
Note | String | The merchant provided notes that are visible to both the customer and PayPal. | |
TimePosted | Datetime | The date and time when the contact details were posted. |
PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes.
This view returns a list of disputes for the authenticated user.
The following filters are supported by the PayPal API:
The CreateTime filter supports the >, >=, <, <=, and = operators, while the other filters only support the = operator.
The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side.
SELECT * FROM Disputes WHERE DisputeId = 'PP-D-12345'
SELECT * FROM Disputes WHERE CreateTime > '2016-01-01'
Name | Type | References | Description |
DisputeId [KEY] | String | The ID of the dispute. | |
CreatedTime | Datetime | The date and time when the dispute was created. | |
UpdatedTime | Datetime | The date and time when the dispute was updated. | |
Status | String | The status of the dispute.
使用できる値は次のとおりです。OPEN, WAITING_FOR_BUYER_RESPONSE, WAITING_FOR_SELLER_RESPONSE, UNDER_REVIEW, RESOLVED, OTHER | |
Reason | String | The reason for the item-level dispute.
使用できる値は次のとおりです。MERCHANDISE_OR_SERVICE_NOT_RECEIVED, MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED, UNAUTHORISED, CREDIT_NOT_PROCESSED, DUPLICATE_TRANSACTION, INCORRECT_AMOUNT, PAYMENT_BY_OTHER_MEANS, CANCELED_RECURRING_BILLING, PROBLEM_WITH_REMITTANCE, OTHER | |
DisputeState | String | The state of the dispute.
使用できる値は次のとおりです。OPEN_INQUIRIES, REQUIRED_ACTION, REQUIRED_OTHER_PARTY_ACTION, UNDER_PAYPAL_REVIEW, APPEALABLE, RESOLVED | |
DisputeCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
DisputeAmountValue | Decimal | The value of the amount. |
PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes.
This view returns a list of transactions with details for a specific dispute.
The following filters are supported by the PayPal API:
The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side.
SELECT * FROM DisputeTransactions WHERE DisputeId = 'PP-D-12345'
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. |
Query Invoices in PayPal.
The only filter supported by the PayPal API is Id. Server-side processing is only supported for the '=' operator.
SELECT * FROM Invoices WHERE Id = 'INV2-LV8Z-5XH2-L4Z6-7LQ4'
The Cloud processes other filters client side within the Cloud.
Name | Type | References | Description |
Id [KEY] | String | The ID of the invoice. | |
ParentId | String | The parent ID to an invoice that defines the group invoice to which the invoice is related. | |
Status | String | The status of the invoice. | |
Reference | String | The reference data. Includes a post office (PO) number. | |
Currency | String | The three-character ISO-4217 currency code that identifies the currency. | |
Note | String | A note to the invoice recipient. Also appears on the invoice notification email. | |
TermsAndConditions | String | The general terms of the invoice. Can include return or cancellation policy and other terms and conditions. | |
Memo | String | A private bookkeeping memo for the user. | |
InvoiceDate | Datetime | The invoice date as specificed by the sender, in Internet date and time format. | |
InvoiceNumber | String | A private bookkeeping memo for the user. | |
TermType | String | The payment term. Payment can be due upon receipt, a specified date, or in a set number of days. | |
DueDate | Datetime | The date when the invoice payment is due, in Internet date and time format. | |
DueAmount | Decimal | The due amount, which is the balance amount outstanding after payments. | |
Gratuity | Decimal | The amount paid by the payer as gratuity to the invoicer. | |
PaidAmount | Decimal | The aggregated payment amounts against this invoice. | |
RefundAmount | Decimal | The aggregated refund amounts. | |
CreatedTime | Datetime | The date and time when the resource was created, in Internet date and time format. | |
CreatedBy | String | The email address of the account that created the resource. | |
LastUpdatedTime | Datetime | The date and time when the resource was last edited, in Internet date and time format. | |
LastUpdatedBy | String | The email address of the account that last edited the resource. | |
CancelTime | Datetime | The date and time when the resource was canceled, in Internet date and time format. | |
CancelledBy | String | The actor who canceled the resource. | |
FirstSentTime | Datetime | The date and time when the resource was first sent, in Internet date and time format. | |
LastSentTime | Datetime | The date and time when the resource was last sent, in Internet date and time format. | |
LastSentBy | String | The email address of the account that last sent the resource. | |
CreatedByFlow | String | The flow variation that created this invoice. | |
RecipientViewUrl | String | The URL for the invoice payer view hosted on paypal.com. | |
InvoicerViewUrl | String | The URL for the invoice merchant view hosted on paypal.com. | |
InvoicerBusinessName | String | The business name of the party. | |
InvoicerPrefixName | String | The prefix, or title, to the party's name. | |
InvoicerFirstName | String | When the party is a person, the party's given, or first, name. | |
InvoicerMiddleName | String | When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name. | |
InvoicerLastName | String | When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. | |
InvoicerSuffixName | String | The suffix for the party's name. | |
InvoicerFullName | String | When the party is a person, the party's full name. | |
InvoicerAddressLine1 | String | The first line of the address. For example, number or street. | |
InvoicerAddressLine2 | String | The second line of the address. For example, suite or apartment number. | |
InvoicerAddressLine3 | String | The third line of the address, if needed. | |
InvoicerAddressPostalCode | String | The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. | |
InvoicerAddressCountryCode | String | The two-character ISO 3166-1 code that identifies the country or region. | |
InvoicerAddressStreetNumber | String | The street number. | |
InvoicerAddressStreetName | String | The street name. Just Drury in Drury Lane. | |
InvoicerAddressStreetType | String | The street type. For example, avenue, boulevard, road, or expressway. | |
InvoicerAddressDeliveryService | String | The delivery service. Post office box, bag number, or post office name. | |
InvoicerAddressBuildingName | String | A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. | |
InvoicerAddressSubBuilding | String | The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. | |
InvoicerEmail | String | The invoicer email address, which must be listed in the user's PayPal profile. | |
InvoicerWebsite | String | The invoicer's website. | |
InvoicerTaxId | String | The invoicer's tax ID. | |
InvoicerAdditionalNotes | String | Any additional information. Includes business hours. | |
InvoicerLogoUrl | String | The full URL to an external logo image. The logo image must not be larger than 250 pixels wide by 90 pixels high. | |
TaxCalculatedAfterDiscount | Boolean | Indicates whether the tax is calculated before or after a discount. | |
TaxInclusive | Boolean | Indicates whether the unit price includes tax. | |
AllowTip | Boolean | Indicates whether the invoice enables the customer to enter a tip amount during payment. | |
TemplateId | String | The template ID. The template determines the layout of the invoice. Includes which fields to show and hide. | |
AllowPartialPayment | Boolean | Indicates whether the invoice allows a partial payment. If false, the invoice must be paid in full. If true, the invoice allows partial payments. | |
MinimumAmountDue | String | The minimum amount allowed for a partial payment. Valid only when allow_partial_payment is true. | |
InvoiceAmount | Decimal | The invoice amount summary of item total, discount, tax total and shipping. | |
InvoiceCurrency | String | The invoice amount summary of item total, discount, tax total and shipping. | |
ItemTotal | Decimal | The subtotal for all items. Must equal the sum of (quantity * price) for all items. | |
InvoiceDiscountPercentage | String | The discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places. | |
InvoiceDiscountValue | Decimal | The invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places. | |
ItemDiscountValue | Decimal | The discount as an amount at item level. | |
TaxTotal | Decimal | The aggregated amount of the item and shipping taxes. | |
ShippingAmount | Decimal | The shipping fee for all items. Includes tax on shipping. | |
ShippingTaxAmount | Decimal | The calculated tax amount. The tax amount is added to the item total. | |
ShippingTaxPercentage | String | The tax rate. Value is from 0 to 100. Supports up to five decimal places. | |
ShippingTaxName | String | The name of the tax applied on the invoice items. |
Query the list of event types that are subscribed to a Webhook.
The only filter supported by the PayPal API is WebhookId, which only supports the = operator. This is a required parameter.The Cloud processes other filters client side within the Cloud.
For example, the following query is processed server side and retrieves the Notifications list for the specified Webhook.
SELECT * FROM Notifications WHERE WebhookId = '8BU398853V564980H'
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. |
Query details about an Order.
Note: PayPal REST API does not give us a way to list all OrderId-s, so you must specify it. If you need such use case, it's recommended to use the Transactions and TransactionDetails views in SOAP schema.
The only filter supported by the PayPal API is Id, which is required.
The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side and retrieve details for a specific Order.
SELECT * FROM OrderDetails WHERE Id = 'O-1HE90236LH9332431' SELECT * FROM OrderDetails WHERE Id IN ('O-1HE90236LH9332431', 'O-7D635956955612146')
Name | Type | References | Description |
Id [KEY] | String | The ID of the order. | |
Status | String | The order status. The possible values are: CREATED, SAVED, APPROVED, VOIDED, COMPLETED. | |
Intent | String | The intent to either capture payment immediately or authorize a payment for an order after order creation. The possible values are: CAPTURE, AUTHORIZE. | |
CreatedTime | Datetime | The date and time when the transaction occurred. | |
UpdatedTime | Datetime | The date and time when the transaction was last updated. | |
PayerId | String | The ID of the customer who approves and pays for the order. The customer is also known as the payer. | |
PayerGivenName | String | The name of the customer who approves and pays for the order. The customer is also known as the payer. | |
PayerSurname | String | The last name of the customer who approves and pays for the order. The customer is also known as the payer. | |
PayerEmail | String | The email of the customer who approves and pays for the order. The customer is also known as the payer. | |
PayerPhoneType | String | The phone type. | |
PayerPhoneNumber | String | The phone number, in its canonical international E.164 numbering plan format. | |
PayerBirthDate | String | The birth date of the payer in YYYY-MM-DD format. | |
PayerTaxId | String | The customer's tax ID. Supported for the PayPal payment method only. | |
PayerTaxType | String | The customer's tax ID type. Supported for the PayPal payment method only. | |
PayerAddressLine1 | String | The first line of the address. For example, number or street. | |
PayerAddressLine2 | String | The second line of the address. For example, suite or apartment number. | |
PayerAddressPostalCode | String | The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. | |
PayerAddressCountryCode | String | The two-character ISO 3166-1 code that identifies the country or region. |
Get the items in an Order.
Note: PayPal REST API does not give us a way to list all OrderId-s, so you must specify it. If you need such use case, it's recommended to use the Transactions and TransactionItems views in SOAP schema.
The only filter supported by the PayPal API is OrderId, which is required.
The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side and retrieve details for a specific Order.
SELECT * FROM OrderItems WHERE OrderId = 'O-1HE90236LH9332431' SELECT * FROM OrderItems WHERE OrderId IN ('O-1HE90236LH9332431', 'O-7D635956955612146')
Name | Type | References | Description |
OrderId | String | The ID of the Order this Item belongs to. | |
Id | String | The PayPal-generated ID for the purchase unit. This ID appears in both the payer's transaction history and the emails that the payer receives. | |
ReferenceId | String | The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through PATCH. | |
Amount | String | The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any. | |
Description | String | The purchase description. | |
CustomId | String | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. | |
InvoiceId | String | The API caller-provided external invoice ID for this order. | |
SoftDescriptor | String | The payment descriptor on account transactions on the customer's credit card statement. | |
ShipperFullName | String | When the party is a person, the party's full name. | |
ShippingAddressLine1 | String | The first line of the address. For example, number or street. | |
ShippingAddressLine2 | String | The second line of the address. For example, suite or apartment number. | |
ShippingAddressPostalCode | String | The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. | |
ShippingAddressCountryCode | String | The two-character ISO 3166-1 code that identifies the country or region. | |
PayeeEmail | String | The email address of merchant. | |
PayeeMerchantId | String | The encrypted PayPal account ID of the merchant. | |
DisbursementMode | String | The funds that are held on behalf of the merchant. |
Query details about authorized Payments.
The only supported filters are Id and OrderId. Filters only supports the = operator The Cloud processes other filters client side within the Cloud.
For example, the following query is processed server side and retrieves Payments that were created after the specified date.
SELECT * FROM Payments WHERE Id > 'P-41250-2' AND OrderId = 'O-123550-05'
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. |
Query Transaction details including the amount and item details.
The only filter supported by the PayPal API is PaymentId, which is required. The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side and retrieve a list of Transactions for the specified Payment.
SELECT * FROM PaymentTransactions WHERE PaymentId = 'PAY-6SL93120VR4146201KZYWPVY' SELECT * FROM PaymentTransactions WHERE PaymentId IN ('PAY-6SL93120VR4146201KZYWPVY', 'PAY-6SL93120VR0000201KZYWPVY')
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. |
Retrieve details about Payouts.
The only filter supported by the PayPal API is PayoutBatchId, which is required. The Cloud processes other filters client side within the Cloud.
For example, the following query is processed server side and retrieves details for a specific Payout.
SELECT * FROM PayoutDetails WHERE PayoutBatchId = 'HSY55UPD25KF2'
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. |
Retrieve payout items from a Payout.
The only filter supported by the PayPal API is PayoutBatchId, which is required. The Cloud processes other filters client side within the Cloud.
For example, the following query is processed server side and retrieves all payout items for a specific Payout.
SELECT * FROM PayoutItems WHERE PayoutBatchId = 'HSY55UPD25KF2'
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. |
List the Billing Plans.
This view returns a list of subscription plans for the authenticated user.
The following filters are supported by the PayPal API:
SELECT * FROM Plans WHERE Id = '1234' SELECT * FROM Plans WHERE ProductId = '1234'
The Cloud processes other filters client side within the Cloud.
Name | Type | References | Description |
Id [KEY] | String | The unique PayPal-generated ID for the plan. | |
CreateTime | Datetime | The date and time when the plan was created | |
Description | String | The detailed description of the plan. | |
BillingCyclesVersion | Integer | The active pricing scheme for this billing cycle. | |
BillingCyclesPricingModel | String | The active pricing scheme for this billing cycle. | |
BillingCyclesFrequency | String | The frequency details for this billing cycle. | |
BillingCyclesTenureType | String | The tenure type of the billing cycle. | |
BillingCyclesSequence | Integer | The order in which this cycle is to run among other billing cycles. | |
BillingCyclesTotalCycles | Integer | The number of times this billing cycle gets executed. | |
Links | String | contains the link of plan object | |
Name | String | The plan name. | |
ProductId | String | The ID for the product. | |
QuantitySupported | Boolean | Indicates whether you can subscribe to this plan by providing a quantity for the goods or service.. | |
Status | String | The plan status. | |
TaxesInclusive | Boolean | Indicates whether the tax was already included in the billing amount. | |
TaxesPercentage | String | The tax percentage on the billing amount. | |
UpdateTime | Datetime | The date and time when the plan was last updated. |
Query details about a specific Refund.
The only filter supported by the PayPal API is Id, which is required. The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side and retrieve details for a specific Refund.
SELECT * FROM RefundDetails WHERE Id = '4W92068757818534U' SELECT * FROM RefundDetails WHERE Id IN ('4W92068757818534U', '4W91234757818534U')
Name | Type | References | Description |
Id [KEY] | String | The PayPal-generated ID for the captured payment. | |
Status | String | The status of the captured payment. | |
StatusDetails | String | The details of the captured payment status. | |
AmountValue | Decimal | The amount for this captured payment. | |
AmountCurrency | String | The currency of the amount for this captured payment. | |
InvoiceId | String | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | |
NoteToPayer | String | The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives. | |
SellerGrossAmount | Decimal | The amount for this captured payment. | |
SellerPaypalFee | Decimal | The applicable fee for this captured payment. | |
SellerNetAmount | Decimal | The net amount that the payee receives for this captured payment in their PayPal account. | |
TotalRefundedMoney | Decimal | The total amount refunded from the original capture to date. | |
CreateTime | Datetime | The time of authorization. | |
UpdateTime | Datetime | The time that the resource was last updated. |
Query details about a Sale Transaction.
The only filter supported by the PayPal API is Id, which is required. The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side and retrieve details for a specific Sale.
SELECT * FROM SaleDetails WHERE Id = '6M2430095X488331A' SELECT * FROM SaleDetails WHERE Id IN ('6M2430095X488331A', '6M2410805X488331A')
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.
The only filter supported by the PayPal API is Id, which is required. The Cloud processes other filters client side within the Cloud.
SELECT * FROM Subscriptions WHERE Id = '1234'
NOTE: We can get get the SubscriptionId by creating the subscription using CreateSubscription Stored procedure.
The Cloud processes other filters client side within the Cloud.
Name | Type | References | Description |
Id [KEY] | String | The PayPal-generated ID for the subscription. | |
BillingInfocycle_executions | String | The trial and regular billing executions. | |
BillingInfo_FailedPaymentsCount | Integer | The Failed payments count. | |
BillingInfo_LastPaymentAmountCurrencyCode | String | The last payment amount currency code. | |
BillingInfo_LastPaymentAmountValue | String | The last payment amount. | |
BillingInfo_LastPaymentTime | Datetime | The date and time when the last payment was made. | |
BillingInfo_NextBillingTime | Datetime | The next date and time for billing this subscription. | |
BillingInfo_OutstandingBalanceCurrencyCode | String | The total pending bill amount, to be paid by the subscriber. | |
BillingInfo_outstandingBalanceValue | String | The total pending bill amount, to be paid by the subscriber. | |
CreateTime | Datetime | The date and time of subscription created. | |
Links | String | Links for the subscription objects. | |
PlanId | String | The ID of the plan. | |
Quantity | Integer | The quantity of the product in the subscription. | |
ShippingAmountCurrencyCode | String | The currency for a financial transaction, such as a balance or payment due. | |
ShippingAmountValue | String | The amount for a financial transaction, such as a balance or payment due. | |
StartTime | Datetime | The start date and time of the subscription. | |
Status | String | The status of the subscription. | |
StatusUpdateTime | Datetime | The date and time of status updated. | |
SubscriberEmailAddress | String | The email address of the payer. | |
SubscriberName_GivenName | String | The given name of the payer. | |
SubscriberName_Surname | String | The sur name of the payer. | |
SubscriberPayerId | String | The PayPal-assigned ID for the payer. | |
SubscriberShippingAddress_AddressAddressLine1 | String | Primary address of the payer. | |
SubscriberShippingAddress_AddressAddressLine2 | String | Secondary address of the payer. | |
SubscriberShippingAddress_AddressAdminArea1 | String | Primary address of the payer. | |
SubscriberShippingAddress_AddressAdminArea2 | String | Secondary address of the payer. | |
SubscriberShippingAddress_AddressCountryCode | String | Country code of the payer address. | |
SubscriberShippingAddress_AddressPostalCode | String | Postal code of the payer address. | |
SubscriberShippingAddress_NameFullName | String | Full name of the Payer. | |
UpdateTime | Datetime | The date and time of subscription updated. |
Lists transactions for a subscription.
This view returns a list of transactions with details for a specific subscription.
The following filters are supported by the PayPal API:
SELECT * FROM SubscriptionTransactions WHERE SubscriptionId = '1234' SELECT * FROM SubscriptionTransactions WHERE SubscriptionId = '1234' AND StartTime = '2018-01-21T07:50:20.940Z' AND EndTime = '2018-08-21T07:50:20.940Z'
NOTE: 1. SubscriptionId, StartTime and EndTime are the required parameters for this view and if StartTime and EndTime are not specified in the query the default values will be assigned from the code. 2. We can get get the SubscriptionId by creating the subscription using CreateSubscription Stored procedure.
The Cloud processes other filters client side within the Cloud.
Name | Type | References | Description |
SubscriptionId | String | The ID of the subscription. | |
AmountWithBreakdown_FeeAmountCurrencyCode | String | The fee details for the transaction. | |
AmountWithBreakdown_FeeAmountValue | String | The fee details for the transaction. | |
AmountWithBreakdown_GrossAmountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
AmountWithBreakdown_GrossAmountValue | String | The value of the currency. | |
AmountWithBreakdown_NetAmountCurrencyCode | String | The currency code of the net amount that the payee receives for this transaction in their PayPal account. | |
AmountWithBreakdown_NetAmountValue | String | The net amount that the payee receives for this transaction in their PayPal account. | |
PayerEmail | String | The email ID of the customer. | |
PayerNameGivenName | String | When the party is a person, the party's given, or first, name. | |
PayerNameSurname | String | When the party is a person, the party's surname or family name. Also known as the last name. | |
Status | String | The initial state of the plan. | |
Time | Datetime | The date and time when the transaction was processed. |
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 transaction reports.
The filters supported by the PayPal API are StartDate, EndDate, TransactionId, PaymentInstrumentType, BalanceAffectingRecordsOnly, StoreId, TerminalId, TransactionAmount, TransactionCurrency, TransactionStatus, TransactionType. Server-side processing is only supported for the '=' operator.
SELECT * FROM TransactionReports WHERE StartDate = '2021-09-06 12:12:12' AND EndDate = '2021-09-11 12:12:12'
The Cloud processes other filters client side within the Cloud.
Name | Type | References | Description |
AccountNumber | String | The merchant account number. | |
LastRefreshedDatetime | Datetime | The date and time when the data was last refreshed, in Internet date and time format. | |
AuctionInfoAuctionBuyerId | String | The ID of the buyer who makes the purchase in the auction. | |
AuctionInfoAuctionClosingDate | Datetime | The date and time when the auction closes. | |
AuctionInfoAuctionItemSite | String | The auction site URL. | |
AuctionInfoAuctionSite | String | The name of the auction site. | |
PayerInfoAccountId | String | The PayPal customer account ID. | |
PayerInfoAddressStatus | String | The address status of the payer. | |
PayerInfoCountryCode | String | The two-character ISO 3166-1 code that identifies the country or region of the payer. | |
PayerInfoEmailAddress | String | The email address of the payer. | |
PayerInfoPayerNameAlternateFullName | String | The party's alternate name. | |
PayerInfoPayerNameGivenName | String | When the party is a person, the party's given, or first, name. | |
PayerInfoPayerNameSurname | String | When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname. | |
PayerInfoPayerStatus | String | The status of the payer. Value is Y or N. | |
ShippingInfoAddressCity | String | The city name. | |
ShippingInfoAddressCountryCode | String | The two-character ISO 3166-1 code that identifies the country or region. | |
ShippingInfoAddressLine1 | String | The first line of the address. For example, number or street. | |
ShippingInfoAddressLine2 | String | The second line of the address. For example, suite or apartment number. | |
ShippingInfoAddressPostalCode | String | The postal code, which is the zip code or equivalent. | |
ShippingInfoName | String | The recipient's name. | |
StoreInfoStoreId | String | The ID of a store for a merchant in the system of record. | |
StoreInfoTerminalId | String | The terminal ID for the checkout stand in a merchant store. | |
TransactionInfoCustomField | String | The merchant-provided custom text. | |
TransactionInfoFeeAmountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
TransactionInfoFeeAmountValue | String | The value of fee. | |
TransactionInfoInsuranceAmountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
TransactionInfoInsuranceAmountValue | String | The value of insurance amount. | |
TransactionInfoInvoiceId | String | The invoice ID that is sent by the merchant with the transaction. | |
TransactionInfoPaypalAccountId | String | The ID of the PayPal account of the counterparty. | |
TransactionInfoProtectionEligibility | String | Indicates whether the transaction is eligible for protection. | |
TransactionInfoShippingAmountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
TransactionInfoShippingAmountValue | String | The value of shipping amount. | |
TransactionInfoShippingDiscountAmountCurrency_code | String | The three-character ISO-4217 currency code that identifies the currency. | |
TransactionInfoShippingDiscountAmountValue | String | The value of shipping discount amount. | |
TransactionInfoTransactionAmountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
TransactionInfoTransactionAmountValue | String | The value of transaction amount. | |
TransactionInfoTransactionEventCode | String | A five-digit transaction event code that classifies the transaction type based on money movement and debit or credit. | |
TransactionInfoTransactionId | String | The PayPal-generated transaction ID. | |
TransactionInfoTransactionInitiationDate | Datetime | The date and time when work on a transaction began in the PayPal system, as expressed in the time zone of the account on this side of the payment. | |
TransactionInfoTransactionNote | String | A special note that the payer passes to the payee. Might contain special customer requests, such as shipping instructions. | |
TransactionInfoTransactionStatus | String | A code that indicates the transaction status. | |
TransactionInfoTransactionSubject | String | The subject of payment. The payer passes this value to the payee. The payer controls this data through the interface through which he or she sends the data. | |
TransactionInfoTransactionUpdatedDate | Datetime | The date and time when the transaction was last changed, as expressed in the time zone of the account on this side of the payment. |
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. |
List Cart Info of Transaction Reports.
The filters supported by the PayPal API are StartDate, EndDate, TransactionId, PaymentInstrumentType, BalanceAffectingRecordsOnly, StoreId, TerminalId, TransactionAmount, TransactionCurrency, TransactionStatus, TransactionType. Server-side processing is only supported for the '=' operator.
SELECT * FROM TransactionReportsCartInfoItemDetails WHERE StartDate = '2021-09-06 12:12:12' AND EndDate = '2021-09-11 12:12:12'
The Cloud processes other filters client side within the Cloud.
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. |
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. |
List Incentive Details of Transaction Reports.
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. |
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. |
Query the list of Webhooks.
The PayPal API does not support any filters on this table. However, projections are supported. All filters are processed client side within the Cloud.
Name | Type | References | Description |
Id [KEY] | String | The identifier of the webhook resource. | |
Url | String | The webhook notification endpoint URL. |
ストアドプロシージャはファンクションライクなインターフェースで、PayPal の単純なSELECT 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにPayPal から関連するレスポンスデータを返します。
Name | Description |
CreatePayouts | Makes payouts in Paypal. |
CreateSubscription | Create a subscription for Paypal. |
SendInvoice | Send an Invoice, by Id, to a customer. |
Makes payouts in Paypal.
You cannot create a payout without payout items. To create payout items, you must insert data either using a JSON aggregate or via temporary table called 'PayoutItem#TEMP'. Refer to the following examples for more information.
Example: Create payouts using JSON aggregate
EXECUTE CreatePayouts SenderBatchId = '1247', EmailSubject = 'You have a payout!', EmailMessage = 'You have received a payout! Thanks for using our service!', PayoutItem = '[{\n" + "\"recipient_type\": \"EMAIL\",\n" + "\"amount\": {\n" + "\"value\": \"0.0\",\n" + "\"currency\": \"USD\"\n" + "},\n" + "\"note\": \"Thanks for your patronage3333!\",\n" + "\"receiver\": \"receiver@example.com\",\n" + "\"sender_item_id\": \"201403140001\"\n" + "}, {\n" + "\"recipient_type\": \"PHONE\",\n" + "\"amount\": {\n" + "\"value\": \"0.0\",\n" + "\"currency\": \"USD\"\n" + "\t},\n" + "\"note\": \"Thanks for your support!\",\n" + "\"receiver\": \"91-734-234-1234\",\n" + "\"sender_item_id\": \"201403140002\"\n" + "}\n" + "]'
Example: Create payouts using temp table
You first need to insert into PayoutItem#TEMP to create payout items.
INSERT INTO PayoutItem#TEMP (RecipientType, AmountValue, AmountCurrency, Note, SenderItemId, Receiver) VALUES ('EMAIL', '3.2', 'USD', 'Thanks for your patronage!', '201403140001', 'receiver@example.com') INSERT INTO PayoutItem#TEMP (RecipientType, AmountValue, AmountCurrency, Note, SenderItemId, Receiver) VALUES ('PHONE', '8.98', 'USD', 'Thanks for your support!', '201403140002', '91-734-234-1234')
After creating at least one payout item, you can execute the stored procedure.
EXECUTE CreatePayouts SenderBatchId = '123', EmailSubject = 'You have a payout!', EmailMessage = 'You have received a payout! Thanks for using our service!'
The following columns are required to create a payout item:
Name | Type | Required | Description |
SenderBatchId | String | True | A sender-specified ID number. Tracks the payout in an accounting system. |
EmailSubject | String | False | 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. |
EmailMessage | String | False | The email message that PayPal sends when the payout item completes. The message is the same for all recipients. |
PayoutItems | String | False | A JSON aggregate which contains an array of individual payout items |
Name | Type | Description |
PayoutBatchId | String | The PayPal-generated ID for the payout. |
BatchStatus | String | The PayPal-generated payout status. If the payout passes preliminary checks, the status is PENDING. |
Create a subscription for Paypal.
The CreateSubscription Stored Procedure requires PlanId to create a Paypal Subscription.
EXECUTE CreateSubscription PlanId = 'P-5ML4271244454362WXNWU5NQ', StartTime = '2021-11-01T00:00:00Z', ShippingAmount = '{\n" + " \"currency_code\": \"USD\",\n" + " \"value\": \"10.00\"\n" + " }', subscriber = '{\n" + " \"name\": {\n" + " \"given_name\": \"John\",\n" + " \"surname\": \"Doe\"\n" + " },\n" + " \"email_address\": \"customer@example.com\",\n" + " \"shipping_address\": {\n" + " \"name\": {\n" + " \"full_name\": \"John Doe\"\n" + " },\n" + " \"address\": {\n" + " \"address_line_1\": \"2211 N First Street\",\n" + " \"address_line_2\": \"Building 17\",\n" + " \"admin_area_2\": \"San Jose\",\n" + " \"admin_area_1\": \"CA\",\n" + " \"postal_code\": \"95131\",\n" + " \"country_code\": \"US\"\n" + " }\n" + " }\n" + " }'
The following columns are required to create a subscription:
Name | Type | Required | Description |
PlanId | String | True | The ID of the plan.. |
StartTime | String | False | The date and time when the subscription started. |
Quantity | String | False | The quantity of the product in the subscription.. |
ShippingAmount | String | False | A JSON aggregate which contain the shipping charges. |
Subscriber | String | False | A JSON aggregate which contain the subscriber request information . |
ApplicationContext | String | False | A JSON aggregate which contain the application context, which customizes the payer experience during the subscription approval process with PayPal. |
CustomId | String | False | The custom id for the subscription. Can be invoice id. |
Plan | String | False | A JSON aggregate which contain An inline plan object to customise the subscription. |
Name | Type | Description |
SubscriptionId | String | The PayPal-generated ID for the subscription. |
Status | String | The PayPal-generated subscription status. |
Send an Invoice, by Id, to a customer.
Name | Type | Required | Description |
InvoiceId | String | True | The Id of the invoice to send. |
Subject | String | False | The subject of the email that is sent as a notification to the recipient. |
Note | String | False | A note to the payer. |
SendToInvoicer | Boolean | False | Indicates whether to send a copy of the email to the merchant. |
SendToRecipient | Boolean | False | Indicates whether to send a copy of the email to the 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. |
CData Cloud は、PayPal SOAP API をデータベースビュー としてモデル化します。一般的に、読み取り専用のデータはビューとして表示されます。これらはスキーマファイルにて定義されます。スキーマファイルは、スキーマを簡単にカスタマイズできるシンプルなテキストベースのコンフィギュレーションファイルです。
このセクションでは、SOAP データモデルに関するAPI の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
ビュー は変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
Balance | View all the currencies of the account and their balances. |
BalanceAffecting | Query Transactions that affect the account balance. |
BalanceTransfer | Query Transactions involving Balance Transfers. |
BillPay | Query Transactions involving BillPay Transactions. |
CurrencyConversions | Query Transactions involving Currency Conversions. |
Dividend | Query Transactions involving Dividends. |
ECheck | Query Transactions involving eChecks. |
Fee | Query Transactions involving Fees. |
FundsAdded | Query Transactions generated when funds are added to the balance. |
FundsWithdrawn | Query Transactions generated when funds are withdrawn from the balance. |
MassPay | Query Mass Payments Transactions. |
MoneyRequest | Query Money Request Transactions. |
Received | Query payments-received Transactions. |
Referral | Query Transactions involving Referrals. |
Refund | Query Transactions involving Refunds. |
Reversal | Query Transactions involving BillPay Reversals. |
Sent | Query payments-sent Transactions. |
Shipping | Query Transactions involving UPS Shipping Fees. |
Subscription | Query Transactions involving Subscriptions. |
TransactionDetails | Query details about a specific Transaction using the GetTransactionDetails API. |
TransactionItems | Query details about a specific Transaction's items using the GetTransactionDetails API. |
Transactions | Query Transaction history using the TransactionSearch API. |
View all the currencies of the account and their balances.
Name | Type | References | Description |
CurrencyID | String | The currency of the balance. | |
Balance | Double | The balance of the associated currency. |
Query Transactions that affect the account balance.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | Date and time that the transaction occurred. Character length and limitations: The date and time of the transaction. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by the invoice identification key, as set by you for the original transaction. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a nonprimary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Transactions involving Balance Transfers.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, or Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode field to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by the invoice identification key, as set by you for the original transaction. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by an alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a nonprimary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Transactions involving BillPay Transactions.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by the invoice identification key, as set by you for the original transaction. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Transactions involving Currency Conversions.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by the invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Transactions involving Dividends.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Transactions involving eChecks.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Transactions involving Fees.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Transactions generated when funds are added to the balance.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | An alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Transactions generated when funds are withdrawn from the balance.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Mass Payments Transactions.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Money Request Transactions.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query payments-received Transactions.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | An alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Transactions involving Referrals.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Transactions involving Refunds.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Transactions involving BillPay Reversals.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query payments-sent Transactions.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Transactions involving UPS Shipping Fees.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query Transactions involving Subscriptions.
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | The date and time that the transaction occurred. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by the credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | Search by the alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
Query details about a specific Transaction using the GetTransactionDetails API.
The only filter supported by the PayPal API is TransactionId, which is required. The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side and retrieve details for a specific Transaction.
Warning: Requesting all TransactionDetails for all transactions could take a long time depending on the number of transactions.
SELECT * FROM TransactionDetails WHERE TransactionId = '4W92068757818534U' SELECT * FROM TransactionDetails WHERE TransactionId IN ('4W92068757818534U', '0TM835405G491863M') SELECT * FROM TransactionDetails WHERE TransactionId IN (SELECT Id FROM Transactions)
Name | Type | References | Description |
TransactionId [KEY] | String | Unique transaction Id of the payment. | |
ReceiverBusiness | String | Details about a single transaction. This field is not applicable for point-of-sale transactions. | |
ReceiverEmail | String | Primary email address of the payment recipient (the merchant). | |
ReceiverId | String | Unique account Id of the payment recipient (the merchant). This value is the same as the value of the referral Id of the recipient. | |
PayerEmail | String | Email address of the buyer. | |
PayerId | String | Unique PayPal Customer Account identification number. | |
PayerStatus | String | Status of the buyer. | |
PayerFirstName | String | The first name of the buyer. | |
PayerMiddleName | String | The middle name of the buyer. | |
PayerLastName | String | The last name of the buyer. | |
PayerSuffix | String | The suffix of the buyer. | |
PayerCountry | String | The country of residence of the buyer in the form of ISO standard 3166 2-character country codes. | |
PayerBusiness | String | The business name of the buyer. | |
StreetAddress | String | The first street address. | |
City | String | The name of the city. | |
State | String | The state or province. | |
PostalCode | String | U.S. ZIP code or other country-specific postal code. | |
ShippingCountry | String | The expanded name of the country. | |
PayerPhone | String | The phone number. | |
ParentTransactionId | String | The parent or related transaction identification number. | |
TransactionType | String | The type of transaction. | |
PaymentType | String | Indicates whether the payment is instant or delayed. | |
PaymentDate | Datetime | The date-time stamp of the payment. | |
GrossAmount | Decimal | The final amount charged, including any shipping and taxes from your Merchant Profile. | |
FeeAmount | Decimal | The PayPal fee amount charged for the transaction. | |
SettleAmount | Decimal | The amount deposited in your PayPal account after a currency conversion. | |
TaxAmount | Decimal | The tax charged on the transaction. | |
ExchangeRate | String | The exchange rate if a currency conversion occurred. This is relevant only if you are billing in the non-primary currency of the buyer. If the buyer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the account of the buyer. | |
PaymentStatus | String | Status of the payment. | |
PendingReason | String | The reason the payment is pending. | |
ProtectionEligibility | String | Prior to version 64.4, the kind of seller protection in force for the transaction. | |
ProtectionEligibilityType | String | Since version 64.4, the kind of seller protection in force for the transaction. | |
StoreId | String | StoreId as entered in the transaction. | |
Subject | String | The value of the subject field entered by the buyer when making a payment. | |
InvoiceId | String | Invoice number you set in the original transaction. | |
Memo | String | Memo entered by your customer in the PayPal Website Payments note field. | |
SalesTax | Decimal | Amount of tax charged on payment. | |
AuctionBuyerId | String | The auction Id of the buyer. | |
AuctionClosingDate | Datetime | The close date of the auction. |
Query details about a specific Transaction's items using the GetTransactionDetails API.
The only filter supported by the PayPal API is TransactionId, which is required. The Cloud processes other filters client side within the Cloud.
For example, the following queries are processed server side and retrieve details for a specific Transaction.
Warning: Requesting all TransactionItems for all transactions could take a long time depending on the number of transactions.
SELECT * FROM TransactionItems WHERE TransactionId = '4W92068757818534U' SELECT * FROM TransactionItems WHERE TransactionId IN ('4W92068757818534U', '0TM835405G491863M') SELECT * FROM TransactionItems WHERE TransactionId IN (SELECT Id FROM Transactions)
Name | Type | References | Description |
TransactionID | String | Unique transaction Id of the payment. | |
EbayItemTxnId | String | The eBay auction transaction Id of the item that you use to identify items that the buyer purchased. | |
ItemName | String | Item name set by you or entered by the customer. | |
ItemNumber | Integer | Item number set by you. If this was a shopping cart transaction, PayPal appends the number of the item to the HTML item_number variable, for example, item_number1, item_number2, and so forth. | |
ShippingAmount | Decimal | Shipping Amount. | |
HandlingAmount | Decimal | Handling Amount. | |
Quantity | Integer | Quantity set by you or entered by the buyer. | |
CouponId | String | Coupon identification number. | |
CouponAmount | Decimal | Amount (value) of the coupon. | |
ItemAmount | Decimal | Cost of the item. | |
CouponAmountCurrency | String | Currency of the coupon amount, e.g., a 3-character currency code. | |
SalesTax | Decimal | Amount of tax charged on payment for this item. |
Query Transaction history using the TransactionSearch API.
The following filters are supported by the PayPal API:
The Date filter supports the >, >=, <, <=, and = operators while the other filters only support the = operator.
The Cloud processes other filters client side within the Cloud.
For example, the following query is processed server side and retrieves Transactions that were created after the specified Date.
SELECT * FROM Transactions WHERE Date > '2015-12-15T12:00:00' AND Amount = '11'
Other important filter you can execute client-side is the Type filter. You can use that column to retrive i.e: only the Orders.
After retrieving the IDs of transactions with type order, you can use these IDs to query TransactionItems and TransactionDetails views, to get more details.
SELECT * FROM Transactions WHERE Type = 'Order'
Name | Type | References | Description |
Id [KEY] | String | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | The display name of the buyer. | |
NetAmount | Decimal | The net amount of the transaction. | |
FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | The status of the transaction. It is one of the following values: Pending, Processing, Success, Denied, or Reversed.
使用できる値は次のとおりです。Pending, Processing, Success, Denied, Reversed | |
Date | Datetime | Date and time that the transaction occurred. Character length and limitations: Date and time are in UTC/GMT format; for example, 2013-08-24T05:38:48Z. | |
Timezone | String | The time zone of the transaction. The value is always GMT. | |
Type | String | The type of the transaction. It is one of the following values: Order, Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | Search by the email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
TransactionClass | String | Search by the classification of the transaction. Some kinds of possible classes of transactions are not searchable with this field. You cannot search for bank transfer withdrawals, for example. This field has one of the following values: All, Sent, Received, MassPay, MoneyRequest, FundsAdded, FundsWithdrawn, Referral, Fee, Subscription, Dividend, Billpay, Refund, CurrencyConversions, BalanceTransfer, Reversal, Shipping, BalanceAffecting, or ECheck.
使用できる値は次のとおりです。All, Sent, Received, MassPay, MoneyRequest, FundsAdded, FundsWithdrawn, Referral, Fee, Subscription, Dividend, Billpay, Refund, CurrencyConversions, BalanceTransfer, Reversal, Shipping, BalanceAffecting, ECheck | |
Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | Search by credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale. | |
CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | Search by the invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | An alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
PayerName | String | Search by the name of the buyer. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、PayPal のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | データベース名。 |
SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベース。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | テーブル名またはビュー名。 |
TableType | String | テーブルの種類(テーブルまたはビュー)。 |
Description | String | テーブルまたはビューの説明。 |
IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Payments テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Payments'
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | カラムを含むテーブルまたはビューの名前。 |
ColumnName | String | カラム名。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | カラムのストレージサイズ。 |
DisplaySize | Int32 | 指定されたカラムの通常の最大幅(文字数)。 |
NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | カラムのスケール(小数点以下の桁数)。 |
IsNullable | Boolean | カラムがNull を含められるかどうか。 |
Description | String | カラムの簡単な説明。 |
Ordinal | Int32 | カラムのシーケンスナンバー。 |
IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
IsHidden | Boolean | カラムが非表示かどうか。 |
IsArray | Boolean | カラムが配列かどうか。 |
IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベース。 |
SchemaName | String | ストアドプロシージャを含むスキーマ。 |
ProcedureName | String | ストアドプロシージャの名前。 |
Description | String | ストアドプロシージャの説明。 |
ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、SelectEntries ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
ColumnName | String | ストアドプロシージャパラメータの名前。 |
Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | 数値データの小数点以下の桁数。 |
IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
IsArray | Boolean | パラメータが配列かどうか。 |
Description | String | パラメータの説明。 |
Ordinal | Int32 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、Payments テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Payments'
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前 |
IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
PrimaryKeyName | String | 主キーの名前。 |
ForeignKeyName | String | 外部キーの名前。 |
ReferencedCatalogName | String | 主キーを含むデータベース。 |
ReferencedSchemaName | String | 主キーを含むスキーマ。 |
ReferencedTableName | String | 主キーを含むテーブル。 |
ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
名前 | タイプ | 説明 |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前 |
PrimaryKeyName | String | 主キーの名前。 |
ForeignKeyName | String | 外部キーの名前。 |
ReferencedCatalogName | String | 主キーを含むデータベース。 |
ReferencedSchemaName | String | 主キーを含むスキーマ。 |
ReferencedTableName | String | 主キーを含むテーブル。 |
ReferencedColumnName | String | 主キーのカラム名。 |
ForeignKeyType | String | 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前。 |
KeySeq | String | 主キーのシーケンス番号。 |
KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | インデックスを含むデータベースの名前。 |
SchemaName | String | インデックスを含むスキーマの名前。 |
TableName | String | インデックスを含むテーブルの名前。 |
IndexName | String | インデックス名。 |
ColumnName | String | インデックスに関連付けられたカラムの名前。 |
IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
Type | Int16 | インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
SortOrder | String | 並べ替え順序:A が昇順、D が降順。 |
OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
このテーブルをクエリする際は、config 接続文字列を使用する必要があります。
jdbc:cdata:paypal:config:
この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | 接続プロパティ名。 |
ShortDescription | String | 簡単な説明。 |
Type | String | 接続プロパティのデータ型。 |
Default | String | 明示的に設定されていない場合のデフォルト値。 |
Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
Required | Boolean | プロパティが接続に必要かどうか。 |
Category | String | 接続プロパティのカテゴリ。 |
IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
Ordinal | Int32 | パラメータのインデックス。 |
CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
名前 | 説明 | 有効な値 |
AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
STRING_FUNCTIONS | サポートされている文字列関数。 | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS | サポートされている数値関数。 | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS | サポートされている日付および時刻関数。 | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES | レプリケーション中にスキップされたテーブルを示します。 | |
REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。 | |
IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
DIALECT | 使用するSQL ダイアレクトを示します。 | |
KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS | 使用したいcacheOptions を指定する文字列値。 | |
ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
Name | Type | Description |
NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | データ変更処理から返された、データベース生成Id。 |
Batch | String | バッチの識別子。1 は単一処理。 |
Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
プロパティ | 説明 |
AuthScheme | The type of authentication to use when connecting to PayPal. |
User | 認証で使用されるPayPal ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
Signature | The signature required to use the SOAP API. |
UseSandbox | A Boolean value indicating if you are using a Sandbox account. |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Schema | The type of schema to use. |
プロパティ | 説明 |
IncludeDetails | A Boolean value indicating if you will get extra details (for example, the ShippingAddress fields when querying the Invoices table). |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | The type of authentication to use when connecting to PayPal. |
User | 認証で使用されるPayPal ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
Signature | The signature required to use the SOAP API. |
UseSandbox | A Boolean value indicating if you are using a Sandbox account. |
The type of authentication to use when connecting to PayPal.
string
"Auto"
認証で使用されるPayPal ユーザーアカウント。
string
""
このフィールドは、Password とともに、PayPal サーバーに対して認証をするために使われます。
The signature required to use the SOAP API.
string
""
The signature required to use the SOAP API.
Along with Signature, User and Password are required to access the Transaction and TransactionDetails tables.
To create an API signature, you need a PayPal business account. To create the signature, log in and click Profile. Click My Selling Tools and, in the Selling Online section, click Update in the API Access section. On the resulting page, click Request API Credentials.
A Boolean value indicating if you are using a Sandbox account.
bool
false
A Boolean value indicating if you are using a Sandbox account.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
string
""
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Schema | The type of schema to use. |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
The type of schema to use.
string
"SOAP"
The schemas available are REST (to use the REST API) and SOAP (to use the Classic API).
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
IncludeDetails | A Boolean value indicating if you will get extra details (for example, the ShippingAddress fields when querying the Invoices table). |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
A Boolean value indicating if you will get extra details (for example, the ShippingAddress fields when querying the Invoices table).
bool
false
A Boolean value indicating if you will get extra details (for example, the ShippingAddress fields when querying the Invoices table).
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
int
-1
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
string
""
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
int
60
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。