# Xendit Python SDK
The official Xendit Python SDK provides a simple and convenient way to call Xendit's REST API
in applications written in Python.
* Package version: 5.0.0
## Requirements
Python >= 3.10
# Getting Started
## Installation
Install directly from Xendit's Github Repository:
```sh
pip install git+https://github.com/xendit/xendit-python.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/xendit/xendit-python.git`)
Then import the package:
```python
import xendit
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import xendit
```
## Authorization
The SDK needs to be instantiated using your secret API key obtained from the [Xendit Dashboard](https://dashboard.xendit.co/settings/developers#api-keys).
You can sign up for a free Dashboard account [here](https://dashboard.xendit.co/register).
```python
import xendit
from xendit.apis import BalanceApi
from pprint import pprint
xendit.set_api_key('XENDIT_API_KEY')
client = xendit.ApiClient()
try:
response = BalanceApi(client).get_balance('CASH')
pprint(response)
except xendit.XenditSdkException as e:
print("Exception when calling BalanceApi->get_balance: %s\n" % e)
```
# Documentation
Find detailed API information and examples for each of our product's by clicking the links below,
* [Invoice](docs/InvoiceApi.md)
* [PaymentRequest](docs/PaymentRequestApi.md)
* [PaymentMethod](docs/PaymentMethodApi.md)
* [Refund](docs/RefundApi.md)
* [Balance](docs/BalanceApi.md)
* [Transaction](docs/TransactionApi.md)
* [Customer](docs/CustomerApi.md)
* [Payout](docs/PayoutApi.md)
All URIs are relative to *https://api.xendit.co*. For more information about our API, please refer to *https://developers.xendit.co/*.
Further Reading
* [Xendit Docs](https://docs.xendit.co/)
* [Xendit API Reference](https://developers.xendit.co/)
Raw data
{
"_id": null,
"home_page": "https://github.com/xendit/xendit-python",
"name": "xendit-python",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "xendit, sdk",
"author": "DevX Team",
"author_email": "devx@xendit.co",
"download_url": "https://files.pythonhosted.org/packages/da/50/453896bd2d7906a4e1b5d45edaa8db8d6daaad49430375f80331cd61b78b/xendit_python-5.0.0.tar.gz",
"platform": null,
"description": "![Xendit Python SDK](images/header.jpg \"Xendit Python SDK\")\n\n# Xendit Python SDK\n\nThe official Xendit Python SDK provides a simple and convenient way to call Xendit's REST API\nin applications written in Python.\n\n* Package version: 5.0.0\n\n## Requirements\n\nPython >= 3.10\n\n# Getting Started\n\n## Installation\n\nInstall directly from Xendit's Github Repository:\n\n```sh\npip install git+https://github.com/xendit/xendit-python.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/xendit/xendit-python.git`)\n\nThen import the package:\n```python\nimport xendit\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport xendit\n```\n\n## Authorization\n\nThe SDK needs to be instantiated using your secret API key obtained from the [Xendit Dashboard](https://dashboard.xendit.co/settings/developers#api-keys).\nYou can sign up for a free Dashboard account [here](https://dashboard.xendit.co/register).\n\n```python\nimport xendit\nfrom xendit.apis import BalanceApi\nfrom pprint import pprint\n\nxendit.set_api_key('XENDIT_API_KEY')\n\nclient = xendit.ApiClient()\n\ntry:\n response = BalanceApi(client).get_balance('CASH')\n pprint(response)\nexcept xendit.XenditSdkException as e:\n print(\"Exception when calling BalanceApi->get_balance: %s\\n\" % e)\n```\n\n# Documentation\n\nFind detailed API information and examples for each of our product's by clicking the links below,\n\n* [Invoice](docs/InvoiceApi.md)\n* [PaymentRequest](docs/PaymentRequestApi.md)\n* [PaymentMethod](docs/PaymentMethodApi.md)\n* [Refund](docs/RefundApi.md)\n* [Balance](docs/BalanceApi.md)\n* [Transaction](docs/TransactionApi.md)\n* [Customer](docs/CustomerApi.md)\n* [Payout](docs/PayoutApi.md)\n\nAll URIs are relative to *https://api.xendit.co*. For more information about our API, please refer to *https://developers.xendit.co/*.\n\nFurther Reading\n\n* [Xendit Docs](https://docs.xendit.co/)\n* [Xendit API Reference](https://developers.xendit.co/)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Xendit REST API Client for Python - Invoice, Payment Request, Payment Method, Refund, Balance, Transaction, Customer, and Payout Services https://xendit.github.io/apireference/",
"version": "5.0.0",
"project_urls": {
"Homepage": "https://github.com/xendit/xendit-python",
"Repository": "https://github.com/xendit/xendit-python"
},
"split_keywords": [
"xendit",
" sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23e6bb71d29c642be3b84dadc2db075c4d2cc0d58f7fe4ff88b9fb521adfd8ae",
"md5": "8e0b61c433e691ad6fd1cc36ffd0532d",
"sha256": "eecb2b1a997e1213ec4dfbb78b8a6dd805f15444f124347edc1f5ecfa1ad254f"
},
"downloads": -1,
"filename": "xendit_python-5.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e0b61c433e691ad6fd1cc36ffd0532d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 753297,
"upload_time": "2024-04-01T03:42:15",
"upload_time_iso_8601": "2024-04-01T03:42:15.183961Z",
"url": "https://files.pythonhosted.org/packages/23/e6/bb71d29c642be3b84dadc2db075c4d2cc0d58f7fe4ff88b9fb521adfd8ae/xendit_python-5.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da50453896bd2d7906a4e1b5d45edaa8db8d6daaad49430375f80331cd61b78b",
"md5": "4c524bd718b8ddd38a04cf53b80446af",
"sha256": "6f144d450ae41d24bee4818203c19baa786f210413f682809f3fce5f546d5ed0"
},
"downloads": -1,
"filename": "xendit_python-5.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4c524bd718b8ddd38a04cf53b80446af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 209259,
"upload_time": "2024-04-01T03:42:17",
"upload_time_iso_8601": "2024-04-01T03:42:17.399465Z",
"url": "https://files.pythonhosted.org/packages/da/50/453896bd2d7906a4e1b5d45edaa8db8d6daaad49430375f80331cd61b78b/xendit_python-5.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 03:42:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xendit",
"github_project": "xendit-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "python_dateutil",
"specs": [
[
">=",
"2.5.3"
]
]
},
{
"name": "setuptools",
"specs": [
[
">=",
"21.0.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
">=",
"1.25.3"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "pytest",
"specs": [
[
"==",
"7.4.3"
]
]
}
],
"tox": true,
"lcname": "xendit-python"
}
JSON
