v1

latestOpenAPI 3.0.0Apache 2.02026-07-134807111.3 MB
bunqme-tab

bunq.me tabs allows you to create a payment request and share the link through e-mail, chat, etc. Multiple persons are able to respond to the payment request and pay through bunq, iDeal or SOFORT.

get/user/{userID}/monetary-account/{monetary-accountID}/bunqme-tab/{itemId}

Path parameters

userIDinteger required
monetary-accountIDinteger required
itemIdinteger required

Headers

Cache-Controlstring

The standard HTTP Cache-Control header is required for all signed requests.

User-Agentstring required

The User-Agent header field should contain information about the user agent originating the request. There are no restrictions on the value of this header.

X-Bunq-Languagestring

The X-Bunq-Language header must contain a preferred language indication. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore. Currently only the languages en_US and nl_NL are supported. Anything else will default to en_US.

X-Bunq-Regionstring

The X-Bunq-Region header must contain the region (country) of the client device. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore.

X-Bunq-Client-Request-Idstring

This header must 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-Geolocationstring

This header must specify the geolocation of the device. The format of this value is longitude latitude altitude radius country. The country is expected to be formatted of an ISO 3166-1 alpha-2 country code. When no geolocation is available or known the header must still be included but can be zero valued.

X-Bunq-Client-Authenticationstring required

The authentication token is used to authenticate the source of the API call. It is required by all API calls except for POST /v1/installation. It is important to note that the device and session calls are using the token from the response of the installation call, while all the other calls use the token from the response of the session-server call

Response

bunq.me tabs allows you to create a payment request and share the link through e-mail, chat, etc. Multiple persons are able to respond to the payment request and pay through bunq, iDeal or SOFORT.

idinteger

The id of the created bunq.me.

createdstring

The timestamp when the bunq.me was created.

updatedstring

The timestamp when the bunq.me was last updated.

time_expirystring

The timestamp of when the bunq.me expired or will expire.

monetary_account_idinteger

The id of the MonetaryAccount the bunq.me was sent from.

statusstring

The status of the bunq.me. Can be WAITING_FOR_PAYMENT, CANCELLED or EXPIRED.

typestring

The type of the bunq.me Tab. Should be BUNQ_ME

bunqme_tab_share_urlstring

The url that points to the bunq.me page.