Name | paystack-api-wrapper JSON |
Version |
0.1.1
JSON |
| download |
home_page | None |
Summary | Modern, test-driven Python client for the Paystack API — built to save you time integrating into Python projects. |
upload_time | 2025-08-21 02:47:20 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.9 |
license | MIT |
keywords |
api
fintech
nigeria
payment
paystack
python
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Paystack API Wrapper
[](https://pypi.org/project/paystack-api-wrapper/)
[](https://pypi.org/project/paystack-api-wrapper/)
[](https://pypi.org/project/paystack-api-wrapper/)
[](https://github.com/theolujay/paystack-api-wrapper/blob/main/LICENSE)
[](https://github.com/theolujay/paystack-api-wrapper/actions)
[](https://codecov.io/gh/theolujay/paystack-api-wrapper)
A clean, intuitive, and reliable Python wrapper for the Paystack API.
This library was built to **eliminate repetitive boilerplate** when integrating Paystack into your Python projects, while emphasizing **modern design, robust error handling, and a test-driven foundation**. Covers the full API with clean abstractions, so you can focus on building features—not handling payments.
See the [Paystack API docs](https://paystack.com/docs/api/) for reference, and explore the [Usage Guide](./docs/USAGE.md) for practical examples.
---
## Installation
```bash
pip install paystack-api-wrapper
```
---
## Quick Start
1. **Initialize the client with your secret key**
(Best practice: store your secret key as an environment variable `PAYSTACK_SECRET_KEY`.)
```python
import os
from paystack import PaystackClient, APIError
secret_key = os.getenv("PAYSTACK_SECRET_KEY")
client = PaystackClient(secret_key=secret_key)
```
2. **Make an API call** (e.g., initialize a transaction):
```python
try:
data, meta = client.transactions.initialize(
email="customer@example.com",
amount=50000, # amount in kobo
currency="NGN"
)
print("Transaction initialized:", data)
# {'authorization_url': '...', 'access_code': '...', 'reference': '...'}
except APIError as e:
print(f"API error: {e.message}")
```
See the [**Full Usage Guide**](./docs/USAGE.md) for details on handling responses, pagination, and advanced error management.
---
## Available APIs
The client exposes all major Paystack API resources as properties:
* `apple_pay`
* `bulk_charges`
* `charge`
* `customers`
* `dedicated_virtual_accounts`
* `direct_debit`
* `disputes`
* `integration`
* `miscellaneous`
* `payment_pages`
* `payment_requests`
* `plans`
* `products`
* `refunds`
* `settlements`
* `subaccounts`
* `subscriptions`
* `terminal`
* `transactions`
* `transaction_splits`
* `transfers`
* `transfers_control`
* `transfer_recipients`
* `verification`
* `virtual_terminal`
---
## Contributing
Contributions are welcome! Check out the [contributing guide](./CONTRIBUTING.md) to get started.
---
## License
MIT © [Joseph Ezekiel](https://github.com/theolujay) – see [LICENSE](./LICENSE) for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "paystack-api-wrapper",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Joseph Ezekiel <theolujay@gmail.com>",
"keywords": "api, fintech, nigeria, payment, paystack, python",
"author": null,
"author_email": "Joseph Ezekiel <theolujay@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/9c/39/754aff614bbbce90a0730549ccd20a71320027527ff93f287b48b3e4c958/paystack_api_wrapper-0.1.1.tar.gz",
"platform": null,
"description": "# Paystack API Wrapper\n\n[](https://pypi.org/project/paystack-api-wrapper/)\n[](https://pypi.org/project/paystack-api-wrapper/)\n[](https://pypi.org/project/paystack-api-wrapper/)\n\n[](https://github.com/theolujay/paystack-api-wrapper/blob/main/LICENSE)\n[](https://github.com/theolujay/paystack-api-wrapper/actions) \n[](https://codecov.io/gh/theolujay/paystack-api-wrapper)\n\nA clean, intuitive, and reliable Python wrapper for the Paystack API.\n\nThis library was built to **eliminate repetitive boilerplate** when integrating Paystack into your Python projects, while emphasizing **modern design, robust error handling, and a test-driven foundation**. Covers the full API with clean abstractions, so you can focus on building features\u2014not handling payments.\n\nSee the [Paystack API docs](https://paystack.com/docs/api/) for reference, and explore the [Usage Guide](./docs/USAGE.md) for practical examples.\n\n---\n\n## Installation\n\n```bash\npip install paystack-api-wrapper\n```\n\n---\n\n## Quick Start\n\n1. **Initialize the client with your secret key**\n\n (Best practice: store your secret key as an environment variable `PAYSTACK_SECRET_KEY`.)\n\n ```python\n import os\n from paystack import PaystackClient, APIError\n\n secret_key = os.getenv(\"PAYSTACK_SECRET_KEY\")\n client = PaystackClient(secret_key=secret_key)\n ```\n\n2. **Make an API call** (e.g., initialize a transaction):\n\n ```python\n try:\n data, meta = client.transactions.initialize(\n email=\"customer@example.com\",\n amount=50000, # amount in kobo\n currency=\"NGN\"\n )\n print(\"Transaction initialized:\", data)\n # {'authorization_url': '...', 'access_code': '...', 'reference': '...'}\n\n except APIError as e:\n print(f\"API error: {e.message}\")\n ```\n\nSee the [**Full Usage Guide**](./docs/USAGE.md) for details on handling responses, pagination, and advanced error management.\n\n---\n\n## Available APIs\n\nThe client exposes all major Paystack API resources as properties:\n\n* `apple_pay`\n* `bulk_charges`\n* `charge`\n* `customers`\n* `dedicated_virtual_accounts`\n* `direct_debit`\n* `disputes`\n* `integration`\n* `miscellaneous`\n* `payment_pages`\n* `payment_requests`\n* `plans`\n* `products`\n* `refunds`\n* `settlements`\n* `subaccounts`\n* `subscriptions`\n* `terminal`\n* `transactions`\n* `transaction_splits`\n* `transfers`\n* `transfers_control`\n* `transfer_recipients`\n* `verification`\n* `virtual_terminal`\n\n---\n\n## Contributing\n\nContributions are welcome! Check out the [contributing guide](./CONTRIBUTING.md) to get started.\n\n---\n\n## License\n\nMIT \u00a9 [Joseph Ezekiel](https://github.com/theolujay) \u2013 see [LICENSE](./LICENSE) for details.",
"bugtrack_url": null,
"license": "MIT",
"summary": "Modern, test-driven Python client for the Paystack API \u2014 built to save you time integrating into Python projects.",
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/theolujay/paystack-api-wrapper/issues",
"Documentation": "https://github.com/theolujay/paystack-api-wrapper/blob/main/docs/USAGE.md",
"Homepage": "https://github.com/theolujay/paystack-api-wrapper/blob/main/README.md",
"Repository": "https://github.com/theolujay/paystack-api-wrapper"
},
"split_keywords": [
"api",
" fintech",
" nigeria",
" payment",
" paystack",
" python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b5ed21a853d18be7111cbd84a9675e9bff9207c5248bc1451cf56b0ed8662ecb",
"md5": "c35e3e372262268ecfe7b12686c81779",
"sha256": "1b6d5112e797cb70e084de612b81334f8c51ceeb9d51da21472b782e4d9eca3f"
},
"downloads": -1,
"filename": "paystack_api_wrapper-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c35e3e372262268ecfe7b12686c81779",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 54904,
"upload_time": "2025-08-21T02:47:18",
"upload_time_iso_8601": "2025-08-21T02:47:18.277410Z",
"url": "https://files.pythonhosted.org/packages/b5/ed/21a853d18be7111cbd84a9675e9bff9207c5248bc1451cf56b0ed8662ecb/paystack_api_wrapper-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9c39754aff614bbbce90a0730549ccd20a71320027527ff93f287b48b3e4c958",
"md5": "e508ef8f4a4eca4a182cf6e5068f40e9",
"sha256": "d5bc1dca0dc0a894101e99e134d1548ead6fc9e64dfe7de16785097aa886ae2f"
},
"downloads": -1,
"filename": "paystack_api_wrapper-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "e508ef8f4a4eca4a182cf6e5068f40e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 117753,
"upload_time": "2025-08-21T02:47:20",
"upload_time_iso_8601": "2025-08-21T02:47:20.493695Z",
"url": "https://files.pythonhosted.org/packages/9c/39/754aff614bbbce90a0730549ccd20a71320027527ff93f287b48b3e4c958/paystack_api_wrapper-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-21 02:47:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "theolujay",
"github_project": "paystack-api-wrapper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "paystack-api-wrapper"
}