Articles in this section

Available PayPal APIs

Naga Sri Hari Gonaboyina
Updated

When you configure an export, import, or other type of flow step using the prebuilt PayPal connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the PayPal API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource API endpoint Export Import
Add tracking Add tracking information for multiple PayPal transactions X
Add tracking information for PayPal transaction X
List tracking information X
Update or cancel tracking information for PayPal transaction X
Show tracking information X
Billing plans (Deprecated) List billing plans (Deprecated) X
Show billing plan details (Deprecated) X
Create billing plan (Deprecated) X
Update billing plan (Deprecated) X
Catalog products List products X
Show product details X
Create product X
Update product X
Currency exchange Create exchange rate quote X
Disputes List disputes X
Show dispute details X
Provide evidence X
Accept offer to resolve dispute X
Acknowledge returned item X
Provide supporting information for dispute X
Make offer to resolve dispute X
Settle dispute X
Partially update dispute X
Update dispute status X
Accept claim X
Deny offer to resolve dispute X
Appeal dispute X
Send message about dispute to other party X
Escalate dispute to claim X
Identity Show user profile information X
Show user profile details X
Create user X
List users X
Update user X
Show user details X
Delete user X
Invoicing List invoices X
Show invoice details X
Generate invoice number X
Create draft invoice X
Delete invoice X
Fully update invoice X
Cancel sent invoice X
Record payment for invoice X
Delete external payment X
Record refund for invoice X
Delete external refund X
Send invoice reminder X
Send invoice X
Show template details X
Fully update template X
Delete template X
Search for invoices X
List templates X
Create template X
Generate QR code X
Orders Show order details X
Create order X
Authorize payment for order X
Capture payment for order X
Update order X
Confirm the order X
Add tracking information for an order X
Update or cancel tracking information for an order X
Receive updated order information via callback URL X
Partner referrals Create partner referral X
Show referral data X
Payment experience List web experience profiles X
Show web experience profile details by ID X
Create web experience profile X
Update web experience profile X
Delete web experience profile X
Partially update web experience profile X
Payment method tokens Create payment token for a given payment source X
List all payment tokens X
Retrieve a payment token X
Delete payment token X
Create a setup token X
Retrieve a setup token X
Payments Show details for authorized payment X
Show captured payment details X
Show refund details X
Capture authorized payment X
Reauthorize authorized payment X
Void authorized payment X
Refund captured payment X
Payouts Show payout batch details X
Show payout item details X
Create batch payout X
Cancel unclaimed payout item X
Referenced payouts Create referenced batch payout X
List items in referenced batch payout X
Create referenced payout item X
Show referenced payout item details X
Subscriptions List plans X
Show plan details X
Show subscription details X
List transactions for subscription X
Create plan X
Update plan X
Activate plan X
Deactivate plan X
Update pricing X
Create subscription X
Activate subscription X
Cancel subscription X
Capture authorized payment on subscription X
Revise plan or quantity of subscription X
Suspend subscription X
Update plan X
List subscriptions X
Update subscription X
Transaction search List transactions X
List all balances X
Vault List vaulted credit cards X
Show vaulted credit card details X
Store credit card X
Update vaulted credit card X
Delete vaulted credit card X
Webhooks management Create webhook X
List webhooks X
Show webhook details X
Update webhook X
Delete webhook X
List event subscriptions for webhook X
Create webhook lookup X
List webhook lookups X
Show webhook lookup details X
Delete webhook lookup X
Verify webhook signature X
List available events X
List event notifications X
Show event notification details X
Resend event notification X
Simulate webhook event X

Available DI objects

The following objects are available when using PayPal as a source in Celigo Data Integration (DI).

Primary key: PayPal assigns a unique identifier (for example, id, dispute_id, or transaction_id depending on the object) to each record.

Object API endpoint Available extract modes Delta field
Catalog products List products Full —
Disputes List disputes Full, Incremental start_time
Identity List users Full —
Invoicing List invoices Full —
Subscriptions List subscriptions Full, Incremental start_time_after
Transaction search List transactions Full, Incremental start_date

Response schemas

Click an object below to view its response fields and delta configuration.

Catalog products — List products

Response schema:

Field Type
id string (Primary key)
name string
description string
create_time string
links objectarray
links.href string
links.rel string
links.method string
Disputes — List disputes

Delta configuration: use it to request incremental data.

Setting Value
Delta filter start_time = {{{encodeURI lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
dispute_id string (Primary key)
create_time string
update_time string
disputed_transactions objectarray
disputed_transactions.buyer_transaction_id string
disputed_transactions.buyer object
disputed_transactions.buyer.payer_id string
disputed_transactions.seller object
disputed_transactions.seller.merchant_id string
disputed_transactions.seller_protection_type string
disputed_transactions.seller_protection_eligible boolean
reason string
status string
dispute_state string
dispute_amount object
dispute_amount.currency_code string
dispute_amount.value string
outcome string
dispute_life_cycle_stage string
dispute_channel string
dispute_flow string
links objectarray
links.href string
links.rel string
links.method string
Identity — List users

Response schema:

Field Type
userName string (PII)
name object
name.familyName string (PII)
name.givenName string (PII)
emails objectarray
emails.value string (PII)
emails.primary boolean
entitlements objectarray
entitlements.value string
id string (Primary key)
externalId string
meta object
meta.resourceType string
meta.created string
meta.location string
Invoicing — List invoices
Subscriptions — List subscriptions

Delta configuration: use it to request incremental data.

Setting Value
Delta filter start_time_after = {{{encodeURI lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id string (Primary key)
status string
status_change_note string
status_update_time string
plan_id string
start_time string
quantity string
shipping_amount object
shipping_amount.currency_code string
shipping_amount.value string
subscriber object
subscriber.email_address string
subscriber.name object
subscriber.name.given_name string
subscriber.name.surname string
subscriber.tenant string
subscriber.shipping_address object
subscriber.shipping_address.name object
subscriber.shipping_address.name.given_name string
subscriber.shipping_address.name.surname string
subscriber.shipping_address.address object
subscriber.shipping_address.address.address_line_1 string
subscriber.shipping_address.address.address_line_2 string
subscriber.shipping_address.address.admin_area_2 string
subscriber.shipping_address.address.admin_area_1 string
subscriber.shipping_address.address.postal_code string
subscriber.shipping_address.address.country_code string
subscriber.payment_source object
subscriber.payment_source.card object
subscriber.payment_source.card.name string
subscriber.payment_source.card.last_digits string
subscriber.payment_source.card.brand string
subscriber.payment_source.card.attributes object
subscriber.payment_source.card.attributes.vault object
subscriber.payment_source.card.attributes.vault.id string
subscriber.payment_source.card.attributes.vault.customer object
subscriber.payment_source.card.attributes.vault.customer.id string
subscriber.payment_source.card.expiry string
billing_info object
billing_info.outstanding_balance object
billing_info.outstanding_balance.currency_code string
billing_info.outstanding_balance.value string
billing_info.cycle_executions objectarray
billing_info.cycle_executions.tenure_type string
billing_info.cycle_executions.sequence number
billing_info.cycle_executions.cycles_completed number
billing_info.cycle_executions.cycles_remaining number
billing_info.cycle_executions.current_pricing_scheme_version number
billing_info.cycle_executions.total_cycles number
billing_info.last_payment object
billing_info.last_payment.amount object
billing_info.last_payment.amount.currency_code string
billing_info.last_payment.amount.value string
billing_info.last_payment.time string
billing_info.next_billing_time string
billing_info.final_payment_time string
billing_info.failed_payments_count number
create_time string
update_time string
plan_overridden boolean
links objectarray
links.href string
links.rel string
links.method string