Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-134807111.3 MB
monetary-account-external-savings

Endpoint for managing monetary account savings which are connected to external services.

get/user/{userID}/monetary-account-external-savings

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

Response

Endpoint for managing monetary account savings which are connected to external services.

idinteger

The id of the MonetaryAccountExternalSavings.

createdstring

The timestamp of the MonetaryAccountExternalSavings's creation.

updatedstring

The timestamp of the MonetaryAccountExternalSavings's last update.

currencystring

The currency of the MonetaryAccountExternalSavings as an ISO 4217 formatted currency code.

descriptionstring

The description of the MonetaryAccountExternalSavings. Defaults to 'bunq account'.

public_uuidstring

The MonetaryAccountExternalSavings's public UUID.

statusstring

The status of the MonetaryAccountExternalSavings. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN

sub_statusstring

The sub-status of the MonetaryAccountExternalSavings providing extra information regarding the status. Will be NONE for ACTIVE or PENDING_REOPEN, COMPLETELY or ONLY_ACCEPTING_INCOMING for BLOCKED and REDEMPTION_INVOLUNTARY, REDEMPTION_VOLUNTARY or PERMANENT for CANCELLED.

reasonstring

The reason for voluntarily cancelling (closing) the MonetaryAccountExternalSavings, can only be OTHER.

reason_descriptionstring

The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountExternalSavings. Can be any user provided message.

user_idinteger

The id of the User who owns the MonetaryAccountExternalSavings.

display_namestring

The legal name of the user / company using this monetary account.

savings_goal_progressinteger

The progress in percentages for the Savings Goal set for this MonetaryAccountExternalSavings.

number_of_payment_remainingstring

The number of payments that can be made from this savings account