Belvo Python SDK
Belvo Python SDK
🚨 Limited maintenance until 31.12.2023
Please be advised that this SDK has transitioned to limited maintenance mode and will no longer receive updates for new features. Essential security updates will continue to be provided until December 31, 2023.
After this date, the SDK will be archived and no further updates will be released. While you are welcome to continue using the code please note that you will be solely responsible for managing and implementing any required security patches or updates.
How to use
If you want to check the full documentation about Belvo API: https://developers.belvo.com
Or if you want to more information about:
- Python 3.6+
🚀 Getting started
$ pip install belvo-python
Usage (create link via widget)
When your user successfully links their account using the Connect Widget, your implemented callback funciton will return the
link_id required to make further API to retrieve information.
from pprint import pprint from belvo.client import Client from belvo.enums import AccessMode # Login to Belvo API client = Client("your-secret-key-id", "your-secret-key", "sandbox") # Get the link_id from the result of your widget callback function link_id = result_from_callback_function.id # Get all accounts client.Accounts.create(link=link_id) # Pretty print all checking accounts for account in client.Accounts.list(type="checking"): pprint(account)
Usage (create link via SDK)
You can also manually create the link using the SDK. However, for security purposes, we highly recommend, that you use the Connect Widget to create the link and follow the Usage (create link via widget) example.
from pprint import pprint from belvo.client import Client from belvo.enums import AccessMode # Login to Belvo API client = Client("your-secret-key-id", "your-secret-key", "sandbox") # Register a link link = client.Links.create( institution="erebor_mx_retail", username="johndoe", password="supersecret", access_mode=AccessMode.SINGLE ) # Get all accounts client.Accounts.create(link=link["id"]) # Pretty print all checking accounts for account in client.Accounts.list(type="checking"): pprint(account)
Errors and exceptions
By default, when you use our SDK, we automatically return the error. However, if you prefer to receive the exception, you need to set the
raise_exception optional parameter to
from pprint import pprint from belvo.client import Client from belvo.enums import AccessMode from belvo.exceptions import RequestError # Login to Belvo API client = Client("my-secret-key-id", "my-secret-key", "sandbox") try: # Register a link link = client.Links.create( access_mode=AccessMode.SINGLE, institution="erebor_mx_retail", username="<username>", password="<pass>", raise_exception=True, # Set this optional paramter ) except RequestError as e: # do something with the error pprint(e) else: # do something with the link pprint(link)
To release a new version of the SDK to PyPI:
- Create a new branch from master.
make new-version major|minor|patchto bump a new version.
- Create a new pull request for the new version.
- Once the new version is merged in
master, create a
tagmatching the new version.
Anyone can do something to make
belvo-python better, so contributors are always welcome!
If you wish to submit a pull request, please be sure check the items on this list:
- Tests related to the changed code were executed
- The source code has been coded following the OWASP security best practices (https://owasp.org/www-pdf-archive/OWASP_SCP_Quick_Reference_Guide_v2.pdf).
- Commit message properly labeled
- There is a ticket associated to each PR.
For more details about contributing to this project, please take a look to our guidelines.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for belvo_python-0.39.1-py2.py3-none-any.whl