[<img src="https://blockbee.io/static/assets/images/blockbee_logo_nospaces.png" width="300"/>](image.png)
# BlockBee's Python Library
Python implementation of BlockBee's payment gateway
## Deprecated! It has been integrated into [python-blockbee](https://github.com/blockbee-io/python-blockbee).
## Requirements:
```
Python >= 3.0
Requests >= 2.20
```
## Install
```shell script
pip install python-blockbee-checkout
```
[on pypi](https://pypi.python.org/pypi/python-blockbee-checkout)
or
[on GitHub](https://github.com/blockbee-io/python-blockbee-checkout)
## Usage
### Importing in your project file
```python
from BlockBee import BlockBeeCheckoutHelper
```
### Generate a Payment Checkout page
```python
from BlockBee import BlockBeeCheckoutHelper
bb = BlockBeeCheckoutHelper(api_key, params, bb_params)
payment_page = bb.payment_request(redirect_url, value)
```
Where:
* ``api_key`` is the API Key provided by our [Dashboard](https://dash.blockbee.io/).
* ``params`` is any parameter you wish to send to identify the payment, such as `{'order_id': 1234}`.
* ``bb_params`` parameters that will be passed to BlockBee _(check which extra parameters are available here: https://docs.blockbee.io/#operation/create).
* ``redirect_url`` URL in your platform, where the user will be redirected to following the payment. Should be able to process the payment using the `success_token`.
* ``value`` amount in currency set in Payment Settings you want to receive from the user.
### Getting notified when the user completes the Payment
> When receiving payments, you have the option to receive them in either the ``notify_url`` or the ``redirect_url``, but adding the ``redirect_url`` is required (refer to our documentation at https://docs.blockbee.io/#operation/paymentipn).
### Requesting Deposit
```python
from BlockBee import BlockBeeCheckoutHelper
bb = BlockBeeCheckoutHelper(api_key, params, bb_params)
deposit_page = bb.deposit_request(notify_url)
```
* ``api_key`` is the API Key provided by our [Dashboard](https://dash.blockbee.io/).
* ``params`` is any parameter you wish to send to identify the payment, such as `{'order_id': 1234}`.
* ``bb_params`` parameters that will be passed to BlockBee _(check which extra parameters are available here: https://docs.blockbee.io/#operation/deposit).
* ``notify_url`` URL in your platform, where the IPN will be sent notifying that a deposit was done. Parameters are available here: https://docs.blockbee.io/#operation/depositipn.
### Getting notified when the user makes a deposit
> When receiving deposits, you must provide a ``notify_url`` where our system will send an IPN every time a user makes a deposit (refer to our documentation at https://docs.blockbee.io/#operation/depositipn).
## Help
Need help?
Contact us @ https://blockbee.io/contacts/
### Changelog
#### 1.0.0
* Initial Release
#### 1.0.1
* Minor bugfixes
#### 1.0.2
* Minor bugfixes
Raw data
{
"_id": null,
"home_page": "https://github.com/blockbee-io/python-blockbee-checkout",
"name": "python-blockbee-checkout",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "BlockBee",
"author_email": "info@blockbee.io",
"download_url": "https://files.pythonhosted.org/packages/d6/ad/a950608977ee874bb569cb9ac252cd2b7c42ab198a09cd4006740681aa32/python-blockbee-checkout-1.0.3.tar.gz",
"platform": null,
"description": "[<img src=\"https://blockbee.io/static/assets/images/blockbee_logo_nospaces.png\" width=\"300\"/>](image.png)\n\n\n# BlockBee's Python Library\nPython implementation of BlockBee's payment gateway\n\n## Deprecated! It has been integrated into [python-blockbee](https://github.com/blockbee-io/python-blockbee).\n\n## Requirements:\n\n```\nPython >= 3.0\nRequests >= 2.20\n```\n\n## Install\n\n```shell script\npip install python-blockbee-checkout\n```\n\n[on pypi](https://pypi.python.org/pypi/python-blockbee-checkout)\nor\n[on GitHub](https://github.com/blockbee-io/python-blockbee-checkout)\n\n## Usage\n\n### Importing in your project file\n\n```python\nfrom BlockBee import BlockBeeCheckoutHelper\n```\n\n### Generate a Payment Checkout page\n\n```python\nfrom BlockBee import BlockBeeCheckoutHelper\n\nbb = BlockBeeCheckoutHelper(api_key, params, bb_params)\n\npayment_page = bb.payment_request(redirect_url, value)\n```\n\nWhere:\n\n* ``api_key`` is the API Key provided by our [Dashboard](https://dash.blockbee.io/).\n* ``params`` is any parameter you wish to send to identify the payment, such as `{'order_id': 1234}`.\n* ``bb_params`` parameters that will be passed to BlockBee _(check which extra parameters are available here: https://docs.blockbee.io/#operation/create).\n* ``redirect_url`` URL in your platform, where the user will be redirected to following the payment. Should be able to process the payment using the `success_token`.\n* ``value`` amount in currency set in Payment Settings you want to receive from the user.\n\n### Getting notified when the user completes the Payment\n> When receiving payments, you have the option to receive them in either the ``notify_url`` or the ``redirect_url``, but adding the ``redirect_url`` is required (refer to our documentation at https://docs.blockbee.io/#operation/paymentipn).\n\n### Requesting Deposit\n```python\nfrom BlockBee import BlockBeeCheckoutHelper\n\nbb = BlockBeeCheckoutHelper(api_key, params, bb_params)\n\ndeposit_page = bb.deposit_request(notify_url)\n```\n\n* ``api_key`` is the API Key provided by our [Dashboard](https://dash.blockbee.io/).\n* ``params`` is any parameter you wish to send to identify the payment, such as `{'order_id': 1234}`.\n* ``bb_params`` parameters that will be passed to BlockBee _(check which extra parameters are available here: https://docs.blockbee.io/#operation/deposit).\n* ``notify_url`` URL in your platform, where the IPN will be sent notifying that a deposit was done. Parameters are available here: https://docs.blockbee.io/#operation/depositipn.\n\n### Getting notified when the user makes a deposit\n> When receiving deposits, you must provide a ``notify_url`` where our system will send an IPN every time a user makes a deposit (refer to our documentation at https://docs.blockbee.io/#operation/depositipn).\n\n## Help\n\nNeed help? \nContact us @ https://blockbee.io/contacts/\n\n\n### Changelog\n\n#### 1.0.0\n* Initial Release\n\n#### 1.0.1\n* Minor bugfixes\n\n#### 1.0.2\n* Minor bugfixes\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Library for BlockBee Checkout",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/blockbee-io/python-blockbee-checkout"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d6ada950608977ee874bb569cb9ac252cd2b7c42ab198a09cd4006740681aa32",
"md5": "dbf4f9a04cc539a442a2de736808c45e",
"sha256": "3d9393aad4d105cc88d37abad59256191952a9b1b4eaf4974bc7aea45cca3f46"
},
"downloads": -1,
"filename": "python-blockbee-checkout-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "dbf4f9a04cc539a442a2de736808c45e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4006,
"upload_time": "2024-03-18T20:46:05",
"upload_time_iso_8601": "2024-03-18T20:46:05.092460Z",
"url": "https://files.pythonhosted.org/packages/d6/ad/a950608977ee874bb569cb9ac252cd2b7c42ab198a09cd4006740681aa32/python-blockbee-checkout-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-18 20:46:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "blockbee-io",
"github_project": "python-blockbee-checkout",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": [
[
">=",
"2.20"
]
]
}
],
"lcname": "python-blockbee-checkout"
}
JSON
