Headers
HTTP headers allow your application and bunq to pass additional information about with the request or response.
Though headers are already implemented in our SDKs, we recommend that you follow these instructions to make sure you set appropriate headers when calling the bunq API directly.
Request Headers
Mandatory request headers
Cache-Control
Cache-Control: no-cache
The standard HTTP Cache-Control header is required for all requests.
User-Agent
User-Agent: bunq-TestServer/1.00 sandbox/0.17b3
The User-Agent header field must contain information about the user agent originating the request. There are no restrictions on the value of this header.
X-Bunq-Client-Signature
Header and URL signature will stop being validated on April 28, 2020. Please sign the request body only.
X-Bunq-Client-Authentication
X-Bunq-Client-Authentication: 622749ac8b00c81719ad0c7d822d3552e8ff153e3447eabed1a6713993749440
The authentication Token is used to identify the sender of the API call. It is required for all API calls except POST /v1/installation.
Pass the installation Token you get in the response to the
POST /installationcall in the/device-serverand/session-servercalls.Pass the session Token you get in the response to the
POST /session-servercall in all the other calls.
Optional request headers
X-Bunq-Language
X-Bunq-Language: en_US
en_US is the default language setting for responses and error descriptions.
The X-Bunq-Language header must carry the preferred language indicator. The value of this header must follow this format: an ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code separated by an underscore.
We currently only support en_US and nl_NL. Any other language will default to en_US.
X-Bunq-Region
X-Bunq-Region: en_US
en_US is the default region for localization formatting.
The X-Bunq-Region header must contain the region (country) of the client device. The value of this header must follow this format: an ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code separated by an underscore.
X-Bunq-Client-Request-Id
X-Bunq-Client-Request-Id: a4f0de
This header has to specify an ID with each request that is unique for the logged in user. There are no restrictions for the format of this ID. However, the server will respond with an error when the same ID is used again on the same DeviceServer.
X-Bunq-Geolocation
X-Bunq-Geolocation: 4.89 53.2 12 100 NL
X-Bunq-Geolocation: 0 0 0 0 000 (if no geolocation is available or known)
This header has to specify the geolocation of the device. The format of this value is longitude latitude altitude radius country. The country is expected to take the form of an ISO 3166-1 alpha-2 country code.
This header makes it possible for bunq to map the geolocation with the payment.
Attachment headers
Content-Type
Content-Type: image/jpeg
Use this header when uploading an attachment to pass its MIME type. We support the following content types:
image/png;
image/jpeg;
image/gif.
X-Bunq-Attachment-Description
Use this header to provide a description of an attachment.
Response Headers
All Responses
X-Bunq-Client-Request-Id
X-Bunq-Client-Request-Id: a4f0de
The header contains the same id that was provided in the X-Bunq-Client-Request-Id header of the request. It is included in the response (and request) signature so it can be used to ensure this is the response to the request.
X-Bunq-Client-Response-Id
X-Bunq-Client-Response-Id: 76cc7772-4b23-420a-9586-8721dcdde174
The header carries a unique id of the response formatted as a UUID. You can use it to add extra protection against replay attacks.
X-Bunq-Server-Signature
The header contains the signature of the bunq server for this response. See the signing page for details on how to verify this signature.
pageSigningWarning header
X-Bunq-Warning
X-Bunq-Warning: "You have a negative balance. Please check the app for more details."
We use it to warn you something is impacting your bunq account and/or API access.
Last updated