Bunq · Schema

MonetaryAccountExternalSavings

Banking

Properties

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

JSON Schema

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