Bunq · Schema

MonetaryAccountSavingsRead

Banking

Properties

Name Type Description
id integer The id of the MonetaryAccountSavings.
created string The timestamp of the MonetaryAccountSavings's creation.
updated string The timestamp of the MonetaryAccountSavings's last update.
avatar object The Avatar of the MonetaryAccountSavings.
currency string The currency of the MonetaryAccountSavings as an ISO 4217 formatted currency code.
description string The description of the MonetaryAccountSavings. Defaults to 'bunq account'.
daily_limit object The daily spending limit Amount of the MonetaryAccountSavings. Defaults to 1000 EUR. Currency must match the MonetaryAccountSavings's currency. Limited to 10000 EUR.
balance object The current available balance Amount of the MonetaryAccountSavings.
alias array The Aliases for the MonetaryAccountSavings.
public_uuid string The MonetaryAccountSavings's public UUID.
status string The status of the MonetaryAccountSavings. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN
sub_status string 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 REDEMPTI
reason string The reason for voluntarily cancelling (closing) the MonetaryAccountSavings, can only be OTHER.
reason_description string The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountSavings. Can be any user provided message.
all_co_owner array The users the account will be joint with.
user_id integer The id of the User who owns the MonetaryAccountSavings.
monetary_account_profile object The profile of the account.
setting object The settings of the MonetaryAccountSavings.
savings_goal object The Savings Goal set for this MonetaryAccountSavings.
savings_goal_progress integer The progress in percentages for the Savings Goal set for this MonetaryAccountSavings.
number_of_payment_remaining string The number of payments that can be made from this savings account
all_auto_save_id array The ids of the AutoSave.
View JSON Schema on GitHub

JSON Schema

bunq-monetaryaccountsavingsread-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MonetaryAccountSavingsRead",
  "title": "MonetaryAccountSavingsRead",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The id of the MonetaryAccountSavings.",
      "readOnly": true,
      "writeOnly": false
    },
    "created": {
      "type": "string",
      "description": "The timestamp of the MonetaryAccountSavings's creation.",
      "readOnly": true,
      "writeOnly": false
    },
    "updated": {
      "type": "string",
      "description": "The timestamp of the MonetaryAccountSavings's last update.",
      "readOnly": true,
      "writeOnly": false
    },
    "avatar": {
      "type": "object",
      "description": "The Avatar of the MonetaryAccountSavings.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Avatar"
    },
    "currency": {
      "type": "string",
      "description": "The currency of the MonetaryAccountSavings as an ISO 4217 formatted currency code.",
      "readOnly": true,
      "writeOnly": false
    },
    "description": {
      "type": "string",
      "description": "The description of the MonetaryAccountSavings. Defaults to 'bunq account'.",
      "readOnly": true,
      "writeOnly": false
    },
    "daily_limit": {
      "type": "object",
      "description": "The daily spending limit Amount of the MonetaryAccountSavings. Defaults to 1000 EUR. Currency must match the MonetaryAccountSavings's currency. Limited to 10000 EUR.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Amount"
    },
    "balance": {
      "type": "object",
      "description": "The current available balance Amount of the MonetaryAccountSavings.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Amount"
    },
    "alias": {
      "type": "array",
      "description": "The Aliases for the MonetaryAccountSavings.",
      "readOnly": true,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/Pointer"
      }
    },
    "public_uuid": {
      "type": "string",
      "description": "The MonetaryAccountSavings's public UUID.",
      "readOnly": true,
      "writeOnly": false
    },
    "status": {
      "type": "string",
      "description": "The status of the MonetaryAccountSavings. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN",
      "readOnly": true,
      "writeOnly": false
    },
    "sub_status": {
      "type": "string",
      "description": "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.",
      "readOnly": true,
      "writeOnly": false
    },
    "reason": {
      "type": "string",
      "description": "The reason for voluntarily cancelling (closing) the MonetaryAccountSavings, can only be OTHER.",
      "readOnly": true,
      "writeOnly": false
    },
    "reason_description": {
      "type": "string",
      "description": "The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountSavings. Can be any user provided message.",
      "readOnly": true,
      "writeOnly": false
    },
    "all_co_owner": {
      "type": "array",
      "description": "The users the account will be joint with.",
      "readOnly": true,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/CoOwner"
      }
    },
    "user_id": {
      "type": "integer",
      "description": "The id of the User who owns the MonetaryAccountSavings.",
      "readOnly": true,
      "writeOnly": false
    },
    "monetary_account_profile": {
      "type": "object",
      "description": "The profile of the account.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/MonetaryAccountProfile"
    },
    "setting": {
      "type": "object",
      "description": "The settings of the MonetaryAccountSavings.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/MonetaryAccountSetting"
    },
    "savings_goal": {
      "type": "object",
      "description": "The Savings Goal set for this MonetaryAccountSavings.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Amount"
    },
    "savings_goal_progress": {
      "type": "integer",
      "description": "The progress in percentages for the Savings Goal set for this MonetaryAccountSavings.",
      "readOnly": true,
      "writeOnly": false
    },
    "number_of_payment_remaining": {
      "type": "string",
      "description": "The number of payments that can be made from this savings account",
      "readOnly": true,
      "writeOnly": false
    },
    "all_auto_save_id": {
      "type": "array",
      "description": "The ids of the AutoSave.",
      "readOnly": true,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/BunqId"
      }
    }
  }
}