--- title: "GET /user/{userID}/share-invite-monetary-account-response/{itemId}" method: GET path: "/user/{userID}/share-invite-monetary-account-response/{itemId}" tags: ["share-invite-monetary-account-response"] --- # GET /user/{userID}/share-invite-monetary-account-response/{itemId} `GET /user/{userID}/share-invite-monetary-account-response/{itemId}` ## Request - Base URL: `https://public-api.sandbox.bunq.com/v1` - URL: `https://public-api.sandbox.bunq.com/v1/user/{userID}/share-invite-monetary-account-response/{itemId}` - Auth: none declared. Required headers: `User-Agent`, `X-Bunq-Client-Authentication` Return the details of a specific share a user was invited to. ## Path parameters - `userID` integer, required - `itemId` integer, required ## Headers - `Cache-Control` string - `User-Agent` string, required - `X-Bunq-Language` string - `X-Bunq-Region` string - `X-Bunq-Client-Request-Id` string - `X-Bunq-Geolocation` string - `X-Bunq-Client-Authentication` string, required ## Response `200` Used to view or respond to shares a user was invited to. See 'share-invite-bank-inquiry' for more information about the inquiring endpoint. - ShareInviteMonetaryAccountResponseRead - `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` LabelMonetaryAccount - `iban` string: The IBAN of the monetary account. - `display_name` string: The name to display with this monetary account. - `avatar` Avatar - `uuid` string: The public UUID of the avatar. - `anchor_uuid` string: The public UUID of object this avatar is anchored to. - `image` Image[]: The actual image information of this avatar. - `attachment_public_uuid` string: The public UUID of the public attachment containing the image. - `content_type` string: The content-type as a MIME filetype. - `height` integer: The image height in pixels. - `width` integer: The image width in pixels. - `style` string: The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string: The public UUID of the label-user. - `display_name` string: The name to be displayed for this user, as it was given on the request. - `country` string: The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string: The public UUID of the avatar. - `anchor_uuid` string: The public UUID of object this avatar is anchored to. - `image` Image[]: The actual image information of this avatar. - `attachment_public_uuid` string: The public UUID of the public attachment containing the image. - `content_type` string: The content-type as a MIME filetype. - `height` integer: The image height in pixels. - `width` integer: The image width in pixels. - `style` string: The style (if applicable) for this Avatar. - `public_nick_name` string: The current nickname of the user. - `country` string: The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string: The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string: The alias value. - `name` string: The alias name. - `service` string: The pointer service. Only required for external counterparties. - `is_light` boolean: Whether or not the monetary account is light. - `swift_bic` string: The BIC used for a SWIFT payment. - `swift_account_number` string: The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string: The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string: The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string: The merchant category code. - `user_alias_cancelled` LabelUser - `uuid` string: The public UUID of the label-user. - `display_name` string: The name to be displayed for this user, as it was given on the request. - `country` string: The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string: The public UUID of the avatar. - `anchor_uuid` string: The public UUID of object this avatar is anchored to. - `image` Image[]: The actual image information of this avatar. - `attachment_public_uuid` string: The public UUID of the public attachment containing the image. - `content_type` string: The content-type as a MIME filetype. - `height` integer: The image height in pixels. - `width` integer: The image width in pixels. - `style` string: The style (if applicable) for this Avatar. - `public_nick_name` string: The current nickname of the user. - `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` ShareDetail - `payment` ShareDetailPayment - `make_payments` boolean: If set to true, the invited user will be able to make payments from the shared account. - `make_draft_payments` boolean: If set to true, the invited user will be able to make draft payments from the shared account. - `view_balance` boolean: If set to true, the invited user will be able to view the account balance. - `view_old_events` boolean: If set to true, the invited user will be able to view events from before the share was active. - `view_new_events` boolean: If set to true, the invited user will be able to view events starting from the time the share became active. - `read_only` ShareDetailReadOnly - `view_balance` boolean: If set to true, the invited user will be able to view the account balance. - `view_old_events` boolean: If set to true, the invited user will be able to view events from before the share was active. - `view_new_events` boolean: If set to true, the invited user will be able to view events starting from the time the share became active. - `draft_payment` ShareDetailDraftPayment - `make_draft_payments` boolean: If set to true, the invited user will be able to make draft payments from the shared account. - `view_balance` boolean: If set to true, the invited user will be able to view the account balance. - `view_old_events` boolean: If set to true, the invited user will be able to view events from before the share was active. - `view_new_events` boolean: If set to true, the invited user will be able to view events starting from the time the share became active. - `access_type` string: Type of access that is wanted, one of VIEW_BALANCE, VIEW_TRANSACTION, DRAFT_PAYMENT or FULL_TRANSIENT - `status` string: The status of the share. Can be ACTIVE, REVOKED, REJECTED. - `relation_user` RelationUser - `user_id` string: The user's ID. - `counter_user_id` string: The counter user's ID. - `label_user` LabelUser - `uuid` string: The public UUID of the label-user. - `display_name` string: The name to be displayed for this user, as it was given on the request. - `country` string: The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string: The public UUID of the avatar. - `anchor_uuid` string: The public UUID of object this avatar is anchored to. - `image` Image[]: The actual image information of this avatar. - `attachment_public_uuid` string: The public UUID of the public attachment containing the image. - `content_type` string: The content-type as a MIME filetype. - `height` integer: The image height in pixels. - `width` integer: The image width in pixels. - `style` string: The style (if applicable) for this Avatar. - `public_nick_name` string: The current nickname of the user. - `counter_label_user` LabelUser - `uuid` string: The public UUID of the label-user. - `display_name` string: The name to be displayed for this user, as it was given on the request. - `country` string: The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string: The public UUID of the avatar. - `anchor_uuid` string: The public UUID of object this avatar is anchored to. - `image` Image[]: The actual image information of this avatar. - `attachment_public_uuid` string: The public UUID of the public attachment containing the image. - `content_type` string: The content-type as a MIME filetype. - `height` integer: The image height in pixels. - `width` integer: The image width in pixels. - `style` string: The style (if applicable) for this Avatar. - `public_nick_name` string: The current nickname of the user. - `relationship` string: The requested relation type. - `status` string: The request's status, only for UPDATE. - `user_status` string: The account status of a user - `counter_user_status` string: The account status of a user - `company_employee_setting_adyen_card_transaction` CompanyEmployeeSettingAdyenCardTransaction - `pointer_counter_user` Pointer, required - `type` string: The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string: The alias value. - `name` string: The alias name. - `service` string: The pointer service. Only required for external counterparties. - `status` string: Whether the user is allowed to use Tap to Pay. - `monetary_account_payout_id` integer: The ID of the monetary account where Tap to Pay transactions should be paid out to. - `all_company_employee_card` CompanyEmployeeCard[]: Cards accessible by the company employee - `pointer_counter_user` Pointer, required - `type` string: The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string: The alias value. - `name` string: The alias name. - `service` string: The pointer service. Only required for external counterparties. - `pointer_monetary_account` Pointer, required - `type` string: The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string: The alias value. - `name` string: The alias name. - `service` string: The pointer service. Only required for external counterparties. - `type` string, required: The type of card to order. - `product_type` string, required: The product type of the card to order. - `company_name_on_card` string: The name of the company that should be displayed on the card. - `employee_name_on_card` string: The name of the employee that should be displayed on the card. - `employee_preferred_name_on_card` string: The user's preferred name as it will be on the card. - `amount_limit_monthly` Amount - `value` string: The amount formatted to two decimal places. - `currency` string: The currency of the amount. It is an ISO 4217 formatted currency code. - `status` string: The status of the employee card. - `card` Card - `pin_code` string: The plaintext pin code. Requests require encryption to be enabled. - `activation_code` string: DEPRECATED: Activate a card by setting status to ACTIVE when the order_status is ACCEPTED_FOR_PRODUCTION. - `status` string: The status to set for the card. Can be ACTIVE, DEACTIVATED, LOST, STOLEN or CANCELLED, and can only be set to LOST/STOLEN/CANCELLED when order status is ACCEPTED_FOR_PRODUCTION/DELIVERED_TO_CUSTOMER/CARD_UPDATE_REQUESTED/CARD_UPDATE_SENT/CARD_UPDATE_ACCEPTED. Can only be set to DEACTIVATED after initial activation, i.e. order_status is DELIVERED_TO_CUSTOMER/CARD_UPDATE_REQUESTED/CARD_UPDATE_SENT/CARD_UPDATE_ACCEPTED. Mind that all the possible choices (apart from ACTIVE and DEACTIVATED) are permanent and cannot be changed after. - `order_status` string: The order status to set for the card. Set to CARD_REQUEST_PENDING to get a virtual card produced. - `card_limit` Amount - `value` string: The amount formatted to two decimal places. - `currency` string: The currency of the amount. It is an ISO 4217 formatted currency code. - `card_limit_atm` Amount - `value` string: The amount formatted to two decimal places. - `currency` string: The currency of the amount. It is an ISO 4217 formatted currency code. - `country_permission` CardCountryPermission[]: The countries for which to grant (temporary) permissions to use the card. - `country` string: The country to allow transactions in (e.g. NL, DE). - `expiry_time` string: Expiry time of this rule. - `id` integer: The id of the card country permission entry. - `pin_code_assignment` CardPinAssignment[]: Array of Types, PINs, account IDs assigned to the card. - `type` string: PIN type. Can be PRIMARY, SECONDARY or TERTIARY - `routing_type` string: Routing type. - `pin_code` string: The 4 digit PIN to be assigned to this account. - `monetary_account_id` integer: The ID of the monetary account to assign to this pin for the card. - `status` string: The status of the card pin assignment. - `primary_account_numbers` CardPrimaryAccountNumber[]: Array of PANs and their attributes. - `id` integer: The ID for this Virtual PAN. - `description` string: The description for this PAN. - `status` string: The status for this PAN, only for Online Cards. - `monetary_account_id` integer: The ID of the monetary account to assign to this PAN, only for Online Cards. - `uuid` string: The UUID for this Virtual PAN. - `four_digit` string: The last four digits of the PAN. - `type` string: The type of the PAN. - `monetary_account_id_fallback` integer: ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied. - `preferred_name_on_card` string: The user's preferred name as it will be on the card. - `second_line` string: The second line of text on the card - `cancellation_reason` string: The reason for card cancellation. - `amount_spent_monthly` Amount - `value` string: The amount formatted to two decimal places. - `currency` string: The currency of the amount. It is an ISO 4217 formatted currency code. - `number_of_company_employee_card_receipt_pending` integer: The number of transactions that still need a receipt. - `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. ## Other responses - `400`: This is how the error response looks like for 4XX response codes ## Changes - **2024-11-28** `1046cf774ccf`: 3 warning, 5 info - removed the optional property `relation_user/all_company_employee_card/items/relation_user_id` from the response with the `200` status - removed the optional property `relation_user/company_employee_setting_adyen_card_transaction/relation_user_id` from the response with the `200` status - removed the optional property `relation_user/number_of_company_employee_card_receipt_pending` from the response with the `200` status - added the optional property `relation_user/all_company_employee_card/items/number_of_company_employee_card_receipt_pending` to the response with the `200` status - …4 more - **2024-11-27** `818f9a4297e2`: 3 info - added the optional property `relation_user/all_company_employee_card` to the response with the `200` status - added the optional property `relation_user/company_employee_setting_adyen_card_transaction` to the response with the `200` status - added the optional property `relation_user/number_of_company_employee_card_receipt_pending` to the response with the `200` status - **2024-01-08** `8dfb44c77ea0`: 2 warning - removed the optional property `relation_user/all_company_employee_card` from the response with the `200` status - removed the optional property `relation_user/company_employee_setting_adyen_card_transaction` from the response with the `200` status [Operation history](https://skmtc.dev/bunq/apis/bunq-api/changes/user/:userID/share-invite-monetary-account-response/:itemId/get.md) --- [API](https://skmtc.dev/bunq/apis/bunq-api.md) - [All operations](https://skmtc.dev/bunq/apis/bunq-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bunq/apis/bunq-api/revisions/369477c7bd26?raw)