Paypal Transaction
This page contains the setup guide and reference information for the Paypal Transaction source connector.
Prerequisites
The Paypal Transaction API is used to get the history of transactions for a PayPal account.
Setup guide
Step 1: Set up Paypal Transaction
In order to get an Client ID and Secret please go to this page and follow the instructions. After registration you may find your Client ID and Secret here.
Our Paypal Transactions Source Connector does not support OAuth at this time due to limitations outside of our control. If OAuth for Paypal Transactions is critical to your business, please reach out to us to discuss how we may be able to partner on this effort.
Step 2: Set up the Paypal Transaction connector in Airbyte
For Airbyte Cloud:
- Log into your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click +new source.
- On the Set up the source page, enter the name for the Paypal Transaction connector and select Paypal Transaction from the Source type dropdown.
- Enter your client id
- Enter your secret
- Choose if your account is sandbox
- Enter the date you want your sync to start from
- Click Set up source.
For Airbyte Open Source:
- Navigate to the Airbyte Open Source dashboard
- Set the name for your source
- Enter your client id
- Enter your secret
- Choose if your account is sandbox
- Enter the date you want your sync to start from
- Click Set up source
Supported sync modes
The PayPal Transaction source connector supports the following sync modes:
| Feature | Supported? |
|---|---|
| Full Refresh Sync | Yes |
| Incremental - Append Sync | Yes |
| Namespaces | No |
Supported Streams
This Source is capable of syncing the following core Streams:
Performance considerations
Paypal transaction API has some limits
start_date_min= 3 years, API call lists transaction for the previous three years.start_date_max= 1.5 days, it takes a maximum of three hours for executed transactions to appear in the list transactions call. It is set to 1.5 days by default based on experience, otherwise API throw an error.stream_slice_period= 7 day, the maximum supported date range is 31 days.records_per_request= 10000, the maximum number of records in a single request.page_size= 500, the maximum page size is 500.requests_per_minute= 30, maximum limit is 50 requests per minute from IP address to all endpoint
By default, syncs are performed with a slice period of 7 days. If you see errors with the message Result set size is greater than the maximum limit. Change the filter criteria and try again., lower the size of the slice period in your connection configuration.
Data type map
| Integration Type | Airbyte Type |
|---|---|
string | string |
number | number |
array | array |
object | object |
Reference
Config fields reference
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 2.2.1 | 2024-01-11 | 34155 | prepare for airbyte-lib |
| 2.2.0 | 2023-10-25 | 31852 | The size of the time_window can be configured |
| 2.1.2 | 2023-10-23 | 31759 | Keep transaction_id as a string and fetch data in 7-day batches |
| 2.1.1 | 2023-10-19 | 31599 | Base image migration: remove Dockerfile and use the python-connector-base image |
| 2.1.0 | 2023-08-14 | 29223 | Migrate Python CDK to Low Code schema |
| 2.0.0 | 2023-07-05 | 27916 | Update Balances schema |
| 1.0.0 | 2023-07-03 | 27968 | mark Client ID and Client Secret as required fields |
| 0.1.13 | 2023-02-20 | 22916 | Specified date formatting in specification |
| 0.1.12 | 2023-02-18 | 23211 | Fix error handler |
| 0.1.11 | 2023-01-27 | 22019 | Set AvailabilityStrategy for streams explicitly to None |
| 0.1.10 | 2022-09-04 | 17554 | Made the spec and source config to be consistent |
| 0.1.9 | 2022-08-18 | 15741 | Removed OAuth2.0 option |
| 0.1.8 | 2022-07-25 | 15000 | Added support of OAuth2.0 authentication, fixed bug when normalization couldn't handle nested cursor field and primary key |
| 0.1.7 | 2022-07-18 | 14804 | Added RESULTSET_TOO_LARGE error validation |
| 0.1.6 | 2022-06-10 | 13682 | Updated paypal transaction schema |
| 0.1.5 | 2022-04-27 | 12335 | Added fixtures to mock time.sleep for connectors that explicitly sleep |
| 0.1.4 | 2021-12-22 | 9034 | Updated connector fields title/description |
| 0.1.3 | 2021-12-16 | 8580 | Added more logs during check connection stage |
| 0.1.2 | 2021-11-08 | 7499 | Removed base-python dependencies |
| 0.1.1 | 2021-08-03 | 5155 | Fixed start_date_min limit |
| 0.1.0 | 2021-06-10 | 4240 | PayPal Transaction Search API |