Monetary Account Savings | bunq API Documentation

post

Create new MonetaryAccountSavings.

Path parameters

userIDintegerRequired

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

currencystringOptional

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

descriptionstringOptional

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

avatar_uuidstringWrite-onlyOptional

The UUID of the Avatar of the MonetaryAccountSavings.

statusstringOptional

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

sub_statusstringOptional

The sub-status of the MonetaryAccountSavings 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.

reasonstringOptional

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

reason_descriptionstringOptional

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

idintegerRead-onlyOptional

The id of the MonetaryAccountSavings.

createdstringRead-onlyOptional

The timestamp of the MonetaryAccountSavings's creation.

updatedstringRead-onlyOptional

The timestamp of the MonetaryAccountSavings's last update.

public_uuidstringRead-onlyOptional

The MonetaryAccountSavings's public UUID.

user_idintegerRead-onlyOptional

The id of the User who owns the MonetaryAccountSavings.

savings_goal_progressintegerRead-onlyOptional

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

number_of_payment_remainingstringRead-onlyOptional

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

Responses

200

With MonetaryAccountSavings you can create a new savings account.

application/json

400

This is how the error response looks like for 4XX response codes

application/json

post

POST /v1/user/{userID}/monetary-account-savings HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Content-Type: application/json
Accept: */*
Content-Length: 451

{
  "currency": "text",
  "description": "text",
  "daily_limit": {
    "value": "text",
    "currency": "text"
  },
  "avatar_uuid": "text",
  "status": "text",
  "sub_status": "text",
  "reason": "text",
  "reason_description": "text",
  "all_co_owner": [
    {
      "alias": {
        "uuid": "text",
        "display_name": "text",
        "country": "text"
      }
    }
  ],
  "setting": {
    "color": "text",
    "icon": "text",
    "default_avatar_status": "text",
    "restriction_chat": "text",
    "sdd_expiration_action": "text"
  },
  "savings_goal": {
    "value": "text",
    "currency": "text"
  }
}

{
  "Id": {
    "id": 1
  }
}

get

Get a specific MonetaryAccountSavings.

Path parameters

userIDintegerRequired

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

With MonetaryAccountSavings you can create a new savings account.

application/json

400

This is how the error response looks like for 4XX response codes

application/json

get

GET /v1/user/{userID}/monetary-account-savings/{itemId} HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Accept: */*

{
  "id": 1,
  "created": "text",
  "updated": "text",
  "avatar": {
    "uuid": "text",
    "anchor_uuid": "text",
    "image": [
      {
        "attachment_public_uuid": "text",
        "content_type": "text",
        "height": 1,
        "width": 1
      }
    ],
    "style": "text"
  },
  "currency": "text",
  "description": "text",
  "daily_limit": {
    "value": "text",
    "currency": "text"
  },
  "balance": {
    "value": "text",
    "currency": "text"
  },
  "alias": [
    {
      "type": "text",
      "value": "text",
      "name": "text"
    }
  ],
  "public_uuid": "text",
  "status": "text",
  "sub_status": "text",
  "reason": "text",
  "reason_description": "text",
  "all_co_owner": [
    {
      "alias": {
        "uuid": "text",
        "display_name": "text",
        "country": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "text"
        },
        "public_nick_name": "text"
      },
      "status": "text"
    }
  ],
  "user_id": 1,
  "monetary_account_profile": {
    "profile_fill": {
      "status": "text",
      "balance_preferred": {
        "value": "text",
        "currency": "text"
      },
      "balance_threshold_low": {
        "value": "text",
        "currency": "text"
      },
      "issuer": {
        "bic": "text",
        "name": "text"
      }
    },
    "profile_drain": {
      "status": "text",
      "balance_preferred": {
        "value": "text",
        "currency": "text"
      },
      "balance_threshold_high": {
        "value": "text",
        "currency": "text"
      },
      "savings_account_alias": {
        "iban": "text",
        "display_name": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "text"
        },
        "label_user": {
          "uuid": "text",
          "display_name": "text",
          "country": "text",
          "avatar": {
            "uuid": "text",
            "anchor_uuid": "text",
            "image": [
              {
                "attachment_public_uuid": "text",
                "content_type": "text",
                "height": 1,
                "width": 1
              }
            ],
            "style": "text"
          },
          "public_nick_name": "text"
        },
        "country": "text",
        "bunq_me": {
          "type": "text",
          "value": "text",
          "name": "text"
        },
        "is_light": true,
        "swift_bic": "text",
        "swift_account_number": "text",
        "transferwise_account_number": "text",
        "transferwise_bank_code": "text",
        "merchant_category_code": "text"
      }
    }
  },
  "setting": {
    "color": "text",
    "icon": "text",
    "default_avatar_status": "text",
    "restriction_chat": "text",
    "sdd_expiration_action": "text"
  },
  "savings_goal": {
    "value": "text",
    "currency": "text"
  },
  "savings_goal_progress": 1,
  "number_of_payment_remaining": "text",
  "all_auto_save_id": [
    {
      "id": 1
    }
  ]
}

get

Gets a listing of all MonetaryAccountSavingss of a given user.

Path parameters

userIDintegerRequired

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

With MonetaryAccountSavings you can create a new savings account.

application/json

400

This is how the error response looks like for 4XX response codes

application/json

get

GET /v1/user/{userID}/monetary-account-savings HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Accept: */*

[
  {
    "id": 1,
    "created": "text",
    "updated": "text",
    "avatar": {
      "uuid": "text",
      "anchor_uuid": "text",
      "image": [
        {
          "attachment_public_uuid": "text",
          "content_type": "text",
          "height": 1,
          "width": 1
        }
      ],
      "style": "text"
    },
    "currency": "text",
    "description": "text",
    "daily_limit": {
      "value": "text",
      "currency": "text"
    },
    "balance": {
      "value": "text",
      "currency": "text"
    },
    "alias": [
      {
        "type": "text",
        "value": "text",
        "name": "text"
      }
    ],
    "public_uuid": "text",
    "status": "text",
    "sub_status": "text",
    "reason": "text",
    "reason_description": "text",
    "all_co_owner": [
      {
        "alias": {
          "uuid": "text",
          "display_name": "text",
          "country": "text",
          "avatar": {
            "uuid": "text",
            "anchor_uuid": "text",
            "image": [
              {
                "attachment_public_uuid": "text",
                "content_type": "text",
                "height": 1,
                "width": 1
              }
            ],
            "style": "text"
          },
          "public_nick_name": "text"
        },
        "status": "text"
      }
    ],
    "user_id": 1,
    "monetary_account_profile": {
      "profile_fill": {
        "status": "text",
        "balance_preferred": {
          "value": "text",
          "currency": "text"
        },
        "balance_threshold_low": {
          "value": "text",
          "currency": "text"
        },
        "issuer": {
          "bic": "text",
          "name": "text"
        }
      },
      "profile_drain": {
        "status": "text",
        "balance_preferred": {
          "value": "text",
          "currency": "text"
        },
        "balance_threshold_high": {
          "value": "text",
          "currency": "text"
        },
        "savings_account_alias": {
          "iban": "text",
          "display_name": "text",
          "avatar": {
            "uuid": "text",
            "anchor_uuid": "text",
            "image": [
              {
                "attachment_public_uuid": "text",
                "content_type": "text",
                "height": 1,
                "width": 1
              }
            ],
            "style": "text"
          },
          "label_user": {
            "uuid": "text",
            "display_name": "text",
            "country": "text",
            "avatar": {
              "uuid": "text",
              "anchor_uuid": "text",
              "image": [
                {
                  "attachment_public_uuid": "text",
                  "content_type": "text",
                  "height": 1,
                  "width": 1
                }
              ],
              "style": "text"
            },
            "public_nick_name": "text"
          },
          "country": "text",
          "bunq_me": {
            "type": "text",
            "value": "text",
            "name": "text"
          },
          "is_light": true,
          "swift_bic": "text",
          "swift_account_number": "text",
          "transferwise_account_number": "text",
          "transferwise_bank_code": "text",
          "merchant_category_code": "text"
        }
      }
    },
    "setting": {
      "color": "text",
      "icon": "text",
      "default_avatar_status": "text",
      "restriction_chat": "text",
      "sdd_expiration_action": "text"
    },
    "savings_goal": {
      "value": "text",
      "currency": "text"
    },
    "savings_goal_progress": 1,
    "number_of_payment_remaining": "text",
    "all_auto_save_id": [
      {
        "id": 1
      }
    ]
  }
]

put

Update a specific existing MonetaryAccountSavings.

Path parameters

userIDintegerRequired

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

currencystringOptional

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

descriptionstringOptional

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

avatar_uuidstringWrite-onlyOptional

The UUID of the Avatar of the MonetaryAccountSavings.

statusstringOptional

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

sub_statusstringOptional

The sub-status of the MonetaryAccountSavings 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.

reasonstringOptional

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

reason_descriptionstringOptional

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

idintegerRead-onlyOptional

The id of the MonetaryAccountSavings.

createdstringRead-onlyOptional

The timestamp of the MonetaryAccountSavings's creation.

updatedstringRead-onlyOptional

The timestamp of the MonetaryAccountSavings's last update.

public_uuidstringRead-onlyOptional

The MonetaryAccountSavings's public UUID.

user_idintegerRead-onlyOptional

The id of the User who owns the MonetaryAccountSavings.

savings_goal_progressintegerRead-onlyOptional

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

number_of_payment_remainingstringRead-onlyOptional

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

Responses

200

With MonetaryAccountSavings you can create a new savings account.

application/json

400

This is how the error response looks like for 4XX response codes

application/json

put

PUT /v1/user/{userID}/monetary-account-savings/{itemId} HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Content-Type: application/json
Accept: */*
Content-Length: 451

{
  "currency": "text",
  "description": "text",
  "daily_limit": {
    "value": "text",
    "currency": "text"
  },
  "avatar_uuid": "text",
  "status": "text",
  "sub_status": "text",
  "reason": "text",
  "reason_description": "text",
  "all_co_owner": [
    {
      "alias": {
        "uuid": "text",
        "display_name": "text",
        "country": "text"
      }
    }
  ],
  "setting": {
    "color": "text",
    "icon": "text",
    "default_avatar_status": "text",
    "restriction_chat": "text",
    "sdd_expiration_action": "text"
  },
  "savings_goal": {
    "value": "text",
    "currency": "text"
  }
}

{
  "Id": {
    "id": 1
  }
}