{ "info": { "author": "bunq", "author_email": "support@bunq.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Build Tools" ], "description": "# bunq Python SDK\n\n## Introduction\nHi developers!\n\nWelcome to the bunq Python SDK! \ud83d\udc68\u200d\ud83d\udcbb\n\nWe're very happy to introduce yet another unique product: complete banking SDKs! \nNow you can build even bigger and better apps and integrate them with your bank of the free! \ud83c\udf08\n\nBefore you dive into this brand new SDK, please consider:\n- Checking out our new developer\u2019s page [https://bunq.com/en/developer](https://bunq.com/en/developer) \ud83d\ude4c \n- Grabbing your production API key from the bunq app or generate a Sandbox API key using [Tinker](https://www.bunq.com/developer) \ud83d\udddd\n- Visiting [together.bunq.com](https://together.bunq.com) where you can share your creations,\nquestions and experience \ud83c\udfa4\n\nGive us your feedback, create pull requests, build your very own bunq apps and most importantly:\nhave fun! \ud83d\udcaa\n\nThis SDK is in **beta**. We cannot guarantee constant availability or stability. \nThanks to your feedback we will make improvements on it.\n\n## Installation\n``pip install bunq_sdk --upgrade``\n\n## Usage\n\n### Creating an API context\nIn order to start making calls with the bunq API, you must first register your API key and device,\nand create a session. In the SDKs, we group these actions and call it \"creating an API context\". The\ncontext can be created by using the following code snippet:\n\n```\napiContext = context.ApiContext(ENVIRONMENT_TYPE, API_KEY,\n DEVICE_DESCRIPTION);\napiContext.save(API_CONTEXT_FILE_PATH)\ncontext.BunqContext.loadApiContext(apiContext)\n```\n\nThis code snippet, except for `context.BunqContext.loadApiContext(apiContext)` should be called once per API key. \n\n#### Example\n\nSee [`tinker/setup_context`](https://github.com/bunq/tinker_python/blob/2182b8be276fda921657ad22cfe0b8b48a585ccf/tinker/libs/bunq_lib.py#L44-L59)\n\n#### Safety considerations\nThe file storing the context details (i.e. `bunq.conf`) is a key to your account. Anyone having\naccess to it is able to perform any Public API actions with your account. Therefore, we recommend\nchoosing a truly safe place to store it.\n\n### Making API calls\nThere is a class for each endpoint. Each class has functions for each supported action. These\nactions can be `create`, `get`, `update`, `delete` and `list`.\n\nSometimes API calls have dependencies, for instance `MonetaryAccount`. Making changes to a monetary\naccount always also needs a reference to a `User`. These dependencies are required as arguments when\nperforming API calls. Take a look at [doc.bunq.com](https://doc.bunq.com) for the full\ndocumentation.\n\n#### Creating objects\nCreating objects through the API requires an `ApiContext`, a `requestMap` and identifiers of all\ndependencies (such as User ID required for accessing a Monetary Account). Optionally, custom headers\ncan be passed to requests.\n\n\n```\npayment_id = endpoint.Payment.create(\n\tamount=Amount(amount_string, self._CURRENCY_EURL),\n counterparty_alias=Pointer(self._POINTER_TYPE_EMAIL, recipient),\n description=description\n )\n```\n\n##### Example\nSee [`tinker/make_payment`](https://github.com/bunq/tinker_python/blob/2182b8be276fda921657ad22cfe0b8b48a585ccf/tinker/libs/bunq_lib.py#L140-L151)\n\n#### Reading objects\nReading objects through the API requires an `ApiContext`, identifiers of all dependencies (such as\nUser ID required for accessing a Monetary Account), and the identifier of the object to read (ID or\nUUID) Optionally, custom headers can be passed to requests.\n\nThis type of calls always returns a model.\n\n```\nmonetary_account = generated.MonetaryAccountBank.get(\n _MONETARY_ACCOUNT_ITEM_ID\n)\n```\n\n##### Example\nSee [`tinker/list_all_payment`](https://github.com/bunq/tinker_python/blob/2182b8be276fda921657ad22cfe0b8b48a585ccf/tinker/libs/bunq_lib.py#L85-L103)\n\n#### Updating objects\nUpdating objects through the API goes the same way as creating objects, except that also the object to update identifier \n(ID or UUID) is needed.\n\n```\nendpoint.Card.update(\n\tcard_id=int(card_id),\n\tmonetary_account_current_id=int(account_id)\n\t)\n```\n\n##### Example\nSee [`tinker/update_card`](https://github.com/bunq/tinker_python/blob/2182b8be276fda921657ad22cfe0b8b48a585ccf/tinker/libs/bunq_lib.py#L167-L174)\n\n#### Deleting objects\nDeleting objects through the API requires an `ApiContext`, identifiers of all dependencies (such as User ID required for\naccessing a Monetary Account), and the identifier of the object to delete (ID or UUID) Optionally, custom headers can be\npassed to requests.\n\n```\nSession.delete(self._SESSION_ID)\n```\n\n##### Example\n\n\n#### Listing objects\nListing objects through the API requires an `ApiContext` and identifiers of all dependencies (such as User ID required\nfor accessing a Monetary Account). Optionally, custom headers can be passed to requests.\n\n```\nusers = generated.User.list(api_context)\n```\n\n##### Example\nSee [`UserListExample.py`](./examples/user_list_example.py)\n\n## Running Samples\nTo get an indication on how the SDK works you can use the python tinker which is located at https://github.com/bunq/tinker_python\n\n## Running Tests\n\nInformation regarding the test cases can be found in the [README.md](./tests/README.md)\nlocated in [test](/tests)\n\n## Exceptions\nThe SDK can raise multiple exceptions. For an overview of these exceptions please\ntake a look at [EXCEPTIONS.md](./EXCEPTIONS.md)", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/bunq/sdk_python", "keywords": "open-banking sepa bunq finance api payment", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "bunq-sdk", "package_url": "https://pypi.org/project/bunq-sdk/", "platform": "", "project_url": "https://pypi.org/project/bunq-sdk/", "project_urls": { "Homepage": "https://github.com/bunq/sdk_python" }, "release_url": "https://pypi.org/project/bunq-sdk/1.10.16/", "requires_dist": null, "requires_python": ">=3.5.3", "summary": "bunq Python SDK", "version": "1.10.16" }, "last_serial": 5415245, "releases": { "0.10.0": [ { "comment_text": "", "digests": { "md5": "ad6fd00c80635e2a50a5b5db4b5b1f35", "sha256": "181fc598530e3bd724d089a2796afb02936e94cc4fc5ce9b227459e4fe6464cc" }, "downloads": -1, "filename": "bunq_sdk-0.10.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ad6fd00c80635e2a50a5b5db4b5b1f35", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 47923, "upload_time": "2017-08-23T05:02:38", "url": "https://files.pythonhosted.org/packages/74/8c/f8aba1cfdc6b45bb0c816190b7c236376c263d2d06995810b880e112f8df/bunq_sdk-0.10.0-py2.py3-none-any.whl" } ], "0.11.0": [ { "comment_text": "", "digests": { "md5": "6ca6918a9d3ab541c1103b34dcc8e446", "sha256": "33766660d8770ff34cb2ae2d5dcb77dc4d1f95dab9b4e4e0c015c3d14f353354" }, "downloads": -1, "filename": "bunq_sdk-0.11.0-py3-none-any.whl", "has_sig": false, "md5_digest": "6ca6918a9d3ab541c1103b34dcc8e446", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 50870, "upload_time": "2017-09-06T19:20:13", "url": "https://files.pythonhosted.org/packages/7d/5a/c21121e3394f2d6c200936c9cee6b414b6c198eeee9cd310de0df5b7c199/bunq_sdk-0.11.0-py3-none-any.whl" } ], "0.12.0": [ { "comment_text": "", "digests": { "md5": "41a0727ac898de99f53f7f3a68f6a1b8", "sha256": "66347770c40479b783905d7559404de5ac85a8b175f4a865a7dd9542181fe913" }, "downloads": -1, "filename": "bunq_sdk-0.12.0-py3-none-any.whl", "has_sig": false, "md5_digest": "41a0727ac898de99f53f7f3a68f6a1b8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 67518, "upload_time": "2017-10-11T08:44:04", "url": "https://files.pythonhosted.org/packages/37/9f/bb37db596e6171914bdf29745da84b88e245a78650a20a1f73868749e22a/bunq_sdk-0.12.0-py3-none-any.whl" } ], "0.12.2": [ { "comment_text": "", "digests": { "md5": "45cacd98a2e6e232eea4a0893f70e020", "sha256": "c9251ab498a854761bb5a67ad645982db699e4999d9026cb861e9484dee5d30b" }, "downloads": -1, "filename": "bunq_sdk-0.12.2-py3-none-any.whl", "has_sig": false, "md5_digest": "45cacd98a2e6e232eea4a0893f70e020", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 66475, "upload_time": "2017-11-08T15:22:23", "url": "https://files.pythonhosted.org/packages/c9/4e/a135e846eb9e6fffa8fb4a6a3228e9e7de1e5bf977b8df0b22ad79234c7b/bunq_sdk-0.12.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7b1aa223c83fe11b12c906c2a9614c45", "sha256": "07280af951afdc3a69e427d04616e86c437ccdee08d8c48fa3204141553d73c5" }, "downloads": -1, "filename": "bunq_sdk-0.12.2.tar.gz", "has_sig": false, "md5_digest": "7b1aa223c83fe11b12c906c2a9614c45", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 56564, "upload_time": "2017-11-08T15:22:27", "url": "https://files.pythonhosted.org/packages/16/4a/d9b339f596cd0b6da07830e6ac184b19cdc39c5815f9392b332bd7b8eaa9/bunq_sdk-0.12.2.tar.gz" } ], "0.12.3": [ { "comment_text": "", "digests": { "md5": "9e93f973b259975b90f39bc5b2ed9429", "sha256": "6b3380086cc78fea37d3eebe834b3aa9b8f92619f4c4a9513ce8f725a89bc7fa" }, "downloads": -1, "filename": "bunq_sdk-0.12.3.tar.gz", "has_sig": false, "md5_digest": "9e93f973b259975b90f39bc5b2ed9429", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 63447, "upload_time": "2017-11-15T18:03:47", "url": "https://files.pythonhosted.org/packages/02/eb/e7cd928efa7f30b43c0d261039bfc35a6905f7160b70273468e721bc2a1e/bunq_sdk-0.12.3.tar.gz" } ], "0.12.4": [ { "comment_text": "", "digests": { "md5": "8a92a423e83e34f83bfecbe52195f22d", "sha256": "2ec174b3f7a293c917b9e63a4d857aa502870e62f8f2ea91101476878c5445bc" }, "downloads": -1, "filename": "bunq_sdk-0.12.4-py3-none-any.whl", "has_sig": false, "md5_digest": "8a92a423e83e34f83bfecbe52195f22d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 110895, "upload_time": "2018-03-20T21:07:14", "url": "https://files.pythonhosted.org/packages/7a/86/0df98ccbaf2856a021b2db00bcc3a4f65420d5e911d3de18443b8afb056b/bunq_sdk-0.12.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ae768872ead244a3365d7431171eadd5", "sha256": "2e7205357a81c61e7991dbf4f75ebd175affb63af93ca276f5ea61e14ea02c74" }, "downloads": -1, "filename": "bunq_sdk-0.12.4.tar.gz", "has_sig": false, "md5_digest": "ae768872ead244a3365d7431171eadd5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 70896, "upload_time": "2017-12-21T16:41:00", "url": "https://files.pythonhosted.org/packages/3b/55/faf9be5a604a1bd23e466d4135558dcc08e89ea8402c0b48174bcca31633/bunq_sdk-0.12.4.tar.gz" } ], "0.13.0": [ { "comment_text": "", "digests": { "md5": "4b1c7d94a00d11b8795d1f8e8d6b1cce", "sha256": "c0fd7c73052678c128bdcbbceb85efde62667401cf29ac4f6fe72fa8bc017444" }, "downloads": -1, "filename": "bunq_sdk-0.13.0-py3-none-any.whl", "has_sig": false, "md5_digest": "4b1c7d94a00d11b8795d1f8e8d6b1cce", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3", "size": 110892, "upload_time": "2018-03-20T21:07:15", "url": "https://files.pythonhosted.org/packages/d9/52/8666a85d94273b6990a98951792f611cb65c9bd3834b4fdfcc6745115c9b/bunq_sdk-0.13.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "100a50a8e6f9f0b104cf1676e218c761", "sha256": "86ad3b89cb1b88ca8953e238bec40df4fe87a4f81614c3eea35dfc2b12d3912f" }, "downloads": -1, "filename": "bunq_sdk-0.13.0.tar.gz", "has_sig": false, "md5_digest": "100a50a8e6f9f0b104cf1676e218c761", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 101697, "upload_time": "2018-03-22T19:45:49", "url": "https://files.pythonhosted.org/packages/c8/22/1afaaf066cb79e8b3baea4cc9b0f4d7bfe140b2eac1bbd007c1d5eacb059/bunq_sdk-0.13.0.tar.gz" } ], "0.13.1": [ { "comment_text": "", "digests": { "md5": "8c4c054e1f5e34fb7cc6316ef906f953", "sha256": "1be2ff904f98e85797c66b867a6c6abc95e37d30216690edabc07cf023579d18" }, "downloads": -1, "filename": "bunq_sdk-0.13.1.tar.gz", "has_sig": false, "md5_digest": "8c4c054e1f5e34fb7cc6316ef906f953", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 101758, "upload_time": "2018-05-30T09:23:39", "url": "https://files.pythonhosted.org/packages/de/74/a451e3d65b44121d87b261779a8886f74e98ba812745d302b8f12b7a4156/bunq_sdk-0.13.1.tar.gz" } ], "0.9.0": [ { "comment_text": "", "digests": { "md5": "63d466ada28f95e24f7d158d7a86b199", "sha256": "124e8299599c7cdb8daad3cb8f55fba1fce20661678b764c08e00171b2b1ea68" }, "downloads": -1, "filename": "bunq_sdk-0.9.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "63d466ada28f95e24f7d158d7a86b199", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 46114, "upload_time": "2017-08-02T16:00:10", "url": "https://files.pythonhosted.org/packages/35/1d/1056c01f7b5dcf7a67eafff7c5c60faef8bccacbc70bba54d68d4f2c6d61/bunq_sdk-0.9.0-py2.py3-none-any.whl" } ], "0.9.1": [ { "comment_text": "", "digests": { "md5": "beecc91d7798df9013123ae1f5958dd8", "sha256": "1a5875ac7eadb519a2ddf2299ea439990da7bbeeabeef287a81f93d79dcbaab4" }, "downloads": -1, "filename": "bunq_sdk-0.9.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "beecc91d7798df9013123ae1f5958dd8", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 47111, "upload_time": "2017-08-07T14:16:06", "url": "https://files.pythonhosted.org/packages/95/e0/fa2aef6dd7da80c11292087fbe9006706e050f57b15436060292a5360be2/bunq_sdk-0.9.1-py2.py3-none-any.whl" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "87625444c8d9bb4d302cb14efdb5d05a", "sha256": "2f40bef503863237693d0d2a1e88f055c9bd96174aec72ac209e05877f7ac314" }, "downloads": -1, "filename": "bunq_sdk-1.0.0.tar.gz", "has_sig": false, "md5_digest": "87625444c8d9bb4d302cb14efdb5d05a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 107129, "upload_time": "2018-07-24T19:54:00", "url": "https://files.pythonhosted.org/packages/41/e0/e61e7b06c7ee27dead589e4e30ce08b1c1d10d27d4e6732833e1ec1d44d6/bunq_sdk-1.0.0.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "3f87719bf7d61b14b44a1306ab3d39ba", "sha256": "677da2a382fe7184d63e08e3bee05d944ee42e93584d537e39e93817540aa281" }, "downloads": -1, "filename": "bunq_sdk-1.1.0.tar.gz", "has_sig": false, "md5_digest": "3f87719bf7d61b14b44a1306ab3d39ba", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 115432, "upload_time": "2018-10-05T15:57:30", "url": "https://files.pythonhosted.org/packages/16/41/74a9c01d3f29f97b580326d3fbcc8bdc3f13e6ec6d762d1b89d88cd0f85e/bunq_sdk-1.1.0.tar.gz" } ], "1.10.1": [ { "comment_text": "", "digests": { "md5": "b161b075c22da7e871538eee2e270f3f", "sha256": "25092047cc250ad467d015f244b50b55eef0a872da040382856f7f6a2a8db8c7" }, "downloads": -1, "filename": "bunq_sdk-1.10.1.tar.gz", "has_sig": false, "md5_digest": "b161b075c22da7e871538eee2e270f3f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 128220, "upload_time": "2019-03-22T19:23:41", "url": "https://files.pythonhosted.org/packages/d8/6b/a06a75e9966c21c66af3c95d4e045193887c27d8c509512701d8c0c9b427/bunq_sdk-1.10.1.tar.gz" } ], "1.10.16": [ { "comment_text": "", "digests": { "md5": "53294a39de226b8c686d338ca8041edd", "sha256": "1791d45a55c9efba58d3027e7e833d7365aaba76e127e7da84aa43deccc744f2" }, "downloads": -1, "filename": "bunq_sdk-1.10.16.tar.gz", "has_sig": false, "md5_digest": "53294a39de226b8c686d338ca8041edd", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5.3", "size": 131809, "upload_time": "2019-06-18T13:32:27", "url": "https://files.pythonhosted.org/packages/67/3b/03d3474f89ec6b65d93a1b157b163c443d34f6bc023faaf0087234b42778/bunq_sdk-1.10.16.tar.gz" } ], "1.10.2": [ { "comment_text": "", "digests": { "md5": "9b21b117f15d57b11b81529b7aad07d5", "sha256": "d81d0d5fdc302a370c68545aa632b8c5800015182f310c167500190ceede2f79" }, "downloads": -1, "filename": "bunq_sdk-1.10.2.tar.gz", "has_sig": false, "md5_digest": "9b21b117f15d57b11b81529b7aad07d5", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5.3", "size": 132401, "upload_time": "2019-05-22T14:31:44", "url": "https://files.pythonhosted.org/packages/b5/17/33523dd959ba4be0de473166fe618c756e4e47ebd914c2e0185a4623e1ed/bunq_sdk-1.10.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "53294a39de226b8c686d338ca8041edd", "sha256": "1791d45a55c9efba58d3027e7e833d7365aaba76e127e7da84aa43deccc744f2" }, "downloads": -1, "filename": "bunq_sdk-1.10.16.tar.gz", "has_sig": false, "md5_digest": "53294a39de226b8c686d338ca8041edd", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5.3", "size": 131809, "upload_time": "2019-06-18T13:32:27", "url": "https://files.pythonhosted.org/packages/67/3b/03d3474f89ec6b65d93a1b157b163c443d34f6bc023faaf0087234b42778/bunq_sdk-1.10.16.tar.gz" } ] }