1
0
mirror of synced 2025-12-30 21:02:43 -05:00
Files
airbyte/airbyte-integrations/connectors/source-paystack/BOOTSTRAP.md
folusoogunlana 0e70491e0f 🎉 New Source: Paystack 🌟 (#7214)
* feat(67): add support for 'spec' using Python HTTP API source template and stripe as an example

* chore(67): add sample state and config

* feat(67): add check functionality for paystack source by fetching first customer

* feat(67): add support for discover and read customer stream

* feat(67): add paystack source connector to UI

* feat(67): update source definitions to use 0.1.0

* Hacktoberfest 67 paystack source (#1)

* feat(67): add support for 'spec' using Python HTTP API source template and stripe as an example

* chore(67): add sample state and config

* feat(67): add check functionality for paystack source by fetching first customer

* feat(67): add support for discover and read customer stream

* feat(67): add paystack source connector to UI

* feat(67): update source definitions to use 0.1.0

Co-authored-by: Foluso Ogunlana <foluso_ogunlana@stearsng.com>

* feat(67): update stream state cursor field to be integer and to match API record field name

* chore(67): add unit tests for source and streams

* chore(67): store formatted date time in state to match type of catalog

* chore(67): add configuration for acceptance integration tests

* docs(67): update docs and summary with paystack

* chore(67): add essential schemas to be catalogued for new streams

* feat(67): add support for critical streams - transactions subscriptions transfers refunds settlements

* docs(67): update image and bootstrap

* chore(67): update builds.md to include paystack badge

* docs(67): add changelog and source definition JSON file

* docs(67): add paystack to integrations readme

* chore(67): update check_connection to airbyte standard

* refactor to simplify streams and remove constants file

* fix(67): correct "null, null" values in schemas

* chore(67): update file formatting with gradle format

Co-authored-by: Foluso <5675998+foogunlana@users.noreply.github.com>
2021-11-01 23:37:00 +05:30

1.4 KiB

Paystack

paystack.com is a Payment Gateway and its REST API is similar to Stripe's. This Paystack API connector is implemented with Airbyte CDK.

The Paystack API has resources including (not exhaustive)

  • Customers
  • Transactions - Payments and payment attempts
  • Subscriptions - Recurring payments
  • Invoices - Requests for payment
  • Settlements - Transfers from the Paystack Gateway account to the merchant (account instance owner) bank account
  • Refunds - Reversed payments

The Paystack API can be used to charge customers, and to perform CRUD operations on any of the above resources. For Airbyte only the "R" - read operations are needed, however Paystack currently supports a single secret key which can do all CRUD operations.

Notes & Quirks

  • Pagination uses the query parameters "page" (starting at 1) and "perPage".
  • The standard cursor field is "createdAt" on all responses, except the "Invoices" stream which uses "created_at". It's likely the interface for this resource is either outdated or failed to be backward compatible (some other resources have both fields and some have only "createdAt").

## Useful links below