Advanced Analytica Advanced Analytica: IBOM
← All connectors
Paypal Transaction logo

Source connector

Paypal Transaction

Set up Paypal Transaction as a source and move its data into your chosen destination.

Version 2.6.61 certified generally available

Paypal

Set up the Paypal source connector using this guide and reference information.

This connector authenticates requests using PayPal APIs OAuth 2.0 access token.

Prerequisites

You need a Paypal account, which you can get by following these steps.

The same page explains how to set up a Sandbox for testing before using the connector in production.

Setup guide

Step 1: Get your Paypal secrets

After creating your account, you can get your Client ID and Secret. You’ll find them in your Apps & Credentials page.

Step 2: Set up the Paypal Transaction connector in Airbyte

  1. Log in to your Airbyte account.

  2. In the left navigation bar, select Sources.

    a. If you’re creating your first source, enter Paypal Transaction in the search bar and select it.

    b. If you’ve configured sources, select +new source in the top-right corner. Enter Paypal Transaction in the search bar and select the connector.

  3. Set your source name.

  4. Enter your Client ID.

  5. Enter your Client secret.

  6. Start Date: Use the datepicker or manually enter a UTC date and time in the format YYYY-MM-DDTHH:MM:SSZ.

  7. Switch the Sandbox toggle ON/Off. It’s OFF by default, so the connector works only in production.

  8. (Optional) Dispute Start Date Range: Use the datepicker or manually enter a UTC date and time in the format YYYY-MM-DDTHH:MM:SS.sssZ.

    • If you don’t add a date and sync lists_disputes stream, the connector retrieves data from the previous 180 days by default.
    • If you enter a datetime, you must include milliseconds.
    • This option works only for lists_disputes stream.
  9. (Optional) Refresh Token: You can manually enter a refresh token. The stream currently handles this automatically.

  10. (Optional) Number of days per request: Specify how many days the connector covers when requesting data from the Paypal API. A smaller retrieval window can help when you have a rate limit.

  • Paypal limits each request to 10K records. This option helps when weekly syncs contain more than 10K records.
  • The default value is 7.
  • The maximum value is 31 days.
  1. Select Set up source.

:::info

By default, syncs use a seven-day slice period. PayPal caps each transaction search at 10K records. The transactions stream automatically retries rejected slices using smaller date ranges. The sync fails only if PayPal rejects a one-second date range. If a sync fails with Result set size is greater than the maximum limit or RESULTSET_TOO_LARGE:

  • Reduce the slice period in your connection configuration’s optional parameters.
  • If a one-day slice isn’t enough, shorten the scheduled sync window. This may help you avoid the 10K limit.

:::

Supported sync modes

The PayPal Transaction source connector supports these sync modes:

FeatureSupported?
Full Refresh SyncYes
Incremental - Append SyncYes
NamespacesNo

Supported streams

This source can sync these core streams:

Transactions stream

The table below lists this connector’s configuration parameters, default values and available features.

Param/FeatureTransactions
Start DateTimestamp with TZ (no ms)
Dispute Start Date RangeNA
Refresh tokenAuto
Number of days per requestMax 31 , 7(D)
Pagination StrategyPage Increment
Page size Max 500 (F)
Full Refresh:white_check_mark:
Incremental:white_check_mark: (D)

D: Default configured value

F: Fixed value. You can’t configure it.


Balances stream

The table below lists this connector’s configuration parameters, default values and available features.

Param/FeatureBalances
Start DateTimestamp with TZ (no ms)
Dispute Start Date RangeNA
Refresh tokenAuto
Number of days per requestNA
Pagination StrategyNA
Page size NA
Full Refresh:white_check_mark:
Incremental:white_check_mark: (D)

D: Default configured value

F: Fixed value. You can’t configure it.


List Products stream

The table below lists this connector’s configuration parameters, default values and available features.

Param/FeatureList Products
Start DateNA
Dispute Start Date RangeNA
Refresh tokenAuto
Number of days per requestNA
Pagination StrategyPage Increment
Page size Max 20 (F)
Full Refresh:white_check_mark: (D)
Incremental:x:

D: Default configured value

F: Fixed value. You can’t configure it.

:::caution

The API limits data retrieval speed, so consider this when configuring your stream. Retrieving a +30K catalog can take 10 to 15 minutes in some cases.

:::


Show Products stream

The table below lists this connector’s configuration parameters, default values and available features.

Param/FeatureShow Prod. Details
Start DateNA
Dispute Start Date RangeNA
Refresh tokenAuto
Number of days per requestNA
Pagination StrategyNA
Page size NA
Full Refresh:white_check_mark: (D)
Incremental:x:

D: Default configured value

F: Fixed value. You can’t configure it.

:::caution

The parent stream paginates 20 items at a time, the maximum allowed page size. Paypal API calls aren’t concurrent, so sync time depends entirely on the server. This stream can take considerable time to sync. Consider syncing it and its parent stream, list_products, at the end of the day. Depending on the catalog size, the sync can take several hours.

:::


List Disputes stream

The table below lists this connector’s configuration parameters, default values and available features.

Param/FeatureList Disputes
Start DateNA
Dispute Start Date RangeTimestamp with TZ (w/ms)
Refresh tokenAuto
Number of days per requestMax 180 , 7(D)
Pagination StrategyPage Token
Page size Max 50 (F)
Full Refresh:white_check_mark:
Incremental:white_check_mark: (D)

D: Default configured value

F: Fixed value. You can’t configure it.


Search Invoices stream

The table below lists this connector’s configuration parameters, default values and available features.

Param/FeatureSearch Invoices
Start DateTimestamp with TZ (no ms)
Dispute Start Date RangeNA
Refresh tokenAuto
Number of days per requestND
Pagination StrategyPage Number
Page size Max 100 (F)
Full Refresh:white_check_mark: (D)
Incremental:x:

D: Default configured value

F: Fixed value. You can’t configure it.

ND: Not defined in the source.

:::info

The connector passes the configured start_end to the request body and uses creation_date_range.start and creation_date_range.end. See Paypal Developer API documentation for more information.

:::


List Payments stream

The table below lists this connector’s configuration parameters, default values and available features.

Param/FeatureList Payments
Start DateTimestamp with TZ (no ms)
Dispute Start Date RangeNA
Refresh tokenAuto
Number of days per requestNA , 7(D)
Pagination StrategyPage Cursor
Page size Max 20 (F)
Full Refresh:white_check_mark:
Incremental:white_check_mark: (D)

D: Default configured value

F: Fixed value. You can’t configure it.


Performance considerations

  • Data Availability: Executed transactions can take up to 3 hours to appear in the list transactions call.
  • Number of days per request: The maximum supported date range is 31 days.
  • Historical Data: You can’t retrieve more than 3yrs of data for the transactions stream. For dispute_start_date, you can retrieve only 180 days of data. See the specifications for each stream.
  • records_per_request: A single request supports up to 10K records due to an API server restriction.
  • page_size: The number of records per page differs by stream. By default, source-paypal-transaction sets each stream’s maximum allowed page size.
  • requests_per_minute: The API server limits all endpoints to 50 requests per minute from each IP address.

Data type map

Integration TypeAirbyte Type
stringstring
numbernumber
arrayarray
objectobject

IP allow list

If you use Airbyte Cloud and your organisation restricts access to specific IPs, add Airbyte Cloud IP addresses to your allow list.

Changelog

Expand to review
VersionDatePull RequestSubject
2.6.612026-11-1091676Update dependencies
2.6.602026-11-0390673Update dependencies
2.6.592026-11-0190328Simplify error handling configuration with no change to retry, backoff, or window-splitting behavior
2.6.582026-10-2789998Update dependencies
2.6.572026-10-2089356Update dependencies
2.6.562026-10-1485249Wait 100 seconds before each retry of a failed transactions request, such as on HTTP 429 or 5xx, as the other streams already do
2.6.552026-10-1388730Update dependencies
2.6.542026-10-0687974Update dependencies
2.6.532026-09-2987441Keep the list_disputes start date inside PayPal’s 180-day window to fix INVALID_DATE_RANGE 400 errors on first syncs
2.6.522026-09-2986920feat(source-paypal-transaction): adopt declarative request_window_red…
2.6.512026-09-2987311Update dependencies
2.6.512026-09-2286920Replace the transactions stream’s custom DateWindowSplittingRetriever/ResultSetTooLargeErrorHandler components with the CDK’s declarative request_window_splitting feature; the stream’s failure type when a window is rejected even at its smallest split changes from config_error to transient_error
2.6.502026-09-2286765Update dependencies
2.6.492026-09-1586180Update dependencies
2.6.482026-09-0884916Retry oversized transactions date slices as smaller date ranges instead of failing the sync on the first RESULTSET_TOO_LARGE response
2.6.472026-09-0885594Update dependencies
2.6.462026-08-2679676Fix transaction_id primary key emitted as null for IDs resembling scientific notation
2.6.452026-08-1884690Update dependencies
2.6.442026-08-1184075Update dependencies
2.6.432026-07-2883194Update to CDK 7.23.8 (fixes AirbyteCustomCodeNotPermittedError for bundled custom components) and remove the temporary Cloud version override
2.6.422026-07-281082Roll Cloud back to 2.6.40 — 2.6.41 is built on SDM 7.23.7, which breaks bundled custom components
2.6.412026-07-2883052Update dependencies
2.6.402026-07-2182533Update dependencies
2.6.392026-07-1481962Update dependencies
2.6.382026-06-3081175Update dependencies
2.6.372026-06-2380610Update dependencies
2.6.362026-06-1679986Update dependencies
2.6.352026-06-0979456Update dependencies
2.6.342026-06-0278907Update dependencies
2.6.332026-04-2877335Update dependencies
2.6.322026-04-2176710Update dependencies
2.6.312026-04-0776135Fix undefined security_context variable in payments generator utility script
2.6.302026-03-3175850Update dependencies
2.6.292026-03-2475396Update dependencies
2.6.282026-03-1074484Update dependencies
2.6.272026-03-0373875Update dependencies
2.6.262026-02-2674027Fix INVALID_DATE_TIME_FORMAT error on disputes stream by using 3-digit milliseconds
2.6.252026-02-1773574Update dependencies
2.6.242026-02-1073171Update dependencies
2.6.232026-02-0372637Update dependencies
2.6.222026-01-2270967Update HTTP response action for 400 error transactions from IGNORE to FAIL
2.6.212026-01-2071652Update dependencies
2.6.202025-12-1870505Update dependencies
2.6.192025-11-2569974Update dependencies
2.6.182025-11-1869668Update dependencies
2.6.172025-10-2969044Update dependencies
2.6.162025-10-2168286Update dependencies
2.6.152025-10-1467760Update dependencies
2.6.142025-10-0767348Update dependencies
2.6.132025-09-3066378Update dependencies
2.6.122025-09-0965835Update dependencies
2.6.112025-08-2365171Update dependencies
2.6.102025-08-0964716Update dependencies
2.6.92025-08-0264258Update dependencies
2.6.82025-07-2663821Update dependencies
2.6.72025-07-1963449Update dependencies
2.6.62025-07-1263255Update dependencies
2.6.52025-07-0562625Update dependencies
2.6.42025-06-2862390Update dependencies
2.6.32025-06-2161932Update dependencies
2.6.22025-06-1451848Update dependencies
2.6.12025-06-0558674Update CDK to fix complex datatype errors with interpolation
2.6.02024-10-2347282Migrate to Manifest-only
2.5.82025-01-1143797Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
2.5.72024-06-2540269Update dependencies
2.5.62024-06-2240110Update dependencies
2.5.52024-06-0438983[autopull] Upgrade base image to v1.2.1
2.5.42024-05-2038265Replace AirbyteLogger with logging.Logger
2.5.32024-04-2436654Schema descriptions
2.5.22024-04-1937435Updated manifest.yaml to use the latest CDK Manifest version to fix the Incremental STATE values
2.5.12024-03-1536165Unpin CDK Version
2.5.02024-03-1536173Extended Disputes stream schema with missing properties
2.4.02024-02-2035465Per-error reporting and continue sync on stream failures
2.3.02024-02-1434510Silver certified. New Streams Added
2.2.22024-02-0935075Manage dependencies with Poetry.
2.2.12024-01-1134155prepare for airbyte-lib
2.2.02023-10-2531852The size of the time_window can be configured
2.1.22023-10-2331759Keep transaction_id as a string and fetch data in 7-day batches
2.1.12023-10-1931599Base image migration: remove Dockerfile and use the python-connector-base image
2.1.02023-08-1429223Migrate Python CDK to Low Code schema
2.0.02023-07-0527916Update Balances schema
1.0.02023-07-0327968mark Client ID and Client Secret as required fields
0.1.132023-02-2022916Specified date formatting in specification
0.1.122023-02-1823211Fix error handler
0.1.112023-01-2722019Set AvailabilityStrategy for streams explicitly to None
0.1.102022-09-0417554Made the spec and source config to be consistent
0.1.92022-08-1815741Removed OAuth2.0 option
0.1.82022-07-2515000Added support of OAuth2.0 authentication, fixed bug when normalization couldn’t handle nested cursor field and primary key
0.1.72022-07-1814804Added RESULTSET_TOO_LARGE error validation
0.1.62022-06-1013682Updated paypal transaction schema
0.1.52022-04-2712335Added fixtures to mock time.sleep for connectors that explicitly sleep
0.1.42021-12-229034Updated connector fields title/description
0.1.32021-12-168580Added more logs during check connection stage
0.1.22021-11-087499Removed base-python dependencies
0.1.12021-08-035155Fixed start_date_min limit
0.1.02021-06-104240PayPal Transaction Search API
Advanced Analytica

Most businesses are sitting on information they can’t use at speed. The people who hold it are busy, and when they leave, the knowledge goes with them. The documents are static, and the processes around them weren’t designed for AI.

Advanced Analytica works with these businesses to turn that information into structured data assets. Once they're integrated, AI systems can govern it, and the business can use it. We bring in the strategy, the specification and the AI skills to rework how the business operates.

MOVE FAST. STAY SAFE.