<img src="https://img.shields.io/github/license/TralahM/pyflexpay"> <img src="https://img.shields.io/github/last-commit/TralahM/pyflexpay"> <img src="https://img.shields.io/github/contributors/TralahM/pyflexpay"> <img src="https://img.shields.io/github/issues-pr-raw/TralahM/pyflexpay?color=blue"> <img src="https://img.shields.io/github/issues-pr-closed-raw/TralahM/pyflexpay?color=red"> <img src="https://img.shields.io/github/issues-raw/TralahM/pyflexpay?color=green">
<img src="https://img.shields.io/github/issues-closed-raw/TralahM/pyflexpay?color=yellow"> <img src="https://img.shields.io/github/forks/TralahM/pyflexpay?label=Forks&style=social"> <img src="https://img.shields.io/github/forks/TralahM/pyflexpay?label=Forks&style=social"> <img src="https://img.shields.io/github/stars/TralahM/pyflexpay?style=social">
<img src="https://img.shields.io/github/watchers/TralahM/pyflexpay?label=Watch&style=social"> <img src="https://img.shields.io/github/downloads/TralahM/pyflexpay/total"> <img src="https://img.shields.io/github/repo-size/TralahM/pyflexpay"> <img src="https://img.shields.io/github/languages/count/TralahM/pyflexpay"> <img src="https://img.shields.io/github/v/tag/TralahM/pyflexpay"> <img src="https://img.shields.io/readthedocs/pyflexpay"> <img src="https://img.shields.io/pypi/v/pyflexpay"> <img src="https://img.shields.io/pypi/pyversions/pyflexpay"> <img src="https://img.shields.io/pypi/wheel/pyflexpay"> <img src="https://img.shields.io/pypi/status/pyflexpay?label=pypi%20status"> <img src="https://img.shields.io/pypi/format/pyflexpay?label=pypi%20format">
# pyflexpay
> A Python SDK for the FlexPay API used by Corporate Merchants to
> connect to FlexPay to perform mobile money transactions.
The FlexPay API provides access to two interfaces, the interface for sending
the request (Payment Service) and that for verifying the
transaction (Check transaction).
### Table of Contents
- [Payment Service](#Payment-Service)
- [Check Transaction](#Check-transaction)
- [Merchant Payout Service](#Merchant-Payout-Service)
- [QuickStart](#QuickStart)
- [Documentation/Usage](#Documentation)
- [Contributing](#Contributing)
- [Credits](#Credits)
---
## Payment Service
This service is used to send a payment request to FlexPay
- URL: https://ip:port/api/rest/v1/paymentService
- Method: POST
- Format: JSON
### Request
![](payment_service_request_params.png)
### Response
![](payment_service_response_params.png)
### Result
![](payment_service_result.png)
### Example
![](payment_service_example.png)
## Check transaction
This service is used to check the status of a payment request previously sent to FlexPay.
- URL: http://ip:port/api/rest/v1/check/orderNumber
- Method: GET
### Request
![](check_transaction_request_params.png)
### Response
![](check_transaction_response_params.png)
### Example
![](check_transaction_example.png)
## Merchant Payout Service
This service allows a merchant to send money to a user’s phone number, from the merchant mobile
money account.
- URL: https://ip:port/api/rest/v1/merchantPayOutService
- Method: POST
- Format: JSON
### Request
![](payment_service_request_params.png)
### Response
![](payment_service_response_params.png)
### Result
![](payment_service_result.png)
---
## QuickStart
#### Installation
```
pip install pyflexpay
```
#### From Source
```
git clone https://github.com/TralahM/pyflexpay
cd pyflexpay
python setup.py bdist_wheel
pip install -e .
```
---
## Documentation
[![Documentation](https://img.shields.io/badge/Docs-pyflexpay-blue.svg?style=for-the-badge)](https://pyflexpay.readthedocs.io)
#### API Reference
---
## Contributing
---
## Credits
[![TralahTek](https://img.shields.io/badge/Organization-TralahTek-black.svg?style=for-the-badge&logo=github)](https://github.com/TralahTek)
[![TralahM](https://img.shields.io/badge/Engineer-TralahM-blue.svg?style=for-the-badge&logo=github)](https://github.com/TralahM)
[![TralahM](https://img.shields.io/badge/Maintainer-TralahM-green.svg?style=for-the-badge&logo=github)](https://github.com/TralahM)
[![](https://img.shields.io/badge/Github-TralahM-green?style=for-the-badge&logo=github)](https://github.com/TralahM)
[![](https://img.shields.io/badge/Twitter-%40tralahtek-blue?style=for-the-badge&logo=twitter)](https://twitter.com/TralahM)
[![TralahM](https://img.shields.io/badge/Kaggle-TralahM-purple.svg?style=for-the-badge&logo=kaggle)](https://kaggle.com/TralahM)
[![TralahM](https://img.shields.io/badge/LinkedIn-TralahM-white.svg?style=for-the-badge&logo=linkedin)](https://linkedin.com/in/TralahM)
[![Blog](https://img.shields.io/badge/Blog-tralahm.tralahtek.com-blue.svg?style=for-the-badge&logo=rss)](https://tralahm.github.io)
[![TralahTek](https://img.shields.io/badge/Organization-TralahTek-cyan.svg?style=for-the-badge)](https://github.com/tralahtek)
---
Raw data
{
"_id": null,
"home_page": "https://github.com/TralahM/pyflexpay",
"name": "pyflexpay",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Tralah M Brian",
"author_email": "briantralah@gmail.com",
"download_url": "",
"platform": null,
"description": "<img src=\"https://img.shields.io/github/license/TralahM/pyflexpay\"> <img src=\"https://img.shields.io/github/last-commit/TralahM/pyflexpay\"> <img src=\"https://img.shields.io/github/contributors/TralahM/pyflexpay\"> <img src=\"https://img.shields.io/github/issues-pr-raw/TralahM/pyflexpay?color=blue\"> <img src=\"https://img.shields.io/github/issues-pr-closed-raw/TralahM/pyflexpay?color=red\"> <img src=\"https://img.shields.io/github/issues-raw/TralahM/pyflexpay?color=green\">\n<img src=\"https://img.shields.io/github/issues-closed-raw/TralahM/pyflexpay?color=yellow\"> <img src=\"https://img.shields.io/github/forks/TralahM/pyflexpay?label=Forks&style=social\"> <img src=\"https://img.shields.io/github/forks/TralahM/pyflexpay?label=Forks&style=social\"> <img src=\"https://img.shields.io/github/stars/TralahM/pyflexpay?style=social\">\n<img src=\"https://img.shields.io/github/watchers/TralahM/pyflexpay?label=Watch&style=social\"> <img src=\"https://img.shields.io/github/downloads/TralahM/pyflexpay/total\"> <img src=\"https://img.shields.io/github/repo-size/TralahM/pyflexpay\"> <img src=\"https://img.shields.io/github/languages/count/TralahM/pyflexpay\"> <img src=\"https://img.shields.io/github/v/tag/TralahM/pyflexpay\"> <img src=\"https://img.shields.io/readthedocs/pyflexpay\"> <img src=\"https://img.shields.io/pypi/v/pyflexpay\"> <img src=\"https://img.shields.io/pypi/pyversions/pyflexpay\"> <img src=\"https://img.shields.io/pypi/wheel/pyflexpay\"> <img src=\"https://img.shields.io/pypi/status/pyflexpay?label=pypi%20status\"> <img src=\"https://img.shields.io/pypi/format/pyflexpay?label=pypi%20format\">\n\n# pyflexpay\n> A Python SDK for the FlexPay API used by Corporate Merchants to\n> connect to FlexPay to perform mobile money transactions.\n\nThe FlexPay API provides access to two interfaces, the interface for sending\nthe request (Payment Service) and that for verifying the\ntransaction (Check transaction).\n\n### Table of Contents\n- [Payment Service](#Payment-Service)\n- [Check Transaction](#Check-transaction)\n- [Merchant Payout Service](#Merchant-Payout-Service)\n- [QuickStart](#QuickStart)\n- [Documentation/Usage](#Documentation)\n- [Contributing](#Contributing)\n- [Credits](#Credits)\n\n---\n\n## Payment Service\nThis service is used to send a payment request to FlexPay\n- URL: https://ip:port/api/rest/v1/paymentService\n- Method: POST\n- Format: JSON\n\n### Request\n![](payment_service_request_params.png)\n\n\n### Response\n![](payment_service_response_params.png)\n\n\n### Result\n![](payment_service_result.png)\n\n### Example\n![](payment_service_example.png)\n\n## Check transaction\nThis service is used to check the status of a payment request previously sent to FlexPay.\n- URL: http://ip:port/api/rest/v1/check/orderNumber\n- Method: GET\n\n### Request\n![](check_transaction_request_params.png)\n\n\n### Response\n![](check_transaction_response_params.png)\n\n\n### Example\n![](check_transaction_example.png)\n\n## Merchant Payout Service\nThis service allows a merchant to send money to a user\u2019s phone number, from the merchant mobile\nmoney account. \n- URL: https://ip:port/api/rest/v1/merchantPayOutService\n- Method: POST\n- Format: JSON\n\n### Request\n![](payment_service_request_params.png)\n\n\n### Response\n![](payment_service_response_params.png)\n\n\n### Result\n![](payment_service_result.png)\n\n---\n\n## QuickStart\n#### Installation\n\n```\npip install pyflexpay\n```\n#### From Source\n```\ngit clone https://github.com/TralahM/pyflexpay\ncd pyflexpay\n\npython setup.py bdist_wheel\npip install -e .\n\n```\n---\n\n## Documentation\n\n[![Documentation](https://img.shields.io/badge/Docs-pyflexpay-blue.svg?style=for-the-badge)](https://pyflexpay.readthedocs.io)\n\n\n#### API Reference\n\n---\n## Contributing\n\n---\n\n## Credits\n[![TralahTek](https://img.shields.io/badge/Organization-TralahTek-black.svg?style=for-the-badge&logo=github)](https://github.com/TralahTek)\n[![TralahM](https://img.shields.io/badge/Engineer-TralahM-blue.svg?style=for-the-badge&logo=github)](https://github.com/TralahM)\n[![TralahM](https://img.shields.io/badge/Maintainer-TralahM-green.svg?style=for-the-badge&logo=github)](https://github.com/TralahM)\n\n\n\n[![](https://img.shields.io/badge/Github-TralahM-green?style=for-the-badge&logo=github)](https://github.com/TralahM)\n[![](https://img.shields.io/badge/Twitter-%40tralahtek-blue?style=for-the-badge&logo=twitter)](https://twitter.com/TralahM)\n[![TralahM](https://img.shields.io/badge/Kaggle-TralahM-purple.svg?style=for-the-badge&logo=kaggle)](https://kaggle.com/TralahM)\n[![TralahM](https://img.shields.io/badge/LinkedIn-TralahM-white.svg?style=for-the-badge&logo=linkedin)](https://linkedin.com/in/TralahM)\n\n\n[![Blog](https://img.shields.io/badge/Blog-tralahm.tralahtek.com-blue.svg?style=for-the-badge&logo=rss)](https://tralahm.github.io)\n\n[![TralahTek](https://img.shields.io/badge/Organization-TralahTek-cyan.svg?style=for-the-badge)](https://github.com/tralahtek)\n---\n",
"bugtrack_url": null,
"license": "GPLV3",
"summary": "A Python SDK for the FlexPay API for Payments Aggregation",
"version": "0.8",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "d26ae25173317ce67ac526b866ecb549",
"sha256": "408dca96c905782b6d2f56a19d206039026d60b68c49d10b9eb04f4cc0a71488"
},
"downloads": -1,
"filename": "pyflexpay-0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d26ae25173317ce67ac526b866ecb549",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4841,
"upload_time": "2022-12-01T11:51:19",
"upload_time_iso_8601": "2022-12-01T11:51:19.958094Z",
"url": "https://files.pythonhosted.org/packages/b9/2b/bb53572a0cb7e6cecb97498c24d482826c3b0fbc7f7ef25ceeeab0c9ce95/pyflexpay-0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-01 11:51:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "TralahM",
"github_project": "pyflexpay",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyflexpay"
}