Request Inquiry

get
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{itemId}

Get the details of a specific payment request, including its status. bunqme_share_url is always null if the counterparty is a bunq user.

Path parameters
userIDintegerRequired
monetary-accountIDintegerRequired
itemIdintegerRequired
Header parameters
Cache-ControlstringOptional

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

User-AgentstringRequired

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-LanguagestringOptional

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-RegionstringOptional

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-IdstringOptional

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-GeolocationstringOptional

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-AuthenticationstringRequired

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

Responses
200

RequestInquiry, aka 'RFP' (Request for Payment), is one of the innovative features that bunq offers. To request payment from another bunq account a new Request Inquiry is created. As with payments you can add attachments to a RFP. Requests for Payment are the foundation for a number of consumer features like 'Split the bill' and 'Request forwarding'. We invite you to invent your own based on the bunq api!

application/json
get
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{itemId}
put
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{itemId}

Revoke a request for payment, by updating the status to REVOKED.

Path parameters
userIDintegerRequired
monetary-accountIDintegerRequired
itemIdintegerRequired
Header parameters
Cache-ControlstringOptional

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

User-AgentstringRequired

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-LanguagestringOptional

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-RegionstringOptional

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-IdstringOptional

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-GeolocationstringOptional

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-AuthenticationstringRequired

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

Body
descriptionstringOptional

The description of the inquiry.

merchant_referencestringOptional

The client's custom reference that was attached to the request and the mutation.

statusstringOptional

The status of the request.

minimum_ageintegerOptional

The minimum age the user accepting the RequestInquiry must have.

require_addressstringOptional

Whether or not an address must be provided on accept.

want_tipbooleanWrite-onlyOptional

[DEPRECATED] Whether or not the accepting user can give an extra tip on top of the requested Amount. Defaults to false.

allow_amount_lowerbooleanWrite-onlyOptional

[DEPRECATED] Whether or not the accepting user can choose to accept with a lower amount than requested. Defaults to false.

allow_amount_higherbooleanWrite-onlyOptional

[DEPRECATED] Whether or not the accepting user can choose to accept with a higher amount than requested. Defaults to false.

allow_bunqmebooleanWrite-onlyRequired

Whether or not sending a bunq.me request is allowed.

redirect_urlstringOptional

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

event_idintegerWrite-onlyOptional

The ID of the associated event if the request was made using 'split the bill'.

idintegerRead-onlyOptional

The id of the created RequestInquiry.

createdstringRead-onlyOptional

The timestamp of the payment request's creation.

updatedstringRead-onlyOptional

The timestamp of the payment request's last update.

time_respondedstringRead-onlyOptional

The timestamp of when the payment request was responded to.

time_expirystringRead-onlyOptional

The timestamp of when the payment request expired.

monetary_account_idintegerRead-onlyOptional

The id of the monetary account the request response applies to.

batch_idintegerRead-onlyOptional

The id of the batch if the request was part of a batch.

scheduled_idintegerRead-onlyOptional

The id of the scheduled job if the request was scheduled.

bunqme_share_urlstringRead-onlyOptional

The url that points to the bunq.me request.

Responses
200

RequestInquiry, aka 'RFP' (Request for Payment), is one of the innovative features that bunq offers. To request payment from another bunq account a new Request Inquiry is created. As with payments you can add attachments to a RFP. Requests for Payment are the foundation for a number of consumer features like 'Split the bill' and 'Request forwarding'. We invite you to invent your own based on the bunq api!

application/json
put
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{itemId}
get
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry

Get all payment requests for a user's monetary account. bunqme_share_url is always null if the counterparty is a bunq user.

Path parameters
userIDintegerRequired
monetary-accountIDintegerRequired
Header parameters
Cache-ControlstringOptional

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

User-AgentstringRequired

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-LanguagestringOptional

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-RegionstringOptional

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-IdstringOptional

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-GeolocationstringOptional

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-AuthenticationstringRequired

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

Responses
200

RequestInquiry, aka 'RFP' (Request for Payment), is one of the innovative features that bunq offers. To request payment from another bunq account a new Request Inquiry is created. As with payments you can add attachments to a RFP. Requests for Payment are the foundation for a number of consumer features like 'Split the bill' and 'Request forwarding'. We invite you to invent your own based on the bunq api!

application/json
get
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry
post
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry

Create a new payment request.

Path parameters
userIDintegerRequired
monetary-accountIDintegerRequired
Header parameters
Cache-ControlstringOptional

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

User-AgentstringRequired

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-LanguagestringOptional

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-RegionstringOptional

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-IdstringOptional

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-GeolocationstringOptional

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-AuthenticationstringRequired

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

Body
descriptionstringOptional

The description of the inquiry.

merchant_referencestringOptional

The client's custom reference that was attached to the request and the mutation.

statusstringOptional

The status of the request.

minimum_ageintegerOptional

The minimum age the user accepting the RequestInquiry must have.

require_addressstringOptional

Whether or not an address must be provided on accept.

want_tipbooleanWrite-onlyOptional

[DEPRECATED] Whether or not the accepting user can give an extra tip on top of the requested Amount. Defaults to false.

allow_amount_lowerbooleanWrite-onlyOptional

[DEPRECATED] Whether or not the accepting user can choose to accept with a lower amount than requested. Defaults to false.

allow_amount_higherbooleanWrite-onlyOptional

[DEPRECATED] Whether or not the accepting user can choose to accept with a higher amount than requested. Defaults to false.

allow_bunqmebooleanWrite-onlyRequired

Whether or not sending a bunq.me request is allowed.

redirect_urlstringOptional

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

event_idintegerWrite-onlyOptional

The ID of the associated event if the request was made using 'split the bill'.

idintegerRead-onlyOptional

The id of the created RequestInquiry.

createdstringRead-onlyOptional

The timestamp of the payment request's creation.

updatedstringRead-onlyOptional

The timestamp of the payment request's last update.

time_respondedstringRead-onlyOptional

The timestamp of when the payment request was responded to.

time_expirystringRead-onlyOptional

The timestamp of when the payment request expired.

monetary_account_idintegerRead-onlyOptional

The id of the monetary account the request response applies to.

batch_idintegerRead-onlyOptional

The id of the batch if the request was part of a batch.

scheduled_idintegerRead-onlyOptional

The id of the scheduled job if the request was scheduled.

bunqme_share_urlstringRead-onlyOptional

The url that points to the bunq.me request.

Responses
200

RequestInquiry, aka 'RFP' (Request for Payment), is one of the innovative features that bunq offers. To request payment from another bunq account a new Request Inquiry is created. As with payments you can add attachments to a RFP. Requests for Payment are the foundation for a number of consumer features like 'Split the bill' and 'Request forwarding'. We invite you to invent your own based on the bunq api!

application/json
post
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry

Last updated

Was this helpful?