# Python SDK for the TelePay API
Official TelePay client library for the Python language, so you can easely process cryptocurrency payments using the REST API.
[](https://opensource.org/licenses/MIT)
[](https://github.com/telepay-cash/telepay-python/actions?query=workflow%3ACI)
[](https://pypi.org/project/telepay)
[](https://github.com/telepay-cash/telepay-python/commits)
[](https://github.com/telepay-cash/telepay-python/commits)
[](https://github.com/telepay-cash/telepay-python/stargazers)
[](https://github.com/telepay-cash/telepay-python/network/members)
[](https://github.com/telepay-cash/telepay-python)
[](https://github.com/telepay-cash/telepay-python/graphs/contributors)
[](https://pepy.tech/project/telepay)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
[](https://t.me/TelePayCash)
[](https://blog.telepay.cash)
## Installation
Install the package with pip:
```bash
pip install telepay
```
Or using [Poetry](https://python-poetry.org/):
```bash
poetry add telepay
```
## Using the library
Refer to the [TelePay Docs](https://telepay.readme.io) and follow the [first steps guide](https://telepay.readme.io/reference/first-steps), you'll get your TelePay account and API key.
To make requests to the TelePay API, you need to import a client. We have two clients:
* `TelePaySyncClient`: make requests synchronously.
* `TelePayAsyncClient` make requests asynchronously.
**Import and use the client**
```python
from telepay.v1 import TelePaySyncClient, TelePayAsyncClient
client = TelePaySyncClient(secret_api_key)
client = TelePayAsyncClient(secret_api_key)
```
**Use the client as a context manager**
We recommend using the client as a context manager, like this:
```python
with TelePaySyncClient(secret_api_key) as client:
# use the client
...
```
or
```python
async with TelePayAsyncClient(secret_api_key) as client:
# use the client
...
```
## API endpoints
The API endpoints are documented in the [TelePay documentation](https://telepay.readme.io/reference/endpoints), refer to that pages to know more about them.
To manage the requests, if the client is async, you should use the `await` keyword, like this:
```python
response = await client.method(...)
```
Where `method` is the endpoint method.
**get_me**
Info about the current merchant. [Read docs](https://telepay.readme.io/reference/getme)
```python
account = client.get_me()
```
**get_balance**
Get your merchant wallet assets with corresponding balance. [Read docs](https://telepay.readme.io/reference/getbalance)
```python
wallets = client.get_balance()
```
Or get a specific wallet balance by specifying the `asset`, `blockchain` and `network`.
```python
wallet = client.get_balance(asset='TON', blockchain='TON', network='network')
```
### Assets
**get_asset**
Get asset details. [Read docs](https://telepay.readme.io/reference/getasset)
```python
asset = client.get_asset(asset='TON', blockchain='TON')
```
**get_assets**
Get assets suported by TelePay. [Read docs](https://telepay.readme.io/reference/getassets)
```python
assets = client.get_assets()
```
### Invoices
**get_invoice**
Get invoice details, by its number. [Read docs](https://telepay.readme.io/reference/getinvoice)
```python
invoice = client.get_invoice(number)
```
**get_invoices**
Get your merchant invoices. [Read docs](https://telepay.readme.io/reference/getinvoices)
```python
invoices = client.get_invoices()
```
**create_invoice**
Creates an invoice, associated to your merchant. [Read docs](https://telepay.readme.io/reference/createinvoice)
```python
invoice = client.create_invoice(
asset='TON',
blockchain='TON',
network='mainnet',
amount=1,
description='Product',
metadata={
'color': 'red',
'size': 'large',
},
success_url='https://example.com/success',
cancel_url='https://example.com/cancel',
expires_at=30
)
```
**cancel_invoice**
Cancel invoice, by its number. [Read docs](https://telepay.readme.io/reference/cancelinvoice)
```python
invoice = client.cancel_invoice(number)
```
**delete_invoice**
Delete invoice, by its number. [Read docs](https://telepay.readme.io/reference/deleteinvoice)
```python
status = client.delete_invoice(number)
```
### Transfers
**transfer**
Transfer funds between internal wallets. Off-chain operation. [Read docs](https://telepay.readme.io/reference/transfer)
```python
status = client.transfer(
asset='TON',
blockchain='TON',
network='mainnet',
amount=1,
username='test',
message='Thanks'
)
```
### Withdrawals
**get_withdraw_minimum**
Obtains minimum amount required to withdraw funds on a given asset. [Read docs](https://telepay.readme.io/reference/getwithdrawminimum)
```python
minimum = client.get_withdraw_minimum(
asset='TON',
blockchain='TON',
network='mainnet',
)
```
**get_withdraw_fee**
Get estimated withdraw fee, composed of blockchain fee and processing fee. [Read docs](https://telepay.readme.io/reference/getwithdrawfee)
```python
fees = client.get_withdraw_fee(
to_address='EQCKYK7bYBt1t8UmdhImrbiSzC5ijfo_H3Zc_Hk8ksRpOkOk',
asset='TON',
blockchain='TON',
network='mainnet',
amount=1,
message='test'
)
```
**withdraw**
Withdraw funds from merchant wallet to external wallet. On-chain operation. [Read docs](https://telepay.readme.io/reference/withdraw)
```python
status = client.withdraw(
to_address='EQCKYK7bYBt1t8UmdhImrbiSzC5ijfo_H3Zc_Hk8ksRpOkOk',
asset='TON',
blockchain='TON',
network='mainnet',
amount=1,
message='test'
)
```
### Webhooks
> Webhooks allows you to get updates delivered to your app server whenever we have events on our side. We will send a POST request over HTTPS, with serialized JSON data of the event, to the endpoint defined by you in the Developers > Webhooks section, in your merchant dashboard. [Read more in the docs](https://telepay.readme.io/reference/webhooks).
**get_webhook**
Get webhook details, by its id. [Read docs](https://telepay.readme.io/reference/getwebhook)
```python
client.get_webhook(id)
```
**get_webhooks**
Get your merchant webhooks. [Read docs](https://telepay.readme.io/reference/getwebhooks)
```python
webhooks = client.get_webhooks()
```
**create_webhook**
Create a webhook. [Read docs](https://telepay.readme.io/reference/createwebhook)
```python
webhook = client.create_webhook(
url='https://example.com',
secret='hello',
events=['all'],
active=True
)
```
**update_webhook**
Update a webhook. [Read docs](https://telepay.readme.io/reference/updatewebhook)
```python
webhook = client.update_webhook(
url='https://example.com',
secret='hello',
events=['invoice.completed'],
active=True
)
```
**activate_webhook**
Activate a webhook, by its id. [Read docs](https://telepay.readme.io/reference/activatewebhook)
```python
client.activate_webhook(id)
```
**deactivate_webhook**
Deactivate a webhook, by its id. [Read docs](https://telepay.readme.io/reference/deactivatewebhook)
```python
client.deactivate_webhook(id)
```
**delete_webhook**
Delete a webhook, by its id. [Read docs](https://telepay.readme.io/reference/deletewebhook)
```python
client.deactivate_webhook(id)
```
### Webhook utils
The `telepay.v1.webhooks` module contains utilities to manage webhooks received on your side.
* `get_signature(data, secret)`: Returns a webhook signature, used to verify data integrity of the webhook. This is optional, but highly recommended.
* `TelePayWebhookListener`: A lightweight webhook listener, to receive webhooks from TelePay. You could build your own, like using django views, flask views, or any other web framework. Your choice.
**Example using `TelePayWebhookListener`**
```python
from telepay.v1.webhooks import TelePayWebhookListener
def callback(headers, data):
print("Executing callback...")
# do your stuff here
listener = TelePayWebhookListener(
secret="SECRET",
callback=callback,
host="localhost",
port=5000,
url="/webhook",
log_level="error",
)
listener.listen()
```
Running the listener will output something like this:
Modify the listener parameters to your needs, knowing this:
* `secret`: A secret token that your side knows and it's configured in the webhook definition, on the TelePay dashboard.
* `callback`: The callback function that is called when new webhook arrives, receiving it's HTTP headers and data.
* `host`: The host on which the listener will be running.
* `port`: The port on which the listener will be exposed.
* `url`: The webhook url, which is secret and should only be known by your app and TelePay. Otherwise, it could lead to security issues.
* `log_level`: The listener logger level, like `"error"`, `"info"` or `"debug"`.
## Contributors ✨
The library is made by ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center">
<a href="https://carloslugones.com">
<img src="https://avatars.githubusercontent.com/u/18733370?v=4?s=100" width="100px;" alt=""/><br />
<sub><b>Carlos Lugones</b></sub>
</a>
<br />
<a href="https://github.com/telepay-cash/telepay-python/commits?author=CarlosLugones" title="Code">💻</a>
</td>
<td align="center">
<a href="https://github.com/ilyvsc">
<img src="https://avatars.githubusercontent.com/u/68219934?v=4" width="100px;" alt=""/><br />
<sub><b>Luis Diaz</b></sub>
</a>
<br />
<a href="https://github.com/telepay-cash/telepay-python/commits?author=ilyvsc" title="Code">💻</a>
</td>
<td align="center">
<a href="https://ragnarok22.dev">
<img src="https://avatars.githubusercontent.com/u/8838803?v=4" width="100px;" alt=""/><br />
<sub><b>Reinier Hernández</b></sub>
</a>
<br />
<a href="https://github.com/telepay-cash/telepay-python/commits?author=ragnarok22" title="Code">💻</a>
</td>
</tr>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
Raw data
{
"_id": null,
"home_page": "https://github.com/TelePay-cash/telepay-python",
"name": "telepay",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "payments,gateway,cryptocurrencies,API",
"author": "Carlos Lugones",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/3f/8c/03c6c7bea005a6102e736d74a9f466d89c5d5c1d86a9580685a43fc98e80/telepay-1.1.0.tar.gz",
"platform": null,
"description": "# Python SDK for the TelePay API\n\n\n\nOfficial TelePay client library for the Python language, so you can easely process cryptocurrency payments using the REST API.\n\n[](https://opensource.org/licenses/MIT)\n[](https://github.com/telepay-cash/telepay-python/actions?query=workflow%3ACI)\n[](https://pypi.org/project/telepay)\n[](https://github.com/telepay-cash/telepay-python/commits)\n[](https://github.com/telepay-cash/telepay-python/commits)\n[](https://github.com/telepay-cash/telepay-python/stargazers)\n[](https://github.com/telepay-cash/telepay-python/network/members)\n[](https://github.com/telepay-cash/telepay-python)\n[](https://github.com/telepay-cash/telepay-python/graphs/contributors)\n[](https://pepy.tech/project/telepay)\n[](https://github.com/psf/black)\n[](https://pycqa.github.io/isort/)\n[](https://t.me/TelePayCash)\n[](https://blog.telepay.cash)\n\n## Installation\n\nInstall the package with pip:\n\n```bash\npip install telepay\n```\n\nOr using [Poetry](https://python-poetry.org/):\n\n```bash\npoetry add telepay\n```\n\n## Using the library\n\nRefer to the [TelePay Docs](https://telepay.readme.io) and follow the [first steps guide](https://telepay.readme.io/reference/first-steps), you'll get your TelePay account and API key.\n\nTo make requests to the TelePay API, you need to import a client. We have two clients:\n* `TelePaySyncClient`: make requests synchronously.\n* `TelePayAsyncClient` make requests asynchronously.\n\n**Import and use the client**\n\n```python\nfrom telepay.v1 import TelePaySyncClient, TelePayAsyncClient\n\nclient = TelePaySyncClient(secret_api_key)\nclient = TelePayAsyncClient(secret_api_key)\n```\n\n**Use the client as a context manager**\n\nWe recommend using the client as a context manager, like this:\n\n```python\nwith TelePaySyncClient(secret_api_key) as client:\n # use the client\n ...\n```\n\nor\n\n```python\nasync with TelePayAsyncClient(secret_api_key) as client:\n # use the client\n ...\n```\n\n## API endpoints\n\nThe API endpoints are documented in the [TelePay documentation](https://telepay.readme.io/reference/endpoints), refer to that pages to know more about them.\n\nTo manage the requests, if the client is async, you should use the `await` keyword, like this:\n\n```python\nresponse = await client.method(...)\n```\n\nWhere `method` is the endpoint method.\n\n**get_me**\n\nInfo about the current merchant. [Read docs](https://telepay.readme.io/reference/getme)\n\n```python\naccount = client.get_me()\n```\n\n**get_balance**\n\nGet your merchant wallet assets with corresponding balance. [Read docs](https://telepay.readme.io/reference/getbalance)\n\n```python\nwallets = client.get_balance()\n```\n\nOr get a specific wallet balance by specifying the `asset`, `blockchain` and `network`.\n\n```python\nwallet = client.get_balance(asset='TON', blockchain='TON', network='network')\n```\n\n### Assets\n\n**get_asset**\n\nGet asset details. [Read docs](https://telepay.readme.io/reference/getasset)\n\n```python\nasset = client.get_asset(asset='TON', blockchain='TON')\n```\n\n**get_assets**\n\nGet assets suported by TelePay. [Read docs](https://telepay.readme.io/reference/getassets)\n\n```python\nassets = client.get_assets()\n```\n\n### Invoices\n\n**get_invoice**\n\nGet invoice details, by its number. [Read docs](https://telepay.readme.io/reference/getinvoice)\n\n```python\ninvoice = client.get_invoice(number)\n```\n\n**get_invoices**\n\nGet your merchant invoices. [Read docs](https://telepay.readme.io/reference/getinvoices)\n\n```python\ninvoices = client.get_invoices()\n```\n\n**create_invoice**\n\nCreates an invoice, associated to your merchant. [Read docs](https://telepay.readme.io/reference/createinvoice)\n\n```python\ninvoice = client.create_invoice(\n asset='TON',\n blockchain='TON',\n network='mainnet',\n amount=1,\n description='Product',\n metadata={\n 'color': 'red',\n 'size': 'large',\n },\n success_url='https://example.com/success',\n cancel_url='https://example.com/cancel',\n expires_at=30\n)\n```\n\n**cancel_invoice**\n\nCancel invoice, by its number. [Read docs](https://telepay.readme.io/reference/cancelinvoice)\n\n```python\ninvoice = client.cancel_invoice(number)\n```\n\n**delete_invoice**\n\nDelete invoice, by its number. [Read docs](https://telepay.readme.io/reference/deleteinvoice)\n\n```python\nstatus = client.delete_invoice(number)\n```\n\n### Transfers\n\n**transfer**\n\nTransfer funds between internal wallets. Off-chain operation. [Read docs](https://telepay.readme.io/reference/transfer)\n\n```python\nstatus = client.transfer(\n asset='TON',\n blockchain='TON',\n network='mainnet',\n amount=1,\n username='test',\n message='Thanks'\n)\n```\n\n### Withdrawals\n\n**get_withdraw_minimum**\n\nObtains minimum amount required to withdraw funds on a given asset. [Read docs](https://telepay.readme.io/reference/getwithdrawminimum)\n\n```python\nminimum = client.get_withdraw_minimum(\n asset='TON',\n blockchain='TON',\n network='mainnet',\n)\n```\n\n**get_withdraw_fee**\n\nGet estimated withdraw fee, composed of blockchain fee and processing fee. [Read docs](https://telepay.readme.io/reference/getwithdrawfee)\n\n```python\nfees = client.get_withdraw_fee(\n to_address='EQCKYK7bYBt1t8UmdhImrbiSzC5ijfo_H3Zc_Hk8ksRpOkOk',\n asset='TON',\n blockchain='TON',\n network='mainnet',\n amount=1,\n message='test'\n)\n```\n\n**withdraw**\n\nWithdraw funds from merchant wallet to external wallet. On-chain operation. [Read docs](https://telepay.readme.io/reference/withdraw)\n\n```python\nstatus = client.withdraw(\n to_address='EQCKYK7bYBt1t8UmdhImrbiSzC5ijfo_H3Zc_Hk8ksRpOkOk',\n asset='TON',\n blockchain='TON',\n network='mainnet',\n amount=1,\n message='test'\n)\n```\n\n### Webhooks\n\n> Webhooks allows you to get updates delivered to your app server whenever we have events on our side. We will send a POST request over HTTPS, with serialized JSON data of the event, to the endpoint defined by you in the Developers > Webhooks section, in your merchant dashboard. [Read more in the docs](https://telepay.readme.io/reference/webhooks).\n\n**get_webhook**\n\nGet webhook details, by its id. [Read docs](https://telepay.readme.io/reference/getwebhook)\n\n```python\nclient.get_webhook(id)\n```\n\n**get_webhooks**\n\nGet your merchant webhooks. [Read docs](https://telepay.readme.io/reference/getwebhooks)\n\n```python\nwebhooks = client.get_webhooks()\n```\n\n**create_webhook**\n\nCreate a webhook. [Read docs](https://telepay.readme.io/reference/createwebhook)\n\n```python\nwebhook = client.create_webhook(\n url='https://example.com',\n secret='hello',\n events=['all'],\n active=True\n)\n```\n\n**update_webhook**\n\nUpdate a webhook. [Read docs](https://telepay.readme.io/reference/updatewebhook)\n\n```python\nwebhook = client.update_webhook(\n url='https://example.com',\n secret='hello',\n events=['invoice.completed'],\n active=True\n)\n```\n\n**activate_webhook**\n\nActivate a webhook, by its id. [Read docs](https://telepay.readme.io/reference/activatewebhook)\n\n```python\nclient.activate_webhook(id)\n```\n\n**deactivate_webhook**\n\nDeactivate a webhook, by its id. [Read docs](https://telepay.readme.io/reference/deactivatewebhook)\n\n```python\nclient.deactivate_webhook(id)\n```\n\n**delete_webhook**\n\nDelete a webhook, by its id. [Read docs](https://telepay.readme.io/reference/deletewebhook)\n\n```python\nclient.deactivate_webhook(id)\n```\n\n### Webhook utils\n\nThe `telepay.v1.webhooks` module contains utilities to manage webhooks received on your side.\n\n* `get_signature(data, secret)`: Returns a webhook signature, used to verify data integrity of the webhook. This is optional, but highly recommended.\n* `TelePayWebhookListener`: A lightweight webhook listener, to receive webhooks from TelePay. You could build your own, like using django views, flask views, or any other web framework. Your choice.\n\n**Example using `TelePayWebhookListener`**\n\n```python\nfrom telepay.v1.webhooks import TelePayWebhookListener\n\ndef callback(headers, data):\n print(\"Executing callback...\")\n # do your stuff here\n\nlistener = TelePayWebhookListener(\n secret=\"SECRET\",\n callback=callback,\n host=\"localhost\",\n port=5000,\n url=\"/webhook\",\n log_level=\"error\",\n)\n\nlistener.listen()\n```\n\nRunning the listener will output something like this:\n\n\n\nModify the listener parameters to your needs, knowing this:\n* `secret`: A secret token that your side knows and it's configured in the webhook definition, on the TelePay dashboard.\n* `callback`: The callback function that is called when new webhook arrives, receiving it's HTTP headers and data.\n* `host`: The host on which the listener will be running.\n* `port`: The port on which the listener will be exposed.\n* `url`: The webhook url, which is secret and should only be known by your app and TelePay. Otherwise, it could lead to security issues.\n* `log_level`: The listener logger level, like `\"error\"`, `\"info\"` or `\"debug\"`.\n\n## Contributors \u2728\n\nThe library is made by ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n <tr>\n <td align=\"center\">\n <a href=\"https://carloslugones.com\">\n <img src=\"https://avatars.githubusercontent.com/u/18733370?v=4?s=100\" width=\"100px;\" alt=\"\"/><br />\n <sub><b>Carlos Lugones</b></sub>\n </a>\n <br />\n <a href=\"https://github.com/telepay-cash/telepay-python/commits?author=CarlosLugones\" title=\"Code\">\ud83d\udcbb</a>\n </td>\n <td align=\"center\">\n <a href=\"https://github.com/ilyvsc\">\n <img src=\"https://avatars.githubusercontent.com/u/68219934?v=4\" width=\"100px;\" alt=\"\"/><br />\n <sub><b>Luis Diaz</b></sub>\n </a>\n <br />\n <a href=\"https://github.com/telepay-cash/telepay-python/commits?author=ilyvsc\" title=\"Code\">\ud83d\udcbb</a>\n </td>\n <td align=\"center\">\n <a href=\"https://ragnarok22.dev\">\n <img src=\"https://avatars.githubusercontent.com/u/8838803?v=4\" width=\"100px;\" alt=\"\"/><br />\n <sub><b>Reinier Hern\u00e1ndez</b></sub>\n </a>\n <br />\n <a href=\"https://github.com/telepay-cash/telepay-python/commits?author=ragnarok22\" title=\"Code\">\ud83d\udcbb</a>\n </td>\n </tr>\n</table>\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python SDK for the TelePay API",
"version": "1.1.0",
"split_keywords": [
"payments",
"gateway",
"cryptocurrencies",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "283cfbdbba7963c63cc6df4d685f2958876807b53719f8a8bc2c33cbc66b07f3",
"md5": "7648a37b188343a6d088e378bc6100b2",
"sha256": "584e39693630f1e27e18e751b77cb3d5d4fe6d39ec6032fcf100591c13926467"
},
"downloads": -1,
"filename": "telepay-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7648a37b188343a6d088e378bc6100b2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 16527,
"upload_time": "2023-01-24T02:31:23",
"upload_time_iso_8601": "2023-01-24T02:31:23.685790Z",
"url": "https://files.pythonhosted.org/packages/28/3c/fbdbba7963c63cc6df4d685f2958876807b53719f8a8bc2c33cbc66b07f3/telepay-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f8c03c6c7bea005a6102e736d74a9f466d89c5d5c1d86a9580685a43fc98e80",
"md5": "f447ec122bc58fd84afc4a8422e5e67a",
"sha256": "c6fcb72b57732dfd1d00f4ad2b91d642bdc7c082ee983a3c70b2406808abfd52"
},
"downloads": -1,
"filename": "telepay-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f447ec122bc58fd84afc4a8422e5e67a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 14850,
"upload_time": "2023-01-24T02:31:25",
"upload_time_iso_8601": "2023-01-24T02:31:25.522272Z",
"url": "https://files.pythonhosted.org/packages/3f/8c/03c6c7bea005a6102e736d74a9f466d89c5d5c1d86a9580685a43fc98e80/telepay-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-24 02:31:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "TelePay-cash",
"github_project": "telepay-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "telepay"
}
JSON
