Bunq · Schema

ShareInviteMonetaryAccountResponse

Banking

Properties

Name	Type	Description
status	string	The status of the share. Can be ACTIVE, REVOKED, REJECTED.
card_id	integer	The card to link to the shared monetary account. Used only if share_detail is ShareDetailCardPayment.
id	integer	The id of the ShareInviteBankResponse.
created	string	The timestamp of the ShareInviteBankResponse creation.
updated	string	The timestamp of the ShareInviteBankResponse last update.
counter_alias	object	The monetary account and user who created the share.
user_alias_cancelled	object	The user who cancelled the share if it has been revoked or rejected.
monetary_account_id	integer	The id of the monetary account the ACCEPTED share applies to. null otherwise.
draft_share_invite_bank_id	integer	The id of the draft share invite bank.
share_detail	object	The share details.
access_type	string	Type of access that is wanted, one of VIEW_BALANCE, VIEW_TRANSACTION, DRAFT_PAYMENT or FULL_TRANSIENT
relation_user	object	All of the relation users towards this MA.
share_type	string	The share type, either STANDARD or MUTUAL.
start_date	string	The start date of this share.
end_date	string	The expiration date of this share.
description	string	The description of this share. It is basically the monetary account description.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ShareInviteMonetaryAccountResponse",
  "title": "ShareInviteMonetaryAccountResponse",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The status of the share. Can be ACTIVE, REVOKED, REJECTED.",
      "readOnly": false,
      "writeOnly": false
    },
    "card_id": {
      "type": "integer",
      "description": "The card to link to the shared monetary account. Used only if share_detail is ShareDetailCardPayment.",
      "readOnly": false,
      "writeOnly": true
    },
    "id": {
      "type": "integer",
      "description": "The id of the ShareInviteBankResponse.",
      "readOnly": true,
      "writeOnly": false
    },
    "created": {
      "type": "string",
      "description": "The timestamp of the ShareInviteBankResponse creation.",
      "readOnly": true,
      "writeOnly": false
    },
    "updated": {
      "type": "string",
      "description": "The timestamp of the ShareInviteBankResponse last update.",
      "readOnly": true,
      "writeOnly": false
    },
    "counter_alias": {
      "type": "object",
      "description": "The monetary account and user who created the share.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/LabelMonetaryAccount"
    },
    "user_alias_cancelled": {
      "type": "object",
      "description": "The user who cancelled the share if it has been revoked or rejected.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/LabelUser"
    },
    "monetary_account_id": {
      "type": "integer",
      "description": "The id of the monetary account the ACCEPTED share applies to. null otherwise.",
      "readOnly": true,
      "writeOnly": false
    },
    "draft_share_invite_bank_id": {
      "type": "integer",
      "description": "The id of the draft share invite bank.",
      "readOnly": true,
      "writeOnly": false
    },
    "share_detail": {
      "type": "object",
      "description": "The share details.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/ShareDetail"
    },
    "access_type": {
      "type": "string",
      "description": "Type of access that is wanted, one of VIEW_BALANCE, VIEW_TRANSACTION, DRAFT_PAYMENT or FULL_TRANSIENT",
      "readOnly": true,
      "writeOnly": false
    },
    "relation_user": {
      "type": "object",
      "description": "All of the relation users towards this MA.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/RelationUser"
    },
    "share_type": {
      "type": "string",
      "description": "The share type, either STANDARD or MUTUAL.",
      "readOnly": true,
      "writeOnly": false
    },
    "start_date": {
      "type": "string",
      "description": "The start date of this share.",
      "readOnly": true,
      "writeOnly": false
    },
    "end_date": {
      "type": "string",
      "description": "The expiration date of this share.",
      "readOnly": true,
      "writeOnly": false
    },
    "description": {
      "type": "string",
      "description": "The description of this share. It is basically the monetary account description.",
      "readOnly": true,
      "writeOnly": false
    }
  }
}