Skip to content

Latest commit

 

History

History
104 lines (75 loc) · 3 KB

README.md

File metadata and controls

104 lines (75 loc) · 3 KB
Raw

hacs_badge

Bunq Integration

This integration provides access to Bunq:

  • monetary account balance sensors including transactions
  • debit- and creditcard sensors with a reference to the linked account
  • a service to transfer funds to own accounts
  • a service to link an account to a card.

⚠️⚠️⚠️⚠️⚠️ Backward incompatibility ⚠️⚠️⚠️⚠️⚠️

Version 1.0.0 of the integration was using configuration.yaml and bunq api key. This is now fully deprecated. It won't work anymore. It was replaced by oauth.

If you are upgrading, before installing version 2.0.0 you should:

  • uninstall the previous integration
  • and clean up the configuration.yaml

Minimum version for HA

2023.6.1+

Integration configuration

Simply follow the config flow. The integration uses oauth. In order to get the "client id" and the "client secret" follow these steps:

  • Open the bunq app
  • Go to "Profile"
  • Go to "Developers"
  • Click OAuth
  • Click "Add redirect URL"
  • Enter "https://my.home-assistant.io/redirect/oauth"
  • Click "Done"
  • Click "SHOW CLIENT DETAILS"
  • use the values when configuring the integration

Note: During the configuration process you will be redirected to https://my.home-assistant.io. There, you need to enter the address on which your home assistant can be reached (it can be local ip/dns or external one) Then click on "Link Account"

Why oauth instead of API Key ?

oauth is much safer. API keys gives all writes to your accounts (including money transfert). However, oauth only allow reading.

Displaying transaction details

Each account sensor can show the balance as well as a list of transactions.
You can use the custom card html-template-card to display them.

Example of configuration:

type: "custom:html-template-card"
title: Transactions
ignore_line_breaks: true
content: >
    <style>.bunq_table { width:100% } .bunq_table tr:nth-child(even) {background:
    var(--material-secondary-background-color)}</style>
    <table class="bunq_table">
        <tr>
            <th>Amount</th> <th>Description</th> <th>Time</th>
        </tr>

        {% for transaction in state_attr('sensor.bunq_groceries', 'transactions') %}
        <tr>
            <td style="width: 20%;text-align:right">
            {{ transaction.amount }}&nbsp;{{ transaction.currency }}
            </td>

            <td style="padding:0 0.5em">
            {{ transaction.description }}
            </td>

            <td style="width: 20%;">
            {{ strptime(transaction.created, '%Y-%m-%d %H:%M:%S.%f') | relative_time }}
            </td>
        </tr>
        {% endfor %}
    </table>

CHANGELOG

V2.1.0

  • Add card sensor and service
  • Add transfer service

V2.0.0

  • Replace api_key by oauth
  • Modernize all the code

V1.0.0

  • Initial version