Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-134807111.3 MB
token-qr-request-ideal

Create a request from an ideal transaction.

post/user/{userID}/token-qr-request-ideal

Path parameters

userIDinteger 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

Request body

tokenstring required

The token passed from a site or read from a QR code.

Response

Using this call you create a request for payment from an external token provided with an ideal transaction. Make sure your iDEAL payments are compliant with the iDEAL standards, by following the following manual: https:/www.bunq.com/terms-idealstandards. It's very important to keep these points in mind when you are using the endpoint to make iDEAL payments from your application.

idinteger

The id of the RequestResponse.

time_respondedstring

The timestamp of when the RequestResponse was responded to.

time_expirystring

The timestamp of when the RequestResponse expired or will expire.

monetary_account_idinteger

The id of the MonetaryAccount the RequestResponse was received on.

descriptionstring

The description for the RequestResponse provided by the requesting party. Maximum 9000 characters.

statusstring

The status of the created RequestResponse. Can only be PENDING.

minimum_ageinteger

The minimum age the user accepting the RequestResponse must have.

require_addressstring

Whether or not an address must be provided on accept.

redirect_urlstring

The URL which the user is sent to after accepting or rejecting the Request.

typestring

The type of the RequestResponse. Can be only be IDEAL.

sub_typestring

The subtype of the RequestResponse. Can be only be NONE.

eligible_whitelist_idinteger

The whitelist id for this action or null.