For the complete documentation index, see llms.txt. This page is also available as Markdown.

Share Invite Monetary Account Inquiry

Use this endpoint to invite another bunq user to access your monetary account with configurable permissions.

Endpoints

  • POST /v1/user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry

  • GET /v1/user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry/{itemId}

  • PUT /v1/user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry/{itemId}

Sending an invite

Specify the invitee via counter_user_alias and configure permissions in share_detail:

{
  "counter_user_alias": {
    "type": "EMAIL",
    "value": "invitee@example.com"
  },
  "share_detail": {
    "ShareDetailPayment": {
      "make_payments": false,
      "make_draft_payments": false,
      "view_balance": true,
      "view_old_events": false,
      "view_new_events": true
    }
  },
  "status": "PENDING",
  "share_type": "STANDARD"
}

The invite starts with status: PENDING until the invitee accepts or rejects it via Share Invite Monetary Account Response.

ShareDetailPayment fields

Field
Type
Description

make_payments

boolean

Allow the invitee to make payments from this account

make_draft_payments

boolean

Allow the invitee to create draft payments

view_balance

boolean

Allow the invitee to see the account balance

view_old_events

boolean

Allow the invitee to see past transactions

view_new_events

boolean

Allow the invitee to see new transactions

Last updated

Was this helpful?