このページでは、CData Cloud でのPayPal への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

PayPal への接続

接続の確立 は、CData Cloud にデータベースを作成するためのPayPal への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してPayPal からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、PayPal に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

PayPal への接続

• SOAP API にはSignature API 認証情報が必要です。SOAP API を認証するには、AuthScheme をBasic に設定し、Username、Password、およびSignature プロパティを設定する必要があります。SOAP API を有効にすると、これらのAPI 認証情報が生成されます。
• REST API はOAuth 認証標準を使用しています。REST API を認証するには、AuthScheme をOAuth に設定し、OAuthClientId およびOAuthClientSecret プロパティを設定する必要があります。

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

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

SOAP API

非推奨：SOAP API は廃止予定です。より優れたリソースアクセスのため、REST APIをご利用ください。

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

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

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

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

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

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

REST API

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

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

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

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

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

Creating a Custom OAuth Application

A custom OAuth application is required to authenticate on Desktop applications, Web applications, or Headless machines while using the REST API.

To register an OAuth application and obtain the OAuth client credentials, the Client Id, and Client Secret:

1. Log in to your PayPal developer account.
2. Navigate to My Apps & Credentials (under Dashboard).
3. Scroll to the REST API apps section.
4. Click Create App.
5. Specify a name for your application.
6. From the drop down list, select the sandbox account from which data will be retrieved.

PayPal generates a set of sandbox and live OAuth keys for the application. The sandbox credentials display after the application has been created. To see the live credentials, select the Live option.

The sandbox credentials are used to get data only for the sandbox account you selected while creating the application. The Live credentials are used to get data only for the developer account that was used to create this application.

SSL 設定のカスタマイズ

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

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

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

The CData Cloud models two PayPal APIs as relational databases, the REST API and the SOAP API. Set the Schema property and use the information in each section to select the proper API based on your project needs.

Using the REST API

The REST API is the newer API and is becoming more popular with PayPal users. However, the REST API lists only the transactions and actions made via the REST API and excludes the UI and the SOAP API.

See REST データモデル for the available entities in the REST API.

Using the SOAP API

The SOAP (Classic) API has full information on transactions, which includes transactions created from the UI, the REST API, and the SOAP API.

See SOAP データモデル for the available entities in the SOAP API.

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

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

ビュー

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

ストアドプロシージャ

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

PayPal REST API Limitations

There are some limitations in the PayPal REST API. For example, it provides no way to list all orders/payments, so to query the related views like OrderItems, OrderDetails, Payments you must know the respective ID and specify it.

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

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

CData Cloud - PayPal ビュー

Query details about Authorizations.

Table Specific Information

Select

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

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

SELECT * FROM AuthorizationDetails WHERE Id = '70K15739YA1955155'

SELECT * FROM AuthorizationDetails WHERE Id IN ('70K15739YA1955155', '70K15739YA1955156')

Columns

List all non crypto balances.

Table Specific Information

Select

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

The following filters are supported by the PayPal API:

• Currency
• AsOfTime

The filters only support the = operator.

The Cloud processes other filters client side within the Cloud.

For example, the following queries are processed server side.

• The following query retrieves details for a specific currency:
  

  SELECT * FROM Balances WHERE Currency = 'USD'

• The following query returns details for Balance records created before the specified date time:
  

  SELECT * FROM Balances WHERE AsOfTime = '2022-01-09 20:59:59.0'

Columns

Query details about a captured Payment.

Table Specific Information

Select

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

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

SELECT * FROM CaptureDetails WHERE Id = '9G02572041588110H'

SELECT * FROM CaptureDetails WHERE Id IN ('9G02572041588110H', '9G02572041588111H')

Columns

Query details about the funding instrument of the payer, such as a Credit Card or a token that represents a Credit Card.

Table Specific Information

Select

This view returns a list of Credit Cards or details for a specific one.

The following filters are supported by the PayPal API:

• Id
• CreateTime
• MerchantId
• ExternalCardId
• ExternalCustomerId

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

The Cloud processes other filters client side within the Cloud.

For example, the following queries are processed server side.

• The following query retrieves details for a specific Credit Card. The last seven characters of the credit card ID are masked and therefore ignored by the API during validation when filtering by ID.
  

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

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

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

Columns

List all crypto balances.

Table Specific Information

Select

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

The following filters are supported by the PayPal API:

• AsOfTime

The filters only support the = operator.

The Cloud processes other filters client side within the Cloud.

For example, the following queries are processed server side.

• The following query returns details for Balance records created before the specified date time:
  

  SELECT * FROM CryptoBalances WHERE AsOfTime = '2022-01-09 20:59:59.0'

Columns

PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes.

Table Specific Information

Select

This view returns a list of disputes with detailed information for the authenticated user.

The following filters are supported by the PayPal API:

• DisputeId

The Cloud processes other filters client side within the Cloud.

For example, the following queries are processed server side.

• The following query retrieves details for a specific Dispute:
  

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

Columns

PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes.

Table Specific Information

Select

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

The following filters are supported by the PayPal API:

• DisputeId
• DisputeState
• CreateTime

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

The Cloud processes other filters client side within the Cloud.

For example, the following queries are processed server side.

• The following query retrieves details for a specific dispute:
  

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

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

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

Columns

PayPal merchants, partners, and external developers can use the PayPal Disputes API to manage disputes.

Table Specific Information

Select

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

The following filters are supported by the PayPal API:

• DisputeId

The Cloud processes other filters client side within the Cloud.

For example, the following queries are processed server side.

• The following query retrieves transaction details for a specific dispute:
  

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

Columns

Query Invoices in PayPal.

Table Specific Information

Select

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

The following filters are supported by the PayPal API:

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

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

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

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

The Cloud processes other filters client side within the Cloud.

Columns

Pseudo-Columns

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

Query the list of event types that are subscribed to a Webhook.

Table Specific Information

Select

The only filter supported by the PayPal API is WebhookId, which only supports the = operator. This is a required parameter.The Cloud processes other filters client side within the Cloud.

For example, the following query is processed server side and retrieves the Notifications list for the specified Webhook.

SELECT * FROM Notifications WHERE WebhookId = '8BU398853V564980H'

Columns

Queries details about an Order.

Table Specific Information

Select

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

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

SELECT * FROM OrderDetails WHERE Id = 'O-1HE90236LH9332431'

SELECT * FROM OrderDetails WHERE Id IN ('O-1HE90236LH9332431', 'O-7D635956955612146')

Columns

Gets the items in an Order.

Table Specific Information

Select

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

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

SELECT * FROM OrderItems WHERE OrderId = 'O-1HE90236LH9332431'

SELECT * FROM OrderItems WHERE OrderId IN ('O-1HE90236LH9332431', 'O-7D635956955612146')

Columns

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

Table Specific Information

Select

Note: PartnerReferrals API does not give us a way to list all PartnerReferralId-s, so you must specify it.
The only filter supported by the PayPal API is Id, which is required. The Cloud processes other filters client side within the Cloud.

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

SELECT * FROM PartnerReferrals where id= 'ZjcyODU4ZWYtYTA1OC00ODIwLTk2M2EtOTZkZWQ4NmQwYzI3RU12cE5xa0xMRmk1NWxFSVJIT1JlTFdSbElCbFU1Q3lhdGhESzVQcU9iRT0='

Columns

Query details about authorized Payments.

Table Specific Information

Select

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

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

SELECT * FROM Payments WHERE Id > 'P-41250-2' AND OrderId =  'O-123550-05'

Columns

Lists merchant-created templates with associated details.

Table Specific Information

Select

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

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

The Cloud processes other filters client side within the Cloud.

Columns

Query Transaction details including the amount and item details.

Table Specific Information

Select

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

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

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

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

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

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

Columns

Retrieve details about Payouts.

Table Specific Information

Select

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

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

SELECT * FROM PayoutDetails WHERE PayoutBatchId = 'HSY55UPD25KF2'

Columns

Retrieve payout items from a Payout.

Table Specific Information

Select

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

For example, the following queries are processed server side.

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

Columns

List the Billing Plans.

Table Specific Information

Select

This view returns a list of subscription plans for the authenticated user.

The following filters are supported by the PayPal API:

• Id
• ProductId

SELECT * FROM Plans WHERE Id = '1234'
SELECT * FROM Plans WHERE ProductId = '1234'

The Cloud processes other filters client side within the Cloud.

Columns

Retrieve the list of product details.

Table Specific Information

Select

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

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

The Cloud processes other filters client side within the Cloud.

For example, the following queries are processed server side.

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

Columns

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

Table Specific Information

Select

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

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

The Cloud processes other filters client side within the Cloud.

For example, the following queries are processed server side.

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

Columns

Query details about a specific Refund.

Table Specific Information

Select

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

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

SELECT * FROM RefundDetails WHERE Id = '4W92068757818534U'

SELECT * FROM RefundDetails WHERE Id IN ('4W92068757818534U', '4W91234757818534U')

Columns

Query details about a Sale Transaction.

Table Specific Information

Select

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

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

SELECT * FROM SaleDetails WHERE Id = '6M2430095X488331A'

SELECT * FROM SaleDetails WHERE Id IN ('6M2430095X488331A', '6M2410805X488331A')

Columns

Get billing and subscription details.

Table Specific Information

Select

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

SELECT * FROM Subscriptions WHERE Id = '1234'

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

The Cloud processes other filters client side within the Cloud.

Columns

Lists transactions for a subscription.

Table Specific Information

Select

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

The following filters are supported by the PayPal API:

• SubscriptionId
• StartTime
• EndTime

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

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

The Cloud processes other filters client side within the Cloud.

Columns

Pseudo-Columns

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

Lists merchant-created templates with associated details.

Table Specific Information

Select

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

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

The Cloud processes other filters client side within the Cloud.

Columns

Lists transaction reports.

Table Specific Information

Select

The filters supported by the PayPal API are StartDate, EndDate, TransactionId, PaymentInstrumentType, BalanceAffectingRecordsOnly, StoreId, TerminalId, TransactionAmount, TransactionCurrency, TransactionStatus, TransactionType. Server-side processing is only supported for the '=' operator.

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

The Cloud processes other filters client side within the Cloud.

Columns

Pseudo-Columns

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

List Cart Info of Transaction Reports.

Table Specific Information

Select

The filters supported by the PayPal API are StartDate, EndDate, TransactionId, PaymentInstrumentType, BalanceAffectingRecordsOnly, StoreId, TerminalId, TransactionAmount, TransactionCurrency, TransactionStatus, TransactionType. Server-side processing is only supported for the '=' operator.

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

The Cloud processes other filters client side within the Cloud.

Columns

Pseudo-Columns

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

List Incentive Details of Transaction Reports.

Columns

Pseudo-Columns

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

Shows OpenID Connect user profile information for standard claims.

Table Specific Information

Select

The Cloud processes all filters client side within the Cloud.

SELECT * FROM UserInfo

Columns

Lists users.

Table Specific Information

Select

The Cloud processes all filters client side within the Cloud.

SELECT * FROM Users

Columns

Query the list of Webhooks.

Table Specific Information

Select

The PayPal API does not support any filters on this table. However, projections are supported. All filters are processed client side within the Cloud.

Columns

ストアドプロシージャはファンクションライクなインターフェースで、PayPal の単純なSELECT 処理にとどまらずCloud の機能を拡張します。

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

CData Cloud - PayPal ストアドプロシージャ

Creates a draft invoice.

Stored Procedure Specific Information

The CreateDraftInvoice Stored Procedure requires following columns to execute:

• InvoiceItems
• DetailCurrencyCode

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

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

Input

Result Set Columns

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

Stored Procedure Specific Information

The CreateOrder Stored Procedure requires following columns to execute:

• Intent
• PurchaseUnits

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

Input

Result Set Columns

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

Stored Procedure Specific Information

The CreatePayment Stored Procedure requires following columns to execute:

• Intent
• ReturnUrl
• CancelUrl
• PayerPaymentMethod
• Transactions

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

Input

Result Set Columns

Makes payouts in Paypal.

Table Specific Information

Payout Items

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

Example: Create payouts using JSON aggregate

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

Example: Create payouts using temp table

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

INSERT INTO PayoutItem#TEMP (RecipientType, AmountValue, AmountCurrency, Note, SenderItemId, Receiver) VALUES ('EMAIL', '3.2', 'USD', 'Thanks for your patronage!', '201403140001', '[email protected]')
INSERT INTO PayoutItem#TEMP (RecipientType, AmountValue, AmountCurrency, Note, SenderItemId, Receiver) VALUES ('PHONE', '8.98', 'USD', 'Thanks for your support!', '201403140002', '91-734-234-1234')

Execute

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

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

The following columns are required to create a payout item:

• RecipientType
• AmountValue
• AmountCurrency
• SenderItemId
• Receiver

Input

Result Set Columns

Create a subscription for Paypal.

Stored Procedure Specific Information

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

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

The following columns are required to create a subscription:

• PlanId

Input