Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-134807111.3 MB
payment

Get a listing of all Payments performed on a given MonetaryAccount (incoming and outgoing).

get/user/{userID}/monetary-account/{monetary-accountID}/payment

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

Using Payment, you can send payments to bunq and non-bunq users from your bunq MonetaryAccounts. This can be done using bunq Aliases or IBAN Aliases. When transferring money to other bunq MonetaryAccounts you can also refer to Attachments. These will be received by the counter-party as part of the Payment. You can also retrieve a single Payment or all executed Payments of a specific monetary account.

idinteger

The id of the created Payment.

createdstring

The timestamp when the Payment was done.

updatedstring

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

monetary_account_idinteger

The id of the MonetaryAccount the Payment was made to or from (depending on whether this is an incoming or outgoing Payment).

descriptionstring

The description for the Payment. Maximum 140 characters for Payments to external IBANs, 9000 characters for Payments to only other bunq MonetaryAccounts.

typestring

The type of Payment, can be BUNQ, EBA_SCT, EBA_SDD, IDEAL, SWIFT or FIS (card).

sub_typestring

The sub-type of the Payment, can be PAYMENT, WITHDRAWAL, REVERSAL, REQUEST, BILLING, SCT, SDD or NLO.

bunqto_statusstring

The status of the bunq.to payment.

bunqto_sub_statusstring

The sub status of the bunq.to payment.

bunqto_share_urlstring

The status of the bunq.to payment.

bunqto_expirystring

When bunq.to payment is about to expire.

bunqto_time_respondedstring

The timestamp of when the bunq.to payment was responded to.

merchant_referencestring

Optional data included with the Payment specific to the merchant.

batch_idinteger

The id of the PaymentBatch if this Payment was part of one.

scheduled_idinteger

The id of the JobScheduled if the Payment was scheduled.