Skip to content

Commit 65295b7

Browse files
lazebnyilazebnyi
authored
🎉Source PayPal Transactions: Updated docs (#15105)
* Updated docs * Updated docs
1 parent 39029f8 commit 65295b7

File tree

1 file changed

+55
-39
lines changed

1 file changed

+55
-39
lines changed

‎docs/integrations/sources/paypal-transaction.md

Lines changed: 55 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,52 @@
11
# Paypal Transaction
22

3-
## Overview
3+
This page contains the setup guide and reference information for the Paypal Transaction source connector.
44

5-
The [Paypal Transaction API](https://developer.paypal.com/docs/api/transaction-search/v1/). is used to get the history of transactions for a PayPal account.
5+
## Prerequisites
66

7-
#### Output schema
7+
The [Paypal Transaction API](https://developer.paypal.com/docs/api/transaction-search/v1/) is used to get the history of transactions for a PayPal account.
88

9-
This Source is capable of syncing the following core Streams:
9+
## Setup guide
10+
### Step 1: Set up Paypal Transaction
1011

11-
* [Transactions](https://developer.paypal.com/docs/api/transaction-search/v1/#transactions)
12-
* [Balances](https://developer.paypal.com/docs/api/transaction-search/v1/#balances)
12+
In order to get an `Client ID` and `Secret` please go to [this](https://developer.paypal.com/docs/platforms/get-started/) page and follow the instructions. After registration you may find your `Client ID` and `Secret` [here](https://developer.paypal.com/developer/accounts/).
1313

14-
#### Data type mapping
14+
## Step 2: Set up the Paypal Transaction connector in Airbyte
1515

16-
| Integration Type | Airbyte Type | Notes |
17-
| :--- | :--- | :--- |
18-
| `string` | `string` | |
19-
| `number` | `number` | |
20-
| `array` | `array` | |
21-
| `object` | `object` | |
16+
### For Airbyte Cloud:
17+
1. [Log into your Airbyte Cloud](https://cloud.airbyte.io/workspaces) account.
18+
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
19+
3. On the Set up the source page, enter the name for the Paypal Transaction connector and select **Paypal Transaction** from the Source type dropdown.
20+
4. For Airbyte Cloud, click **Authenticate your Paypal Transaction account** to sign in with Paypal and authorize your account.
21+
5. Choose if your account is sandbox
22+
6. Enter the date you want your sync to start from
23+
7. Click **Set up source**.
2224

23-
#### Features
25+
### For Airbyte OSS:
26+
1. Navigate to the Airbyte Open Source dashboard
27+
2. Set the name for your source
28+
4. Enter your client id
29+
4. Enter your secret
30+
4. Choose if your account is sandbox
31+
5. Enter the date you want your sync to start from
32+
6. Click **Set up source**
2433

25-
| Feature | Supported? |
26-
| :--- | :--- |
27-
| Full Refresh Sync | Yes |
28-
| Incremental - Append Sync | Yes |
29-
| Namespaces | No |
34+
## Supported sync modes
3035

31-
### Getting started
36+
The PayPal Transaction source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
3237

33-
### Requirements
38+
| Feature | Supported? |
39+
| :------------------------ | :--------- |
40+
| Full Refresh Sync | Yes |
41+
| Incremental - Append Sync | Yes |
42+
| Namespaces | No |
3443

35-
* client\_id.
36-
* secret.
37-
* is\_sandbox.
44+
## Supported Streams
3845

39-
### Setup guide
46+
This Source is capable of syncing the following core Streams:
4047

41-
In order to get an `Client ID` and `Secret` please go to \[this\]\([https://developer.paypal.com/docs/platforms/get-started/](https://developer.paypal.com/docs/platforms/get-started/) page and follow the instructions. After registration you may find your `Client ID` and `Secret` [here](https://developer.paypal.com/developer/accounts/).
48+
* [Transactions](https://developer.paypal.com/docs/api/transaction-search/v1/#transactions)
49+
* [Balances](https://developer.paypal.com/docs/api/transaction-search/v1/#balances)
4250

4351
## Performance considerations
4452

@@ -51,19 +59,27 @@ Paypal transaction API has some [limits](https://developer.paypal.com/docs/integ
5159
* `page_size` = 500, the maximum page size is 500.
5260
* `requests_per_minute` = 30, maximum limit is 50 requests per minute from IP address to all endpoint
5361

54-
Transactions sync is performed with default `stream_slice_period` = 1 day, it means that there will be 1 request for each day between start\_date and now \(or end\_date\). if `start_date` is greater then `start_date_max`. Balances sync is similarly performed with default `stream_slice_period` = 1 day, but it will do additional request for the end\_date of the sync \(now\).
62+
Transactions sync is performed with default `stream_slice_period` = 1 day, it means that there will be 1 request for each day between start_date and now or end_date. if `start_date` is greater then `start_date_max`. Balances sync is similarly performed with default `stream_slice_period` = 1 day, but it will do additional request for the end_date of the sync now.
5563

56-
## Changelog
64+
## Data type map
5765

58-
| Version | Date | Pull Request | Subject |
59-
|:--------|:-----------|:---------------------------------------------------------|:------------------------------------------------------------------------|
60-
| 0.1.8 | 2022-07-25 | [15000](https://github.com/airbytehq/airbyte/pull/15000) | Added support of `OAuth2.0` authentication, fixed bug when normalization couldn't handle nested cursor field and primary key
61-
| 0.1.7 | 2022-07-18 | [14804](https://github.com/airbytehq/airbyte/pull/14804) | Adding `RESULTSET_TOO_LARGE` error validation |
62-
| 0.1.6 | 2022-06-10 | [13682](https://github.com/airbytehq/airbyte/pull/13682) | Update paypal transaction schema |
63-
| 0.1.5 | 2022-04-27 | [12335](https://github.com/airbytehq/airbyte/pull/12335) | Adding fixtures to mock time.sleep for connectors that explicitly sleep |
64-
| 0.1.4 | 2021-12-22 | [9034](https://github.com/airbytehq/airbyte/pull/9034) | Update connector fields title/description |
65-
| 0.1.3 | 2021-12-16 | [8580](https://github.com/airbytehq/airbyte/pull/8580) | Added more logs during `check connection` stage |
66-
| 0.1.2 | 2021-11-08 | [7499](https://github.com/airbytehq/airbyte/pull/7499) | Remove base-python dependencies |
67-
| 0.1.1 | 2021-08-03 | [5155](https://github.com/airbytehq/airbyte/pull/5155) | Fix start\_date\_min limit |
68-
| 0.1.0 | 2021-06-10 | [4240](https://github.com/airbytehq/airbyte/pull/4240) | PayPal Transaction Search API |
66+
| Integration Type | Airbyte Type |
67+
| :--------------- | :----------- |
68+
| `string` | `string` |
69+
| `number` | `number` |
70+
| `array` | `array` |
71+
| `object` | `object` |
72+
73+
## Changelog
6974

75+
| Version | Date | Pull Request | Subject |
76+
|:--------|:-----------|:---------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------|
77+
| 0.1.8 | 2022-07-25 | [15000](https://github.com/airbytehq/airbyte/pull/15000) | Added support of `OAuth2.0` authentication, fixed bug when normalization couldn't handle nested cursor field and primary key |
78+
| 0.1.7 | 2022-07-18 | [14804](https://github.com/airbytehq/airbyte/pull/14804) | Added `RESULTSET_TOO_LARGE` error validation |
79+
| 0.1.6 | 2022-06-10 | [13682](https://github.com/airbytehq/airbyte/pull/13682) | Updated paypal transaction schema |
80+
| 0.1.5 | 2022-04-27 | [12335](https://github.com/airbytehq/airbyte/pull/12335) | Added fixtures to mock time.sleep for connectors that explicitly sleep |
81+
| 0.1.4 | 2021-12-22 | [9034](https://github.com/airbytehq/airbyte/pull/9034) | Updated connector fields title/description |
82+
| 0.1.3 | 2021-12-16 | [8580](https://github.com/airbytehq/airbyte/pull/8580) | Added more logs during `check connection` stage |
83+
| 0.1.2 | 2021-11-08 | [7499](https://github.com/airbytehq/airbyte/pull/7499) | Removed base-python dependencies |
84+
| 0.1.1 | 2021-08-03 | [5155](https://github.com/airbytehq/airbyte/pull/5155) | Fixed start_date_min limit |
85+
| 0.1.0 | 2021-06-10 | [4240](https://github.com/airbytehq/airbyte/pull/4240) | PayPal Transaction Search API |

0 commit comments

Comments
 (0)