[deprecated] Share Invite Monetary Account Inquiry

PreviousSession NextShare Invite Monetary Account Response

Last updated 1 month ago

Was this helpful?

[DEPRECATED - use /share-invite-monetary-account-response] Get a list with all the share inquiries for a monetary account, only if the requesting user has permission to change the details of the various ones.

Path parameters

userIDintegerRequired

monetary-accountIDintegerRequired

Header parameters

Cache-ControlstringOptional

The standard HTTP Cache-Control header is required for all signed requests.

User-AgentstringRequired

The User-Agent header field should contain information about the user agent originating the request. There are no restrictions on the value of this header.

X-Bunq-LanguagestringOptional

The X-Bunq-Language header must contain a preferred language indication. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore. Currently only the languages en_US and nl_NL are supported. Anything else will default to en_US.

X-Bunq-RegionstringOptional

The X-Bunq-Region header must contain the region (country) of the client device. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore.

X-Bunq-Client-Request-IdstringOptional

This header must specify an ID with each request that is unique for the logged in user. There are no restrictions for the format of this ID. However, the server will respond with an error when the same ID is used again on the same DeviceServer.

X-Bunq-GeolocationstringOptional

This header must specify the geolocation of the device. The format of this value is longitude latitude altitude radius country. The country is expected to be formatted of an ISO 3166-1 alpha-2 country code. When no geolocation is available or known the header must still be included but can be zero valued.

X-Bunq-Client-AuthenticationstringRequired

The authentication token is used to authenticate the source of the API call. It is required by all API calls except for POST /v1/installation. It is important to note that the device and session calls are using the token from the response of the installation call, while all the other calls use the token from the response of the session-server call

Responses

get

GET /v1/user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Accept: */*

[
  {
    "alias": {
      "iban": "text",
      "display_name": "text",
      "avatar": {
        "uuid": "text",
        "anchor_uuid": "text",
        "image": [
          {
            "attachment_public_uuid": "text",
            "content_type": "text",
            "height": 1,
            "width": 1
          }
        ],
        "style": "text"
      },
      "label_user": {
        "uuid": "text",
        "display_name": "text",
        "country": "text",
        "avatar": {
          "uuid": "text",
          "anchor_uuid": "text",
          "image": [
            {
              "attachment_public_uuid": "text",
              "content_type": "text",
              "height": 1,
              "width": 1
            }
          ],
          "style": "text"
        },
        "public_nick_name": "text"
      },
      "country": "text",
      "bunq_me": {
        "type": "text",
        "value": "text",
        "name": "text"
      },
      "is_light": true,
      "swift_bic": "text",
      "swift_account_number": "text",
      "transferwise_account_number": "text",
      "transferwise_bank_code": "text",
      "merchant_category_code": "text"
    },
    "user_alias_created": {
      "uuid": "text",
      "display_name": "text",
      "country": "text",
      "avatar": {
        "uuid": "text",
        "anchor_uuid": "text",
        "image": [
          {
            "attachment_public_uuid": "text",
            "content_type": "text",
            "height": 1,
            "width": 1
          }
        ],
        "style": "text"
      },
      "public_nick_name": "text"
    },
    "user_alias_revoked": {
      "uuid": "text",
      "display_name": "text",
      "country": "text",
      "avatar": {
        "uuid": "text",
        "anchor_uuid": "text",
        "image": [
          {
            "attachment_public_uuid": "text",
            "content_type": "text",
            "height": 1,
            "width": 1
          }
        ],
        "style": "text"
      },
      "public_nick_name": "text"
    },
    "counter_user_alias": {
      "uuid": "text",
      "display_name": "text",
      "country": "text",
      "avatar": {
        "uuid": "text",
        "anchor_uuid": "text",
        "image": [
          {
            "attachment_public_uuid": "text",
            "content_type": "text",
            "height": 1,
            "width": 1
          }
        ],
        "style": "text"
      },
      "public_nick_name": "text"
    },
    "monetary_account_id": 1,
    "status": "text",
    "access_type": "text",
    "relationship": "text",
    "id": 1
  }
]

[DEPRECATED - use /share-invite-monetary-account-response] Get the details of a specific share inquiry.

Path parameters

userIDintegerRequired

monetary-accountIDintegerRequired

itemIdintegerRequired

Header parameters

Cache-ControlstringOptional

The standard HTTP Cache-Control header is required for all signed requests.

User-AgentstringRequired

The User-Agent header field should contain information about the user agent originating the request. There are no restrictions on the value of this header.

X-Bunq-LanguagestringOptional

X-Bunq-RegionstringOptional

X-Bunq-Client-Request-IdstringOptional

X-Bunq-GeolocationstringOptional

X-Bunq-Client-AuthenticationstringRequired

Responses

get

GET /v1/user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry/{itemId} HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Accept: */*

{
  "alias": {
    "iban": "text",
    "display_name": "text",
    "avatar": {
      "uuid": "text",
      "anchor_uuid": "text",
      "image": [
        {
          "attachment_public_uuid": "text",
          "content_type": "text",
          "height": 1,
          "width": 1
        }
      ],
      "style": "text"
    },
    "label_user": {
      "uuid": "text",
      "display_name": "text",
      "country": "text",
      "avatar": {
        "uuid": "text",
        "anchor_uuid": "text",
        "image": [
          {
            "attachment_public_uuid": "text",
            "content_type": "text",
            "height": 1,
            "width": 1
          }
        ],
        "style": "text"
      },
      "public_nick_name": "text"
    },
    "country": "text",
    "bunq_me": {
      "type": "text",
      "value": "text",
      "name": "text"
    },
    "is_light": true,
    "swift_bic": "text",
    "swift_account_number": "text",
    "transferwise_account_number": "text",
    "transferwise_bank_code": "text",
    "merchant_category_code": "text"
  },
  "user_alias_created": {
    "uuid": "text",
    "display_name": "text",
    "country": "text",
    "avatar": {
      "uuid": "text",
      "anchor_uuid": "text",
      "image": [
        {
          "attachment_public_uuid": "text",
          "content_type": "text",
          "height": 1,
          "width": 1
        }
      ],
      "style": "text"
    },
    "public_nick_name": "text"
  },
  "user_alias_revoked": {
    "uuid": "text",
    "display_name": "text",
    "country": "text",
    "avatar": {
      "uuid": "text",
      "anchor_uuid": "text",
      "image": [
        {
          "attachment_public_uuid": "text",
          "content_type": "text",
          "height": 1,
          "width": 1
        }
      ],
      "style": "text"
    },
    "public_nick_name": "text"
  },
  "counter_user_alias": {
    "uuid": "text",
    "display_name": "text",
    "country": "text",
    "avatar": {
      "uuid": "text",
      "anchor_uuid": "text",
      "image": [
        {
          "attachment_public_uuid": "text",
          "content_type": "text",
          "height": 1,
          "width": 1
        }
      ],
      "style": "text"
    },
    "public_nick_name": "text"
  },
  "monetary_account_id": 1,
  "status": "text",
  "access_type": "text",
  "relationship": "text",
  "id": 1
}

[DEPRECATED - use /share-invite-monetary-account-response] Create a new share inquiry for a monetary account, specifying the permission the other bunq user will have on it.

Path parameters

userIDintegerRequired

monetary-accountIDintegerRequired

Header parameters

Cache-ControlstringOptional

The standard HTTP Cache-Control header is required for all signed requests.

User-AgentstringRequired

The User-Agent header field should contain information about the user agent originating the request. There are no restrictions on the value of this header.

X-Bunq-LanguagestringOptional

X-Bunq-RegionstringOptional

X-Bunq-Client-Request-IdstringOptional

X-Bunq-GeolocationstringOptional

X-Bunq-Client-AuthenticationstringRequired

Body

access_typestringOptional

Type of access that is in place.

draft_share_invite_bank_idintegerWrite-onlyOptional

DEPRECATED: USE access_type INSTEAD | The id of the draft share invite bank.

statusstringOptional

The status of the share. Can be ACTIVE, REVOKED, REJECTED.

relationshipstringOptional

The relationship: COMPANY_DIRECTOR, COMPANY_EMPLOYEE, etc

share_typestringWrite-onlyOptional

DEPRECATED: USE access_type INSTEAD | The share type, either STANDARD or MUTUAL.

start_datestringWrite-onlyOptional

DEPRECATED: USE access_type INSTEAD | The start date of this share.

end_datestringWrite-onlyOptional

DEPRECATED: USE access_type INSTEAD | The expiration date of this share.

monetary_account_idintegerRead-onlyOptional

The id of the monetary account the share applies to.

idintegerRead-onlyOptional

The id of the newly created share invite.

Responses

post

POST /v1/user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Content-Type: application/json
Accept: */*
Content-Length: 559

{
  "counter_user_alias": {
    "uuid": "text",
    "display_name": "text",
    "country": "text"
  },
  "access_type": "text",
  "draft_share_invite_bank_id": 1,
  "share_detail": {
    "payment": {
      "make_payments": true,
      "make_draft_payments": true,
      "view_balance": true,
      "view_old_events": true,
      "view_new_events": true
    },
    "read_only": {
      "view_balance": true,
      "view_old_events": true,
      "view_new_events": true
    },
    "draft_payment": {
      "make_draft_payments": true,
      "view_balance": true,
      "view_old_events": true,
      "view_new_events": true
    }
  },
  "status": "text",
  "relationship": "text",
  "share_type": "text",
  "start_date": "text",
  "end_date": "text"
}

{
  "id": 1
}

[DEPRECATED - use /share-invite-monetary-account-response] Update the details of a share. This includes updating status (revoking or cancelling it), granted permission and validity period of this share.

Path parameters

userIDintegerRequired

monetary-accountIDintegerRequired

itemIdintegerRequired

Header parameters

Cache-ControlstringOptional

The standard HTTP Cache-Control header is required for all signed requests.

User-AgentstringRequired

The User-Agent header field should contain information about the user agent originating the request. There are no restrictions on the value of this header.

X-Bunq-LanguagestringOptional

X-Bunq-RegionstringOptional

X-Bunq-Client-Request-IdstringOptional

X-Bunq-GeolocationstringOptional

X-Bunq-Client-AuthenticationstringRequired

Body

access_typestringOptional

Type of access that is in place.

draft_share_invite_bank_idintegerWrite-onlyOptional

DEPRECATED: USE access_type INSTEAD | The id of the draft share invite bank.

statusstringOptional

The status of the share. Can be ACTIVE, REVOKED, REJECTED.

relationshipstringOptional

The relationship: COMPANY_DIRECTOR, COMPANY_EMPLOYEE, etc

share_typestringWrite-onlyOptional

DEPRECATED: USE access_type INSTEAD | The share type, either STANDARD or MUTUAL.

start_datestringWrite-onlyOptional

DEPRECATED: USE access_type INSTEAD | The start date of this share.

end_datestringWrite-onlyOptional

DEPRECATED: USE access_type INSTEAD | The expiration date of this share.

monetary_account_idintegerRead-onlyOptional

The id of the monetary account the share applies to.

idintegerRead-onlyOptional

The id of the newly created share invite.

Responses

put

PUT /v1/user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry/{itemId} HTTP/1.1
Host: public-api.sandbox.bunq.com
User-Agent: text
X-Bunq-Client-Authentication: text
Content-Type: application/json
Accept: */*
Content-Length: 559

{
  "counter_user_alias": {
    "uuid": "text",
    "display_name": "text",
    "country": "text"
  },
  "access_type": "text",
  "draft_share_invite_bank_id": 1,
  "share_detail": {
    "payment": {
      "make_payments": true,
      "make_draft_payments": true,
      "view_balance": true,
      "view_old_events": true,
      "view_new_events": true
    },
    "read_only": {
      "view_balance": true,
      "view_old_events": true,
      "view_new_events": true
    },
    "draft_payment": {
      "make_draft_payments": true,
      "view_balance": true,
      "view_old_events": true,
      "view_new_events": true
    }
  },
  "status": "text",
  "relationship": "text",
  "share_type": "text",
  "start_date": "text",
  "end_date": "text"
}

{
  "Id": {
    "id": 1
  }
}