v1

latestOpenAPI 3.0.0Apache 2.02026-07-134807111.3 MB
request-response

Get all RequestResponses for a MonetaryAccount.

get/user/{userID}/monetary-account/{monetary-accountID}/request-response

Path parameters

userIDinteger required
monetary-accountIDinteger 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

A RequestResponse is what a user on the other side of a RequestInquiry gets when he is sent one. So a RequestInquiry is the initiator and visible for the user that sent it and that wants to receive the money. A RequestResponse is what the other side sees, i.e. the user that pays the money to accept the request. The content is almost identical.

idinteger

The id of the Request Response.

createdstring

The timestamp when the Request Response was created.

updatedstring

The timestamp when the Request Response was last updated (will be updated when chat messages are received).

time_respondedstring

The timestamp of when the RequestResponse was responded to.

time_expirystring

The timestamp of when the RequestResponse expired or will expire.

time_refund_requestedstring

The timestamp of when a refund request for the RequestResponse was claimed.

time_refundedstring

The timestamp of when the RequestResponse was refunded.

monetary_account_idinteger

The id of the MonetaryAccount the RequestResponse was received on.

statusstring

The status of the RequestResponse. Can be ACCEPTED, PENDING, REJECTED, REFUND_REQUESTED, REFUNDED or REVOKED.

descriptionstring

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

minimum_ageinteger

The minimum age the user accepting the RequestResponse must have.

require_addressstring

Whether or not an address must be provided on accept.

typestring

The type of the RequestInquiry. Can be DIRECT_DEBIT, DIRECT_DEBIT_B2B, IDEAL, SOFORT or INTERNAL.

sub_typestring

The subtype of the RequestInquiry. Can be ONCE or RECURRING for DIRECT_DEBIT RequestInquiries and NONE for all other.

redirect_urlstring

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

credit_scheme_identifierstring

The credit scheme id provided by the counterparty for DIRECT_DEBIT inquiries.

mandate_identifierstring

The mandate id provided by the counterparty for DIRECT_DEBIT inquiries.

registration_actionstring

Recommended registration action after IdealIssuerTransaction from iDEAL issuer transaction.

eligible_whitelist_idinteger

The whitelist id for this action or null.

event_idinteger

The ID of the latest event for the request.

monetary_account_preferred_idinteger

The ID of the monetary account this user prefers to pay the request from.