The bunq API is based on the RESTful principles. It returns responses in the JSON format. The only exclusion is binary (image) files.
Before you start sending API requests, you need to get an API key and activate it. API activation happens when you install it and link your IP address and device to it (create an API context). The steps below will guide you through what you need to do to start sending custom API requests.
- Create an API key. You can do it either in our developer portal or in the bunq app (Profile → Security & Settings → Developers → API keys). If you want to test our sandbox first, our bunq Developer is the best place to start.
- Register a device. A device can be a phone (private), a computer, or a server (public). You can register a new device by using the
POST /installationandPOST /device-servercalls. This will activate your API key. You only need to do this once. - Open a session. Sessions are temporary and expire after the auto-logout time set for the user account. It can be changed in the bunq app.
- Make your first call!
{% hint style="info" %} Looking to start with the sandbox environment first? Jump to the Sandbox page. {% endhint %}
{% page-ref page="basics/sandbox/" %}
Developments in the financial sector, changing regulatory regimes and new feature requests require us to be flexible. This means we can iterate quickly to improve the API and related tooling. Therefore, we have chosen not to attach any version numbers to the changes just yet.
We will inform you in a timely manner of any important changes we make before they are deployed on together.bunq.com. You can also subscribe to our API newsletter to make sure you don't miss any important updates.