PayPal Connection

Overview
Quick Start
Configuration
Knowledge Base
What's New

Overview

PayPal Connection

Configuration is provided for establishing connections with the PayPal service. The configuration is used in the REST Connection Manager.

Setup

Press icon to get more information about the connection parameters.

Obtain data

Use REST Source component to get data from service resource.

Insert data

Use REST Destination component to insert data into service resource.

Quick Start

Establish connection

No votes yet

In this task, we will show you step-by-step how to create a connection to Paypal REST API using COZYROC's REST Connection Manager.

Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.

Step 2. From drop-down menu Configuration select Paypal. Set [Host] to the desired Host in the Server host parameter. Then provide your instance client_id for the parameter username and client_secret for the parameter password in the grid below. To get your environment client_id and client_secret please visit https://developer.paypal.com/api/rest/

Step 3. Click "Test Connection" to test your connection.

Congratulations! You have now established a connection to your Paypal instance.

Consume data from service

No votes yet

In this guide, we will show how to read data from the Paypal service resource using the COZYROC REST Source component.

Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".

Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.

Step 3. Double click on the "REST Source" component and select Paypal connection from the combo. Select from available Paypal resources listed in the second combo below.

Optionally you can include extra parameters in the grid below if needed.

Step 4. Click on the "Columns tab" and select Paypal resource columns you want to read.

Step 5. Click Preview to make sure all necessary resource columns are included.

Bravo! You have now learned how to read data from Paypal service.

Push data to service

No votes yet

In this guide, we will show how to write data to the Paypal service resource using the COZYROC REST Destination component.

Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".

Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.

Step 3. Double click on the "REST Destination" component and select Paypal connection from the combo. Also, select resource action and Paypal resource you want to work on.

Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.

If you want to provide input for other resource composite objects, change the input above and map the columns.

Done. You have now learned how to write data into the Paypal resource.

Contribute

Configuration

Service

Base URL address: https://[Host].paypal.com/v2.

Authentication

The authentication uses a session token.

The authentication has the following user-defined parameters:

client_id: Required. Specify client_id.
client_secret: Required. Specify client_secret.

The following request parameters will be automatically processed during the authentication process:

Authorization: Bearer {{=token.Access}}

Documentation: https://developer.paypal.com/docs/api/reference/get-an-access-token/.

Resources

Tracker

Based on resource template General.

[Read] action

The result is extracted from: {{=PayPal.readList(resource, '/shipping/trackers/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of tracker identifiers.

Documentation: https://developer.paypal.com/docs/api/tracking/v1/#trackers_get.

[Create] action

Endpoint URL address: /shipping/trackers-batch.

The following request parameters will be automatically processed:

application/json: {{={ trackers: batch } }}

Documentation: https://developer.paypal.com/docs/api/tracking/v1/#trackers-batch.

[Update] action

Endpoint URL address: /shipping/trackers/{{=item.id}}.

Documentation: https://developer.paypal.com/docs/api/tracking/v1/#trackers_put.

Fields

id: A key field. Template: ShortText.
transaction_id: Template: ShortText.
debug_id: Template: ShortText.
name: Template: ShortText.
message: Template: ShortText.
tracking_number: Template: ShortText.
status: Template: ShortText.
carrier: Template: ShortText.
links: Template: Link. A read-only field.

Product

Based on resource template General.

[Read] action

Endpoint URL address: /catalogs/products.
The result is extracted from: {{=response.products}}.

Documentation: https://developer.paypal.com/docs/api/catalog-products/v1/#products_list.

[Read list] action

The result is extracted from: {{=PayPal.readList(resource, '/catalogs/products/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of product identifiers.

Documentation: https://developer.paypal.com/docs/api/catalog-products/v1/#products_get.

[Create] action

Endpoint URL address: /catalogs/products.

Documentation: https://developer.paypal.com/docs/api/catalog-products/v1/#products_create.

[Update] action

Endpoint URL address: /catalogs/products/{{=item.id}}.
The action uses PATCH method.

The following request parameters will be automatically processed:

application/json: {{=PayPal.getUpdatePayload(item)}}

Documentation: https://developer.paypal.com/docs/api/catalog-products/v1/#products_patch.

Fields

id: A key field. Template: ShortText.
name: Template: ShortText.
description: Template: ShortText.
type: Template: ShortText.
category: Template: ShortText.
image_url: Template: ShortText.
home_url: Template: ShortText.
create_time: Template: DateTime. A read-only field.
update_time: Template: DateTime. A read-only field.
links: Template: Link. A read-only field.

Dispute

Based on resource template General.

[Read] action

Endpoint URL address: /customer/disputes.
The result is extracted from: {{=response.items}}.

Documentation: https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_list.

[Update] action

Endpoint URL address: /customer/disputes/{{=item.id}}.
The action uses PATCH method.

The following request parameters will be automatically processed:

application/json: {{=PayPal.getUpdatePayload(item)}}

Documentation: https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes_patch.

Fields

id: A key field. Template: ShortText.
status: Template: ShortText.
reason: Template: ShortText.
dispute_state: Template: ShortText.
dispute_amount: Template: CurrencyT.
create_time: Template: DateTime. A read-only field.
update_time: Template: DateTime. A read-only field.
links: Template: Link. A read-only field.

Dispute | Accept Claim

Based on resource template General.

[Create] action

Endpoint URL address: /customer/disputes/{{=item.id}}/accept-claim.

Documentation: https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes-actions_accept-claim.

Fields

id: A key field. Template: ShortText.
note: Template: ShortText.
accept_claim_reason: Template: LongText. A composite field.
invoice_id: Template: ShortText.
accept_claim_type: Template: LongText. A composite field.
refund_amount: Template: CurrencyT.
return_shipping_address: Template: ReturnShippingAddress.

Dispute | Accept Offer

Based on resource template General.

[Create] action

Endpoint URL address: /customer/disputes/{{=item.id}}/accept-offer.

Documentation: https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes-actions_accept-offer.

Fields

id: A key field. Template: ShortText.
note: Template: ShortText.

Dispute | Deny Offer

Based on resource template General.

[Create] action

Endpoint URL address: /customer/disputes/{{=item.id}}/deny-offer.

Documentation: https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes-actions_deny-offer.

Fields

id: A key field. Template: ShortText.
note: Template: ShortText.

Dispute | Escalate

Based on resource template General.

[Create] action

Endpoint URL address: /customer/disputes/{{=item.id}}/escalate.

Documentation: https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes-actions_escalate.

Fields

id: A key field. Template: ShortText.
note: Template: ShortText.

Dispute | Make Offer

Based on resource template General.

[Create] action

Endpoint URL address: /customer/disputes/{{=item.id}}/make-offer.

Documentation: https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes-actions_make-offer.

Fields

id: A key field. Template: ShortText.
note: Template: ShortText.
invoice_id: Template: ShortText.
offer_type: Template: LongText. A composite field.
offer_amount: Template: CurrencyT.
return_shipping_address: Template: ReturnShippingAddress.

Dispute | Provide Supporting Information

Based on resource template General.

[Create] action

Endpoint URL address: /customer/disputes/{{=item.id}}/provide-supporting-info.

Documentation: https://developer.paypal.com/docs/api/customer-disputes/v1/#disputes-actions_provide-supporting-info.

Fields

id: A key field. Template: ShortText.
note: Template: ShortText.

Application

Based on resource template General.

[Create] action

Endpoint URL address: /identity/applications.

Documentation: https://developer.paypal.com/docs/api/identity/v1/#applications_post.

Fields

redirect_uris: Template: LongText. A composite field.
client_name: Template: ShortText.
logo_uri: Template: ShortText.
contacts: Template: LongText. A composite field.
policy_uri: Template: ShortText.
payer_id: Template: ShortText.
migrated_app: Template: ShortText.
application_type: Template: ShortText.
tos_uri: Template: ShortText.
scope: Template: ShortText.
token_endpoint_auth_method: Template: ShortText.
jwks_uri: Template: ShortText.

Invoice

Based on resource template Base.

[Read] action

Endpoint URL address: /invoicing/invoices.
The result is extracted from: {{=response.items}}.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#invoices_list.

[Read search] action

Endpoint URL address: /invoicing/search-invoices.
The result is extracted from: {{=response.items}}.
The action uses POST method.

The action has the following user-defined parameters:

JSON: Optional in JSON format.

The following request parameters will be automatically processed:

application/json: {{=parameters.get('JSON') ? JSON.parse(parameters.JSON) : parameters}}

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#search-invoices.

[Read list] action

The result is extracted from: {{=PayPal.readList(resource, '/invoicing/invoices/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of invoice identifiers.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#invoices_get.

[Create] action

Endpoint URL address: /invoicing/invoices.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#invoices_create.

[Update] action

Endpoint URL address: /invoicing/invoices/{{=item.id}}.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#invoices_update.

[Delete] action

Endpoint URL address: /invoicing/invoices/{{=item.id}}.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#invoices_delete.

Fields

id: A key field. Template: ShortText.
status: Template: ShortText.
parent_id: Template: ShortText.
detail: Template: InvoiceDetailT.
invoicer: Template: InvoicerT.
primary_recipients: Template: PrimaryRecipientT.
amount: Template: AmountDetailsT.
links: Template: Link. A read-only field.

Invoice | Generate Invoice Number

Based on resource template Base.

[Create] action

Endpoint URL address: /invoicing/generate-next-invoice-number.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#invoices_generate-next-invoice-number.

Fields

invoice_number: A key field. Template: ShortText.

Invoice | Cancel

Based on resource template Base.

[Create] action

Endpoint URL address: /invoicing/invoices/{{=item.id}}/cancel.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#invoices_cancel.

Fields

id: A key field. Template: ShortText.
subject: Template: ShortText.
note: Template: ShortText.
send_to_invoicer: Data type: DT_BOOL
send_to_recipient: Data type: DT_BOOL
additional_recipients: Template: LongText. A composite field.

Invoice | Generate QR Code

Based on resource template Base.

[Create] action

Endpoint URL address: /invoicing/invoices/{{=item.id}}/generate-qr-code.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#invoices_generate-qr-code.

Fields

id: A key field. Template: ShortText.
width: Template: ShortText.
height: Template: ShortText.
action: Data type: DT_BOOL

Invoice | Record Payment for Invoice

Based on resource template Base.

[Create] action

Endpoint URL address: /invoicing/invoices/{{=item.id}}/payments.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#invoices_payments.

Fields

id: A key field. Template: ShortText.
note: Template: ShortText.
method: Template: ShortText.
type: Template: ShortText.
payment_date: Template: Date.
payment_id: Template: ShortText.
amount: Template: CurrencyT.
shipping_info: Template: ShippingInfoT.

Invoice | Delete External Payment

Based on resource template Base.

[Delete] action

Endpoint URL address: /invoicing/invoices/{{=item.id}}/payments/{{=item.transaction_id}}.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#invoices_payments-delete.

Fields

id: A key field. Template: ShortText.
transaction_id: A key field. Template: ShortText.

Invoice | Record Refund for Invoice

Based on resource template Base.

[Create] action

Endpoint URL address: /invoicing/invoices/{{=item.id}}/refunds.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#invoices_refunds.

Fields

id: A key field. Template: ShortText.
method: Template: ShortText.
type: Template: ShortText.
refund_date: Template: Date.
refund_id: Template: ShortText.
amount: Template: CurrencyT.

Invoice | Delete External Refund

Based on resource template Base.

[Delete] action

Endpoint URL address: /invoicing/invoices/{{=item.id}}/refunds/{{=item.transaction_id}}.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#invoices_refunds-delete.

Fields

id: A key field. Template: ShortText.
transaction_id: A key field. Template: ShortText.

Invoice | Send Invoice Reminder

Based on resource template Base.

[Create] action

Endpoint URL address: /invoicing/invoices/{{=item.id}}/remind.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#invoices_remind.

Fields

id: A key field. Template: ShortText.
subject: Template: ShortText.
note: Template: ShortText.
send_to_invoicer: Data type: DT_BOOL
send_to_recipient: Data type: DT_BOOL
additional_recipients: Template: LongText. A composite field.

Invoice | Send

Based on resource template Base.

[Create] action

Endpoint URL address: /invoicing/invoices/{{=item.id}}/send.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#invoices_send.

Fields

id: A key field. Template: ShortText.
subject: Template: ShortText.
note: Template: ShortText.
send_to_invoicer: Data type: DT_BOOL
send_to_recipient: Data type: DT_BOOL
additional_recipients: Template: LongText. A composite field.

Invoice | Template

Based on resource template Template.

[Read] action

Endpoint URL address: /invoicing/templates.
The result is extracted from: {{=response.templates}}.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#templates_list.

[Read list] action

The result is extracted from: {{=PayPal.readList(resource, '/invoicing/templates/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of template identifiers.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#templates_get.

[Create] action

Endpoint URL address: /invoicing/templates.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#templates_create.

[Update] action

Endpoint URL address: /invoicing/templates/{{=item.id}}.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#templates_update.

[Delete] action

Endpoint URL address: /invoicing/templates/{{=item.id}}}.

Documentation: https://developer.paypal.com/docs/api/invoicing/v2/#templates_delete.

Fields

id

A key field. Template: ShortText.

name

Template: ShortText.

default_template

Data type: DT_BOOL

template_info

Field components:

Uses template: ConfigurationT.
Contains the following components: configuration, detail, invoicer, primary_recipients, additional_recipients, items, amount.

settings

Field components:

Contains the following components: template_item_settings, template_subtotal_settings.

unit_of_measure

Template: ShortText.

standard_template

Data type: DT_BOOL

links

Template: Link. A read-only field.

Order

Based on resource template Base.

[Read] action

The result is extracted from: {{=PayPal.readList(resource, '/checkout/orders/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of order identifiers.

Documentation: https://developer.paypal.com/docs/api/orders/v2/#orders_get.

[Create] action

Endpoint URL address: /checkout/orders.

Documentation: https://developer.paypal.com/docs/api/orders/v2/#orders_create.

[Update] action

Endpoint URL address: /checkout/orders/{{=item.id}}.
The action uses PATCH method.

The following request parameters will be automatically processed:

application/json: {{=PayPal.getUpdatePayload(item)}}

Documentation: https://developer.paypal.com/docs/api/orders/v2/#orders_patch.

Fields

id

A key field. Template: ShortText.

status

Template: ShortText.

intent

Template: ShortText.

payer

Field components:

Uses template: ShortText.
Contains the following components: name, email_address, payer_id.

purchase_units

Field components:

An array.
Contains the following components: reference_id, amount.

create_time

Template: DateTime. A read-only field.

links

Template: Link. A read-only field.

Order | Authorize Payment

Based on resource template Base.

[Create] action

Endpoint URL address: /checkout/orders/{{=item.id}}/authorize.

The action has the following user-defined parameters:

PayPal-Request-Id: Provide the PayPal-Request-Id
Prefer: Provide the value for prefer.
PayPal-Client-Metadata-Id: Provide the PayPal-Client-Metadata-Id
PayPal-Auth-Assertion: Provide the PayPal-Auth-Assertion

The following request parameters will be automatically processed:

PayPal-Request-Id: {{=parameters.get('PayPal-Request-Id') }}
Prefer: {{=parameters.get('Prefer') }}
PayPal-Client-Metadata-Id: {{=parameters.get('PayPal-Client-Metadata-Id') }}
PayPal-Auth-Assertion: {{=parameters.get('PayPal-Auth-Assertion') }}

Documentation: https://developer.paypal.com/docs/api/orders/v2/#orders_authorize.

Fields

id

A key field. Template: ShortText.

payment_source

Field components:

Uses template: ShortText.
Contains the following components: token, card.

Order | Capture Payment

Based on resource template Base.

[Create] action

Endpoint URL address: /checkout/orders/{{=item.id}}/capture.

The action has the following user-defined parameters:

PayPal-Request-Id: Provide the PayPal-Request-Id
Prefer: Provide the value for prefer.
PayPal-Client-Metadata-Id: Provide the PayPal-Client-Metadata-Id
PayPal-Auth-Assertion: Provide the PayPal-Auth-Assertion

The following request parameters will be automatically processed:

PayPal-Request-Id: {{=parameters.get('PayPal-Request-Id') }}
Prefer: {{=parameters.get('Prefer') }}
PayPal-Client-Metadata-Id: {{=parameters.get('PayPal-Client-Metadata-Id') }}
PayPal-Auth-Assertion: {{=parameters.get('PayPal-Auth-Assertion') }}

Documentation: https://developer.paypal.com/docs/api/orders/v2/#orders_capture.

Fields

id

A key field. Template: ShortText.

payment_source

Field components:

Uses template: ShortText.
Contains the following components: token, card.

Partner Referal

Based on resource template Base.

[Read] action

The result is extracted from: {{=PayPal.readList(resource, '/customer/partner-referrals/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of partner referal identifiers.

Documentation: https://developer.paypal.com/docs/api/partner-referrals/v2/#partner-referrals_read.

[Create] action

Endpoint URL address: /customer/partner-referrals.

Documentation: https://developer.paypal.com/docs/api/webhooks/v1/#webhooks_post.

Fields

partner_referral_id

A key field. Template: ShortText.

submitter_payer_id

Template: ShortText.

referral_data

Field components:

Uses template: IndividualOwnerT.
Contains the following components: individual_owners, business_entity, email, preferred_language_code, tracking_id, partner_config_override, operations, products, legal_consents.

links

Template: Link. A read-only field.

individual_owners

Template: IndividualOwnerT.

business_entity

Template: BusinessEntityT.

email

Template: ShortText.

preferred_language_code

Template: ShortText.

tracking_id

Template: ShortText.

partner_config_override

Template: PartnerConfigOverrideT.

operations

Template: OperationT.

financial_instruments

Field components:

Contains the following components: banks.

legal_consents

Template: LegalconsentT.

products

Template: LongText. A composite field.

Payment Experience

Based on resource template General.

[Read] action

Endpoint URL address: /payment-experience/web-profiles.
The result is extracted from: {{=response}}.

Documentation: https://developer.paypal.com/docs/api/payment-experience/v1/#web-profiles_get-list.

[Read list] action

The result is extracted from: {{=PayPal.readList(resource, '/payment-experience/web-profiles/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of profile identifiers.

Documentation: https://developer.paypal.com/docs/api/payment-experience/v1/#web-profiles_get.

[Create] action

Endpoint URL address: /payment-experience/web-profiles.

Documentation: https://developer.paypal.com/docs/api/payment-experience/v1/#web-profiles_create.

[Update] action

Endpoint URL address: /payment-experience/web-profiles/{{=item.id}}.

Documentation: https://developer.paypal.com/docs/api/payment-experience/v1/#web-profiles_update.

[Delete] action

Endpoint URL address: /payment-experience/web-profiles/{{=item.id}}.

Documentation: https://developer.paypal.com/docs/api/payment-experience/v1/#web-profiles_delete.

Fields

id

A key field. Template: ShortText.

name

Template: ShortText.

temporary

Data type: DT_BOOL

flow_config

Field components:

Uses template: ShortText.
Contains the following components: landing_page_type, bank_txn_pending_url.

input_fields

Field components:

Contains the following components: no_shipping, address_override.

presentation

Field components:

Uses template: ShortText.
Contains the following components: logo_image.

Payment Authorization

Based on resource template Base.

[Read] action

The result is extracted from: {{=PayPal.readList(resource, '/payments/authorizations/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of authorization identifiers.

Documentation: https://developer.paypal.com/docs/api/payments/v2/#authorizations_get.

Fields

id

A key field. Template: ShortText.

status

Template: ShortText.

amount

Template: CurrencyT.

invoice_id

Template: ShortText.

seller_protection

Field components:

Uses template: ShortText.
Contains the following components: status, dispute_categories.

expiration_time

Template: ShortText.

create_time

Template: DateTime. A read-only field.

update_time

Template: DateTime. A read-only field.

links

Template: Link. A read-only field.

Payment Authorization | Capture

Based on resource template Base.

[Create] action

Endpoint URL address: /payments/authorizations/{{=item.id}}/capture.

The action has the following user-defined parameters:

Prefer: Provide the value for prefer.
PayPal-Request-Id: Provide the PayPal-Request-Id

The following request parameters will be automatically processed:

Prefer: {{=parameters.get('Prefer') }}
PayPal-Request-Id: {{=parameters.get('PayPal-Request-Id') }}

Documentation: https://developer.paypal.com/docs/api/payments/v2/#authorizations_capture.

Fields

id

A key field. Template: ShortText.

amount

Template: CurrencyT.

payment_instruction

Field components:

Uses template: ShortText.
Contains the following components: disbursement_mode, payee_pricing_tier_id.

platform_fee

Field components:

Uses template: CurrencyT.
Contains the following components: amount, payee_base, payee_pricing_tier_id.

invoice_id

Template: ShortText.

final_capture

Data type: DT_BOOL

note_to_payer

Template: ShortText.

soft_descriptor

Template: ShortText.

Payment Authorization | Reauthorize

Based on resource template Base.

[Create] action

Endpoint URL address: /payments/authorizations/{{=item.id}}/reauthorize.

The action has the following user-defined parameters:

Prefer: Provide the value for prefer.
PayPal-Request-Id: Provide the PayPal-Request-Id

The following request parameters will be automatically processed:

Prefer: {{=parameters.get('Prefer') }}
PayPal-Request-Id: {{=parameters.get('PayPal-Request-Id') }}

Documentation: https://developer.paypal.com/docs/api/payments/v2/#authorizations_reauthorize.

Fields

id: A key field. Template: ShortText.
amount: Template: CurrencyT.

Payment Authorization | Void

Based on resource template Base.

[Create] action

Endpoint URL address: /payments/authorizations/{{=item.id}}/void.

The action has the following user-defined parameters:

PayPal-Auth-Assertion: Provide the value for PayPal-Auth-Assertion.

The following request parameters will be automatically processed:

PayPal-Auth-Assertion: {{=parameters.get('PayPal-Auth-Assertion') }}

Documentation: https://developer.paypal.com/docs/api/payments/v2/#authorizations_void.

Fields

id: A key field. Template: ShortText.

Payment Capture

Based on resource template Base.

[Read] action

The result is extracted from: {{=PayPal.readList(resource, '/payments/captures/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of captured payment identifiers.

Documentation: https://developer.paypal.com/docs/api/payments/v2/#captures_get.

Fields

id

A key field. Template: ShortText.

status

Template: ShortText.

status_details

Template: LongText. A composite field.

amount

Field components:

Uses template: ShortText.
Contains the following components: total, currency.

final_capture

Data type: DT_BOOL

seller_protection

Field components:

Uses template: ShortText.
Contains the following components: status, dispute_categories.

seller_receivable_breakdown

Field components:

Uses template: AmountT.
Contains the following components: gross_amount, paypal_fee, net_amount, receivable_amount, paypal_fee_in_receivable_currency, exchange_rate.

invoice_id

Template: ShortText.

create_time

Template: DateTime. A read-only field.

update_time

Template: DateTime. A read-only field.

links

Template: Link. A read-only field.

Payment Capture | Refund

Based on resource template Base.

[Create] action

Endpoint URL address: /payments/captures/{{=item.id}}/refund.

The action has the following user-defined parameters:

Prefer: Provide the value for Prefer.
PayPal-Request-Id: Provide the value for PayPal-Request-Id.
PayPal-Auth-Assertion: Provide the value for PayPal-Auth-Assertion.

The following request parameters will be automatically processed:

Prefer: {{=parameters.get('Prefer') }}
PayPal-Request-Id: {{=parameters.get('PayPal-Request-Id') }}
PayPal-Auth-Assertion: {{=parameters.get('PayPal-Auth-Assertion') }}

Documentation: https://developer.paypal.com/docs/api/payments/v2/#captures_refund.

Fields

id: A key field. Template: ShortText.
amount: Template: CurrencyT.
invoice_id: Template: ShortText.
note_to_payer: Template: ShortText.

Payment Refund

Based on resource template Base.

[Read] action

The result is extracted from: {{=PayPal.readList(resource, '/payments/refunds/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of refund identifiers.

Documentation: https://developer.paypal.com/docs/api/payments/v2/#refunds.

Fields

id

A key field. Template: ShortText.

amount

Template: CurrencyT.

status

Template: ShortText.

note_to_payer

Template: ShortText.

seller_payable_breakdown

Field components:

Uses template: CurrencyT.
Contains the following components: gross_amount, paypal_fee, net_amount, total_refunded_amount.

invoice_id

Template: ShortText.

create_time

Template: DateTime. A read-only field.

update_time

Template: DateTime. A read-only field.

links

Template: Link. A read-only field.

Payout

Based on resource template General.

[Read] action

The result is extracted from: {{=PayPal.readList(resource, '/payments/payouts/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of payout identifiers.

Documentation: https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts_get.

[Create] action

Endpoint URL address: /payments/payouts.

The action has the following user-defined parameters:

PayPal-Request-Id: Provide the PayPal-Request-Id

The following request parameters will be automatically processed:

PayPal-Request-Id: {{=parameters.get('PayPal-Request-Id') }}

Documentation: https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts_post.

Fields

batch_header

Field components:

Uses template: ShortText.
Contains the following components: payout_batch_id, batch_status, time_created, time_completed, sender_batch_header, amount, fees.

sender_batch_header

Template: SenderBatchHeaderT.

items

Field components:

An array.
Contains the following components: payout_item_id, transaction_id, transaction_status, payout_batch_id, recipient_type, alternate_notification_method, notification_language, amount, payout_item_fee, payout_item, time_processed.

links

Template: Link. A read-only field.

Payout Item

Based on resource template General.

[Read] action

The result is extracted from: {{=PayPal.readList(resource, '/payments/payouts-item/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of payout item identifiers.

Documentation: https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts-item_get.

Fields

payout_item_id: A key field. Template: ShortText.
transaction_id: Template: ShortText.
activity_id: Template: ShortText.
transaction_status: Template: ShortText.
payout_item_fee: Template: AmountT.
payout_batch_id: Template: ShortText.
payout_item: Template: PayoutT.
time_processed: Template: DateTime. A read-only field.
links: Template: Link. A read-only field.

Payout Item | Cancel Unclaimed

Based on resource template General.

[Create] action

Endpoint URL address: /payments/payouts-item/{{=item.id}}/cancel.

Documentation: https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts-item_cancel.

Fields

id: A key field. Template: ShortText.

Referenced Payout

Based on resource template General.

[Read] action

The result is extracted from: {{=PayPal.readList(resource, '/payments/referenced-payouts/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of referenced batch payout identifiers.

Documentation: https://developer.paypal.com/docs/api/referenced-payouts/v1/#referenced-payouts_get_batch_details.

[Create] action

Endpoint URL address: /payments/referenced-payouts.

The action has the following user-defined parameters:

Prefer: Provide the value for prefer.
PayPal-Partner-Attribution-Id: Provide the PayPal-Partner-Attribution-Id
PayPal-Request-Id: Provide the PayPal-Request-Id

The following request parameters will be automatically processed:

Prefer: {{=parameters.get('Prefer') }}
PayPal-Partner-Attribution-Id: {{=parameters.get('PayPal-Partner-Attribution-Id') }}
PayPal-Request-Id: {{=parameters.get('PayPal-Request-Id') }}

Documentation: https://developer.paypal.com/docs/api/referenced-payouts/v1/#referenced-payouts_create_batch.

Fields

referenced_payouts

Field components:

An array.
Contains the following components: item_id, processing_state, reference_id, reference_type, payout_amount, payout_destination, payout_transaction_id, disbursement_transaction_id, links.

payout_directive

Field components:

Uses template: ShortText.
Contains the following components: destination, type.

links

Template: Link. A read-only field.

Referenced Payout Item

Based on resource template General.

[Read] action

The result is extracted from: {{=PayPal.readList(resource, '/payments/referenced-payouts-items/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of referenced payout item identifiers.
PayPal-Partner-Attribution-Id: Provide the value for PayPal-Partner-Attribution-Id.

The following request parameters will be automatically processed:

PayPal-Partner-Attribution-Id: {{=parameters.get('PayPal-Partner-Attribution-Id') }}

Documentation: https://developer.paypal.com/docs/api/referenced-payouts/v1/#referenced-payouts-items_get.

[Create] action

Endpoint URL address: /payments/referenced-payouts-items.

The action has the following user-defined parameters:

Prefer: Provide the value for prefer.
PayPal-Partner-Attribution-Id: Provide the PayPal-Partner-Attribution-Id
PayPal-Request-Id: Provide the PayPal-Request-Id

The following request parameters will be automatically processed:

Prefer: {{=parameters.get('Prefer') }}
PayPal-Partner-Attribution-Id: {{=parameters.get('PayPal-Partner-Attribution-Id') }}
PayPal-Request-Id: {{=parameters.get('PayPal-Request-Id') }}

Documentation: https://developer.paypal.com/docs/api/referenced-payouts/v1/#referenced-payouts-items_create.

Fields

item_id

A key field. Template: ShortText.

processing_state

Field components:

Uses template: ShortText.
Contains the following components: status.

reference_id

Template: ShortText.

reference_type

Template: ShortText.

payout_amount

Template: CurrencyT.

payout_destination

Template: ShortText.

payout_transaction_id

Template: ShortText.

links

Template: Link. A read-only field.

Plan

Based on resource template General.

[Read] action

Endpoint URL address: /billing/plans.
The result is extracted from: {{=response.plans}}.

Documentation: https://developer.paypal.com/docs/api/subscriptions/v1/#plans_list.

[Create] action

Endpoint URL address: /billing/plans.

Documentation: https://developer.paypal.com/docs/api/subscriptions/v1/#plans_create.

[Update] action

Endpoint URL address: /billing/plans/{{=item.id}}.
The action uses PATCH method.

The following request parameters will be automatically processed:

application/json: {{=PayPal.getUpdatePayload(item)}}

Documentation: https://developer.paypal.com/docs/api/subscriptions/v1/#plans_patch.

Fields

id: A key field. Template: ShortText.
product_id: Template: ShortText.
status: Template: ShortText.
name: Template: ShortText.
description: Template: ShortText.
usage_type: Template: ShortText.
create_time: Template: DateTime. A read-only field.
update_time: Template: DateTime. A read-only field.
links: Template: Link. A read-only field.

Plan | Pricing

Based on resource template General.

[Create] action

Endpoint URL address: /billing/plans/{{=parameters.plan_id}}/update-pricing-schemes.

The action has the following user-defined parameters:

plan_id: Required. Specify plan identifier/

The following request parameters will be automatically processed:

application/json: {{={ pricing_schemes : batch } }}

Documentation: https://developer.paypal.com/docs/api/subscriptions/v1/#plans_deactivate.

Fields

billing_cycle_sequence

Data type: DT_I4

pricing_scheme

Field components:

Uses template: CurrencyT.
Contains the following components: fixed_price, pricing_model, tiers, roll_out_strategy.

Subscription

Based on resource template General.

[Read] action

The result is extracted from: {{=PayPal.readList(resource, '/billing/subscriptions/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of subscription identifiers.
transactionStartTime: The start time of the range of transactions to list. This is required if you want to retrieve transactions.
transactionEndTime: The end time of the range of transactions to list. This is required if you want to retrieve transactions.

Documentation: https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_get.

[Create] action

Endpoint URL address: /billing/subscriptions.

Documentation: https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_create.

[Update] action

Endpoint URL address: /billing/subscriptions/{{=item.id}}.
The action uses PATCH method.

The following request parameters will be automatically processed:

application/json: {{=PayPal.getUpdatePayload(item)}}

Documentation: https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_patch.

Fields

id

A key field. Template: ShortText.

plan_id

Template: ShortText.

start_time

Template: DateTime.

quantity

Template: ShortText.

status

Template: ShortText.

status_change_note

Template: ShortText.

shipping_amount

Template: CurrencyT.

subscriber

Field components:

Uses template: SubscriptionShipAddressT.
Contains the following components: shipping_address, name, email_address, payer_id.

billing_info

Field components:

Uses template: CurrencyT.
Contains the following components: outstanding_balance, cycle_executions, last_payment, next_billing_time, failed_payments_count.

create_time

Template: DateTime. A read-only field.

update_time

Template: DateTime. A read-only field.

links

Field components:

An array.
Contains the following components: href, rel, method.

plan

Field components:

Uses template: ShortText.
Contains the following components: id, product_id, name, description, status, usage_type, payment_preferences, quantity_supported, billing_cycles, taxes, create_time, update_time, op, path, value, links.

status_update_time

Template: DateTime. A read-only field.

custom_id

Data type: DT_BOOL

transactions

The value is gathered from /billing/subscriptions/{{=item.id}}/transactions address. The gathered value is processed with {{=response.transactions}} expression. Field components:

An array.
Contains the following components: id, status, payer_email, payer_name, amount_with_breakdown, time.

Subscription | Revise

Based on resource template General.

[Create] action

Endpoint URL address: /billing/subscriptions/{{=item.id}}/revise.

Documentation: https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_revise.

Fields

id

A key field. Template: ShortText.

effective_time

Template: DateTime.

quantity

Template: ShortText.

plan_id

Template: ShortText.

shipping_amount

Template: CurrencyT.

shipping_address

Template: SubscriptionShipAddressT.

application_context

Field components:

Uses template: ShortText.
Contains the following components: brand_name, locale, shipping_preference, payment_method, return_url, cancel_url.

plan

Field components:

Contains the following components: payment_preferences, quantity_supported, billing_cycles, taxes.

Subscription | Capture

Based on resource template General.

[Create] action

Endpoint URL address: /billing/subscriptions/{{=item.id}}/capture.

Documentation: https://developer.paypal.com/docs/api/subscriptions/v1/#subscriptions_capture.

Fields

id: A key field. Template: ShortText.
note: Template: ShortText.
capture_type: Template: ShortText.
amount: Template: CurrencyT.

Transaction

Based on resource template General.

[Read] action

Endpoint URL address: /reporting/transactions.
The result is extracted from: {{=response.transaction_details}}.

The action has the following user-defined parameters:

start_date: Required. Specify the start_date and time to filter in format 2014-07-01T00:00:00-0700.
end_date: Required. Specify the end_date and time to filter in format 2014-07-01T00:00:00-0700.

Documentation: https://developer.paypal.com/docs/api/transaction-search/v1/#transactions.

Fields

transaction_info

Field components:

Uses template: ShortText.
Contains the following components: paypal_account_id, transaction_id, transaction_event_code, transaction_initiation_date, transaction_updated_date, transaction_amount, fee_amount, insurance_amount, shipping_amount, shipping_discount_amount, transaction_status, transaction_subject, transaction_note, invoice_id, custom_field, protection_eligibility.

payer_info

Field components:

Uses template: ShortText.
Contains the following components: account_id, email_address, address_status, payer_status, payer_name, country_code.

shipping_info

Field components:

Uses template: ShortText.
Contains the following components: name.

cart_info

Field components:

Contains the following components: item_details.

store_info

Template: LongText. A composite field.

auction_info

Template: LongText. A composite field.

incentive_info

Template: LongText. A composite field.

Balance

Based on resource template General.

[Read] action

Endpoint URL address: /reporting/balances.
The result is extracted from: {{=[response]}}.

Documentation: https://developer.paypal.com/docs/api/transaction-search/v1/#balances_get.

Fields

balances

Field components:

Uses template: ShortText.
Contains the following components: currency, primary, total_balance, available_balance, withheld_balance.

account_id

Template: ShortText.

as_of_time

Template: DateTime.

last_refresh_time

Template: DateTime.

Webhook

Based on resource template General.

[Read] action

Endpoint URL address: /notifications/webhooks.
The result is extracted from: {{=response.webhooks}}.

Documentation: https://developer.paypal.com/docs/api/webhooks/v1/#webhooks_list.

[Read list] action

The result is extracted from: {{=PayPal.readList(resource, '/notifications/webhooks/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of webhook identifiers.

Documentation: https://developer.paypal.com/docs/api/webhooks/v1/#webhooks_get.

[Create] action

Endpoint URL address: /notifications/webhooks.

Documentation: https://developer.paypal.com/docs/api/webhooks/v1/#webhooks_post.

[Update] action

Endpoint URL address: /notifications/webhooks/{{=item.id}}.
The action uses PATCH method.

The following request parameters will be automatically processed:

application/json: {{=PayPal.getUpdatePayload(item)}}

Documentation: https://developer.paypal.com/docs/api/webhooks/v1/#webhooks_update.

[Delete] action

Endpoint URL address: /notifications/webhooks/{{=item.id}}.

Documentation: https://developer.paypal.com/docs/api/webhooks/v1/#webhooks_delete.

Fields

id

A key field. Template: ShortText.

url

Template: ShortText.

event_types

Field components:

An array.
Contains the following components: name, description.

links

Template: Link. A read-only field.

Webhook | Verify Signature

Based on resource template General.

[Create] action

Endpoint URL address: /notifications/verify-webhook-signature.

Documentation: https://developer.paypal.com/docs/api/webhooks/v1/#verify-webhook-signature_post.

Fields

transmission_id

Template: ShortText.

transmission_time

Template: ShortText.

cert_url

Template: ShortText.

auth_algo

Template: ShortText.

transmission_sig

Template: ShortText.

webhook_id

Template: ShortText.

webhook_event

Field components:

Uses template: ShortText.
Contains the following components: id, create_time, resource_type, event_type, summary, resource.

Webhook | Event Type

Based on resource template General.

[Read] action

Endpoint URL address: /notifications/webhooks-event-types.
The result is extracted from: {{=response.event_types}}.

Documentation: https://developer.paypal.com/docs/api/webhooks/v1/#webhooks-event-types_list.

Fields

name: Template: ShortText.
description: Template: ShortText.
status: Template: ShortText.
service: Template: ShortText.
owner: Template: ShortText.
contact: Template: ShortText.

Webhook | Event

Based on resource template General.

[Read] action

Endpoint URL address: /notifications/webhooks-events.
The result is extracted from: {{=response.events}}.

Documentation: https://developer.paypal.com/docs/api/webhooks/v1/#webhooks-events_list.

[Read list] action

The result is extracted from: {{=PayPal.readList(resource, '/notifications/webhooks-events/', parameters)}}.

The action has the following user-defined parameters:

id_list: Required. Specify comma separated list of webhook event identifiers.

Documentation: https://developer.paypal.com/docs/api/webhooks/v1/#webhooks-events_get.

Fields

id

A key field. Template: ShortText.

create_time

Template: ShortText.

resource_type

Template: ShortText.

event_version

Template: ShortText.

event_type

Template: ShortText.

summary

Template: ShortText.

resource_version

Template: ShortText.

resource

Field components:

Uses template: ShortText.
Contains the following components: id, create_time, update_time, state, amount, parent_payment, valid_until, links.

links

Template: Link. A read-only field.

Webhook | Resend Notification

Based on resource template General.

[Create] action

Endpoint URL address: /notifications/webhooks-events/{{=item.id}}/resend.

Documentation: https://developer.paypal.com/docs/api/webhooks/v1/#webhooks-events_resend.

Fields

id: A key field. Template: ShortText.
resource_version: Template: ShortText.
url: Template: ShortText.
event_type: Template: ShortText.

Webhook | Simulate Event

Based on resource template General.

[Create] action

Endpoint URL address: /notifications/simulate-event.

Documentation: https://developer.paypal.com/docs/api/webhooks/v1/#simulate-event.

Fields

id: A key field. Template: ShortText.
webhook_ids: Template: LongText. A composite field.

Referenced Resource Definitions

Base

[Read] action

The result is paginated.

The following request parameters will be automatically processed:

page: {{=parameters.iterator}}
page_size: {{=parameters.batchSize}}
fields: {{=_.without(parameters.fields, 'id', 'note', 'rowNumber', 'custom', 'parameters').join()}}
_includeUserParameters: {{=parameters}}

[Create] action

The action uses POST method.

The following request parameters will be automatically processed:

application/json: {{=item}}
_includeUserParameters: {{=parameters}}

[Update] action

The action uses PUT method.

The following request parameters will be automatically processed:

application/json: {{=item}}
_includeUserParameters: {{=parameters}}

[Delete] action

The action uses DELETE method.

The following request parameters will be automatically processed:

application/json: {{=item}}
_includeUserParameters: {{=parameters}}

General

Based on resource template Base.

Template

[Read] action

The result is paginated.

The following request parameters will be automatically processed:

page: {{=parameters.iterator}}
page_size: {{=parameters.batchSize}}
_includeUserParameters: {{=parameters}}

[Create] action

The action uses POST method.

The following request parameters will be automatically processed:

application/json: {{=item}}
_includeUserParameters: {{=parameters}}

[Update] action

The action uses PUT method.

The following request parameters will be automatically processed:

application/json: {{=item}}
_includeUserParameters: {{=parameters}}

[Delete] action

The action uses DELETE method.

The following request parameters will be automatically processed:

application/json: {{=item}}
_includeUserParameters: {{=parameters}}

Referenced Fields Definitions

ShortText

Data type: DT_WSTR ( length 255 )

LongText

Data type: DT_WSTR ( length 1000 )

DateTime

Data type: DT_DBTIMESTAMP

Date

Data type: DT_DBDATE Before setting, the value is processed with {{=dateFormat(value, 'yyyy-mm-dd')}} expression.

Link

Field components:

An array.
Contains the following components: href, rel, method.

AmountT

Field components:

Uses template: ShortText.
Contains the following components: value, currency.

CurrencyT

Field components:

Uses template: ShortText.
Contains the following components: currency_code, value.

ReturnShippingAddress

Field components:

Uses template: ShortText.
Contains the following components: address_line_1, address_line_2, address_line_3, admin_area_4, admin_area_3, admin_area_2, admin_area_1, postal_code, country_code, address_details.

SubscriptionShipAddressT

Field components:

Contains the following components: name, address.

AddressT

Field components:

Uses template: ShortText.
Contains the following components: address_line_1, address_line_2, admin_area_2, admin_area_1, postal_code, country_code.

AddressesT

Field components:

An array.
Uses template: AddressT.

PhoneT

Field components:

An array.
Contains the following components: country_code, national_number, extension_number, type.

EmailT

Field components:

An array.
Contains the following components: value, primary, type, email.

InvoiceDetailT

Field components:

Uses template: ShortText.
Contains the following components: invoice_number, reference, invoice_date, currency_code, note, term, memo, payment_term, metadata.

InvoicerT

Field components:

Uses template: AddressT.
Contains the following components: name, address, email_address, phones, website, tax_id, logo_url, additional_notes.

GeneralPartnerT

Field components:

Uses template: ShortText.
Contains the following components: names, citizenship, addresses, phones, birth_details.

AmountDetailsT

Field components:

Uses template: ShortText.
Contains the following components: currency_code, value, breakdown.

IndividualOwnerT

Field components:

An array.
Uses template: GeneralPartnerT.

BusinessEntityT

Field components:

Uses template: EmailT.
Contains the following components: business_type, business_industry, business_incorporation, names, emails, website, addresses, phones, beneficial_owners, office_bearers, annual_sales_volume_range, average_monthly_volume_range, purpose_code.

PartnerConfigOverrideT

Field components:

Uses template: ShortText.
Contains the following components: partner_logo_url, return_url, return_url_description, action_renewal_url, show_add_credit_card.

OperationT

Field components:

An array.
Contains the following components: operation, api_integration_preference, billing_agreement.

LegalconsentT

Field components:

An array.
Contains the following components: type, granted.

SenderBatchHeaderT

Field components:

Uses template: ShortText.
Contains the following components: sender_batch_id, email_subject, email_message.

PayoutT

Field components:

Uses template: ShortText.
Contains the following components: recipient_type, amount, note, receiver, sender_item_id.

ShippingInfoT

Field components:

Uses template: AddressT.
Contains the following components: name, address.

PrimaryRecipientT

Field components:

An array.
Contains the following components: billing_info, shipping_info.

ConfigurationT

Field components:

Uses template: ShortText.
Contains the following components: partial_payment, allow_tip, tax_calculated_after_discount, tax_inclusive, template_id.

CardT

Field components:

Uses template: ShortText.
Contains the following components: name, id, number, expiry, security_code, last_digits, card_type, type, brand, billing_address.

Scripts

Main

Knowledge Base

What's New

2.1

New: Introduced connection.

SSIS+ Components Suite

SSIS NoW

Excel Add-in for SAS

Overview

Setup

Obtain data

Insert data

Quick Start

Configuration

Knowledge Base

What's New

Newsletter

Contact Us

Follow Us

Support

SSIS+ Components Suite

SSIS NoW

Excel Add-in for SAS

PayPal Connection

Overview

Setup

Obtain data

Insert data

Quick Start

Configuration

Knowledge Base

What's New

Related documentation