{ "info": { "author": "M\u0169r\u0129thi Borona", "author_email": "tech@lipisha.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable" ], "description": "===============================\r\nLipisha Payment API Client\r\n===============================\r\n\r\n.. image:: https://img.shields.io/pypi/v/lipisha.svg\r\n :target: https://pypi.python.org/pypi/lipisha\r\n\r\n\r\nThis package provides bindings for the Lipisha Payments API (http://developer.lipisha.com/)\r\n\r\n* Free software: BSD license\r\n* Documentation: http://lipisha-python-client.readthedocs.org.\r\n\r\nFeatures\r\n--------\r\n\r\n* Send money\r\n* Send SMS\r\n* Get Float\r\n* Get Balance\r\n* Acknowledge transactions\r\n\r\nExamples\r\n--------\r\n\r\nIPN callback examples are in the examples directory:\r\n\r\nhttps://github.com/lipisha/lipisha-python-client/tree/master/examples\r\n\r\nQuick start\r\n-----------\r\n\r\n.. code-block:: python\r\n\r\n >>> from lipisha import Lipisha\r\n >>> api_key = \"YOUR API KEY\" \r\n >>> api_signature = \"YOUR API SIGNATURE\"\r\n >>> lipisha = Lipisha(api_key, api_signature)\r\n >>> lipisha.api_base_url\r\n 'https://lipisha.com/payments/accounts/index.php/v2/api'\r\n >>> lipisha = Lipisha(api_key, api_signature, api_environment='test')\r\n >>> lipisha.api_base_url\r\n 'http://developer.lipisha.com/index.php/v2/api/'\r\n >>> lipisha = Lipisha(api_key, api_signature, api_environment='live')\r\n >>> lipisha.api_base_url\r\n 'https://lipisha.com/payments/accounts/index.php/v2/api'\r\n\r\n >>> lipisha.confirm_transaction(transaction='YYYE9WWWW0')\r\n \r\n {u'content': {u'transaction': u'YYYE9WWWW0',\r\n u'transaction_account_name': u'Primary',\r\n u'transaction_account_number': u'098777',\r\n u'transaction_amount': u'200.0000',\r\n u'transaction_date': u'2015-08-14 16:51:00',\r\n u'transaction_email': u'',\r\n u'transaction_method': u'Paybill (M-Pesa)',\r\n u'transaction_mobile_number': u'2547XXYYYZZZ',\r\n u'transaction_name': u'Test User Names',\r\n u'transaction_reference': u'99',\r\n u'transaction_status': u'Completed',\r\n u'transaction_type': u'Payment'},\r\n u'status': {u'status': u'SUCCESS',\r\n u'status_code': 0,\r\n u'status_description': u'Transaction Found'}}\r\n\r\n\r\n >>> lipisha.create_payment_account(transaction_account_type=1,\r\n transaction_account_name=\"MPESA Payments\",\r\n transaction_account_manager=\"test_account\")\r\n \r\n {u'content': {u'transaction_account_manager': u'test_account',\r\n u'transaction_account_name': u'MPESA Payments',\r\n u'transaction_account_number': u'09999',\r\n u'transaction_account_type': u'1'},\r\n u'status': {u'status': u'SUCCESS',\r\n u'status_code': 0,\r\n u'status_description': u'Account Created'}}\r\n\r\n >>> lipisha.create_withdrawal_account(transaction_account_type=\"1\",\r\n transaction_account_name=\"Settlement Bank A/C\",\r\n transaction_account_number=\"0100555555555\",\r\n transaction_account_bank_name=\"AZY Bank\",\r\n transaction_account_bank_branch=\"HQ\",\r\n transaction_account_bank_address=\"PO BOX 900032 - 99999 Nairobi, Kenya\",\r\n transaction_account_swift_code=\"ABCXYXXXX\",\r\n transaction_account_manager=\"test_account\")\r\n {u'content': {u'transaction_account_bank_address': u'PO BOX 900032 - 99999 Nairobi, Kenya',\r\n u'transaction_account_bank_branch': u'HQ',\r\n u'transaction_account_bank_name': u'AZY Bank',\r\n u'transaction_account_manager': u'test_account',\r\n u'transaction_account_name': u'Settlement Bank A/C',\r\n u'transaction_account_number': u'0100555555555',\r\n u'transaction_account_swift_code': u'ABCXYXXXX',\r\n u'transaction_account_type': u'1'},\r\n u'status': {u'status': u'SUCCESS',\r\n u'status_code': 0,\r\n u'status_description': u'Account Created'}}\r\n\r\n >>> lipisha.get_balance()\r\n {u'content': {u'balance': u'246.2500', u'currency': u'KES'},\r\n u'status': {u'status': u'SUCCESS',\r\n u'status_code': 0,\r\n u'status_description': u'Balance Found'}}\r\n\r\n >>> lipisha.get_float(account_number=\"098000\")\r\n \r\n {u'content': {u'account_number': u'098000',\r\n u'currency': u'KES',\r\n u'float': u'0.00'},\r\n u'status': {u'status': u'SUCCESS',\r\n u'status_code': 0,\r\n u'status_description': u'Float Found'}}\r\n\r\n >>> lipisha.get_transactions()\r\n \r\n {u'content': [{u'code': None,\r\n u'transaction': u'JJ99X9TC0',\r\n u'transaction_account_name': u'Primary',\r\n u'transaction_account_number': u'098777',\r\n u'transaction_amount': u'50.0000',\r\n u'transaction_date': u'2015-08-06 10:39:00',\r\n u'transaction_email': u'',\r\n u'transaction_method': u'Paybill (M-Pesa)',\r\n u'transaction_mobile_number': u'2547XXYYYZZZ',\r\n u'transaction_name': u'Test User Names',\r\n u'transaction_reference': u'',\r\n u'transaction_reversal_status': u'None',\r\n u'transaction_reversal_status_id': u'1',\r\n u'transaction_status': u'Completed',\r\n u'transaction_type': u'Payment'},\r\n {u'code': None,\r\n u'transaction': u'JJ99X9TC0',\r\n u'transaction_account_name': u'Primary',\r\n u'transaction_account_number': u'098777',\r\n u'transaction_amount': u'-0.7500',\r\n u'transaction_date': u'2015-08-06 10:39:00',\r\n u'transaction_email': u'',\r\n u'transaction_method': u'Paybill (M-Pesa)',\r\n u'transaction_mobile_number': u'2547XXYYYZZZ',\r\n u'transaction_name': u'Test User Names',\r\n u'transaction_reference': u'',\r\n u'transaction_reversal_status': u'None',\r\n u'transaction_reversal_status_id': u'1',\r\n u'transaction_status': u'Completed',\r\n u'transaction_type': u'Fee'},\r\n {u'code': None,\r\n u'transaction': u'YYYE9WWWW0',\r\n u'transaction_account_name': u'Primary',\r\n u'transaction_account_number': u'098777',\r\n u'transaction_amount': u'200.0000',\r\n u'transaction_date': u'2015-08-14 16:51:00',\r\n u'transaction_email': u'',\r\n u'transaction_method': u'Paybill (M-Pesa)',\r\n u'transaction_mobile_number': u'2547XXYYYZZZ',\r\n u'transaction_name': u'Test User Names',\r\n u'transaction_reference': u'99',\r\n u'transaction_reversal_status': u'None',\r\n u'transaction_reversal_status_id': u'1',\r\n u'transaction_status': u'Completed',\r\n u'transaction_type': u'Payment'},\r\n {u'code': None,\r\n u'transaction': u'YYYE9WWWW0',\r\n u'transaction_account_name': u'Primary',\r\n u'transaction_account_number': u'098777',\r\n u'transaction_amount': u'-3.0000',\r\n u'transaction_date': u'2015-08-14 16:51:00',\r\n u'transaction_email': u'',\r\n u'transaction_method': u'Paybill (M-Pesa)',\r\n u'transaction_mobile_number': u'2547XXYYYZZZ',\r\n u'transaction_name': u'Test User Names',\r\n u'transaction_reference': u'99',\r\n u'transaction_reversal_status': u'None',\r\n u'transaction_reversal_status_id': u'1',\r\n u'transaction_status': u'Completed',\r\n u'transaction_type': u'Fee'}],\r\n u'status': {u'status': u'SUCCESS',\r\n u'status_code': 0,\r\n u'status_description': u'Transactions Found'}}\r\n\r\n >>> lipisha.get_transactions(transaction=\"JJ99X9TC0\")\r\n {u'content': [{u'code': None,\r\n u'transaction': u'JJ99X9TC0',\r\n u'transaction_account_name': u'Primary',\r\n u'transaction_account_number': u'098777',\r\n u'transaction_amount': u'50.0000',\r\n u'transaction_date': u'2015-08-06 10:39:00',\r\n u'transaction_email': u'',\r\n u'transaction_method': u'Paybill (M-Pesa)',\r\n u'transaction_mobile_number': u'2547XXYYYZZZ',\r\n u'transaction_name': u'Test User Names',\r\n u'transaction_reference': u'',\r\n u'transaction_reversal_status': u'None',\r\n u'transaction_reversal_status_id': u'1',\r\n u'transaction_status': u'Completed',\r\n u'transaction_type': u'Payment'},\r\n {u'code': None,\r\n u'transaction': u'JJ99X9TC0',\r\n u'transaction_account_name': u'Primary',\r\n u'transaction_account_number': u'098777',\r\n u'transaction_amount': u'-0.7500',\r\n u'transaction_date': u'2015-08-06 10:39:00',\r\n u'transaction_email': u'',\r\n u'transaction_method': u'Paybill (M-Pesa)',\r\n u'transaction_mobile_number': u'2547XXYYYZZZ',\r\n u'transaction_name': u'Test User Names',\r\n u'transaction_reference': u'',\r\n u'transaction_reversal_status': u'None',\r\n u'transaction_reversal_status_id': u'1',\r\n u'transaction_status': u'Completed',\r\n u'transaction_type': u'Fee'}],\r\n u'status': {u'status': u'SUCCESS',\r\n u'status_code': 0,\r\n u'status_description': u'Transactions Found'}}\r\n\r\n >>> lipisha.get_customers()\r\n {u'content': [{u'customer_average': u'125.00000000',\r\n u'customer_email': u'',\r\n u'customer_first_payment_date': u'2015-08-06 10:39:00',\r\n u'customer_last_payment_date': u'2015-08-14 16:51:00',\r\n u'customer_mobile_number': u'2547XXYYYZZZ',\r\n u'customer_name': u'Test User Names',\r\n u'customer_payments': u'2',\r\n u'customer_total': u'250.0000'}],\r\n u'status': {u'status': u'SUCCESS',\r\n u'status_code': 0,\r\n u'status_description': u'Customers Found'}}\r\n\r\n >>> lipisha.get_customers(customer_mobile_number=\"2547XXYYYZZZ\")\r\n {u'content': [{u'customer_average': u'125.00000000',\r\n u'customer_email': u'',\r\n u'customer_first_payment_date': u'2015-08-06 10:39:00',\r\n u'customer_last_payment_date': u'2015-08-14 16:51:00',\r\n u'customer_mobile_number': u'2547XXYYYZZZ',\r\n u'customer_name': u'Test User Names',\r\n u'customer_payments': u'2',\r\n u'customer_total': u'250.0000'}],\r\n u'status': {u'status': u'SUCCESS',\r\n u'status_code': 0,\r\n u'status_description': u'Customers Found'}}\r\n\r\n >>> lipisha.send_airtime(account_number=\"03160\", mobile_number=\"07XXYYYZZZ\", amount=\"50\", network=\"SAF\")\r\n {u'content': {u'amount': u'50',\r\n u'mobile_number': u'07XXYYYZZZ',\r\n u'reference': u'MF0QKVD9W'},\r\n u'status': {u'status': u'SUCCESS',\r\n u'status_code': u'0000',\r\n u'status_description': u'Airtime purchased successfully'}}\r\n\r\n\r\n\r\n >>> lipisha.send_money(account_number=\"098777\", mobile_number=\"07XXYYYZZZ\", amount=50)\r\n {u'content': {u'amount': u'50',\r\n u'customer_name': u'',\r\n u'mobile_number': u'07XXYYYZZZ',\r\n u'reference': u'SP01ZXA45'},\r\n u'status': {u'status': u'SUCCESS',\r\n u'status_code': u'0000',\r\n u'status_description': u'Payout Scheduled'}}\r\n\r\n\r\n >>> lipisha.authorize_card_transaction(account_number=\"098000\",\r\n card_number=\"4242424242424242\",\r\n address1=\"PO BOX 11111 99999\",\r\n address2=\"\",\r\n expiry=\"082020\",\r\n name=\"Lipsha Test Account\",\r\n country=\"KENYA\",\r\n state=\"NAIROBI\",\r\n zip=\"00200\",\r\n security_code=\"999\",\r\n amount=100,\r\n currency='KES')\r\n {u'content': {u'transaction_index': u'{CDD55BEB-F74A-4A8B-8D5C-2FC77FF14E7B}',\r\n u'transaction_reference': 111111},\r\n u'status': {u'status': u'SUCCESS',\r\n u'status_code': u'0000',\r\n u'status_description': u'Transaction Authorized Successfully'}}\r\n\r\n\r\n >>> lipisha.complete_card_transaction(transaction_reference=11111,\r\n transaction_index=\"{CDD55BEB-F74A-4A8B-8D5C-2FC77FF14E7B}\") \r\n {u'content': {u'transaction_index': u'{CDD55BEB-F74A-4A8B-8D5C-2FC77FF14E7B}',\r\n u'transaction_reference': u'11111'},\r\n u'status': {u'status': u'SUCCESS',\r\n u'status_code': u'0000',\r\n u'status_description': u'Transaction Completed Successfully'}}\r\n\r\n >>> lipisha.reverse_card_transaction(transaction_reference=11111, transaction_index=\"{CDD55BEB-F74A-4A8B-8D5C-2FC77FF14E7B}\")\r\n {u'content': None, u'status': None}\r\n\r\nInstallation\r\n------------\r\n\r\nAt the command line::\r\n\r\n $ pip install lipisha\r\n\r\n Or using easy_install\r\n\r\n $ easy_install lipisha\r\n\r\n Manual installation\r\n\r\n $ git clone https://github.com/lipisha/lipisha-python-client.git\r\n $ cd lipisha-python-client\r\n $ python setup.py install\r\n\r\n Or, if you have virtualenvwrapper installed::\r\n\r\n $ mkvirtualenv lipisha\r\n $ pip install lipisha\r\n\r\n\r\n\r\nSee documentation for detailed API. Refer to Lipisha API for parameters required for each method.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/lipisha/lipisha-python-client", "keywords": "lipisha", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "lipisha", "package_url": "https://pypi.org/project/lipisha/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/lipisha/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/lipisha/lipisha-python-client" }, "release_url": "https://pypi.org/project/lipisha/0.2.4/", "requires_dist": null, "requires_python": null, "summary": "This package provides bindings for the Lipisha Payments API (http://developer.lipisha.com/)", "version": "0.2.4" }, "last_serial": 2344391, "releases": { "0.2.2": [ { "comment_text": "", "digests": { "md5": "ddd563c97d16e7461226666e761e3c8f", "sha256": "0c24ea2bfcdc1008f7667cea6e29bcc07e59868d30ef4a8275e936fe0a109445" }, "downloads": -1, "filename": "lipisha-0.2.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ddd563c97d16e7461226666e761e3c8f", "packagetype": "bdist_wheel", "python_version": "any", "requires_python": null, "size": 9551, "upload_time": "2015-08-14T16:02:28", "url": "https://files.pythonhosted.org/packages/fe/ac/3bface0b16179a360cf372180332cd9395bdbccb83e06824d1d76386a070/lipisha-0.2.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f1c2711271fdaaa16cb9cfa8f295aea4", "sha256": "9baaa098b0351ee6f6865e45065896f7445f41fec6c70c83e1390d9fbb9e7281" }, "downloads": -1, "filename": "lipisha-0.2.2.tar.gz", "has_sig": false, "md5_digest": "f1c2711271fdaaa16cb9cfa8f295aea4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21205, "upload_time": "2015-08-14T16:02:17", "url": "https://files.pythonhosted.org/packages/10/15/eaba1590fe500379a594c3fb15aa6429cee7a6e5a3df42d9edf0bdd9d5f8/lipisha-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "6c79e179bf0a226a2c7086ad73811fa8", "sha256": "8e67f0975a995de542cea12281d7d872bb450dd27aa787e74b428631670081ad" }, "downloads": -1, "filename": "lipisha-0.2.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6c79e179bf0a226a2c7086ad73811fa8", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 9579, "upload_time": "2016-04-20T20:38:44", "url": "https://files.pythonhosted.org/packages/c8/c2/ad3671ad529ccd85cde8262f8009f09208269f3ec3d0fe54c622ce690484/lipisha-0.2.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1a3e894f2432c87fa449090e0eb2edf4", "sha256": "66201540567817b1f38fa2b6d358b57b126d5353eb275508a2042a7f5dd3b4b5" }, "downloads": -1, "filename": "lipisha-0.2.3.tar.gz", "has_sig": false, "md5_digest": "1a3e894f2432c87fa449090e0eb2edf4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20820, "upload_time": "2016-04-20T20:38:35", "url": "https://files.pythonhosted.org/packages/bd/bc/b24e2e23d7e1fbe001a9442a19e85ce64ba9556b47e5df84b1a32a219fe5/lipisha-0.2.3.tar.gz" }, { "comment_text": "", "digests": { "md5": "97987cd1afb56c28342864c061448f92", "sha256": "5681f21d6720119d52eb6e18f4fcb93a672e8693f354c1bd64df3c2af699c9fb" }, "downloads": -1, "filename": "lipisha-0.2.4.tar.gz", "has_sig": false, "md5_digest": "97987cd1afb56c28342864c061448f92", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19301, "upload_time": "2016-09-15T14:36:14", "url": "https://files.pythonhosted.org/packages/24/6a/8d2a18885307a5901ffa2c6d64bb917045378f4951739b205f1adf356eaa/lipisha-0.2.4.tar.gz" } ], "0.2.4": [] }, "urls": [] }