Paystack
This page contains the setup guide and reference information for the Paystack source connector.
Prerequisites
- Secret Key
- Start Day
- Lookback Window
Setup guide
Step 1: Set up Paystack connector
- Log into your Airbyte Cloud or Airbyte Open Source account.
- Click Sources and then click + New source.
- On the Set up the source page, select Paystack from the Source type dropdown.
- Enter a name for your source.
- For Secret Key enter your secret key. The Paystack API key usually starts with 'sklive'. You can find yours secret key here.
- For Start Date enter UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
- For Lookback Window (in days) enter the number of days. When set, the connector will always reload data from the past N days, where N is the value set here. This is useful if your data is updated after creation.
Supported sync modes
The Paystack source connector supports the following sync modes:
- Full Refresh
- Incremental
Supported Streams
- Customers (Incremental)
- Disputes (Incremental)
- Invoices (Incremental)
- Refunds (Incremental)
- Settlements (Incremental)
- Subscriptions (Incremental)
- Transactions (Incremental)
- Transfers (Incremental)
Note on Incremental Syncs
The Paystack API does not allow querying objects which were updated since the last sync. Therefore, this connector uses the createdAt field to query for new data in your Paystack account.
If your data is updated after creation, you can use the Loockback Window option when configuring the connector to always reload data from the past N days. This will allow you to pick up updates to the data.
Data type map
The Paystack API is compatible with the JSONSchema types that Airbyte uses internally (string, date-time, object, array, boolean, integer, and number), so no type conversions happen as part of this source.
Features
| Feature | Supported? |
|---|---|
| Full Refresh Sync | Yes |
| Incremental - Append Sync | Yes |
| Incremental - Dedupe Sync | Yes |
| SSL connection | Yes |
Performance considerations
The Paystack connector should not run into Paystack API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.1.3 | 2023-03-21 | 24247 | Specified date formatting in specification |
| 0.1.2 | 2023-03-15 | 24085 | Set additionalProperties: true, add TypeTransformer to Refunds |
| 0.1.1 | 2021-12-07 | 8582 | Update connector fields title/description |
| 0.1.0 | 2021-10-20 | 7214 | Add Paystack source connector |