@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api bunq API
@base https://public-api.sandbox.bunq.com/v1
@version 1.0
@auth ApiKey X-Bunq-Client-Authentication in header
@common_fields {User-Agent: str # 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-Client-Authentication: str # 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, Cache-Control: str # The standard HTTP Cache-Control header is required for all signed requests., X-Bunq-Language: str # 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-Region: str # 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-Id: str # 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-Geolocation: str # 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.}
@endpoints 480
@hint download_for_search
@toc user(452), attachment-public(3), avatar(2), device(2), device-server(3), health-check(1), installation(4), user-company(3), payment-service-provider-credential(2), sandbox-user-company(1), sandbox-user-person(1), server-error(1), session(1), session-server(1), user-payment-service-provider(1), user-person(2)

@group user
@endpoint GET /user/{userID}/additional-transaction-information-category
@desc Get the available categories.
@required {userID: int}
@returns(200) Get the available categories.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/additional-transaction-information-category-user-defined
@desc Manage user-defined categories.
@required {userID: int, status: str # Whether this category is active. Only relevant for user-defined categories.}
@optional {category: str # The category., description: str # The description of the category., color: str # The color of the category., icon: str # The icon of the category.}
@returns(200) {Id: map{id: int}} # Manage user-defined categories.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/attachment
@desc Create a new monetary account attachment. Create a POST request with a payload that contains the binary representation of the file, without any JSON wrapping. Make sure you define the MIME type (i.e. image/jpeg) in the Content-Type header. You are required to provide a description of the attachment using the X-Bunq-Attachment-Description header.
@required {userID: int, monetary-accountID: int}
@returns(200) {id: int} # This call is used to upload an attachment that can be referenced to in payment requests and payments sent from a specific monetary account. Attachments supported are png, jpg and gif.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/attachment/{itemId}
@desc Get a specific attachment. The header of the response contains the content-type of the attachment.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, attachment: map{description: str, content_type: str, urls: [map]}} # This call is used to upload an attachment that is accessible only by a specific user. This can be used for example to upload passport scans or other documents. Attachments supported are png, jpg and gif.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group attachment-public
@endpoint POST /attachment-public
@desc Create a new public attachment. Create a POST request with a payload that contains a binary representation of the file, without any JSON wrapping. Make sure you define the MIME type (i.e. image/jpeg, or image/png) in the Content-Type header. You are required to provide a description of the attachment using the X-Bunq-Attachment-Description header.
@returns(200) {Id: map{id: int}} # This call is used to upload an attachment that can be referenced to as an avatar (through the Avatar endpoint) or in a tab sent. Attachments supported are png, jpg and gif.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /attachment-public/{itemId}
@desc Get a specific attachment's metadata through its UUID. The Content-Type header of the response will describe the MIME type of the attachment file.
@required {itemId: int}
@returns(200) {uuid: str, created: str, updated: str, attachment: map{description: str, content_type: str, urls: [map]}} # This call is used to upload an attachment that can be referenced to as an avatar (through the Avatar endpoint) or in a tab sent. Attachments supported are png, jpg and gif.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group avatar
@endpoint POST /avatar
@desc Avatars are public images used to represent you or your company. Avatars are used to represent users, monetary accounts and cash registers. Avatars cannot be deleted, only replaced. Avatars can be updated after uploading the image you would like to use through AttachmentPublic. Using the attachment_public_uuid which is returned you can update your Avatar. Avatars used for cash registers and company accounts will be reviewed by bunq.
@optional {uuid: str # The public UUID of the avatar., anchor_uuid: str # The public UUID of object this avatar is anchored to., image: [map{attachment_public_uuid: str, content_type: str, height: int, width: int}] # The actual image information of this avatar., style: str # The style (if applicable) for this Avatar.}
@returns(200) {uuid: str} # Avatars are public images used to represent you or your company. Avatars are used to represent users, monetary accounts and cash registers. Avatars cannot be deleted, only replaced. Avatars can be updated after uploading the image you would like to use through AttachmentPublic. Using the attachment_public_uuid which is returned you can update your Avatar. Avatars used for cash registers and company accounts will be reviewed by bunq.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /avatar/{itemId}
@desc Avatars are public images used to represent you or your company. Avatars are used to represent users, monetary accounts and cash registers. Avatars cannot be deleted, only replaced. Avatars can be updated after uploading the image you would like to use through AttachmentPublic. Using the attachment_public_uuid which is returned you can update your Avatar. Avatars used for cash registers and company accounts will be reviewed by bunq.
@required {itemId: int}
@returns(200) {uuid: str, image: [map]} # Avatars are public images used to represent you or your company. Avatars are used to represent users, monetary accounts and cash registers. Avatars cannot be deleted, only replaced. Avatars can be updated after uploading the image you would like to use through AttachmentPublic. Using the attachment_public_uuid which is returned you can update your Avatar. Avatars used for cash registers and company accounts will be reviewed by bunq.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group user
@endpoint GET /user/{userID}/billing-contract-subscription
@desc Get all subscription billing contract for the authenticated user.
@required {userID: int}
@returns(200) Show the subscription billing contract for the authenticated user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/bunqme-fundraiser-profile/{itemId}
@desc bunq.me public profile of the user.
@required {userID: int, itemId: int}
@returns(200) {monetary_account_id: int, owner_user_id: int, color: str, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, currency: str, description: str, attachment: map, pointer: map{type: str, value: str, name: str, service: str}, redirect_url: str, status: str} # bunq.me public profile of the user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/bunqme-fundraiser-profile
@desc bunq.me public profile of the user.
@required {userID: int}
@returns(200) bunq.me public profile of the user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{itemId}
@desc bunq.me fundraiser result containing all payments.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, bunqme_fundraiser_profile: map{pointer: map{type: str, value: str, name: str, service: str}, color: str, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, currency: str, description: str, attachment: map, status: str, redirect_url: str, invite_profile_name: str, merchant_available: [map]}, payments: [map]} # bunq.me fundraiser result containing all payments.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/bunqme-tab
@desc bunq.me tabs allows you to create a payment request and share the link through e-mail, chat, etc. Multiple persons are able to respond to the payment request and pay through bunq, iDeal or SOFORT.
@required {userID: int, monetary-accountID: int, bunqme_tab_entry: map{amount_inquired: map, description: str, redirect_url: str, uuid: str, alias: map, status: str, merchant_available: [map], invite_profile_name: str}}
@optional {status: str # The status of the bunq.me. Ignored in POST requests but can be used for cancelling the bunq.me by setting status as CANCELLED with a PUT request., event_id: int # The ID of the related event if the bunqMeTab made by 'split' functionality.}
@returns(200) {id: int} # bunq.me tabs allows you to create a payment request and share the link through e-mail, chat, etc. Multiple persons are able to respond to the payment request and pay through bunq, iDeal or SOFORT.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/bunqme-tab
@desc bunq.me tabs allows you to create a payment request and share the link through e-mail, chat, etc. Multiple persons are able to respond to the payment request and pay through bunq, iDeal or SOFORT.
@required {userID: int, monetary-accountID: int}
@returns(200) bunq.me tabs allows you to create a payment request and share the link through e-mail, chat, etc. Multiple persons are able to respond to the payment request and pay through bunq, iDeal or SOFORT.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/bunqme-tab/{itemId}
@desc bunq.me tabs allows you to create a payment request and share the link through e-mail, chat, etc. Multiple persons are able to respond to the payment request and pay through bunq, iDeal or SOFORT.
@required {userID: int, monetary-accountID: int, itemId: int, bunqme_tab_entry: map{amount_inquired: map, description: str, redirect_url: str, uuid: str, alias: map, status: str, merchant_available: [map], invite_profile_name: str}}
@optional {status: str # The status of the bunq.me. Ignored in POST requests but can be used for cancelling the bunq.me by setting status as CANCELLED with a PUT request., event_id: int # The ID of the related event if the bunqMeTab made by 'split' functionality.}
@returns(200) {Id: map{id: int}} # bunq.me tabs allows you to create a payment request and share the link through e-mail, chat, etc. Multiple persons are able to respond to the payment request and pay through bunq, iDeal or SOFORT.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/bunqme-tab/{itemId}
@desc bunq.me tabs allows you to create a payment request and share the link through e-mail, chat, etc. Multiple persons are able to respond to the payment request and pay through bunq, iDeal or SOFORT.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, time_expiry: str, monetary_account_id: int, status: str, type: str, alias_monetary_account: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, bunqme_tab_share_url: str, bunqme_tab_entry: map{amount_inquired: map{value: str, currency: str}, description: str, redirect_url: str, uuid: str, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, status: str, merchant_available: [map], invite_profile_name: str}, bunqme_tab_entries: [map], result_inquiries: [map]} # bunq.me tabs allows you to create a payment request and share the link through e-mail, chat, etc. Multiple persons are able to respond to the payment request and pay through bunq, iDeal or SOFORT.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/bunqme-tab-result-response/{itemId}
@desc Used to view bunq.me TabResultResponse objects belonging to a tab. A TabResultResponse is an object that holds details on a tab which has been paid from the provided monetary account.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {payment: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map{payments: map}, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}} # Used to view bunq.me TabResultResponse objects belonging to a tab. A TabResultResponse is an object that holds details on a tab which has been paid from the provided monetary account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/oauth-client/{oauth-clientID}/callback-url/{itemId}
@desc Used for managing OAuth Client Callback URLs.
@required {userID: int, oauth-clientID: int, itemId: int}
@returns(200) {url: str} # Used for managing OAuth Client Callback URLs.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/oauth-client/{oauth-clientID}/callback-url/{itemId}
@desc Used for managing OAuth Client Callback URLs.
@required {userID: int, oauth-clientID: int, itemId: int, url: str # The URL for this callback.}
@returns(200) {Id: map{id: int}} # Used for managing OAuth Client Callback URLs.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/oauth-client/{oauth-clientID}/callback-url/{itemId}
@desc Used for managing OAuth Client Callback URLs.
@required {userID: int, oauth-clientID: int, itemId: int}
@returns(200) Used for managing OAuth Client Callback URLs.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/oauth-client/{oauth-clientID}/callback-url
@desc Used for managing OAuth Client Callback URLs.
@required {userID: int, oauth-clientID: int, url: str # The URL for this callback.}
@returns(200) {Id: map{id: int}} # Used for managing OAuth Client Callback URLs.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/oauth-client/{oauth-clientID}/callback-url
@desc Used for managing OAuth Client Callback URLs.
@required {userID: int, oauth-clientID: int}
@returns(200) Used for managing OAuth Client Callback URLs.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/card/{itemId}
@desc Update the card details. Allow to change pin code, status, limits, country permissions and the monetary account connected to the card. When the card has been received, it can be also activated through this endpoint.
@required {userID: int, itemId: int}
@optional {pin_code: str # The plaintext pin code. Requests require encryption to be enabled., activation_code: str # DEPRECATED: Activate a card by setting status to ACTIVE when the order_status is ACCEPTED_FOR_PRODUCTION., status: str # 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: str # The order status to set for the card. Set to CARD_REQUEST_PENDING to get a virtual card produced., card_limit: map{value: str, currency: str}, card_limit_atm: map{value: str, currency: str}, country_permission: [map{country: str, expiry_time: str, id: int}] # The countries for which to grant (temporary) permissions to use the card., pin_code_assignment: [map{type: str, routing_type: str, pin_code: str, monetary_account_id: int, status: str}] # Array of Types, PINs, account IDs assigned to the card., primary_account_numbers: [map{id: int, description: str, status: str, monetary_account_id: int, uuid: str, four_digit: str, type: str}] # Array of PANs and their attributes., monetary_account_id_fallback: int # 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: str # The user's preferred name as it will be on the card., second_line: str # The second line of text on the card, cancellation_reason: str # The reason for card cancellation.}
@returns(200) {Id: map{id: int}} # Endpoint for retrieving details for the cards the user has access to.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/card/{itemId}
@desc Return the details of a specific card.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, public_uuid: str, user_id: int, user_owner_id: int, user_holder_id: int, type: str, sub_type: str, product_type: str, product_sub_type: str, first_line: str, second_line: str, status: str, sub_status: str, order_status: str, expiry_date: str, name_on_card: str, preferred_name_on_card: str, primary_account_numbers: [map], payment_account_reference: str, card_limit: map{value: str, currency: str}, card_limit_atm: map{value: str, currency: str}, country_permission: [map], label_monetary_account_ordered: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, label_monetary_account_current: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, monetary_account: map{alias: [map], balance: map{value: str, currency: str}, monetary_account_profile: [map], setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, budget: [map], reason: str, reason_description: str, share: map{status: str, card_id: int, id: int, created: str, updated: str, counter_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, user_alias_cancelled: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, monetary_account_id: int, draft_share_invite_bank_id: int, share_detail: map{payment: map, read_only: map, draft_payment: map}, access_type: str, relation_user: map{user_id: str, counter_user_id: str, label_user: map, counter_label_user: map, relationship: str, status: str, user_status: str, counter_user_status: str, company_employee_setting_adyen_card_transaction: map, all_company_employee_card: [map]}, share_type: str, start_date: str, end_date: str, description: str}, all_auto_save_id: [map], fulfillments: [map], relation_user: map{user_id: str, counter_user_id: str, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, counter_label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, relationship: str, status: str, user_status: str, counter_user_status: str, company_employee_setting_adyen_card_transaction: map{pointer_counter_user: map, status: str, monetary_account_payout_id: int}, all_company_employee_card: [map]}, all_co_owner: [map], co_owner_invite: map{status: str, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counter_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, monetary_account_id: int, monetary_account_type: str, freeze_status: str, label_freeze_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, all_co_owner: [map]}, open_banking_account: map{status: str, iban: str, time_synced_last: str, provider_bank: map{account_information_service_status: str, payment_information_service_status: str, name: str, aiia_provider_id: str, country: str, all_payment_method_allowed_sepa: [str], all_payment_method_allowed_domestic: [str], audience_business_status: bool, audience_private_status: bool, avatar: map}, balance_booked: map{value: str, currency: str}, balance_available: map{value: str, currency: str}}, birdee_investment_portfolio: map{risk_profile_type: str, investment_theme: str, name: str, goal: map{amount_target: map, time_end: str}, status: str, number_of_strategy_change_annual_maximum: int, number_of_strategy_change_annual_used: int, external_identifier: str, balance: map{amount_available: map, amount_deposit_total: map, amount_withdrawal_total: map, amount_fee_total: map, amount_profit: map, amount_deposit_pending: map, amount_withdrawal_pending: map}, allocations: [map]}, MonetaryAccountLight: map{currency: str, description: str, daily_limit: map{value: str, currency: str}, avatar_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, user_id: int, balance_maximum: map{value: str, currency: str}, budget_month_used: map{value: str, currency: str}, budget_month_maximum: map{value: str, currency: str}, budget_year_used: map{value: str, currency: str}, budget_year_maximum: map{value: str, currency: str}, budget_withdrawal_year_used: map{value: str, currency: str}, budget_withdrawal_year_maximum: map{value: str, currency: str}}, MonetaryAccountBank: map{currency: str, description: str, daily_limit: map{value: str, currency: str}, avatar_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, display_name: str, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, country_iban: str, id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, user_id: int, monetary_account_profile: map{profile_fill: map, profile_drain: map}, all_auto_save_id: [map]}, MonetaryAccountExternal: map{currency: str, service: str, description: str, daily_limit: map{value: str, currency: str}, avatar_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, display_name: str, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, user_id: int, monetary_account_profile: map{profile_fill: map, profile_drain: map}, all_auto_save_id: [map], open_banking_account: map{status: str, iban: str, time_synced_last: str, provider_bank: map, balance_booked: map, balance_available: map}}, MonetaryAccountInvestment: map{currency: str, provider: str, description: str, daily_limit: map{value: str, currency: str}, avatar_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, display_name: str, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, birdee_investment_portfolio: map{risk_profile_type: str, investment_theme: str, name: str, goal: map, status: str, number_of_strategy_change_annual_maximum: int, number_of_strategy_change_annual_used: int, external_identifier: str, balance: map, allocations: [map]}, monetary_account_deposit_initial_id: int, amount_deposit_initial: map{value: str, currency: str}, id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, user_id: int, monetary_account_profile: map{profile_fill: map, profile_drain: map}, all_auto_save_id: [map]}, MonetaryAccountJoint: map{currency: str, description: str, daily_limit: map{value: str, currency: str}, overdraft_limit: map{value: str, currency: str}, alias: [map], avatar_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, all_co_owner: [map], setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, public_uuid: str, user_id: int, monetary_account_profile: map{profile_fill: map, profile_drain: map}, all_auto_save_id: [map]}, MonetaryAccountSavings: map{currency: str, description: str, daily_limit: map{value: str, currency: str}, avatar_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, all_co_owner: [map], setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, savings_goal: map{value: str, currency: str}, id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, user_id: int, monetary_account_profile: map{profile_fill: map, profile_drain: map}, savings_goal_progress: int, number_of_payment_remaining: str, all_auto_save_id: [map]}, MonetaryAccountSwitchService: map{id: int, created: str, description: str, status: str, sub_status: str}, MonetaryAccountExternalSavings: map{currency: str, service: str, description: str, daily_limit: map{value: str, currency: str}, avatar_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, display_name: str, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, savings_goal: map{value: str, currency: str}, id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, user_id: int, monetary_account_profile: map{profile_fill: map, profile_drain: map}, all_auto_save_id: [map], savings_goal_progress: int, number_of_payment_remaining: str}, MonetaryAccountCard: map{id: int, created: str, updated: str, currency: str, description: str, daily_limit: map{value: str, currency: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, balance_real: map{value: str, currency: str}, alias: [map], public_uuid: str, status: str, sub_status: str, user_id: int}}, pin_code_assignment: [map], monetary_account_id_fallback: int, country: str, card_shipment_tracking_url: str, is_card_eligible_for_free_replacement: bool, card_replacement: map{status: str, address_main: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_postal: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, card_id: int, card_new_id: int}, card_generated_cvc2: map{type: str}, is_limited_edition: bool, card_metal_member_since_date: str, company_employee_card: map{pointer_counter_user: map{type: str, value: str, name: str, service: str}, pointer_monetary_account: map{type: str, value: str, name: str, service: str}, type: str, product_type: str, company_name_on_card: str, employee_name_on_card: str, employee_preferred_name_on_card: str, amount_limit_monthly: map{value: str, currency: str}, status: str, card: map{pin_code: str, activation_code: str, status: str, order_status: str, card_limit: map{value: str, currency: str}, card_limit_atm: map{value: str, currency: str}, country_permission: [map], pin_code_assignment: [map], primary_account_numbers: [map], monetary_account_id_fallback: int, preferred_name_on_card: str, second_line: str, cancellation_reason: str}, amount_spent_monthly: map{value: str, currency: str}, number_of_company_employee_card_receipt_pending: int}} # Endpoint for retrieving details for the cards the user has access to.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/card
@desc Return all the cards available to the user.
@required {userID: int}
@returns(200) Endpoint for retrieving details for the cards the user has access to.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/card-batch
@desc Used to update multiple cards in a batch.
@required {userID: int, cards: [map{id!: int, status: str, card_limit: map, card_limit_atm: map, country_permission: [map], monetary_account_id_fallback: int}] # The cards that need to be updated.}
@returns(200) {updated_card_ids: [map]} # Used to update multiple cards in a batch.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/card-batch-replace
@desc Used to replace multiple cards in a batch.
@required {userID: int, cards: [map{id!: int, name_on_card: str, pin_code_assignment: [map], second_line: str}] # The cards that need to be replaced.}
@returns(200) {updated_card_ids: [map]} # Used to replace multiple cards in a batch.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/card-credit
@desc Create a new credit card request.
@required {userID: int, second_line: str # The second line of text on the card, used as name/description for it. It can contain at most 17 characters and it can be empty., name_on_card: str # The user's name as it will be on the card. Check 'card-name' for the available card names for a user., type: str # The type of card to order. Can be MASTERCARD., product_type: str # The product type of the card to order.}
@optional {first_line: str # The first line of text on the card, used as name/description for it. It can contain at most 17 characters and it can be empty., preferred_name_on_card: str # The user's preferred name that can be put on the card., alias: map{type: str, value: str, name: str, service: str}, pin_code_assignment: [map{type: str, routing_type: str, pin_code: str, monetary_account_id: int, status: str}] # Array of Types, PINs, account IDs assigned to the card., monetary_account_id_fallback: int # ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied., order_status: str # The order status of this card. Can be CARD_REQUEST_PENDING or VIRTUAL_DELIVERY.}
@returns(200) {Id: map{id: int}} # With bunq it is possible to order credit cards that can then be connected with each one of the monetary accounts the user has access to (including connected accounts).
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/card-debit
@desc Create a new debit card request.
@required {userID: int, second_line: str # The second line of text on the card, used as name/description for it. It can contain at most 17 characters and it can be empty., name_on_card: str # The user's name as it will be on the card. Check 'card-name' for the available card names for a user., type: str # The type of card to order. Can be MAESTRO or MASTERCARD., product_type: str # The product type of the card to order.}
@optional {preferred_name_on_card: str # The user's preferred name that can be put on the card., alias: map{type: str, value: str, name: str, service: str}, pin_code_assignment: [map{type: str, routing_type: str, pin_code: str, monetary_account_id: int, status: str}] # Array of Types, PINs, account IDs assigned to the card., monetary_account_id_fallback: int # ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied., order_status: str # The order status of this card. Can be CARD_REQUEST_PENDING or VIRTUAL_DELIVERY.}
@returns(200) {Id: map{id: int}} # With bunq it is possible to order debit cards that can then be connected with each one of the monetary accounts the user has access to (including connected accounts).
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/card-name
@desc Return all the accepted card names for a specific user.
@required {userID: int}
@returns(200) Endpoint for getting all the accepted card names for a user. As bunq do not allow total freedom in choosing the name that is going to be printed on the card, the following formats are accepted: Name Surname, N. Surname, N Surname or Surname.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/certificate-pinned
@desc Pin the certificate chain.
@required {userID: int, certificate_chain: [map{certificate: str}] # The certificate chain in .PEM format.}
@returns(200) {id: int} # This endpoint allow you to pin the certificate chains to your account. These certificate chains are used for SSL validation whenever a callback is initiated to one of your https callback urls.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/certificate-pinned
@desc List all the pinned certificate chain for the given user.
@required {userID: int}
@returns(200) This endpoint allow you to pin the certificate chains to your account. These certificate chains are used for SSL validation whenever a callback is initiated to one of your https callback urls.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/certificate-pinned/{itemId}
@desc Remove the pinned certificate chain with the specific ID.
@required {userID: int, itemId: int}
@returns(200) This endpoint allow you to pin the certificate chains to your account. These certificate chains are used for SSL validation whenever a callback is initiated to one of your https callback urls.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/certificate-pinned/{itemId}
@desc Get the pinned certificate chain with the specified ID.
@required {userID: int, itemId: int}
@returns(200) {certificate_chain: str, id: int} # This endpoint allow you to pin the certificate chains to your account. These certificate chains are used for SSL validation whenever a callback is initiated to one of your https callback urls.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/challenge-request/{itemId}
@desc Endpoint for apps to fetch a challenge request.
@required {userID: int, itemId: int}
@returns(200) {amount: str, expiry_time: str, description: str, status: str, decision_description: str, decision_description_translated: str, url_merchant_app: str, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, event_id: int, card_id: int} # Endpoint for apps to fetch a challenge request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/challenge-request/{itemId}
@desc Endpoint for apps to fetch a challenge request.
@required {userID: int, itemId: int, status: str # The status of the identity check. Can be ACCEPTED_PENDING_RESPONSE or REJECTED_PENDING_RESPONSE.}
@returns(200) {Id: map{id: int}} # Endpoint for apps to fetch a challenge request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/company
@desc Create and manage companies.
@required {userID: int, name: str # The company name., address_main: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_postal: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, country: str # The country where the company is registered., legal_form: str # The company's legal form., subscription_type: str # The subscription type for the company.}
@optional {ubo: [map{name: str, date_of_birth: str, nationality: str}] # The names and birth dates of the company's ultimate beneficiary owners. Minimum zero, maximum four., chamber_of_commerce_number: str # The company's chamber of commerce number., avatar_uuid: str # The public UUID of the company's avatar., vat_number: map{type: str, country: str, value: str}, vat_numbers: [map{type: str, country: str, value: str}] # All the vat numbers of the company, signup_track_type: str # The type of signup track the user is following.}
@returns(200) {Id: map{id: int}} # Create and manage companies.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/company
@desc Create and manage companies.
@required {userID: int}
@returns(200) Create and manage companies.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/company/{itemId}
@desc Create and manage companies.
@required {userID: int, itemId: int}
@returns(200) {UserCompany: map{name: str, public_nick_name: str, avatar_uuid: str, address_main: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_postal: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, language: str, region: str, country: str, ubo: [map], chamber_of_commerce_number: str, legal_form: str, status: str, sub_status: str, session_timeout: int, daily_limit_without_confirmation_login: map{value: str, currency: str}, id: int, created: str, updated: str, public_uuid: str, display_name: str, alias: [map], type_of_business_entity: str, sector_of_industry: str, counter_bank_iban: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, version_terms_of_service: str, directors: [map], notification_filters: [map], customer: map{billing_account_id: str, invoice_notification_preference: str, id: int, created: str, updated: str}, customer_limit: map{limit_monetary_account: int, limit_monetary_account_remaining: int, limit_card_debit_maestro: int, limit_card_debit_mastercard: int, limit_card_debit_wildcard: int, limit_card_wildcard: int, limit_card_replacement: int, limit_amount_monthly: map{value: str, currency: str}, spent_amount_monthly: map{value: str, currency: str}}, billing_contract: [map], deny_reason: str, relations: [map], tax_resident: [map]}} # Create and manage companies.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/company/{itemId}
@desc Create and manage companies.
@required {userID: int, itemId: int, name: str # The company name., address_main: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_postal: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, country: str # The country where the company is registered., legal_form: str # The company's legal form., subscription_type: str # The subscription type for the company.}
@optional {ubo: [map{name: str, date_of_birth: str, nationality: str}] # The names and birth dates of the company's ultimate beneficiary owners. Minimum zero, maximum four., chamber_of_commerce_number: str # The company's chamber of commerce number., avatar_uuid: str # The public UUID of the company's avatar., vat_number: map{type: str, country: str, value: str}, vat_numbers: [map{type: str, country: str, value: str}] # All the vat numbers of the company, signup_track_type: str # The type of signup track the user is following.}
@returns(200) {Id: map{id: int}} # Create and manage companies.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/confirmation-of-funds
@desc Used to confirm availability of funds on an account.
@required {userID: int, pointer_iban: map{type: str, value: str, name: str, service: str}, amount: map{value: str, currency: str}}
@returns(200) {Id: map{id: int}} # Used to confirm availability of funds on an account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/chat-conversation/{chat-conversationID}/attachment/{attachmentID}/content
@desc Get the raw content of a specific attachment.
@required {userID: int, chat-conversationID: int, attachmentID: int}
@returns(200) Fetch the raw content of an attachment with given ID. The raw content is the base64 of a file, without any JSON wrapping.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/attachment/{attachmentID}/content
@desc Get the raw content of a specific attachment.
@required {userID: int, monetary-accountID: int, attachmentID: int}
@returns(200) Fetch the raw content of a monetary account attachment with given ID. The raw content is the binary representation of a file, without any JSON wrapping.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group attachment-public
@endpoint GET /attachment-public/{attachment-publicUUID}/content
@desc Get the raw content of a specific attachment.
@required {attachment-publicUUID: str}
@returns(200) Fetch the raw content of a public attachment with given ID. The raw content is the binary representation of a file, without any JSON wrapping.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group user
@endpoint GET /user/{userID}/attachment/{attachmentID}/content
@desc Get the raw content of a specific attachment.
@required {userID: int, attachmentID: int}
@returns(200) Fetch the raw content of a user attachment with given ID. The raw content is the binary representation of a file, without any JSON wrapping.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/export-annual-overview/{export-annual-overviewID}/content
@desc Used to retrieve the raw content of an annual overview.
@required {userID: int, export-annual-overviewID: int}
@returns(200) Fetch the raw content of an annual overview. The annual overview is always in PDF format. Doc won't display the response of a request to get the content of an annual overview.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/export-rib/{export-ribID}/content
@desc Used to retrieve the raw content of an RIB.
@required {userID: int, monetary-accountID: int, export-ribID: int}
@returns(200) Fetch the raw content of an RIB. The RIB is always in PDF format.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/card/{cardID}/export-statement-card/{export-statement-cardID}/content
@desc Fetch the raw content of a card statement export. The returned file format could be CSV or PDF depending on the statement format specified during the statement creation. The doc won't display the response of a request to get the content of a statement export.
@required {userID: int, cardID: int, export-statement-cardID: int}
@returns(200) Fetch the raw content of a card statement export. The returned file format could be CSV or PDF depending on the statement format specified during the statement creation. The doc won't display the response of a request to get the content of a statement export.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/customer-statement/{customer-statementID}/content
@desc Fetch the raw content of a statement export. The returned file format could be MT940, CSV or PDF depending on the statement format specified during the statement creation. The doc won't display the response of a request to get the content of a statement export.
@required {userID: int, monetary-accountID: int, customer-statementID: int}
@returns(200) Fetch the raw content of a statement export. The returned file format could be MT940, CSV or PDF depending on the statement format specified during the statement creation. The doc won't display the response of a request to get the content of a statement export.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/event/{eventID}/statement/{statementID}/content
@desc Fetch the raw content of a payment statement export.
@required {userID: int, monetary-accountID: int, eventID: int, statementID: int}
@returns(200) Fetch the raw content of a payment statement export.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/credential-password-ip/{itemId}
@desc Create a credential of a user for server authentication, or delete the credential of a user for server authentication.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, status: str, expiry_time: str, token_value: str, permitted_device: map{description: str, ip: str}} # Create a credential of a user for server authentication, or delete the credential of a user for server authentication.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/credential-password-ip
@desc Create a credential of a user for server authentication, or delete the credential of a user for server authentication.
@required {userID: int}
@returns(200) Create a credential of a user for server authentication, or delete the credential of a user for server authentication.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/currency-cloud-beneficiary
@desc Endpoint to manage CurrencyCloud beneficiaries.
@required {userID: int, name: str # The name of the beneficiary., country: str # The country of the beneficiary., currency: str # The currency of the beneficiary., payment_type: str # The payment type this requirement is for., legal_entity_type: str # The legal entity type of the beneficiary., all_field: [str] # All fields that were required by CurrencyCloud. Obtained through the CurrencyCloudBeneficiaryRequirement listing.}
@returns(200) {Id: map{id: int}} # Endpoint to manage CurrencyCloud beneficiaries.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/currency-cloud-beneficiary
@desc Endpoint to manage CurrencyCloud beneficiaries.
@required {userID: int}
@returns(200) Endpoint to manage CurrencyCloud beneficiaries.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/currency-cloud-beneficiary/{itemId}
@desc Endpoint to manage CurrencyCloud beneficiaries.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, name: str, account_number: str, currency: str, external_identifier: str} # Endpoint to manage CurrencyCloud beneficiaries.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/currency-cloud-beneficiary-requirement
@desc Endpoint to list requirements for CurrencyCloud beneficiaries.
@required {userID: int}
@returns(200) Endpoint to list requirements for CurrencyCloud beneficiaries.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/currency-cloud-payment-quote
@desc Endpoint for managing currency conversions.
@required {userID: int, monetary-accountID: int, pointers: [map{type: str, value: str, name: str, service: str}] # The points we want to know the fees for.}
@returns(200) {Id: map{id: int}} # Endpoint for managing currency conversions.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/currency-conversion
@desc Endpoint for managing currency conversions.
@required {userID: int, monetary-accountID: int}
@returns(200) Endpoint for managing currency conversions.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/currency-conversion/{itemId}
@desc Endpoint for managing currency conversions.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, status: str, date_delivery_expected: str, rate: str, amount: map{value: str, currency: str}, counter_amount: map{value: str, currency: str}, group_uuid: str, type: str, order_type: str, label_monetary_account: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counter_label_monetary_account: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, payment: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map{payments: map}, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}} # Endpoint for managing currency conversions.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/currency-conversion-quote
@desc Endpoint to create a quote for currency conversions.
@required {userID: int, monetary-accountID: int, amount: map{value: str, currency: str}, currency_source: str # The currency we are converting., currency_target: str # The currency we are converting towards., order_type: str # The type of the quote, SELL or BUY., counterparty_alias: map{type: str, value: str, name: str, service: str}}
@optional {status: str # The status of the quote.}
@returns(200) {Id: map{id: int}} # Endpoint to create a quote for currency conversions.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/currency-conversion-quote/{itemId}
@desc Endpoint to create a quote for currency conversions.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, status: str, amount_source: map{value: str, currency: str}, amount_target: map{value: str, currency: str}, rate: str, time_expiry: str} # Endpoint to create a quote for currency conversions.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/currency-conversion-quote/{itemId}
@desc Endpoint to create a quote for currency conversions.
@required {userID: int, monetary-accountID: int, itemId: int, amount: map{value: str, currency: str}, currency_source: str # The currency we are converting., currency_target: str # The currency we are converting towards., order_type: str # The type of the quote, SELL or BUY., counterparty_alias: map{type: str, value: str, name: str, service: str}}
@optional {status: str # The status of the quote.}
@returns(200) {Id: map{id: int}} # Endpoint to create a quote for currency conversions.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/customer-statement
@desc Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.
@required {userID: int, monetary-accountID: int, statement_format: str # The format type of statement. Allowed values: MT940, CSV, PDF., date_start: str # The start date for making statements., date_end: str # The end date for making statements.}
@optional {regional_format: str # Required for CSV exports. The regional format of the statement, can be UK_US (comma-separated) or EUROPEAN (semicolon-separated)., include_attachment: bool # Only for PDF exports. Includes attachments to mutations in the export, such as scanned receipts.}
@returns(200) {Id: map{id: int}} # Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/customer-statement
@desc Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.
@required {userID: int, monetary-accountID: int}
@returns(200) Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/customer-statement/{itemId}
@desc Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, date_start: str, date_end: str, status: str, statement_number: int, statement_format: str, regional_format: str, alias_monetary_account: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}} # Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/customer-statement/{itemId}
@desc Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate/{payment-auto-allocateID}/definition
@desc List all the definitions in a payment auto allocate.
@required {userID: int, monetary-accountID: int, payment-auto-allocateID: int}
@returns(200) List all the definitions in a payment auto allocate.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group device
@endpoint GET /device/{itemId}
@desc Get a single Device. A Device is either a DevicePhone or a DeviceServer.
@required {itemId: int}
@returns(200) {DeviceServer: map{description: str, secret: str, permitted_ips: [str]}} # Used to get a Device or a listing of Devices. Creating a DeviceServer should happen via /device-server
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /device
@desc Get a collection of Devices. A Device is either a DevicePhone or a DeviceServer.
@returns(200) Used to get a Device or a listing of Devices. Creating a DeviceServer should happen via /device-server
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group device-server
@endpoint POST /device-server
@desc Create a new DeviceServer providing the installation token in the header and signing the request with the private part of the key you used to create the installation. The API Key that you are using will be bound to the IP address of the DeviceServer which you have created.Using a Wildcard API Key gives you the freedom to make API calls even if the IP address has changed after the POST device-server.Find out more at this link https:/bunq.com/en/apikey-dynamic-ip.
@required {description: str # The description of the DeviceServer. This is only for your own reference when reading the DeviceServer again., secret: str # The API key. You can request an API key in the bunq app.}
@optional {permitted_ips: [str] # An array of IPs (v4 or v6) this DeviceServer will be able to do calls from. These will be linked to the API key.}
@returns(200) {id: int} # After having created an Installation you can now create a DeviceServer. A DeviceServer is needed to do a login call with session-server.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /device-server
@desc Get a collection of all the DeviceServers you have created.
@returns(200) After having created an Installation you can now create a DeviceServer. A DeviceServer is needed to do a login call with session-server.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /device-server/{itemId}
@desc Get one of your DeviceServers.
@required {itemId: int}
@returns(200) {id: int, created: str, updated: str, description: str, ip: str, status: str} # After having created an Installation you can now create a DeviceServer. A DeviceServer is needed to do a login call with session-server.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group user
@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/draft-payment
@desc Create a new DraftPayment.
@required {userID: int, monetary-accountID: int, entries: [map{amount: map, counterparty_alias: map, description: str, merchant_reference: str, attachment: [map], id: int, alias: map, type: str}] # The list of entries in the DraftPayment. Each entry will result in a payment when the DraftPayment is accepted., number_of_required_accepts: int # The number of accepts that are required for the draft payment to receive status ACCEPTED. Currently only 1 is valid.}
@optional {status: str # The status of the DraftPayment., previous_updated_timestamp: str # The last updated_timestamp that you received for this DraftPayment. This needs to be provided to prevent race conditions., schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map}}
@returns(200) {id: int} # A DraftPayment is like a regular Payment, but it needs to be accepted by the sending party before the actual Payment is done.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/draft-payment
@desc Get a listing of all DraftPayments from a given MonetaryAccount.
@required {userID: int, monetary-accountID: int}
@returns(200) A DraftPayment is like a regular Payment, but it needs to be accepted by the sending party before the actual Payment is done.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{itemId}
@desc Update a DraftPayment.
@required {userID: int, monetary-accountID: int, itemId: int, entries: [map{amount: map, counterparty_alias: map, description: str, merchant_reference: str, attachment: [map], id: int, alias: map, type: str}] # The list of entries in the DraftPayment. Each entry will result in a payment when the DraftPayment is accepted., number_of_required_accepts: int # The number of accepts that are required for the draft payment to receive status ACCEPTED. Currently only 1 is valid.}
@optional {status: str # The status of the DraftPayment., previous_updated_timestamp: str # The last updated_timestamp that you received for this DraftPayment. This needs to be provided to prevent race conditions., schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map}}
@returns(200) {id: int} # A DraftPayment is like a regular Payment, but it needs to be accepted by the sending party before the actual Payment is done.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{itemId}
@desc Get a specific DraftPayment.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {id: int, monetary_account_id: int, user_alias_created: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, responses: [map], status: str, type: str, entries: [map], object: map{Payment: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}, PaymentBatch: map{payments: map{Payment: [map]}}}, request_reference_split_the_bill: [map], schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map{Payment: map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map, type: str, sub_type: str, payment_arrival_expected: map, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map, address_billing: map, geolocation: map, request_reference_split_the_bill: [map], balance_after_mutation: map, payment_auto_allocate_instance: map, payment_suspended_outgoing: map, payment_fee: map}, PaymentBatch: map{payments: map}}}} # A DraftPayment is like a regular Payment, but it needs to be accepted by the sending party before the actual Payment is done.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/event/{itemId}
@desc Get a specific event for a given user.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, action: str, user_id: str, monetary_account_id: str, object: map{BunqMeTab: map{bunqme_tab_entry: map{amount_inquired: map, description: str, redirect_url: str, uuid: str, alias: map, status: str, merchant_available: [map], invite_profile_name: str}, status: str, event_id: int}, BunqMeTabResultResponse: map{payment: map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map, type: str, sub_type: str, payment_arrival_expected: map, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map, address_billing: map, geolocation: map, request_reference_split_the_bill: [map], balance_after_mutation: map, payment_auto_allocate_instance: map, payment_suspended_outgoing: map, payment_fee: map}}, BunqMeFundraiserResult: map{id: int, created: str, updated: str, bunqme_fundraiser_profile: map{pointer: map, color: str, alias: map, currency: str, description: str, attachment: map, status: str, redirect_url: str, invite_profile_name: str, merchant_available: [map]}, payments: [map]}, Card: map{pin_code: str, activation_code: str, status: str, order_status: str, card_limit: map{value: str, currency: str}, card_limit_atm: map{value: str, currency: str}, country_permission: [map], pin_code_assignment: [map], primary_account_numbers: [map], monetary_account_id_fallback: int, preferred_name_on_card: str, second_line: str, cancellation_reason: str}, CardDebit: map{second_line: str, name_on_card: str, preferred_name_on_card: str, alias: map{type: str, value: str, name: str, service: str}, type: str, product_type: str, pin_code_assignment: [map], monetary_account_id_fallback: int, order_status: str}, DraftPayment: map{status: str, entries: [map], previous_updated_timestamp: str, number_of_required_accepts: int, schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map}}, FeatureAnnouncement: map{avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, title: str, sub_title: str, type: str}, IdealMerchantTransaction: map{amount_requested: map{value: str, currency: str}, issuer: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, amount_guaranteed: map{value: str, currency: str}, expiration: str, issuer_name: str, issuer_authentication_url: str, purchase_identifier: str, status: str, status_timestamp: str, transaction_identifier: str}, Invoice: map{status: str, description: str, external_url: str, id: int, created: str, updated: str, invoice_date: str, invoice_number: str, category: str, group: [map], total_vat_inclusive: map{value: str, currency: str}, total_vat_exclusive: map{value: str, currency: str}, total_vat: map{value: str, currency: str}, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, address: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_address: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, chamber_of_commerce_number: str, vat_number: str, request_reference_split_the_bill: [map]}, ScheduledPayment: map{payment: map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, alias: map}, schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map}, purpose: str, status: str}, ScheduledPaymentBatch: map{payments: [map], schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map}}, ScheduledInstance: map{state: str, time_start: str, time_end: str, error_message: [[map]], scheduled_object: map{Payment: map, PaymentBatch: map}, result_object: map{Payment: map, PaymentBatch: map}, request_reference_split_the_bill: [map]}, MasterCardAction: map{id: int, monetary_account_id: int, card_id: int, amount_local: map{value: str, currency: str}, amount_converted: map{value: str, currency: str}, amount_billing: map{value: str, currency: str}, amount_original_local: map{value: str, currency: str}, amount_original_billing: map{value: str, currency: str}, amount_fee: map{value: str, currency: str}, card_authorisation_id_response: str, decision: str, payment_status: str, decision_description: str, decision_description_translated: str, decision_together_url: str, description: str, authorisation_status: str, authorisation_type: str, pan_entry_mode_user: str, settlement_status: str, clearing_status: str, maturity_date: str, city: str, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, label_card: map{uuid: str, type: str, second_line: str, expiry_date: str, status: str, label_user: map}, merchant_id: str, token_status: str, reservation_expiry_time: str, clearing_expiry_time: str, applied_limit: str, secure_code_id: int, wallet_provider_id: str, request_reference_split_the_bill: [map], card_tokenization_event: map{id: int, created: str, updated: str, action: str, user_id: str, monetary_account_id: str, object: map, status: str, object_data_at_event: map, is_event_latest_for_object: bool, is_event_reassignable: bool}, all_mastercard_action_refund: [map], pos_card_presence: str, pos_card_holder_presence: str, eligible_whitelist_id: int, cashback_payout_item: map{status: str, amount: map, rate_applied: str, transaction_category: map, user_partner_promotion: map}, point_mutation: map{number_of_point: int}, blacklist: map{merchant_name: str, merchant_id: str, merchant_identifier: str, mastercard_merchant_id: str, external_merchant_id: str, id: int, created: str, updated: str, status: str, merchant_hash: str, merchant_avatar: map}, blocklist: map{merchant_name: str, merchant_id: str, merchant_identifier: str, mastercard_merchant_id: str, external_merchant_id: str, id: int, created: str, updated: str, status: str, merchant_hash: str, merchant_avatar: map}, additional_authentication_status: str, pin_status: str, mastercard_action_report: map{mastercard_action_id: int, type: str, status: str, merchant_id: str, merchant_name: str, counterparty_alias: map}, merchant_category_code: str, company_employee_card_receipt: map{status: str}}, BankSwitchServiceNetherlandsIncomingPayment: map{bank_switch_service: map{alias: map, counterparty_alias: map, status: str, user_alias: map, sub_status: str, time_start_desired: str, time_start_actual: str, time_end: str, attachment: map, rejection_reason: str, rejection_reason_description: str, rejection_reason_description_translated: str, rejection_reason_together_url: str}, payment: map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map, type: str, sub_type: str, payment_arrival_expected: map, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map, address_billing: map, geolocation: map, request_reference_split_the_bill: [map], balance_after_mutation: map, payment_auto_allocate_instance: map, payment_suspended_outgoing: map, payment_fee: map}}, Payment: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}, PaymentBatch: map{payments: map{Payment: [map]}}, RequestInquiryBatch: map{request_inquiries: [map], status: str, total_amount_inquired: map{value: str, currency: str}, event_id: int, reference_split_the_bill: map{BillingInvoice: map, DraftPayment: map, MasterCardAction: map, Payment: map, PaymentBatch: map, RequestResponse: map, ScheduleInstance: map, WhitelistResult: map, TransferwisePayment: map, CurrencyConversion: map}}, RequestInquiry: map{amount_inquired: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, status: str, minimum_age: int, require_address: str, want_tip: bool, allow_amount_lower: bool, allow_amount_higher: bool, allow_bunqme: bool, redirect_url: str, event_id: int, id: int, created: str, updated: str, time_responded: str, time_expiry: str, monetary_account_id: int, amount_responded: map{value: str, currency: str}, user_alias_created: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, user_alias_revoked: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, batch_id: int, scheduled_id: int, bunqme_share_url: str, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, reference_split_the_bill: map{BillingInvoice: map, DraftPayment: map, MasterCardAction: map, Payment: map, PaymentBatch: map, RequestResponse: map, ScheduleInstance: map, WhitelistResult: map, TransferwisePayment: map, CurrencyConversion: map}}, RequestResponse: map{amount_responded: map{value: str, currency: str}, status: str, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, currency_conversion_quote_id: int, id: int, created: str, updated: str, time_responded: str, time_expiry: str, time_refund_requested: str, time_refunded: str, user_refund_requested: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, monetary_account_id: int, amount_inquired: map{value: str, currency: str}, description: str, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, attachment: [map], minimum_age: int, require_address: str, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, type: str, sub_type: str, redirect_url: str, credit_scheme_identifier: str, mandate_identifier: str, registration_action: str, eligible_whitelist_id: int, request_reference_split_the_bill: [map], event_id: int, monetary_account_preferred_id: int}, ShareInviteBankInquiry: map{counter_user_alias: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, access_type: str, draft_share_invite_bank_id: int, share_detail: map{payment: map, read_only: map, draft_payment: map}, status: str, relationship: str, share_type: str, start_date: str, end_date: str, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, user_alias_created: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, user_alias_revoked: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, monetary_account_id: int, id: int}, ShareInviteBankResponse: map{status: str, card_id: int, id: int, created: str, updated: str, counter_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, user_alias_cancelled: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, monetary_account_id: int, draft_share_invite_bank_id: int, share_detail: map{payment: map, read_only: map, draft_payment: map}, access_type: str, relation_user: map{user_id: str, counter_user_id: str, label_user: map, counter_label_user: map, relationship: str, status: str, user_status: str, counter_user_status: str, company_employee_setting_adyen_card_transaction: map, all_company_employee_card: [map]}, share_type: str, start_date: str, end_date: str, description: str}, SofortMerchantTransaction: map{amount_requested: map{value: str, currency: str}, issuer: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, amount_guaranteed: map{value: str, currency: str}, issuer_authentication_url: str, status: str, error_message: [[map]], transaction_identifier: str}, TransferwisePayment: map{monetary_account_id: str, recipient_id: str, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, status: str, sub_status: str, status_transferwise: str, status_transferwise_issue: str, amount_source: map{value: str, currency: str}, amount_target: map{value: str, currency: str}, rate: str, reference: str, pay_in_reference: str, time_delivery_estimate: str, quote: map{currency_source: str, currency_target: str, amount_source: map, amount_target: map, id: int, created: str, updated: str, time_expiry: str, quote_id: str, amount_fee: map, rate: str, time_delivery_estimate: str}}}, status: str} # Used to view events. Events are automatically created and contain information about everything that happens to your bunq account. In the bunq app events are shown in your 'overview'. Examples of when events are created or modified: payment sent, payment received, request for payment received or connect invite received.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/event
@desc Get a collection of events for a given user. You can add query the parameters monetary_account_id, status and/or display_user_event to filter the response. When monetary_account_id={id,id} is provided only events that relate to these monetary account ids are returned. When status={AWAITING_REPLY/FINALIZED} is provided the response only contains events with the status AWAITING_REPLY or FINALIZED. When display_user_event={true/false} is set to false user events are excluded from the response, when not provided user events are displayed. User events are events that are not related to a monetary account (for example: connect invites).
@required {userID: int}
@returns(200) Used to view events. Events are automatically created and contain information about everything that happens to your bunq account. In the bunq app events are shown in your 'overview'. Examples of when events are created or modified: payment sent, payment received, request for payment received or connect invite received.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/export-annual-overview
@desc Create a new annual overview for a specific year. An overview can be generated only for a past year.
@required {userID: int, year: int # The year for which the overview is.}
@returns(200) {id: int} # Used to create new and read existing annual overviews of all the user's monetary accounts. Once created, annual overviews can be downloaded in PDF format via the 'export-annual-overview/{id}/content' endpoint.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/export-annual-overview
@desc List all the annual overviews for a user.
@required {userID: int}
@returns(200) Used to create new and read existing annual overviews of all the user's monetary accounts. Once created, annual overviews can be downloaded in PDF format via the 'export-annual-overview/{id}/content' endpoint.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/export-annual-overview/{itemId}
@desc Get an annual overview for a user by its id.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, year: int, alias_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}} # Used to create new and read existing annual overviews of all the user's monetary accounts. Once created, annual overviews can be downloaded in PDF format via the 'export-annual-overview/{id}/content' endpoint.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/export-annual-overview/{itemId}
@desc Used to create new and read existing annual overviews of all the user's monetary accounts. Once created, annual overviews can be downloaded in PDF format via the 'export-annual-overview/{id}/content' endpoint.
@required {userID: int, itemId: int}
@returns(200) Used to create new and read existing annual overviews of all the user's monetary accounts. Once created, annual overviews can be downloaded in PDF format via the 'export-annual-overview/{id}/content' endpoint.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/export-rib
@desc Create a new RIB.
@required {userID: int, monetary-accountID: int}
@returns(200) {id: int} # Used to create new and read existing RIBs of a monetary account
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/export-rib
@desc List all the RIBs for a monetary account.
@required {userID: int, monetary-accountID: int}
@returns(200) Used to create new and read existing RIBs of a monetary account
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/export-rib/{itemId}
@desc Get a RIB for a monetary account by its id.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str} # Used to create new and read existing RIBs of a monetary account
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/export-rib/{itemId}
@desc Used to create new and read existing RIBs of a monetary account
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) Used to create new and read existing RIBs of a monetary account
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/card/{cardID}/export-statement-card/{itemId}
@desc Used to create new and read existing card statement exports. Statement exports can be created in either CSV or PDF file format.
@required {userID: int, cardID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, date_start: str, date_end: str, status: str, regional_format: str, card_id: int} # Used to create new and read existing card statement exports. Statement exports can be created in either CSV or PDF file format.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/card/{cardID}/export-statement-card
@desc Used to create new and read existing card statement exports. Statement exports can be created in either CSV or PDF file format.
@required {userID: int, cardID: int}
@returns(200) Used to create new and read existing card statement exports. Statement exports can be created in either CSV or PDF file format.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/card/{cardID}/export-statement-card-csv
@desc Used to serialize ExportStatementCardCsv
@required {userID: int, cardID: int, date_start: str # The start date for making statements., date_end: str # The end date for making statements., regional_format: str # Required for CSV exports. The regional format of the statement, can be UK_US (comma-separated) or EUROPEAN (semicolon-separated).}
@returns(200) {Id: map{id: int}} # Used to serialize ExportStatementCardCsv
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/card/{cardID}/export-statement-card-csv
@desc Used to serialize ExportStatementCardCsv
@required {userID: int, cardID: int}
@returns(200) Used to serialize ExportStatementCardCsv
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/card/{cardID}/export-statement-card-csv/{itemId}
@desc Used to serialize ExportStatementCardCsv
@required {userID: int, cardID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, date_start: str, date_end: str, status: str, regional_format: str, card_id: int} # Used to serialize ExportStatementCardCsv
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/card/{cardID}/export-statement-card-csv/{itemId}
@desc Used to serialize ExportStatementCardCsv
@required {userID: int, cardID: int, itemId: int}
@returns(200) Used to serialize ExportStatementCardCsv
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/card/{cardID}/export-statement-card-pdf
@desc Used to serialize ExportStatementCardPdf
@required {userID: int, cardID: int, date_start: str # The start date for making statements., date_end: str # The end date for making statements.}
@returns(200) {Id: map{id: int}} # Used to serialize ExportStatementCardPdf
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/card/{cardID}/export-statement-card-pdf
@desc Used to serialize ExportStatementCardPdf
@required {userID: int, cardID: int}
@returns(200) Used to serialize ExportStatementCardPdf
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/card/{cardID}/export-statement-card-pdf/{itemId}
@desc Used to serialize ExportStatementCardPdf
@required {userID: int, cardID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, date_start: str, date_end: str, status: str, card_id: int} # Used to serialize ExportStatementCardPdf
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/card/{cardID}/export-statement-card-pdf/{itemId}
@desc Used to serialize ExportStatementCardPdf
@required {userID: int, cardID: int, itemId: int}
@returns(200) Used to serialize ExportStatementCardPdf
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/feature-announcement/{itemId}
@desc view for updating the feature display.
@required {userID: int, itemId: int}
@returns(200) {avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, title: str, sub_title: str, type: str} # view for updating the feature display.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/card/{cardID}/generated-cvc2
@desc Generate a new CVC2 code for a card.
@required {userID: int, cardID: int}
@optional {type: str # The type of generated cvc2. Can be STATIC or GENERATED.}
@returns(200) {Id: map{id: int}} # Endpoint for generating and retrieving a new CVC2 code.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/card/{cardID}/generated-cvc2
@desc Get all generated CVC2 codes for a card.
@required {userID: int, cardID: int}
@returns(200) Endpoint for generating and retrieving a new CVC2 code.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/card/{cardID}/generated-cvc2/{itemId}
@desc Get the details for a specific generated CVC2 code.
@required {userID: int, cardID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, type: str, cvc2: str, status: str, expiry_time: str} # Endpoint for generating and retrieving a new CVC2 code.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/card/{cardID}/generated-cvc2/{itemId}
@desc Endpoint for generating and retrieving a new CVC2 code.
@required {userID: int, cardID: int, itemId: int}
@optional {type: str # The type of generated cvc2. Can be STATIC or GENERATED.}
@returns(200) {Id: map{id: int}} # Endpoint for generating and retrieving a new CVC2 code.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group health-check
@endpoint GET /health-check
@desc Basic health check for uptime and instance health monitoring.
@returns(200) Basic health check for uptime and instance health monitoring.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group user
@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction
@desc View for requesting iDEAL transactions and polling their status.
@required {userID: int, monetary-accountID: int}
@optional {amount_requested: map{value: str, currency: str}, issuer: str # The BIC of the issuer., monetary_account_id: int # The id of the monetary account this ideal merchant transaction links to., alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, amount_guaranteed: map{value: str, currency: str}, expiration: str # When the transaction will expire., issuer_name: str # The Name of the issuer., issuer_authentication_url: str # The URL to visit to, purchase_identifier: str # The 'purchase ID' of the iDEAL transaction., status: str # The status of the transaction., status_timestamp: str # When the status was last updated., transaction_identifier: str # The 'transaction ID' of the iDEAL transaction.}
@returns(200) {Id: map{id: int}} # View for requesting iDEAL transactions and polling their status.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction
@desc View for requesting iDEAL transactions and polling their status.
@required {userID: int, monetary-accountID: int}
@returns(200) View for requesting iDEAL transactions and polling their status.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{itemId}
@desc View for requesting iDEAL transactions and polling their status.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, amount_guaranteed: map{value: str, currency: str}, amount_requested: map{value: str, currency: str}, expiration: str, issuer: str, issuer_name: str, issuer_authentication_url: str, purchase_identifier: str, status: str, status_timestamp: str, transaction_identifier: str} # View for requesting iDEAL transactions and polling their status.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/insight-preference-date
@desc Used to allow users to set insight/budget preferences.
@required {userID: int}
@returns(200) Used to allow users to set insight/budget preferences.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/insights
@desc Used to get insights about transactions between given time range.
@required {userID: int}
@returns(200) Used to get insights about transactions between given time range.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/insights-search
@desc Used to get events based on time and insight category.
@required {userID: int}
@returns(200) Used to get events based on time and insight category.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group installation
@endpoint POST /installation
@desc This is the only API call that does not require you to use the "X-Bunq-Client-Authentication" and "X-Bunq-Client-Signature" headers.
@required {client_public_key: str # Your public key. This is the public part of the key pair that you are going to use to create value of the "X-Bunq-Client-Signature" header for all future API calls.}
@returns(200) {Id: map{id: int}, Token: map{id: int, created: str, updated: str, token: str}, ServerPublicKey: map{server_public_key: str}} # Installation is used to tell the server about the public key of your key pair. The server uses this key to verify your subsequent calls, which need to be signed with your own private key. Additionally, you can use the token you get from an Installation to authenticate the registration of a new device.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /installation
@desc You must have an active session to make this call. This call returns the Id of the the Installation you are using in your session.
@returns(200) Installation is used to tell the server about the public key of your key pair. The server uses this key to verify your subsequent calls, which need to be signed with your own private key. Additionally, you can use the token you get from an Installation to authenticate the registration of a new device.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /installation/{itemId}
@desc You must have an active session to make this call. This call is used to check whether the Id you provide is the Id of your current installation or not.
@required {itemId: int}
@returns(200) {id: int} # Installation is used to tell the server about the public key of your key pair. The server uses this key to verify your subsequent calls, which need to be signed with your own private key. Additionally, you can use the token you get from an Installation to authenticate the registration of a new device.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group user
@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate/{payment-auto-allocateID}/instance
@desc List all the times a users payment was automatically allocated.
@required {userID: int, monetary-accountID: int, payment-auto-allocateID: int}
@returns(200) List all the times a users payment was automatically allocated.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate/{payment-auto-allocateID}/instance/{itemId}
@desc List all the times a users payment was automatically allocated.
@required {userID: int, monetary-accountID: int, payment-auto-allocateID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map{payments: map{Payment: [map]}}, payment_id: int, all_ginmon_transaction_order: [map]} # List all the times a users payment was automatically allocated.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/invoice
@desc Used to view a bunq invoice.
@required {userID: int, monetary-accountID: int}
@returns(200) Used to view a bunq invoice.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/invoice/{itemId}
@desc Used to view a bunq invoice.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, invoice_date: str, invoice_number: str, status: str, category: str, group: [map], total_vat_inclusive: map{value: str, currency: str}, total_vat_exclusive: map{value: str, currency: str}, total_vat: map{value: str, currency: str}, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, address: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_address: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, chamber_of_commerce_number: str, vat_number: str, request_reference_split_the_bill: [map]} # Used to view a bunq invoice.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/invoice
@desc Used to list bunq invoices by user.
@required {userID: int}
@returns(200) Used to list bunq invoices by user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/invoice/{itemId}
@desc Used to list bunq invoices by user.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, invoice_date: str, invoice_number: str, status: str, group: [map], total_vat_inclusive: map{value: str, currency: str}, total_vat_exclusive: map{value: str, currency: str}, total_vat: map{value: str, currency: str}, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, address: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_address: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, chamber_of_commerce_number: str, vat_number: str} # Used to list bunq invoices by user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/invoice/{invoiceID}/invoice-export/{itemId}
@desc Get a PDF export of an invoice.
@required {userID: int, invoiceID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, status: str} # Get a PDF export of an invoice.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/invoice/{invoiceID}/invoice-export/{itemId}
@desc Get a PDF export of an invoice.
@required {userID: int, invoiceID: int, itemId: int}
@returns(200) {Id: map{id: int}} # Get a PDF export of an invoice.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/invoice/{invoiceID}/invoice-export/{itemId}
@desc Get a PDF export of an invoice.
@required {userID: int, invoiceID: int, itemId: int}
@returns(200) Get a PDF export of an invoice.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/invoice/{invoiceID}/invoice-export
@desc Get a PDF export of an invoice.
@required {userID: int, invoiceID: int}
@returns(200) {Id: map{id: int}} # Get a PDF export of an invoice.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/credential-password-ip/{credential-password-ipID}/ip/{itemId}
@desc Manage the IPs which may be used for a credential of a user for server authentication.
@required {userID: int, credential-password-ipID: int, itemId: int}
@returns(200) {ip: str, status: str} # Manage the IPs which may be used for a credential of a user for server authentication.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/credential-password-ip/{credential-password-ipID}/ip/{itemId}
@desc Manage the IPs which may be used for a credential of a user for server authentication.
@required {userID: int, credential-password-ipID: int, itemId: int, ip: str # The IP address.}
@optional {status: str # The status of the IP. May be "ACTIVE" or "INACTIVE". It is only possible to make requests from "ACTIVE" IP addresses. Only "ACTIVE" IPs will be billed.}
@returns(200) {Id: map{id: int}} # Manage the IPs which may be used for a credential of a user for server authentication.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/credential-password-ip/{credential-password-ipID}/ip
@desc Manage the IPs which may be used for a credential of a user for server authentication.
@required {userID: int, credential-password-ipID: int, ip: str # The IP address.}
@optional {status: str # The status of the IP. May be "ACTIVE" or "INACTIVE". It is only possible to make requests from "ACTIVE" IP addresses. Only "ACTIVE" IPs will be billed.}
@returns(200) {Id: map{id: int}} # Manage the IPs which may be used for a credential of a user for server authentication.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/credential-password-ip/{credential-password-ipID}/ip
@desc Manage the IPs which may be used for a credential of a user for server authentication.
@required {userID: int, credential-password-ipID: int}
@returns(200) Manage the IPs which may be used for a credential of a user for server authentication.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/legal-name
@desc Endpoint for getting available legal names that can be used by the user.
@required {userID: int}
@returns(200) Endpoint for getting available legal names that can be used by the user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/limit
@desc Get all limits for the authenticated user.
@required {userID: int}
@returns(200) Show the limits for the authenticated user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{itemId}
@desc MasterCard transaction view.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {id: int, monetary_account_id: int, card_id: int, amount_local: map{value: str, currency: str}, amount_converted: map{value: str, currency: str}, amount_billing: map{value: str, currency: str}, amount_original_local: map{value: str, currency: str}, amount_original_billing: map{value: str, currency: str}, amount_fee: map{value: str, currency: str}, card_authorisation_id_response: str, decision: str, payment_status: str, decision_description: str, decision_description_translated: str, decision_together_url: str, description: str, authorisation_status: str, authorisation_type: str, pan_entry_mode_user: str, settlement_status: str, clearing_status: str, maturity_date: str, city: str, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, label_card: map{uuid: str, type: str, second_line: str, expiry_date: str, status: str, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}}, merchant_id: str, token_status: str, reservation_expiry_time: str, clearing_expiry_time: str, applied_limit: str, secure_code_id: int, wallet_provider_id: str, request_reference_split_the_bill: [map], card_tokenization_event: map{id: int, created: str, updated: str, action: str, user_id: str, monetary_account_id: str, object: map{BunqMeTab: map{bunqme_tab_entry: map, status: str, event_id: int}, BunqMeTabResultResponse: map{payment: map}, BunqMeFundraiserResult: map{id: int, created: str, updated: str, bunqme_fundraiser_profile: map, payments: [map]}, Card: map{pin_code: str, activation_code: str, status: str, order_status: str, card_limit: map, card_limit_atm: map, country_permission: [map], pin_code_assignment: [map], primary_account_numbers: [map], monetary_account_id_fallback: int, preferred_name_on_card: str, second_line: str, cancellation_reason: str}, CardDebit: map{second_line: str, name_on_card: str, preferred_name_on_card: str, alias: map, type: str, product_type: str, pin_code_assignment: [map], monetary_account_id_fallback: int, order_status: str}, DraftPayment: map{status: str, entries: [map], previous_updated_timestamp: str, number_of_required_accepts: int, schedule: map}, FeatureAnnouncement: map{avatar: map, title: str, sub_title: str, type: str}, IdealMerchantTransaction: map{amount_requested: map, issuer: str, monetary_account_id: int, alias: map, counterparty_alias: map, amount_guaranteed: map, expiration: str, issuer_name: str, issuer_authentication_url: str, purchase_identifier: str, status: str, status_timestamp: str, transaction_identifier: str}, Invoice: map{status: str, description: str, external_url: str, id: int, created: str, updated: str, invoice_date: str, invoice_number: str, category: str, group: [map], total_vat_inclusive: map, total_vat_exclusive: map, total_vat: map, alias: map, address: map, counterparty_alias: map, counterparty_address: map, chamber_of_commerce_number: str, vat_number: str, request_reference_split_the_bill: [map]}, ScheduledPayment: map{payment: map, schedule: map, purpose: str, status: str}, ScheduledPaymentBatch: map{payments: [map], schedule: map}, ScheduledInstance: map{state: str, time_start: str, time_end: str, error_message: [[map]], scheduled_object: map, result_object: map, request_reference_split_the_bill: [map]}, MasterCardAction: map{id: int, monetary_account_id: int, card_id: int, amount_local: map, amount_converted: map, amount_billing: map, amount_original_local: map, amount_original_billing: map, amount_fee: map, card_authorisation_id_response: str, decision: str, payment_status: str, decision_description: str, decision_description_translated: str, decision_together_url: str, description: str, authorisation_status: str, authorisation_type: str, pan_entry_mode_user: str, settlement_status: str, clearing_status: str, maturity_date: str, city: str, alias: map, counterparty_alias: map, label_card: map, merchant_id: str, token_status: str, reservation_expiry_time: str, clearing_expiry_time: str, applied_limit: str, secure_code_id: int, wallet_provider_id: str, request_reference_split_the_bill: [map], card_tokenization_event: map, all_mastercard_action_refund: [map], pos_card_presence: str, pos_card_holder_presence: str, eligible_whitelist_id: int, cashback_payout_item: map, point_mutation: map, blacklist: map, blocklist: map, additional_authentication_status: str, pin_status: str, mastercard_action_report: map, merchant_category_code: str, company_employee_card_receipt: map}, BankSwitchServiceNetherlandsIncomingPayment: map{bank_switch_service: map, payment: map}, Payment: map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map, type: str, sub_type: str, payment_arrival_expected: map, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map, address_billing: map, geolocation: map, request_reference_split_the_bill: [map], balance_after_mutation: map, payment_auto_allocate_instance: map, payment_suspended_outgoing: map, payment_fee: map}, PaymentBatch: map{payments: map}, RequestInquiryBatch: map{request_inquiries: [map], status: str, total_amount_inquired: map, event_id: int, reference_split_the_bill: map}, RequestInquiry: map{amount_inquired: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, status: str, minimum_age: int, require_address: str, want_tip: bool, allow_amount_lower: bool, allow_amount_higher: bool, allow_bunqme: bool, redirect_url: str, event_id: int, id: int, created: str, updated: str, time_responded: str, time_expiry: str, monetary_account_id: int, amount_responded: map, user_alias_created: map, user_alias_revoked: map, batch_id: int, scheduled_id: int, bunqme_share_url: str, address_shipping: map, address_billing: map, geolocation: map, reference_split_the_bill: map}, RequestResponse: map{amount_responded: map, status: str, address_shipping: map, address_billing: map, currency_conversion_quote_id: int, id: int, created: str, updated: str, time_responded: str, time_expiry: str, time_refund_requested: str, time_refunded: str, user_refund_requested: map, monetary_account_id: int, amount_inquired: map, description: str, alias: map, counterparty_alias: map, attachment: [map], minimum_age: int, require_address: str, geolocation: map, type: str, sub_type: str, redirect_url: str, credit_scheme_identifier: str, mandate_identifier: str, registration_action: str, eligible_whitelist_id: int, request_reference_split_the_bill: [map], event_id: int, monetary_account_preferred_id: int}, ShareInviteBankInquiry: map{counter_user_alias: map, access_type: str, draft_share_invite_bank_id: int, share_detail: map, status: str, relationship: str, share_type: str, start_date: str, end_date: str, alias: map, user_alias_created: map, user_alias_revoked: map, monetary_account_id: int, id: int}, ShareInviteBankResponse: map{status: str, card_id: int, id: int, created: str, updated: str, counter_alias: map, user_alias_cancelled: map, monetary_account_id: int, draft_share_invite_bank_id: int, share_detail: map, access_type: str, relation_user: map, share_type: str, start_date: str, end_date: str, description: str}, SofortMerchantTransaction: map{amount_requested: map, issuer: str, monetary_account_id: int, alias: map, counterparty_alias: map, amount_guaranteed: map, issuer_authentication_url: str, status: str, error_message: [[map]], transaction_identifier: str}, TransferwisePayment: map{monetary_account_id: str, recipient_id: str, alias: map, counterparty_alias: map, status: str, sub_status: str, status_transferwise: str, status_transferwise_issue: str, amount_source: map, amount_target: map, rate: str, reference: str, pay_in_reference: str, time_delivery_estimate: str, quote: map}}, status: str, object_data_at_event: map{BunqMeTab: map{bunqme_tab_entry: map, status: str, event_id: int}, BunqMeTabResultResponse: map{payment: map}, BunqMeFundraiserResult: map{id: int, created: str, updated: str, bunqme_fundraiser_profile: map, payments: [map]}, Card: map{pin_code: str, activation_code: str, status: str, order_status: str, card_limit: map, card_limit_atm: map, country_permission: [map], pin_code_assignment: [map], primary_account_numbers: [map], monetary_account_id_fallback: int, preferred_name_on_card: str, second_line: str, cancellation_reason: str}, CardDebit: map{second_line: str, name_on_card: str, preferred_name_on_card: str, alias: map, type: str, product_type: str, pin_code_assignment: [map], monetary_account_id_fallback: int, order_status: str}, DraftPayment: map{status: str, entries: [map], previous_updated_timestamp: str, number_of_required_accepts: int, schedule: map}, FeatureAnnouncement: map{avatar: map, title: str, sub_title: str, type: str}, IdealMerchantTransaction: map{amount_requested: map, issuer: str, monetary_account_id: int, alias: map, counterparty_alias: map, amount_guaranteed: map, expiration: str, issuer_name: str, issuer_authentication_url: str, purchase_identifier: str, status: str, status_timestamp: str, transaction_identifier: str}, Invoice: map{status: str, description: str, external_url: str, id: int, created: str, updated: str, invoice_date: str, invoice_number: str, category: str, group: [map], total_vat_inclusive: map, total_vat_exclusive: map, total_vat: map, alias: map, address: map, counterparty_alias: map, counterparty_address: map, chamber_of_commerce_number: str, vat_number: str, request_reference_split_the_bill: [map]}, ScheduledPayment: map{payment: map, schedule: map, purpose: str, status: str}, ScheduledPaymentBatch: map{payments: [map], schedule: map}, ScheduledInstance: map{state: str, time_start: str, time_end: str, error_message: [[map]], scheduled_object: map, result_object: map, request_reference_split_the_bill: [map]}, MasterCardAction: map{id: int, monetary_account_id: int, card_id: int, amount_local: map, amount_converted: map, amount_billing: map, amount_original_local: map, amount_original_billing: map, amount_fee: map, card_authorisation_id_response: str, decision: str, payment_status: str, decision_description: str, decision_description_translated: str, decision_together_url: str, description: str, authorisation_status: str, authorisation_type: str, pan_entry_mode_user: str, settlement_status: str, clearing_status: str, maturity_date: str, city: str, alias: map, counterparty_alias: map, label_card: map, merchant_id: str, token_status: str, reservation_expiry_time: str, clearing_expiry_time: str, applied_limit: str, secure_code_id: int, wallet_provider_id: str, request_reference_split_the_bill: [map], card_tokenization_event: map, all_mastercard_action_refund: [map], pos_card_presence: str, pos_card_holder_presence: str, eligible_whitelist_id: int, cashback_payout_item: map, point_mutation: map, blacklist: map, blocklist: map, additional_authentication_status: str, pin_status: str, mastercard_action_report: map, merchant_category_code: str, company_employee_card_receipt: map}, BankSwitchServiceNetherlandsIncomingPayment: map{bank_switch_service: map, payment: map}, Payment: map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map, type: str, sub_type: str, payment_arrival_expected: map, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map, address_billing: map, geolocation: map, request_reference_split_the_bill: [map], balance_after_mutation: map, payment_auto_allocate_instance: map, payment_suspended_outgoing: map, payment_fee: map}, PaymentBatch: map{payments: map}, RequestInquiryBatch: map{request_inquiries: [map], status: str, total_amount_inquired: map, event_id: int, reference_split_the_bill: map}, RequestInquiry: map{amount_inquired: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, status: str, minimum_age: int, require_address: str, want_tip: bool, allow_amount_lower: bool, allow_amount_higher: bool, allow_bunqme: bool, redirect_url: str, event_id: int, id: int, created: str, updated: str, time_responded: str, time_expiry: str, monetary_account_id: int, amount_responded: map, user_alias_created: map, user_alias_revoked: map, batch_id: int, scheduled_id: int, bunqme_share_url: str, address_shipping: map, address_billing: map, geolocation: map, reference_split_the_bill: map}, RequestResponse: map{amount_responded: map, status: str, address_shipping: map, address_billing: map, currency_conversion_quote_id: int, id: int, created: str, updated: str, time_responded: str, time_expiry: str, time_refund_requested: str, time_refunded: str, user_refund_requested: map, monetary_account_id: int, amount_inquired: map, description: str, alias: map, counterparty_alias: map, attachment: [map], minimum_age: int, require_address: str, geolocation: map, type: str, sub_type: str, redirect_url: str, credit_scheme_identifier: str, mandate_identifier: str, registration_action: str, eligible_whitelist_id: int, request_reference_split_the_bill: [map], event_id: int, monetary_account_preferred_id: int}, ShareInviteBankInquiry: map{counter_user_alias: map, access_type: str, draft_share_invite_bank_id: int, share_detail: map, status: str, relationship: str, share_type: str, start_date: str, end_date: str, alias: map, user_alias_created: map, user_alias_revoked: map, monetary_account_id: int, id: int}, ShareInviteBankResponse: map{status: str, card_id: int, id: int, created: str, updated: str, counter_alias: map, user_alias_cancelled: map, monetary_account_id: int, draft_share_invite_bank_id: int, share_detail: map, access_type: str, relation_user: map, share_type: str, start_date: str, end_date: str, description: str}, SofortMerchantTransaction: map{amount_requested: map, issuer: str, monetary_account_id: int, alias: map, counterparty_alias: map, amount_guaranteed: map, issuer_authentication_url: str, status: str, error_message: [[map]], transaction_identifier: str}, TransferwisePayment: map{monetary_account_id: str, recipient_id: str, alias: map, counterparty_alias: map, status: str, sub_status: str, status_transferwise: str, status_transferwise_issue: str, amount_source: map, amount_target: map, rate: str, reference: str, pay_in_reference: str, time_delivery_estimate: str, quote: map}}, is_event_latest_for_object: bool, is_event_reassignable: bool}, all_mastercard_action_refund: [map], pos_card_presence: str, pos_card_holder_presence: str, eligible_whitelist_id: int, cashback_payout_item: map{status: str, amount: map{value: str, currency: str}, rate_applied: str, transaction_category: map{category: str, type: str, status: str, order: int, description: str, description_translated: str, color: str, icon: str}, user_partner_promotion: map{promotion_code: str, status: str, number_of_transaction_remaining: int, partner_promotion: map{public_uuid: str, status: str, promotion_code: str, amount_cashback_per_transaction_maximum: map, number_of_transaction_maximum: int, amount_transaction_minimum: map, url_together: str, deeplink: str, partner_name: str, partner_avatar: map, promotion_title_short: [str], promotion_title_long: [str], promotion_description: [str]}}}, point_mutation: map{number_of_point: int}, blacklist: map{merchant_name: str, merchant_id: str, merchant_identifier: str, mastercard_merchant_id: str, external_merchant_id: str, id: int, created: str, updated: str, status: str, merchant_hash: str, merchant_avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}}, blocklist: map{merchant_name: str, merchant_id: str, merchant_identifier: str, mastercard_merchant_id: str, external_merchant_id: str, id: int, created: str, updated: str, status: str, merchant_hash: str, merchant_avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}}, additional_authentication_status: str, pin_status: str, mastercard_action_report: map{mastercard_action_id: int, type: str, status: str, merchant_id: str, merchant_name: str, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}}, merchant_category_code: str, company_employee_card_receipt: map{status: str}} # MasterCard transaction view.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/mastercard-action
@desc MasterCard transaction view.
@required {userID: int, monetary-accountID: int}
@returns(200) MasterCard transaction view.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{itemId}
@desc Get a specific MonetaryAccount.
@required {userID: int, itemId: int}
@returns(200) {MonetaryAccountLight: map{currency: str, description: str, daily_limit: map{value: str, currency: str}, avatar_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, user_id: int, balance_maximum: map{value: str, currency: str}, budget_month_used: map{value: str, currency: str}, budget_month_maximum: map{value: str, currency: str}, budget_year_used: map{value: str, currency: str}, budget_year_maximum: map{value: str, currency: str}, budget_withdrawal_year_used: map{value: str, currency: str}, budget_withdrawal_year_maximum: map{value: str, currency: str}}, MonetaryAccountBank: map{currency: str, description: str, daily_limit: map{value: str, currency: str}, avatar_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, display_name: str, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, country_iban: str, id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, user_id: int, monetary_account_profile: map{profile_fill: map{status: str, balance_preferred: map, balance_threshold_low: map, issuer: map}, profile_drain: map{status: str, balance_preferred: map, balance_threshold_high: map, savings_account_alias: map}}, all_auto_save_id: [map]}, MonetaryAccountExternal: map{currency: str, service: str, description: str, daily_limit: map{value: str, currency: str}, avatar_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, display_name: str, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, user_id: int, monetary_account_profile: map{profile_fill: map{status: str, balance_preferred: map, balance_threshold_low: map, issuer: map}, profile_drain: map{status: str, balance_preferred: map, balance_threshold_high: map, savings_account_alias: map}}, all_auto_save_id: [map], open_banking_account: map{status: str, iban: str, time_synced_last: str, provider_bank: map{account_information_service_status: str, payment_information_service_status: str, name: str, aiia_provider_id: str, country: str, all_payment_method_allowed_sepa: [str], all_payment_method_allowed_domestic: [str], audience_business_status: bool, audience_private_status: bool, avatar: map}, balance_booked: map{value: str, currency: str}, balance_available: map{value: str, currency: str}}}, MonetaryAccountInvestment: map{currency: str, provider: str, description: str, daily_limit: map{value: str, currency: str}, avatar_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, display_name: str, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, birdee_investment_portfolio: map{risk_profile_type: str, investment_theme: str, name: str, goal: map{amount_target: map, time_end: str}, status: str, number_of_strategy_change_annual_maximum: int, number_of_strategy_change_annual_used: int, external_identifier: str, balance: map{amount_available: map, amount_deposit_total: map, amount_withdrawal_total: map, amount_fee_total: map, amount_profit: map, amount_deposit_pending: map, amount_withdrawal_pending: map}, allocations: [map]}, monetary_account_deposit_initial_id: int, amount_deposit_initial: map{value: str, currency: str}, id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, user_id: int, monetary_account_profile: map{profile_fill: map{status: str, balance_preferred: map, balance_threshold_low: map, issuer: map}, profile_drain: map{status: str, balance_preferred: map, balance_threshold_high: map, savings_account_alias: map}}, all_auto_save_id: [map]}, MonetaryAccountJoint: map{currency: str, description: str, daily_limit: map{value: str, currency: str}, overdraft_limit: map{value: str, currency: str}, alias: [map], avatar_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, all_co_owner: [map], setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, public_uuid: str, user_id: int, monetary_account_profile: map{profile_fill: map{status: str, balance_preferred: map, balance_threshold_low: map, issuer: map}, profile_drain: map{status: str, balance_preferred: map, balance_threshold_high: map, savings_account_alias: map}}, all_auto_save_id: [map]}, MonetaryAccountSavings: map{currency: str, description: str, daily_limit: map{value: str, currency: str}, avatar_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, all_co_owner: [map], setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, savings_goal: map{value: str, currency: str}, id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, user_id: int, monetary_account_profile: map{profile_fill: map{status: str, balance_preferred: map, balance_threshold_low: map, issuer: map}, profile_drain: map{status: str, balance_preferred: map, balance_threshold_high: map, savings_account_alias: map}}, savings_goal_progress: int, number_of_payment_remaining: str, all_auto_save_id: [map]}, MonetaryAccountSwitchService: map{id: int, created: str, description: str, status: str, sub_status: str}, MonetaryAccountExternalSavings: map{currency: str, service: str, description: str, daily_limit: map{value: str, currency: str}, avatar_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, display_name: str, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, savings_goal: map{value: str, currency: str}, id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, user_id: int, monetary_account_profile: map{profile_fill: map{status: str, balance_preferred: map, balance_threshold_low: map, issuer: map}, profile_drain: map{status: str, balance_preferred: map, balance_threshold_high: map, savings_account_alias: map}}, all_auto_save_id: [map], savings_goal_progress: int, number_of_payment_remaining: str}, MonetaryAccountCard: map{id: int, created: str, updated: str, currency: str, description: str, daily_limit: map{value: str, currency: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, balance_real: map{value: str, currency: str}, alias: [map], public_uuid: str, status: str, sub_status: str, user_id: int}} # Used to show the MonetaryAccounts that you can access. Currently the only MonetaryAccount type is MonetaryAccountBank. See also: monetary-account-bank.Notification filters can be set on a monetary account level to receive callbacks. For more information check the dedicated callbacks page.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account
@desc Get a collection of all your MonetaryAccounts.
@required {userID: int}
@returns(200) Used to show the MonetaryAccounts that you can access. Currently the only MonetaryAccount type is MonetaryAccountBank. See also: monetary-account-bank.Notification filters can be set on a monetary account level to receive callbacks. For more information check the dedicated callbacks page.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account-bank
@desc Create new MonetaryAccountBank.
@required {userID: int}
@optional {currency: str # The currency of the MonetaryAccountBank as an ISO 4217 formatted currency code., description: str # The description of the MonetaryAccountBank. Defaults to 'bunq account'., daily_limit: map{value: str, currency: str}, avatar_uuid: str # The UUID of the Avatar of the MonetaryAccountBank., status: str # The status of the MonetaryAccountBank. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN, sub_status: str # The sub-status of the MonetaryAccountBank 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., reason: str # The reason for voluntarily cancelling (closing) the MonetaryAccountBank, can only be OTHER., reason_description: str # The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountBank. Can be any user provided message., display_name: str # The legal name of the user / company using this monetary account., setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, country_iban: str # The country of the monetary account IBAN., id: int # The id of the MonetaryAccountBank., created: str # The timestamp of the MonetaryAccountBank's creation., updated: str # The timestamp of the MonetaryAccountBank's last update., avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, alias: [map{type: str, value: str, name: str, service: str}] # The Aliases for the MonetaryAccountBank., public_uuid: str # The MonetaryAccountBank's public UUID., user_id: int # The id of the User who owns the MonetaryAccountBank., monetary_account_profile: map{profile_fill: map, profile_drain: map}, all_auto_save_id: [map{id: int}] # The ids of the AutoSave.}
@returns(200) {Id: map{id: int}} # With MonetaryAccountBank you can create a new bank account, retrieve information regarding your existing MonetaryAccountBanks and update specific fields of an existing MonetaryAccountBank. Examples of fields that can be updated are the description, the daily limit and the avatar of the account.Notification filters can be set on a monetary account level to receive callbacks. For more information check the dedicated callbacks page.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account-bank
@desc Gets a listing of all MonetaryAccountBanks of a given user.
@required {userID: int}
@returns(200) With MonetaryAccountBank you can create a new bank account, retrieve information regarding your existing MonetaryAccountBanks and update specific fields of an existing MonetaryAccountBank. Examples of fields that can be updated are the description, the daily limit and the avatar of the account.Notification filters can be set on a monetary account level to receive callbacks. For more information check the dedicated callbacks page.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account-bank/{itemId}
@desc Get a specific MonetaryAccountBank.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, currency: str, description: str, daily_limit: map{value: str, currency: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, user_id: int, monetary_account_profile: map{profile_fill: map{status: str, balance_preferred: map{value: str, currency: str}, balance_threshold_low: map{value: str, currency: str}, issuer: map{bic: str, name: str}}, profile_drain: map{status: str, balance_preferred: map{value: str, currency: str}, balance_threshold_high: map{value: str, currency: str}, savings_account_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}}}, display_name: str, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, all_auto_save_id: [map]} # With MonetaryAccountBank you can create a new bank account, retrieve information regarding your existing MonetaryAccountBanks and update specific fields of an existing MonetaryAccountBank. Examples of fields that can be updated are the description, the daily limit and the avatar of the account.Notification filters can be set on a monetary account level to receive callbacks. For more information check the dedicated callbacks page.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account-bank/{itemId}
@desc Update a specific existing MonetaryAccountBank.
@required {userID: int, itemId: int}
@optional {currency: str # The currency of the MonetaryAccountBank as an ISO 4217 formatted currency code., description: str # The description of the MonetaryAccountBank. Defaults to 'bunq account'., daily_limit: map{value: str, currency: str}, avatar_uuid: str # The UUID of the Avatar of the MonetaryAccountBank., status: str # The status of the MonetaryAccountBank. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN, sub_status: str # The sub-status of the MonetaryAccountBank 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., reason: str # The reason for voluntarily cancelling (closing) the MonetaryAccountBank, can only be OTHER., reason_description: str # The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountBank. Can be any user provided message., display_name: str # The legal name of the user / company using this monetary account., setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, country_iban: str # The country of the monetary account IBAN., id: int # The id of the MonetaryAccountBank., created: str # The timestamp of the MonetaryAccountBank's creation., updated: str # The timestamp of the MonetaryAccountBank's last update., avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, alias: [map{type: str, value: str, name: str, service: str}] # The Aliases for the MonetaryAccountBank., public_uuid: str # The MonetaryAccountBank's public UUID., user_id: int # The id of the User who owns the MonetaryAccountBank., monetary_account_profile: map{profile_fill: map, profile_drain: map}, all_auto_save_id: [map{id: int}] # The ids of the AutoSave.}
@returns(200) {Id: map{id: int}} # With MonetaryAccountBank you can create a new bank account, retrieve information regarding your existing MonetaryAccountBanks and update specific fields of an existing MonetaryAccountBank. Examples of fields that can be updated are the description, the daily limit and the avatar of the account.Notification filters can be set on a monetary account level to receive callbacks. For more information check the dedicated callbacks page.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account-card/{itemId}
@desc Get a specific MonetaryAccountCard.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, currency: str, description: str, daily_limit: map{value: str, currency: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, balance_real: map{value: str, currency: str}, alias: [map], public_uuid: str, status: str, sub_status: str, user_id: int}
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account-card/{itemId}
@desc Update a specific existing MonetaryAccountCard.
@required {userID: int, itemId: int}
@optional {id: int # The id of the MonetaryAccountCard., created: str # The timestamp of the MonetaryAccountCard's creation., updated: str # The timestamp of the MonetaryAccountCard's last update., currency: str # The currency of the MonetaryAccountCard as an ISO 4217 formatted currency code., description: str # The description of the MonetaryAccountCard. Defaults to 'prepaid credit card'., daily_limit: map{value: str, currency: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, balance_real: map{value: str, currency: str}, alias: [map{type: str, value: str, name: str, service: str}] # The Aliases for the MonetaryAccountCard., public_uuid: str # The MonetaryAccountCard's public UUID., status: str # The status of the MonetaryAccountCard., sub_status: str # The sub-status of the MonetaryAccountCard providing extra information regarding the status., user_id: int # The id of the User who owns the MonetaryAccountCard.}
@returns(200) {Id: map{id: int}}
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account-card
@desc Gets a listing of all MonetaryAccountCard of a given user.
@required {userID: int}
@returns(200)
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account-external
@desc Endpoint for managing monetary accounts which are connected to external services.
@required {userID: int}
@optional {currency: str # The currency of the MonetaryAccountExternal as an ISO 4217 formatted currency code., service: str # The external service the Monetary Account is connected with., description: str # The description of the MonetaryAccountExternal. Defaults to 'bunq account'., daily_limit: map{value: str, currency: str}, avatar_uuid: str # The UUID of the Avatar of the MonetaryAccountExternal., status: str # The status of the MonetaryAccountExternal. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN, sub_status: str # The sub-status of the MonetaryAccountExternal 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., reason: str # The reason for voluntarily cancelling (closing) the MonetaryAccountExternal, can only be OTHER., reason_description: str # The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountExternal. Can be any user provided message., display_name: str # The legal name of the user / company using this monetary account., setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, id: int # The id of the MonetaryAccountExternal., created: str # The timestamp of the MonetaryAccountExternal's creation., updated: str # The timestamp of the MonetaryAccountExternal's last update., avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, alias: [map{type: str, value: str, name: str, service: str}] # The Aliases for the MonetaryAccountExternal., public_uuid: str # The MonetaryAccountExternal's public UUID., user_id: int # The id of the User who owns the MonetaryAccountExternal., monetary_account_profile: map{profile_fill: map, profile_drain: map}, all_auto_save_id: [map{id: int}] # The ids of the AutoSave., open_banking_account: map{status: str, iban: str, time_synced_last: str, provider_bank: map, balance_booked: map, balance_available: map}}
@returns(200) {Id: map{id: int}} # Endpoint for managing monetary accounts which are connected to external services.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account-external
@desc Endpoint for managing monetary accounts which are connected to external services.
@required {userID: int}
@returns(200) Endpoint for managing monetary accounts which are connected to external services.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account-external/{itemId}
@desc Endpoint for managing monetary accounts which are connected to external services.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, currency: str, description: str, daily_limit: map{value: str, currency: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, user_id: int, monetary_account_profile: map{profile_fill: map{status: str, balance_preferred: map{value: str, currency: str}, balance_threshold_low: map{value: str, currency: str}, issuer: map{bic: str, name: str}}, profile_drain: map{status: str, balance_preferred: map{value: str, currency: str}, balance_threshold_high: map{value: str, currency: str}, savings_account_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}}}, display_name: str, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, all_auto_save_id: [map], service: str, open_banking_account: map{status: str, iban: str, time_synced_last: str, provider_bank: map{account_information_service_status: str, payment_information_service_status: str, name: str, aiia_provider_id: str, country: str, all_payment_method_allowed_sepa: [str], all_payment_method_allowed_domestic: [str], audience_business_status: bool, audience_private_status: bool, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}}, balance_booked: map{value: str, currency: str}, balance_available: map{value: str, currency: str}}} # Endpoint for managing monetary accounts which are connected to external services.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account-external/{itemId}
@desc Endpoint for managing monetary accounts which are connected to external services.
@required {userID: int, itemId: int}
@optional {currency: str # The currency of the MonetaryAccountExternal as an ISO 4217 formatted currency code., service: str # The external service the Monetary Account is connected with., description: str # The description of the MonetaryAccountExternal. Defaults to 'bunq account'., daily_limit: map{value: str, currency: str}, avatar_uuid: str # The UUID of the Avatar of the MonetaryAccountExternal., status: str # The status of the MonetaryAccountExternal. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN, sub_status: str # The sub-status of the MonetaryAccountExternal 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., reason: str # The reason for voluntarily cancelling (closing) the MonetaryAccountExternal, can only be OTHER., reason_description: str # The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountExternal. Can be any user provided message., display_name: str # The legal name of the user / company using this monetary account., setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, id: int # The id of the MonetaryAccountExternal., created: str # The timestamp of the MonetaryAccountExternal's creation., updated: str # The timestamp of the MonetaryAccountExternal's last update., avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, alias: [map{type: str, value: str, name: str, service: str}] # The Aliases for the MonetaryAccountExternal., public_uuid: str # The MonetaryAccountExternal's public UUID., user_id: int # The id of the User who owns the MonetaryAccountExternal., monetary_account_profile: map{profile_fill: map, profile_drain: map}, all_auto_save_id: [map{id: int}] # The ids of the AutoSave., open_banking_account: map{status: str, iban: str, time_synced_last: str, provider_bank: map, balance_booked: map, balance_available: map}}
@returns(200) {Id: map{id: int}} # Endpoint for managing monetary accounts which are connected to external services.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account-external-savings
@desc Endpoint for managing monetary account savings which are connected to external services.
@required {userID: int, service: str # The service the MonetaryAccountExternalSavings is connected with.}
@optional {currency: str # The currency of the MonetaryAccountExternalSavings as an ISO 4217 formatted currency code., description: str # The description of the MonetaryAccountExternalSavings. Defaults to 'bunq account'., daily_limit: map{value: str, currency: str}, avatar_uuid: str # The UUID of the Avatar of the MonetaryAccountExternalSavings., status: str # The status of the MonetaryAccountExternalSavings. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN, sub_status: str # 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., reason: str # The reason for voluntarily cancelling (closing) the MonetaryAccountExternalSavings, can only be OTHER., reason_description: str # The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountExternalSavings. Can be any user provided message., display_name: str # The legal name of the user / company using this monetary account., setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, savings_goal: map{value: str, currency: str}, id: int # The id of the MonetaryAccountExternalSavings., created: str # The timestamp of the MonetaryAccountExternalSavings's creation., updated: str # The timestamp of the MonetaryAccountExternalSavings's last update., avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, alias: [map{type: str, value: str, name: str, service: str}] # The Aliases for the MonetaryAccountExternalSavings., public_uuid: str # The MonetaryAccountExternalSavings's public UUID., user_id: int # The id of the User who owns the MonetaryAccountExternalSavings., monetary_account_profile: map{profile_fill: map, profile_drain: map}, all_auto_save_id: [map{id: int}] # The ids of the AutoSave., savings_goal_progress: int # The progress in percentages for the Savings Goal set for this MonetaryAccountExternalSavings., number_of_payment_remaining: str # The number of payments that can be made from this savings account}
@returns(200) {Id: map{id: int}} # Endpoint for managing monetary account savings which are connected to external services.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account-external-savings
@desc Endpoint for managing monetary account savings which are connected to external services.
@required {userID: int}
@returns(200) Endpoint for managing monetary account savings which are connected to external services.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account-external-savings/{itemId}
@desc Endpoint for managing monetary account savings which are connected to external services.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, currency: str, description: str, daily_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, user_id: int, monetary_account_profile: map{profile_fill: map{status: str, balance_preferred: map{value: str, currency: str}, balance_threshold_low: map{value: str, currency: str}, issuer: map{bic: str, name: str}}, profile_drain: map{status: str, balance_preferred: map{value: str, currency: str}, balance_threshold_high: map{value: str, currency: str}, savings_account_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}}}, display_name: str, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, all_auto_save_id: [map], savings_goal: map{value: str, currency: str}, savings_goal_progress: int, number_of_payment_remaining: str} # Endpoint for managing monetary account savings which are connected to external services.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account-external-savings/{itemId}
@desc Endpoint for managing monetary account savings which are connected to external services.
@required {userID: int, itemId: int, service: str # The service the MonetaryAccountExternalSavings is connected with.}
@optional {currency: str # The currency of the MonetaryAccountExternalSavings as an ISO 4217 formatted currency code., description: str # The description of the MonetaryAccountExternalSavings. Defaults to 'bunq account'., daily_limit: map{value: str, currency: str}, avatar_uuid: str # The UUID of the Avatar of the MonetaryAccountExternalSavings., status: str # The status of the MonetaryAccountExternalSavings. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN, sub_status: str # 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., reason: str # The reason for voluntarily cancelling (closing) the MonetaryAccountExternalSavings, can only be OTHER., reason_description: str # The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountExternalSavings. Can be any user provided message., display_name: str # The legal name of the user / company using this monetary account., setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, savings_goal: map{value: str, currency: str}, id: int # The id of the MonetaryAccountExternalSavings., created: str # The timestamp of the MonetaryAccountExternalSavings's creation., updated: str # The timestamp of the MonetaryAccountExternalSavings's last update., avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, alias: [map{type: str, value: str, name: str, service: str}] # The Aliases for the MonetaryAccountExternalSavings., public_uuid: str # The MonetaryAccountExternalSavings's public UUID., user_id: int # The id of the User who owns the MonetaryAccountExternalSavings., monetary_account_profile: map{profile_fill: map, profile_drain: map}, all_auto_save_id: [map{id: int}] # The ids of the AutoSave., savings_goal_progress: int # The progress in percentages for the Savings Goal set for this MonetaryAccountExternalSavings., number_of_payment_remaining: str # The number of payments that can be made from this savings account}
@returns(200) {Id: map{id: int}} # Endpoint for managing monetary account savings which are connected to external services.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account-joint
@desc The endpoint for joint monetary accounts.
@required {userID: int}
@optional {currency: str # The currency of the MonetaryAccountJoint as an ISO 4217 formatted currency code., description: str # The description of the MonetaryAccountJoint. Defaults to 'bunq account'., daily_limit: map{value: str, currency: str}, overdraft_limit: map{value: str, currency: str}, alias: [map{type: str, value: str, name: str, service: str}] # The Aliases for the MonetaryAccountJoint., avatar_uuid: str # The UUID of the Avatar of the MonetaryAccountJoint., status: str # The status of the MonetaryAccountJoint. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN, sub_status: str # The sub-status of the MonetaryAccountJoint 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., reason: str # The reason for voluntarily cancelling (closing) the MonetaryAccountJoint, can only be OTHER., reason_description: str # The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountJoint. Can be any user provided message., all_co_owner: [map{alias: map, status: str}] # The users the account will be joint with., setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, id: int # The id of the MonetaryAccountJoint., created: str # The timestamp of the MonetaryAccountJoint's creation., updated: str # The timestamp of the MonetaryAccountJoint's last update., avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, public_uuid: str # The MonetaryAccountJoint's public UUID., user_id: int # The id of the User who owns the MonetaryAccountJoint., monetary_account_profile: map{profile_fill: map, profile_drain: map}, all_auto_save_id: [map{id: int}] # The ids of the AutoSave.}
@returns(200) {Id: map{id: int}} # The endpoint for joint monetary accounts.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account-joint
@desc The endpoint for joint monetary accounts.
@required {userID: int}
@returns(200) The endpoint for joint monetary accounts.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account-joint/{itemId}
@desc The endpoint for joint monetary accounts.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, currency: str, description: str, daily_limit: map{value: str, currency: str}, overdraft_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, all_co_owner: [map], user_id: int, monetary_account_profile: map{profile_fill: map{status: str, balance_preferred: map{value: str, currency: str}, balance_threshold_low: map{value: str, currency: str}, issuer: map{bic: str, name: str}}, profile_drain: map{status: str, balance_preferred: map{value: str, currency: str}, balance_threshold_high: map{value: str, currency: str}, savings_account_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}}}, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, all_auto_save_id: [map]} # The endpoint for joint monetary accounts.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account-joint/{itemId}
@desc The endpoint for joint monetary accounts.
@required {userID: int, itemId: int}
@optional {currency: str # The currency of the MonetaryAccountJoint as an ISO 4217 formatted currency code., description: str # The description of the MonetaryAccountJoint. Defaults to 'bunq account'., daily_limit: map{value: str, currency: str}, overdraft_limit: map{value: str, currency: str}, alias: [map{type: str, value: str, name: str, service: str}] # The Aliases for the MonetaryAccountJoint., avatar_uuid: str # The UUID of the Avatar of the MonetaryAccountJoint., status: str # The status of the MonetaryAccountJoint. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN, sub_status: str # The sub-status of the MonetaryAccountJoint 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., reason: str # The reason for voluntarily cancelling (closing) the MonetaryAccountJoint, can only be OTHER., reason_description: str # The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountJoint. Can be any user provided message., all_co_owner: [map{alias: map, status: str}] # The users the account will be joint with., setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, id: int # The id of the MonetaryAccountJoint., created: str # The timestamp of the MonetaryAccountJoint's creation., updated: str # The timestamp of the MonetaryAccountJoint's last update., avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, public_uuid: str # The MonetaryAccountJoint's public UUID., user_id: int # The id of the User who owns the MonetaryAccountJoint., monetary_account_profile: map{profile_fill: map, profile_drain: map}, all_auto_save_id: [map{id: int}] # The ids of the AutoSave.}
@returns(200) {Id: map{id: int}} # The endpoint for joint monetary accounts.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account-savings
@desc Create new MonetaryAccountSavings.
@required {userID: int}
@optional {currency: str # The currency of the MonetaryAccountSavings as an ISO 4217 formatted currency code., description: str # The description of the MonetaryAccountSavings. Defaults to 'bunq account'., daily_limit: map{value: str, currency: str}, avatar_uuid: str # The UUID of the Avatar of the MonetaryAccountSavings., status: str # The status of the MonetaryAccountSavings. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN, sub_status: str # The sub-status of the MonetaryAccountSavings 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., reason: str # The reason for voluntarily cancelling (closing) the MonetaryAccountSavings, can only be OTHER., reason_description: str # The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountSavings. Can be any user provided message., all_co_owner: [map{alias: map, status: str}] # The users the account will be joint with., setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, savings_goal: map{value: str, currency: str}, id: int # The id of the MonetaryAccountSavings., created: str # The timestamp of the MonetaryAccountSavings's creation., updated: str # The timestamp of the MonetaryAccountSavings's last update., avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, alias: [map{type: str, value: str, name: str, service: str}] # The Aliases for the MonetaryAccountSavings., public_uuid: str # The MonetaryAccountSavings's public UUID., user_id: int # The id of the User who owns the MonetaryAccountSavings., monetary_account_profile: map{profile_fill: map, profile_drain: map}, savings_goal_progress: int # The progress in percentages for the Savings Goal set for this MonetaryAccountSavings., number_of_payment_remaining: str # The number of payments that can be made from this savings account, all_auto_save_id: [map{id: int}] # The ids of the AutoSave.}
@returns(200) {Id: map{id: int}} # With MonetaryAccountSavings you can create a new savings account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account-savings
@desc Gets a listing of all MonetaryAccountSavingss of a given user.
@required {userID: int}
@returns(200) With MonetaryAccountSavings you can create a new savings account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account-savings/{itemId}
@desc Get a specific MonetaryAccountSavings.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, currency: str, description: str, daily_limit: map{value: str, currency: str}, balance: map{value: str, currency: str}, alias: [map], public_uuid: str, status: str, sub_status: str, reason: str, reason_description: str, all_co_owner: [map], user_id: int, monetary_account_profile: map{profile_fill: map{status: str, balance_preferred: map{value: str, currency: str}, balance_threshold_low: map{value: str, currency: str}, issuer: map{bic: str, name: str}}, profile_drain: map{status: str, balance_preferred: map{value: str, currency: str}, balance_threshold_high: map{value: str, currency: str}, savings_account_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}}}, setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, savings_goal: map{value: str, currency: str}, savings_goal_progress: int, number_of_payment_remaining: str, all_auto_save_id: [map]} # With MonetaryAccountSavings you can create a new savings account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account-savings/{itemId}
@desc Update a specific existing MonetaryAccountSavings.
@required {userID: int, itemId: int}
@optional {currency: str # The currency of the MonetaryAccountSavings as an ISO 4217 formatted currency code., description: str # The description of the MonetaryAccountSavings. Defaults to 'bunq account'., daily_limit: map{value: str, currency: str}, avatar_uuid: str # The UUID of the Avatar of the MonetaryAccountSavings., status: str # The status of the MonetaryAccountSavings. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN, sub_status: str # The sub-status of the MonetaryAccountSavings 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., reason: str # The reason for voluntarily cancelling (closing) the MonetaryAccountSavings, can only be OTHER., reason_description: str # The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountSavings. Can be any user provided message., all_co_owner: [map{alias: map, status: str}] # The users the account will be joint with., setting: map{color: str, icon: str, default_avatar_status: str, restriction_chat: str, sdd_expiration_action: str}, savings_goal: map{value: str, currency: str}, id: int # The id of the MonetaryAccountSavings., created: str # The timestamp of the MonetaryAccountSavings's creation., updated: str # The timestamp of the MonetaryAccountSavings's last update., avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, balance: map{value: str, currency: str}, alias: [map{type: str, value: str, name: str, service: str}] # The Aliases for the MonetaryAccountSavings., public_uuid: str # The MonetaryAccountSavings's public UUID., user_id: int # The id of the User who owns the MonetaryAccountSavings., monetary_account_profile: map{profile_fill: map, profile_drain: map}, savings_goal_progress: int # The progress in percentages for the Savings Goal set for this MonetaryAccountSavings., number_of_payment_remaining: str # The number of payments that can be made from this savings account, all_auto_save_id: [map{id: int}] # The ids of the AutoSave.}
@returns(200) {Id: map{id: int}} # With MonetaryAccountSavings you can create a new savings account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group user-company
@endpoint GET /user-company/{user-companyID}/name
@desc Return all the known (trade) names for a specific user company.
@required {user-companyID: int}
@returns(200) Endpoint for getting all the known (trade) names for a user company. This is needed for updating the user name, as we only accept legal or trade names.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group user
@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/adyen-card-transaction/{adyen-card-transactionID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, adyen-card-transactionID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/adyen-card-transaction/{adyen-card-transactionID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, adyen-card-transactionID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/adyen-card-transaction/{adyen-card-transactionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, adyen-card-transactionID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/adyen-card-transaction/{adyen-card-transactionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, adyen-card-transactionID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/adyen-card-transaction/{adyen-card-transactionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, adyen-card-transactionID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{switch-service-paymentID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, switch-service-paymentID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{switch-service-paymentID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, switch-service-paymentID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{switch-service-paymentID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, switch-service-paymentID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{switch-service-paymentID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, switch-service-paymentID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{switch-service-paymentID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, switch-service-paymentID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{bunqme-fundraiser-resultID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, bunqme-fundraiser-resultID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{bunqme-fundraiser-resultID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, bunqme-fundraiser-resultID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{bunqme-fundraiser-resultID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, bunqme-fundraiser-resultID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{bunqme-fundraiser-resultID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, bunqme-fundraiser-resultID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{bunqme-fundraiser-resultID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, bunqme-fundraiser-resultID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{draft-paymentID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, draft-paymentID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{draft-paymentID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, draft-paymentID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{draft-paymentID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, draft-paymentID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{draft-paymentID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, draft-paymentID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{draft-paymentID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, draft-paymentID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{ideal-merchant-transactionID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, ideal-merchant-transactionID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{ideal-merchant-transactionID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, ideal-merchant-transactionID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{ideal-merchant-transactionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, ideal-merchant-transactionID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{ideal-merchant-transactionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, ideal-merchant-transactionID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{ideal-merchant-transactionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, ideal-merchant-transactionID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, mastercard-actionID: int, description: str # Optional description of the attachment., attachment_id: int # The reference to the uploaded file to attach to this note.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, mastercard-actionID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, mastercard-actionID: int, itemId: int, description: str # Optional description of the attachment., attachment_id: int # The reference to the uploaded file to attach to this note.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, mastercard-actionID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, mastercard-actionID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/open-banking-merchant-transaction/{open-banking-merchant-transactionID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, open-banking-merchant-transactionID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/open-banking-merchant-transaction/{open-banking-merchant-transactionID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, open-banking-merchant-transactionID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/open-banking-merchant-transaction/{open-banking-merchant-transactionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, open-banking-merchant-transactionID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/open-banking-merchant-transaction/{open-banking-merchant-transactionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, open-banking-merchant-transactionID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/open-banking-merchant-transaction/{open-banking-merchant-transactionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, open-banking-merchant-transactionID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{payment-batchID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, payment-batchID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{payment-batchID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, payment-batchID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{payment-batchID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, payment-batchID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{payment-batchID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, payment-batchID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{payment-batchID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, payment-batchID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/payment-delayed/{payment-delayedID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, payment-delayedID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-delayed/{payment-delayedID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, payment-delayedID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/payment-delayed/{payment-delayedID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, payment-delayedID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/payment-delayed/{payment-delayedID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, payment-delayedID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-delayed/{payment-delayedID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, payment-delayedID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/payment/{paymentID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, paymentID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment/{paymentID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, paymentID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/payment/{paymentID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, paymentID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/payment/{paymentID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, paymentID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment/{paymentID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, paymentID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{request-inquiry-batchID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, request-inquiry-batchID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{request-inquiry-batchID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, request-inquiry-batchID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{request-inquiry-batchID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, request-inquiry-batchID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{request-inquiry-batchID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, request-inquiry-batchID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{request-inquiry-batchID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, request-inquiry-batchID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{request-inquiryID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, request-inquiryID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{request-inquiryID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, request-inquiryID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{request-inquiryID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, request-inquiryID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{request-inquiryID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, request-inquiryID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{request-inquiryID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, request-inquiryID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/request-response/{request-responseID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, request-responseID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-response/{request-responseID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, request-responseID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/request-response/{request-responseID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, request-responseID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/request-response/{request-responseID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, request-responseID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-response/{request-responseID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, request-responseID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{schedule-instanceID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, scheduleID: int, schedule-instanceID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{schedule-instanceID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, scheduleID: int, schedule-instanceID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{schedule-instanceID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, scheduleID: int, schedule-instanceID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{schedule-instanceID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, scheduleID: int, schedule-instanceID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{schedule-instanceID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, scheduleID: int, schedule-instanceID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{schedule-payment-batchID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, schedule-payment-batchID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{schedule-payment-batchID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, schedule-payment-batchID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{schedule-payment-batchID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, schedule-payment-batchID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{schedule-payment-batchID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, schedule-payment-batchID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{schedule-payment-batchID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, schedule-payment-batchID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{schedule-paymentID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, schedule-paymentID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{schedule-paymentID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, schedule-paymentID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{schedule-paymentID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, schedule-paymentID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{schedule-paymentID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, schedule-paymentID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{schedule-paymentID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, schedule-paymentID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry-batch/{schedule-request-inquiry-batchID}/note-attachment
@desc Used to manage attachment notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiry-batchID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry-batch/{schedule-request-inquiry-batchID}/note-attachment
@desc Manage the notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiry-batchID: int}
@returns(200) Used to manage attachment notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry-batch/{schedule-request-inquiry-batchID}/note-attachment/{itemId}
@desc Used to manage attachment notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiry-batchID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry-batch/{schedule-request-inquiry-batchID}/note-attachment/{itemId}
@desc Used to manage attachment notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiry-batchID: int, itemId: int}
@returns(200) Used to manage attachment notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry-batch/{schedule-request-inquiry-batchID}/note-attachment/{itemId}
@desc Used to manage attachment notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiry-batchID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry/{schedule-request-inquiryID}/note-attachment
@desc Used to manage attachment notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiryID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry/{schedule-request-inquiryID}/note-attachment
@desc Manage the notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiryID: int}
@returns(200) Used to manage attachment notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry/{schedule-request-inquiryID}/note-attachment/{itemId}
@desc Used to manage attachment notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiryID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry/{schedule-request-inquiryID}/note-attachment/{itemId}
@desc Used to manage attachment notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiryID: int, itemId: int}
@returns(200) Used to manage attachment notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry/{schedule-request-inquiryID}/note-attachment/{itemId}
@desc Used to manage attachment notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiryID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{sofort-merchant-transactionID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, sofort-merchant-transactionID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{sofort-merchant-transactionID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, sofort-merchant-transactionID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{sofort-merchant-transactionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, sofort-merchant-transactionID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{sofort-merchant-transactionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, sofort-merchant-transactionID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{sofort-merchant-transactionID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, sofort-merchant-transactionID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/whitelist/{whitelistID}/whitelist-result/{whitelist-resultID}/note-attachment
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, whitelistID: int, whitelist-resultID: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/whitelist/{whitelistID}/whitelist-result/{whitelist-resultID}/note-attachment
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, whitelistID: int, whitelist-resultID: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/whitelist/{whitelistID}/whitelist-result/{whitelist-resultID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, whitelistID: int, whitelist-resultID: int, itemId: int, attachment_id: int # The reference to the uploaded file to attach to this note.}
@optional {description: str # Optional description of the attachment.}
@returns(200) {Id: map{id: int}} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/whitelist/{whitelistID}/whitelist-result/{whitelist-resultID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, whitelistID: int, whitelist-resultID: int, itemId: int}
@returns(200) Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/whitelist/{whitelistID}/whitelist-result/{whitelist-resultID}/note-attachment/{itemId}
@desc Used to manage attachment notes.
@required {userID: int, monetary-accountID: int, whitelistID: int, whitelist-resultID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, description: str, attachment: [map]} # Used to manage attachment notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/adyen-card-transaction/{adyen-card-transactionID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, adyen-card-transactionID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/adyen-card-transaction/{adyen-card-transactionID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, adyen-card-transactionID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/adyen-card-transaction/{adyen-card-transactionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, adyen-card-transactionID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/adyen-card-transaction/{adyen-card-transactionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, adyen-card-transactionID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/adyen-card-transaction/{adyen-card-transactionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, adyen-card-transactionID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{switch-service-paymentID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, switch-service-paymentID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{switch-service-paymentID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, switch-service-paymentID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{switch-service-paymentID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, switch-service-paymentID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{switch-service-paymentID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, switch-service-paymentID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{switch-service-paymentID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, switch-service-paymentID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{bunqme-fundraiser-resultID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, bunqme-fundraiser-resultID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{bunqme-fundraiser-resultID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, bunqme-fundraiser-resultID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{bunqme-fundraiser-resultID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, bunqme-fundraiser-resultID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{bunqme-fundraiser-resultID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, bunqme-fundraiser-resultID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{bunqme-fundraiser-resultID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, bunqme-fundraiser-resultID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{draft-paymentID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, draft-paymentID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{draft-paymentID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, draft-paymentID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{draft-paymentID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, draft-paymentID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{draft-paymentID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, draft-paymentID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{draft-paymentID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, draft-paymentID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{ideal-merchant-transactionID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, ideal-merchant-transactionID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{ideal-merchant-transactionID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, ideal-merchant-transactionID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{ideal-merchant-transactionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, ideal-merchant-transactionID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{ideal-merchant-transactionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, ideal-merchant-transactionID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{ideal-merchant-transactionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, ideal-merchant-transactionID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, mastercard-actionID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, mastercard-actionID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, mastercard-actionID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, mastercard-actionID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, mastercard-actionID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/open-banking-merchant-transaction/{open-banking-merchant-transactionID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, open-banking-merchant-transactionID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/open-banking-merchant-transaction/{open-banking-merchant-transactionID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, open-banking-merchant-transactionID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/open-banking-merchant-transaction/{open-banking-merchant-transactionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, open-banking-merchant-transactionID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/open-banking-merchant-transaction/{open-banking-merchant-transactionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, open-banking-merchant-transactionID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/open-banking-merchant-transaction/{open-banking-merchant-transactionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, open-banking-merchant-transactionID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{payment-batchID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, payment-batchID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{payment-batchID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, payment-batchID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{payment-batchID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, payment-batchID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{payment-batchID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, payment-batchID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{payment-batchID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, payment-batchID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/payment-delayed/{payment-delayedID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, payment-delayedID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-delayed/{payment-delayedID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, payment-delayedID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/payment-delayed/{payment-delayedID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, payment-delayedID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/payment-delayed/{payment-delayedID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, payment-delayedID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-delayed/{payment-delayedID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, payment-delayedID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/payment/{paymentID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, paymentID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment/{paymentID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, paymentID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/payment/{paymentID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, paymentID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/payment/{paymentID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, paymentID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment/{paymentID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, paymentID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{request-inquiry-batchID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, request-inquiry-batchID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{request-inquiry-batchID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, request-inquiry-batchID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{request-inquiry-batchID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, request-inquiry-batchID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{request-inquiry-batchID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, request-inquiry-batchID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{request-inquiry-batchID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, request-inquiry-batchID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{request-inquiryID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, request-inquiryID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{request-inquiryID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, request-inquiryID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{request-inquiryID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, request-inquiryID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{request-inquiryID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, request-inquiryID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{request-inquiryID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, request-inquiryID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/request-response/{request-responseID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, request-responseID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-response/{request-responseID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, request-responseID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/request-response/{request-responseID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, request-responseID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/request-response/{request-responseID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, request-responseID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-response/{request-responseID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, request-responseID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{schedule-instanceID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, scheduleID: int, schedule-instanceID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{schedule-instanceID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, scheduleID: int, schedule-instanceID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{schedule-instanceID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, scheduleID: int, schedule-instanceID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{schedule-instanceID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, scheduleID: int, schedule-instanceID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{schedule-instanceID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, scheduleID: int, schedule-instanceID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{schedule-payment-batchID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, schedule-payment-batchID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{schedule-payment-batchID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, schedule-payment-batchID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{schedule-payment-batchID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, schedule-payment-batchID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{schedule-payment-batchID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, schedule-payment-batchID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{schedule-payment-batchID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, schedule-payment-batchID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{schedule-paymentID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, schedule-paymentID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{schedule-paymentID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, schedule-paymentID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{schedule-paymentID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, schedule-paymentID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{schedule-paymentID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, schedule-paymentID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{schedule-paymentID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, schedule-paymentID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry-batch/{schedule-request-inquiry-batchID}/note-text
@desc Used to manage text notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiry-batchID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry-batch/{schedule-request-inquiry-batchID}/note-text
@desc Manage the notes for a given schedule request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiry-batchID: int}
@returns(200) Used to manage text notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry-batch/{schedule-request-inquiry-batchID}/note-text/{itemId}
@desc Used to manage text notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiry-batchID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry-batch/{schedule-request-inquiry-batchID}/note-text/{itemId}
@desc Used to manage text notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiry-batchID: int, itemId: int}
@returns(200) Used to manage text notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry-batch/{schedule-request-inquiry-batchID}/note-text/{itemId}
@desc Used to manage text notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiry-batchID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry/{schedule-request-inquiryID}/note-text
@desc Used to manage text notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiryID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry/{schedule-request-inquiryID}/note-text
@desc Manage the notes for a given schedule request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiryID: int}
@returns(200) Used to manage text notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry/{schedule-request-inquiryID}/note-text/{itemId}
@desc Used to manage text notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiryID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry/{schedule-request-inquiryID}/note-text/{itemId}
@desc Used to manage text notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiryID: int, itemId: int}
@returns(200) Used to manage text notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-request-inquiry/{schedule-request-inquiryID}/note-text/{itemId}
@desc Used to manage text notes for a scheduled request.
@required {userID: int, monetary-accountID: int, schedule-request-inquiryID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes for a scheduled request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{sofort-merchant-transactionID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, sofort-merchant-transactionID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{sofort-merchant-transactionID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, sofort-merchant-transactionID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{sofort-merchant-transactionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, sofort-merchant-transactionID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{sofort-merchant-transactionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, sofort-merchant-transactionID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{sofort-merchant-transactionID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, sofort-merchant-transactionID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/whitelist/{whitelistID}/whitelist-result/{whitelist-resultID}/note-text
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, whitelistID: int, whitelist-resultID: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/whitelist/{whitelistID}/whitelist-result/{whitelist-resultID}/note-text
@desc Manage the notes for a given user.
@required {userID: int, monetary-accountID: int, whitelistID: int, whitelist-resultID: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/whitelist/{whitelistID}/whitelist-result/{whitelist-resultID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, whitelistID: int, whitelist-resultID: int, itemId: int}
@optional {content: str # The content of the note.}
@returns(200) {Id: map{id: int}} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/whitelist/{whitelistID}/whitelist-result/{whitelist-resultID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, whitelistID: int, whitelist-resultID: int, itemId: int}
@returns(200) Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/whitelist/{whitelistID}/whitelist-result/{whitelist-resultID}/note-text/{itemId}
@desc Used to manage text notes.
@required {userID: int, monetary-accountID: int, whitelistID: int, whitelist-resultID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, label_user_creator: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, content: str} # Used to manage text notes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/notification-filter-email
@desc Manage the email notification filters for a user.
@required {userID: int}
@optional {notification_filters: [map{notification_filters: [map]}] # The types of notifications that will result in a email notification for this user.}
@returns(200) {Id: map{id: int}} # Manage the email notification filters for a user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/notification-filter-email
@desc Manage the email notification filters for a user.
@required {userID: int}
@returns(200) Manage the email notification filters for a user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/notification-filter-failure
@desc Manage the url notification filters for a user.
@required {userID: int, notification_filter_failed_ids: str # The IDs to retry.}
@returns(200) {Id: map{id: int}} # Manage the url notification filters for a user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/notification-filter-failure
@desc Manage the url notification filters for a user.
@required {userID: int}
@returns(200) Manage the url notification filters for a user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/notification-filter-push
@desc Manage the push notification filters for a user.
@required {userID: int}
@optional {notification_filters: [map{notification_filters: [map]}] # The types of notifications that will result in a push notification for this user.}
@returns(200) {Id: map{id: int}} # Manage the push notification filters for a user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/notification-filter-push
@desc Manage the push notification filters for a user.
@required {userID: int}
@returns(200) Manage the push notification filters for a user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/notification-filter-url
@desc Manage the url notification filters for a user.
@required {userID: int}
@optional {notification_filters: [map{notification_filters: [map]}] # The types of notifications that will result in a url notification for this user.}
@returns(200) {Id: map{id: int}} # Manage the url notification filters for a user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/notification-filter-url
@desc Manage the url notification filters for a user.
@required {userID: int}
@returns(200) Manage the url notification filters for a user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/notification-filter-url
@desc Manage the url notification filters for a user.
@required {userID: int, monetary-accountID: int}
@optional {notification_filters: [map{notification_filters: [map]}] # The types of notifications that will result in a url notification for this monetary account.}
@returns(200) {Id: map{id: int}} # Manage the url notification filters for a user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/notification-filter-url
@desc Manage the url notification filters for a user.
@required {userID: int, monetary-accountID: int}
@returns(200) Manage the url notification filters for a user.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/oauth-client/{itemId}
@desc Used for managing OAuth Clients.
@required {userID: int, itemId: int}
@returns(200) {id: int, status: str, display_name: str, client_id: str, secret: str, callback_url: [map]} # Used for managing OAuth Clients.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/oauth-client/{itemId}
@desc Used for managing OAuth Clients.
@required {userID: int, itemId: int}
@optional {status: str # The status of the Oauth Client, can be ACTIVE or CANCELLED.}
@returns(200) {Id: map{id: int}} # Used for managing OAuth Clients.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/oauth-client
@desc Used for managing OAuth Clients.
@required {userID: int}
@optional {status: str # The status of the Oauth Client, can be ACTIVE or CANCELLED.}
@returns(200) {Id: map{id: int}} # Used for managing OAuth Clients.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/oauth-client
@desc Used for managing OAuth Clients.
@required {userID: int}
@returns(200) Used for managing OAuth Clients.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/payment
@desc Create a new Payment.
@required {userID: int, monetary-accountID: int}
@optional {amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str # The description for the Payment. Maximum 140 characters for Payments to external IBANs, 9000 characters for Payments to only other bunq MonetaryAccounts., attachment: [map{id: int, monetary_account_id: int}] # The Attachments attached to the Payment., merchant_reference: str # Optional data included with the Payment specific to the merchant., allow_bunqto: bool # Whether or not sending a bunq.to payment is allowed., id: int # The id of the created Payment., created: str # The timestamp when the Payment was done., updated: str # The timestamp when the Payment was last updated (will be updated when chat messages are received)., monetary_account_id: int # The id of the MonetaryAccount the Payment was made to or from (depending on whether this is an incoming or outgoing Payment)., alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str # The type of Payment, can be BUNQ, EBA_SCT, EBA_SDD, IDEAL, SWIFT or FIS (card)., sub_type: str # The sub-type of the Payment, can be PAYMENT, WITHDRAWAL, REVERSAL, REQUEST, BILLING, SCT, SDD or NLO., payment_arrival_expected: map{status: str, time: str}, bunqto_status: str # The status of the bunq.to payment., bunqto_sub_status: str # The sub status of the bunq.to payment., bunqto_share_url: str # The status of the bunq.to payment., bunqto_expiry: str # When bunq.to payment is about to expire., bunqto_time_responded: str # The timestamp of when the bunq.to payment was responded to., batch_id: int # The id of the PaymentBatch if this Payment was part of one., scheduled_id: int # The id of the JobScheduled if the Payment was scheduled., address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map{type: str, id: int}] # The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch, balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}
@returns(200) {id: int} # Using Payment, you can send payments to bunq and non-bunq users from your bunq MonetaryAccounts. This can be done using bunq Aliases or IBAN Aliases. When transferring money to other bunq MonetaryAccounts you can also refer to Attachments. These will be received by the counter-party as part of the Payment. You can also retrieve a single Payment or all executed Payments of a specific monetary account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment
@desc Get a listing of all Payments performed on a given MonetaryAccount (incoming and outgoing).
@required {userID: int, monetary-accountID: int}
@returns(200) Using Payment, you can send payments to bunq and non-bunq users from your bunq MonetaryAccounts. This can be done using bunq Aliases or IBAN Aliases. When transferring money to other bunq MonetaryAccounts you can also refer to Attachments. These will be received by the counter-party as part of the Payment. You can also retrieve a single Payment or all executed Payments of a specific monetary account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment/{itemId}
@desc Get a specific previous Payment.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, monetary_account_id: int, amount: map{value: str, currency: str}, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, attachment: [map], merchant_reference: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map{payments: map{Payment: [map]}}, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}} # Using Payment, you can send payments to bunq and non-bunq users from your bunq MonetaryAccounts. This can be done using bunq Aliases or IBAN Aliases. When transferring money to other bunq MonetaryAccounts you can also refer to Attachments. These will be received by the counter-party as part of the Payment. You can also retrieve a single Payment or all executed Payments of a specific monetary account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/payment
@desc MasterCard transaction view.
@required {userID: int, monetary-accountID: int, mastercard-actionID: int}
@returns(200) MasterCard transaction view.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate
@desc Manage a users automatic payment auto allocated settings.
@required {userID: int, monetary-accountID: int, payment_id: int # The payment that should be used to define the triggers for the payment auto allocate., type: str # Whether a payment should be sorted ONCE or RECURRING., definition: [map{type!: str, counterparty_alias: map, description: str, amount: map, fraction: int, id: int, created: str, updated: str}] # The definition of how the money should be allocated.}
@returns(200) {Id: map{id: int}} # Manage a users automatic payment auto allocated settings.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate
@desc Manage a users automatic payment auto allocated settings.
@required {userID: int, monetary-accountID: int}
@returns(200) Manage a users automatic payment auto allocated settings.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate/{itemId}
@desc Manage a users automatic payment auto allocated settings.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, type: str, status: str, trigger_amount: map{value: str, currency: str}, payment: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map{payments: map}, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}, payment_original: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map{payments: map}, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}, payment_latest: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map{payments: map}, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}} # Manage a users automatic payment auto allocated settings.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate/{itemId}
@desc Manage a users automatic payment auto allocated settings.
@required {userID: int, monetary-accountID: int, itemId: int, payment_id: int # The payment that should be used to define the triggers for the payment auto allocate., type: str # Whether a payment should be sorted ONCE or RECURRING., definition: [map{type!: str, counterparty_alias: map, description: str, amount: map, fraction: int, id: int, created: str, updated: str}] # The definition of how the money should be allocated.}
@returns(200) {Id: map{id: int}} # Manage a users automatic payment auto allocated settings.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate/{itemId}
@desc Manage a users automatic payment auto allocated settings.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) Manage a users automatic payment auto allocated settings.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/payment-auto-allocate
@desc List a users automatic payment auto allocated settings.
@required {userID: int}
@returns(200) List a users automatic payment auto allocated settings.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/payment-batch
@desc Create a payment batch by sending an array of single payment objects, that will become part of the batch.
@required {userID: int, monetary-accountID: int}
@optional {payments: map{Payment: [map]}}
@returns(200) {Id: map{id: int}} # Create a payment batch, or show the payment batches of a monetary account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-batch
@desc Return all the payment batches for a monetary account.
@required {userID: int, monetary-accountID: int}
@returns(200) Create a payment batch, or show the payment batches of a monetary account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{itemId}
@desc Revoke a bunq.to payment batch. The status of all the payments will be set to REVOKED.
@required {userID: int, monetary-accountID: int, itemId: int}
@optional {payments: map{Payment: [map]}}
@returns(200) {Id: map{id: int}} # Create a payment batch, or show the payment batches of a monetary account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{itemId}
@desc Return the details of a specific payment batch.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {payments: map{Payment: [map]}} # Create a payment batch, or show the payment batches of a monetary account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group payment-service-provider-credential
@endpoint GET /payment-service-provider-credential/{itemId}
@desc Register a Payment Service Provider and provide credentials
@required {itemId: int}
@returns(200) {id: int, created: str, updated: str, status: str, expiry_time: str, token_value: str, permitted_device: map{description: str, ip: str}} # Register a Payment Service Provider and provide credentials
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /payment-service-provider-credential
@desc Register a Payment Service Provider and provide credentials
@required {client_payment_service_provider_certificate: str # Payment Services Directive 2 compatible QSEAL certificate, client_payment_service_provider_certificate_chain: str # Intermediate and root certificate belonging to the provided certificate., client_public_key_signature: str # The Base64 encoded signature of the public key provided during installation and with the installation token appended as a nonce. Signed with the private key belonging to the QSEAL certificate.}
@returns(200) {Id: map{id: int}} # Register a Payment Service Provider and provide credentials
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group user
@endpoint POST /user/{userID}/payment-service-provider-draft-payment
@desc Manage the PaymentServiceProviderDraftPayment's for a PISP.
@required {userID: int, sender_iban: str # The IBAN of the sender., counterparty_iban: str # The IBAN of the counterparty., counterparty_name: str # The name of the counterparty., description: str # Description of the payment., amount: map{value: str, currency: str}}
@optional {sender_name: str # The name of the sender., status: str # The new status of the Draft Payment. Can only be set to REJECTED or CANCELLED by update.}
@returns(200) {Id: map{id: int}} # Manage the PaymentServiceProviderDraftPayment's for a PISP.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/payment-service-provider-draft-payment
@desc Manage the PaymentServiceProviderDraftPayment's for a PISP.
@required {userID: int}
@returns(200) Manage the PaymentServiceProviderDraftPayment's for a PISP.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/payment-service-provider-draft-payment/{itemId}
@desc Manage the PaymentServiceProviderDraftPayment's for a PISP.
@required {userID: int, itemId: int, sender_iban: str # The IBAN of the sender., counterparty_iban: str # The IBAN of the counterparty., counterparty_name: str # The name of the counterparty., description: str # Description of the payment., amount: map{value: str, currency: str}}
@optional {sender_name: str # The name of the sender., status: str # The new status of the Draft Payment. Can only be set to REJECTED or CANCELLED by update.}
@returns(200) {Id: map{id: int}} # Manage the PaymentServiceProviderDraftPayment's for a PISP.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/payment-service-provider-draft-payment/{itemId}
@desc Manage the PaymentServiceProviderDraftPayment's for a PISP.
@required {userID: int, itemId: int}
@returns(200) {sender_iban: str, receiver_iban: str, amount: map{value: str, currency: str}, status: str} # Manage the PaymentServiceProviderDraftPayment's for a PISP.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/payment-service-provider-issuer-transaction
@desc The endpoint for payment service provider issuer transactions
@required {userID: int, counterparty_alias: map{type: str, value: str, name: str, service: str}, amount: map{value: str, currency: str}, description: str # The description of this transaction, to be shown to the user and to the counter party., url_redirect: str # The url to which the user should be redirected once the transaction is accepted or rejected.}
@optional {time_expiry: str # The (optional) expiration time of the transaction. Defaults to 10 minutes., status: str # The status of the transaction. Can only be used for cancelling the transaction.}
@returns(200) {Id: map{id: int}} # The endpoint for payment service provider issuer transactions
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/payment-service-provider-issuer-transaction
@desc The endpoint for payment service provider issuer transactions
@required {userID: int}
@returns(200) The endpoint for payment service provider issuer transactions
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/payment-service-provider-issuer-transaction/{itemId}
@desc The endpoint for payment service provider issuer transactions
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, public_uuid: str, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, amount: map{value: str, currency: str}, description: str, url_redirect: str, time_expiry: str, status: str, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}} # The endpoint for payment service provider issuer transactions
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/payment-service-provider-issuer-transaction/{itemId}
@desc The endpoint for payment service provider issuer transactions
@required {userID: int, itemId: int, counterparty_alias: map{type: str, value: str, name: str, service: str}, amount: map{value: str, currency: str}, description: str # The description of this transaction, to be shown to the user and to the counter party., url_redirect: str # The url to which the user should be redirected once the transaction is accepted or rejected.}
@optional {time_expiry: str # The (optional) expiration time of the transaction. Defaults to 10 minutes., status: str # The status of the transaction. Can only be used for cancelling the transaction.}
@returns(200) {Id: map{id: int}} # The endpoint for payment service provider issuer transactions
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/invoice/{invoiceID}/pdf-content
@desc Get a PDF export of an invoice.
@required {userID: int, invoiceID: int}
@returns(200) Get a PDF export of an invoice.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/card/{cardID}/replace
@desc Request a card replacement.
@required {userID: int, cardID: int}
@optional {name_on_card: str # The user's name as it will be on the card. Check 'card-name' for the available card names for a user., preferred_name_on_card: str # The user's preferred name that can be put on the card., pin_code_assignment: [map{type: str, routing_type: str, pin_code: str, monetary_account_id: int, status: str}] # Array of Types, PINs, account IDs assigned to the card., second_line: str # The second line on the card.}
@returns(200) {Id: map{id: int}} # It is possible to order a card replacement with the bunq API.You can order up to one free card replacement per year. Additional replacement requests will be billed.The card replacement will have the same expiry date and the same pricing as the old card, but it will have a new card number. You can change the description and optional the PIN through the card replacement endpoint.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry
@desc Create a new payment request.
@required {userID: int, monetary-accountID: int, allow_bunqme: bool # Whether or not sending a bunq.me request is allowed.}
@optional {amount_inquired: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str # The description of the inquiry., attachment: [map{id: int}] # The attachments attached to the payment., merchant_reference: str # The client's custom reference that was attached to the request and the mutation., status: str # The status of the request., minimum_age: int # The minimum age the user accepting the RequestInquiry must have., require_address: str # Whether or not an address must be provided on accept., want_tip: bool # [DEPRECATED] Whether or not the accepting user can give an extra tip on top of the requested Amount. Defaults to false., allow_amount_lower: bool # [DEPRECATED] Whether or not the accepting user can choose to accept with a lower amount than requested. Defaults to false., allow_amount_higher: bool # [DEPRECATED] Whether or not the accepting user can choose to accept with a higher amount than requested. Defaults to false., redirect_url: str # The URL which the user is sent to after accepting or rejecting the Request., event_id: int # The ID of the associated event if the request was made using 'split the bill'., id: int # The id of the created RequestInquiry., created: str # The timestamp of the payment request's creation., updated: str # The timestamp of the payment request's last update., time_responded: str # The timestamp of when the payment request was responded to., time_expiry: str # The timestamp of when the payment request expired., monetary_account_id: int # The id of the monetary account the request response applies to., amount_responded: map{value: str, currency: str}, user_alias_created: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, user_alias_revoked: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, batch_id: int # The id of the batch if the request was part of a batch., scheduled_id: int # The id of the scheduled job if the request was scheduled., bunqme_share_url: str # The url that points to the bunq.me request., address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, reference_split_the_bill: map{BillingInvoice: map, DraftPayment: map, MasterCardAction: map, Payment: map, PaymentBatch: map, RequestResponse: map, ScheduleInstance: map, WhitelistResult: map, TransferwisePayment: map, CurrencyConversion: map}}
@returns(200) {id: int} # RequestInquiry, aka 'RFP' (Request for Payment), is one of the innovative features that bunq offers. To request payment from another bunq account a new Request Inquiry is created. As with payments you can add attachments to a RFP. Requests for Payment are the foundation for a number of consumer features like 'Split the bill' and 'Request forwarding'. We invite you to invent your own based on the bunq api!
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry
@desc Get all payment requests for a user's monetary account. bunqme_share_url is always null if the counterparty is a bunq user.
@required {userID: int, monetary-accountID: int}
@returns(200) RequestInquiry, aka 'RFP' (Request for Payment), is one of the innovative features that bunq offers. To request payment from another bunq account a new Request Inquiry is created. As with payments you can add attachments to a RFP. Requests for Payment are the foundation for a number of consumer features like 'Split the bill' and 'Request forwarding'. We invite you to invent your own based on the bunq api!
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{itemId}
@desc Revoke a request for payment, by updating the status to REVOKED.
@required {userID: int, monetary-accountID: int, itemId: int, allow_bunqme: bool # Whether or not sending a bunq.me request is allowed.}
@optional {amount_inquired: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str # The description of the inquiry., attachment: [map{id: int}] # The attachments attached to the payment., merchant_reference: str # The client's custom reference that was attached to the request and the mutation., status: str # The status of the request., minimum_age: int # The minimum age the user accepting the RequestInquiry must have., require_address: str # Whether or not an address must be provided on accept., want_tip: bool # [DEPRECATED] Whether or not the accepting user can give an extra tip on top of the requested Amount. Defaults to false., allow_amount_lower: bool # [DEPRECATED] Whether or not the accepting user can choose to accept with a lower amount than requested. Defaults to false., allow_amount_higher: bool # [DEPRECATED] Whether or not the accepting user can choose to accept with a higher amount than requested. Defaults to false., redirect_url: str # The URL which the user is sent to after accepting or rejecting the Request., event_id: int # The ID of the associated event if the request was made using 'split the bill'., id: int # The id of the created RequestInquiry., created: str # The timestamp of the payment request's creation., updated: str # The timestamp of the payment request's last update., time_responded: str # The timestamp of when the payment request was responded to., time_expiry: str # The timestamp of when the payment request expired., monetary_account_id: int # The id of the monetary account the request response applies to., amount_responded: map{value: str, currency: str}, user_alias_created: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, user_alias_revoked: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, batch_id: int # The id of the batch if the request was part of a batch., scheduled_id: int # The id of the scheduled job if the request was scheduled., bunqme_share_url: str # The url that points to the bunq.me request., address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, reference_split_the_bill: map{BillingInvoice: map, DraftPayment: map, MasterCardAction: map, Payment: map, PaymentBatch: map, RequestResponse: map, ScheduleInstance: map, WhitelistResult: map, TransferwisePayment: map, CurrencyConversion: map}}
@returns(200) {id: int, created: str, updated: str, time_responded: str, time_expiry: str, monetary_account_id: int, amount_inquired: map{value: str, currency: str}, amount_responded: map{value: str, currency: str}, user_alias_created: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, user_alias_revoked: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, merchant_reference: str, attachment: [map], status: str, batch_id: int, scheduled_id: int, minimum_age: int, require_address: str, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, reference_split_the_bill: map{BillingInvoice: map{status: str, description: str, external_url: str, id: int, created: str, updated: str, invoice_date: str, invoice_number: str, category: str, group: [map], total_vat_inclusive: map{value: str, currency: str}, total_vat_exclusive: map{value: str, currency: str}, total_vat: map{value: str, currency: str}, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, address: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_address: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, chamber_of_commerce_number: str, vat_number: str, request_reference_split_the_bill: [map]}, DraftPayment: map{status: str, entries: [map], previous_updated_timestamp: str, number_of_required_accepts: int, schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map}}, MasterCardAction: map{id: int, monetary_account_id: int, card_id: int, amount_local: map{value: str, currency: str}, amount_converted: map{value: str, currency: str}, amount_billing: map{value: str, currency: str}, amount_original_local: map{value: str, currency: str}, amount_original_billing: map{value: str, currency: str}, amount_fee: map{value: str, currency: str}, card_authorisation_id_response: str, decision: str, payment_status: str, decision_description: str, decision_description_translated: str, decision_together_url: str, description: str, authorisation_status: str, authorisation_type: str, pan_entry_mode_user: str, settlement_status: str, clearing_status: str, maturity_date: str, city: str, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, label_card: map{uuid: str, type: str, second_line: str, expiry_date: str, status: str, label_user: map}, merchant_id: str, token_status: str, reservation_expiry_time: str, clearing_expiry_time: str, applied_limit: str, secure_code_id: int, wallet_provider_id: str, request_reference_split_the_bill: [map], card_tokenization_event: map{id: int, created: str, updated: str, action: str, user_id: str, monetary_account_id: str, object: map, status: str, object_data_at_event: map, is_event_latest_for_object: bool, is_event_reassignable: bool}, all_mastercard_action_refund: [map], pos_card_presence: str, pos_card_holder_presence: str, eligible_whitelist_id: int, cashback_payout_item: map{status: str, amount: map, rate_applied: str, transaction_category: map, user_partner_promotion: map}, point_mutation: map{number_of_point: int}, blacklist: map{merchant_name: str, merchant_id: str, merchant_identifier: str, mastercard_merchant_id: str, external_merchant_id: str, id: int, created: str, updated: str, status: str, merchant_hash: str, merchant_avatar: map}, blocklist: map{merchant_name: str, merchant_id: str, merchant_identifier: str, mastercard_merchant_id: str, external_merchant_id: str, id: int, created: str, updated: str, status: str, merchant_hash: str, merchant_avatar: map}, additional_authentication_status: str, pin_status: str, mastercard_action_report: map{mastercard_action_id: int, type: str, status: str, merchant_id: str, merchant_name: str, counterparty_alias: map}, merchant_category_code: str, company_employee_card_receipt: map{status: str}}, Payment: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}, PaymentBatch: map{payments: map{Payment: [map]}}, RequestResponse: map{amount_responded: map{value: str, currency: str}, status: str, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, currency_conversion_quote_id: int, id: int, created: str, updated: str, time_responded: str, time_expiry: str, time_refund_requested: str, time_refunded: str, user_refund_requested: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, monetary_account_id: int, amount_inquired: map{value: str, currency: str}, description: str, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, attachment: [map], minimum_age: int, require_address: str, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, type: str, sub_type: str, redirect_url: str, credit_scheme_identifier: str, mandate_identifier: str, registration_action: str, eligible_whitelist_id: int, request_reference_split_the_bill: [map], event_id: int, monetary_account_preferred_id: int}, ScheduleInstance: map{state: str, time_start: str, time_end: str, error_message: [[map]], scheduled_object: map{Payment: map, PaymentBatch: map}, result_object: map{Payment: map, PaymentBatch: map}, request_reference_split_the_bill: [map]}, WhitelistResult: map{id: int, monetary_account_paying_id: int, status: str, sub_status: str, error_message: [[map]], whitelist: map, object: map{id: int, requestResponse: map, draftPayment: map}, request_reference_split_the_bill: [map]}, TransferwisePayment: map{monetary_account_id: str, recipient_id: str, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, status: str, sub_status: str, status_transferwise: str, status_transferwise_issue: str, amount_source: map{value: str, currency: str}, amount_target: map{value: str, currency: str}, rate: str, reference: str, pay_in_reference: str, time_delivery_estimate: str, quote: map{currency_source: str, currency_target: str, amount_source: map, amount_target: map, id: int, created: str, updated: str, time_expiry: str, quote_id: str, amount_fee: map, rate: str, time_delivery_estimate: str}}, CurrencyConversion: map{id: int, created: str, updated: str, status: str, date_delivery_expected: str, rate: str, amount: map{value: str, currency: str}, counter_amount: map{value: str, currency: str}, group_uuid: str, type: str, order_type: str, label_monetary_account: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counter_label_monetary_account: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, payment: map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map, type: str, sub_type: str, payment_arrival_expected: map, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map, address_billing: map, geolocation: map, request_reference_split_the_bill: [map], balance_after_mutation: map, payment_auto_allocate_instance: map, payment_suspended_outgoing: map, payment_fee: map}}}} # RequestInquiry, aka 'RFP' (Request for Payment), is one of the innovative features that bunq offers. To request payment from another bunq account a new Request Inquiry is created. As with payments you can add attachments to a RFP. Requests for Payment are the foundation for a number of consumer features like 'Split the bill' and 'Request forwarding'. We invite you to invent your own based on the bunq api!
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{itemId}
@desc Get the details of a specific payment request, including its status. bunqme_share_url is always null if the counterparty is a bunq user.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, time_responded: str, time_expiry: str, monetary_account_id: int, amount_inquired: map{value: str, currency: str}, amount_responded: map{value: str, currency: str}, user_alias_created: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, user_alias_revoked: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, merchant_reference: str, attachment: [map], status: str, batch_id: int, scheduled_id: int, minimum_age: int, require_address: str, bunqme_share_url: str, redirect_url: str, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, reference_split_the_bill: map{BillingInvoice: map{status: str, description: str, external_url: str, id: int, created: str, updated: str, invoice_date: str, invoice_number: str, category: str, group: [map], total_vat_inclusive: map{value: str, currency: str}, total_vat_exclusive: map{value: str, currency: str}, total_vat: map{value: str, currency: str}, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, address: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_address: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, chamber_of_commerce_number: str, vat_number: str, request_reference_split_the_bill: [map]}, DraftPayment: map{status: str, entries: [map], previous_updated_timestamp: str, number_of_required_accepts: int, schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map}}, MasterCardAction: map{id: int, monetary_account_id: int, card_id: int, amount_local: map{value: str, currency: str}, amount_converted: map{value: str, currency: str}, amount_billing: map{value: str, currency: str}, amount_original_local: map{value: str, currency: str}, amount_original_billing: map{value: str, currency: str}, amount_fee: map{value: str, currency: str}, card_authorisation_id_response: str, decision: str, payment_status: str, decision_description: str, decision_description_translated: str, decision_together_url: str, description: str, authorisation_status: str, authorisation_type: str, pan_entry_mode_user: str, settlement_status: str, clearing_status: str, maturity_date: str, city: str, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, label_card: map{uuid: str, type: str, second_line: str, expiry_date: str, status: str, label_user: map}, merchant_id: str, token_status: str, reservation_expiry_time: str, clearing_expiry_time: str, applied_limit: str, secure_code_id: int, wallet_provider_id: str, request_reference_split_the_bill: [map], card_tokenization_event: map{id: int, created: str, updated: str, action: str, user_id: str, monetary_account_id: str, object: map, status: str, object_data_at_event: map, is_event_latest_for_object: bool, is_event_reassignable: bool}, all_mastercard_action_refund: [map], pos_card_presence: str, pos_card_holder_presence: str, eligible_whitelist_id: int, cashback_payout_item: map{status: str, amount: map, rate_applied: str, transaction_category: map, user_partner_promotion: map}, point_mutation: map{number_of_point: int}, blacklist: map{merchant_name: str, merchant_id: str, merchant_identifier: str, mastercard_merchant_id: str, external_merchant_id: str, id: int, created: str, updated: str, status: str, merchant_hash: str, merchant_avatar: map}, blocklist: map{merchant_name: str, merchant_id: str, merchant_identifier: str, mastercard_merchant_id: str, external_merchant_id: str, id: int, created: str, updated: str, status: str, merchant_hash: str, merchant_avatar: map}, additional_authentication_status: str, pin_status: str, mastercard_action_report: map{mastercard_action_id: int, type: str, status: str, merchant_id: str, merchant_name: str, counterparty_alias: map}, merchant_category_code: str, company_employee_card_receipt: map{status: str}}, Payment: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}, PaymentBatch: map{payments: map{Payment: [map]}}, RequestResponse: map{amount_responded: map{value: str, currency: str}, status: str, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, currency_conversion_quote_id: int, id: int, created: str, updated: str, time_responded: str, time_expiry: str, time_refund_requested: str, time_refunded: str, user_refund_requested: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, monetary_account_id: int, amount_inquired: map{value: str, currency: str}, description: str, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, attachment: [map], minimum_age: int, require_address: str, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, type: str, sub_type: str, redirect_url: str, credit_scheme_identifier: str, mandate_identifier: str, registration_action: str, eligible_whitelist_id: int, request_reference_split_the_bill: [map], event_id: int, monetary_account_preferred_id: int}, ScheduleInstance: map{state: str, time_start: str, time_end: str, error_message: [[map]], scheduled_object: map{Payment: map, PaymentBatch: map}, result_object: map{Payment: map, PaymentBatch: map}, request_reference_split_the_bill: [map]}, WhitelistResult: map{id: int, monetary_account_paying_id: int, status: str, sub_status: str, error_message: [[map]], whitelist: map, object: map{id: int, requestResponse: map, draftPayment: map}, request_reference_split_the_bill: [map]}, TransferwisePayment: map{monetary_account_id: str, recipient_id: str, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, status: str, sub_status: str, status_transferwise: str, status_transferwise_issue: str, amount_source: map{value: str, currency: str}, amount_target: map{value: str, currency: str}, rate: str, reference: str, pay_in_reference: str, time_delivery_estimate: str, quote: map{currency_source: str, currency_target: str, amount_source: map, amount_target: map, id: int, created: str, updated: str, time_expiry: str, quote_id: str, amount_fee: map, rate: str, time_delivery_estimate: str}}, CurrencyConversion: map{id: int, created: str, updated: str, status: str, date_delivery_expected: str, rate: str, amount: map{value: str, currency: str}, counter_amount: map{value: str, currency: str}, group_uuid: str, type: str, order_type: str, label_monetary_account: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counter_label_monetary_account: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, payment: map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map, type: str, sub_type: str, payment_arrival_expected: map, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map, address_billing: map, geolocation: map, request_reference_split_the_bill: [map], balance_after_mutation: map, payment_auto_allocate_instance: map, payment_suspended_outgoing: map, payment_fee: map}}}} # RequestInquiry, aka 'RFP' (Request for Payment), is one of the innovative features that bunq offers. To request payment from another bunq account a new Request Inquiry is created. As with payments you can add attachments to a RFP. Requests for Payment are the foundation for a number of consumer features like 'Split the bill' and 'Request forwarding'. We invite you to invent your own based on the bunq api!
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch
@desc Create a request batch by sending an array of single request objects, that will become part of the batch.
@required {userID: int, monetary-accountID: int}
@optional {request_inquiries: [map{amount_inquired: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, status: str, minimum_age: int, require_address: str, want_tip: bool, allow_amount_lower: bool, allow_amount_higher: bool, allow_bunqme!: bool, redirect_url: str, event_id: int, id: int, created: str, updated: str, time_responded: str, time_expiry: str, monetary_account_id: int, amount_responded: map, user_alias_created: map, user_alias_revoked: map, batch_id: int, scheduled_id: int, bunqme_share_url: str, address_shipping: map, address_billing: map, geolocation: map, reference_split_the_bill: map}] # The list of requests that were made., status: str # The status of the request., total_amount_inquired: map{value: str, currency: str}, event_id: int # The ID of the associated event if the request batch was made using 'split the bill'., reference_split_the_bill: map{BillingInvoice: map, DraftPayment: map, MasterCardAction: map, Payment: map, PaymentBatch: map, RequestResponse: map, ScheduleInstance: map, WhitelistResult: map, TransferwisePayment: map, CurrencyConversion: map}}
@returns(200) {Id: map{id: int}} # Create a batch of requests for payment, or show the request batches of a monetary account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch
@desc Return all the request batches for a monetary account.
@required {userID: int, monetary-accountID: int}
@returns(200) Create a batch of requests for payment, or show the request batches of a monetary account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{itemId}
@desc Revoke a request batch. The status of all the requests will be set to REVOKED.
@required {userID: int, monetary-accountID: int, itemId: int}
@optional {request_inquiries: [map{amount_inquired: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, status: str, minimum_age: int, require_address: str, want_tip: bool, allow_amount_lower: bool, allow_amount_higher: bool, allow_bunqme!: bool, redirect_url: str, event_id: int, id: int, created: str, updated: str, time_responded: str, time_expiry: str, monetary_account_id: int, amount_responded: map, user_alias_created: map, user_alias_revoked: map, batch_id: int, scheduled_id: int, bunqme_share_url: str, address_shipping: map, address_billing: map, geolocation: map, reference_split_the_bill: map}] # The list of requests that were made., status: str # The status of the request., total_amount_inquired: map{value: str, currency: str}, event_id: int # The ID of the associated event if the request batch was made using 'split the bill'., reference_split_the_bill: map{BillingInvoice: map, DraftPayment: map, MasterCardAction: map, Payment: map, PaymentBatch: map, RequestResponse: map, ScheduleInstance: map, WhitelistResult: map, TransferwisePayment: map, CurrencyConversion: map}}
@returns(200) {Id: map{id: int}} # Create a batch of requests for payment, or show the request batches of a monetary account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{itemId}
@desc Return the details of a specific request batch.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {request_inquiries: [map], total_amount_inquired: map{value: str, currency: str}, reference_split_the_bill: map{BillingInvoice: map{status: str, description: str, external_url: str, id: int, created: str, updated: str, invoice_date: str, invoice_number: str, category: str, group: [map], total_vat_inclusive: map{value: str, currency: str}, total_vat_exclusive: map{value: str, currency: str}, total_vat: map{value: str, currency: str}, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, address: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_address: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, chamber_of_commerce_number: str, vat_number: str, request_reference_split_the_bill: [map]}, DraftPayment: map{status: str, entries: [map], previous_updated_timestamp: str, number_of_required_accepts: int, schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map}}, MasterCardAction: map{id: int, monetary_account_id: int, card_id: int, amount_local: map{value: str, currency: str}, amount_converted: map{value: str, currency: str}, amount_billing: map{value: str, currency: str}, amount_original_local: map{value: str, currency: str}, amount_original_billing: map{value: str, currency: str}, amount_fee: map{value: str, currency: str}, card_authorisation_id_response: str, decision: str, payment_status: str, decision_description: str, decision_description_translated: str, decision_together_url: str, description: str, authorisation_status: str, authorisation_type: str, pan_entry_mode_user: str, settlement_status: str, clearing_status: str, maturity_date: str, city: str, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, label_card: map{uuid: str, type: str, second_line: str, expiry_date: str, status: str, label_user: map}, merchant_id: str, token_status: str, reservation_expiry_time: str, clearing_expiry_time: str, applied_limit: str, secure_code_id: int, wallet_provider_id: str, request_reference_split_the_bill: [map], card_tokenization_event: map{id: int, created: str, updated: str, action: str, user_id: str, monetary_account_id: str, object: map, status: str, object_data_at_event: map, is_event_latest_for_object: bool, is_event_reassignable: bool}, all_mastercard_action_refund: [map], pos_card_presence: str, pos_card_holder_presence: str, eligible_whitelist_id: int, cashback_payout_item: map{status: str, amount: map, rate_applied: str, transaction_category: map, user_partner_promotion: map}, point_mutation: map{number_of_point: int}, blacklist: map{merchant_name: str, merchant_id: str, merchant_identifier: str, mastercard_merchant_id: str, external_merchant_id: str, id: int, created: str, updated: str, status: str, merchant_hash: str, merchant_avatar: map}, blocklist: map{merchant_name: str, merchant_id: str, merchant_identifier: str, mastercard_merchant_id: str, external_merchant_id: str, id: int, created: str, updated: str, status: str, merchant_hash: str, merchant_avatar: map}, additional_authentication_status: str, pin_status: str, mastercard_action_report: map{mastercard_action_id: int, type: str, status: str, merchant_id: str, merchant_name: str, counterparty_alias: map}, merchant_category_code: str, company_employee_card_receipt: map{status: str}}, Payment: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}, PaymentBatch: map{payments: map{Payment: [map]}}, RequestResponse: map{amount_responded: map{value: str, currency: str}, status: str, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, currency_conversion_quote_id: int, id: int, created: str, updated: str, time_responded: str, time_expiry: str, time_refund_requested: str, time_refunded: str, user_refund_requested: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, monetary_account_id: int, amount_inquired: map{value: str, currency: str}, description: str, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, attachment: [map], minimum_age: int, require_address: str, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, type: str, sub_type: str, redirect_url: str, credit_scheme_identifier: str, mandate_identifier: str, registration_action: str, eligible_whitelist_id: int, request_reference_split_the_bill: [map], event_id: int, monetary_account_preferred_id: int}, ScheduleInstance: map{state: str, time_start: str, time_end: str, error_message: [[map]], scheduled_object: map{Payment: map, PaymentBatch: map}, result_object: map{Payment: map, PaymentBatch: map}, request_reference_split_the_bill: [map]}, WhitelistResult: map{id: int, monetary_account_paying_id: int, status: str, sub_status: str, error_message: [[map]], whitelist: map, object: map{id: int, requestResponse: map, draftPayment: map}, request_reference_split_the_bill: [map]}, TransferwisePayment: map{monetary_account_id: str, recipient_id: str, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, status: str, sub_status: str, status_transferwise: str, status_transferwise_issue: str, amount_source: map{value: str, currency: str}, amount_target: map{value: str, currency: str}, rate: str, reference: str, pay_in_reference: str, time_delivery_estimate: str, quote: map{currency_source: str, currency_target: str, amount_source: map, amount_target: map, id: int, created: str, updated: str, time_expiry: str, quote_id: str, amount_fee: map, rate: str, time_delivery_estimate: str}}, CurrencyConversion: map{id: int, created: str, updated: str, status: str, date_delivery_expected: str, rate: str, amount: map{value: str, currency: str}, counter_amount: map{value: str, currency: str}, group_uuid: str, type: str, order_type: str, label_monetary_account: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counter_label_monetary_account: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, payment: map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map, type: str, sub_type: str, payment_arrival_expected: map, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map, address_billing: map, geolocation: map, request_reference_split_the_bill: [map], balance_after_mutation: map, payment_auto_allocate_instance: map, payment_suspended_outgoing: map, payment_fee: map}}}} # Create a batch of requests for payment, or show the request batches of a monetary account.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/request-response/{itemId}
@desc Update the status to accept or reject the RequestResponse.
@required {userID: int, monetary-accountID: int, itemId: int}
@optional {amount_responded: map{value: str, currency: str}, status: str # The status of the RequestResponse. Can be ACCEPTED, PENDING, REJECTED, REFUND_REQUESTED, REFUNDED or REVOKED., address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, currency_conversion_quote_id: int # When the request is accepted on a monetary account with a different currency, a quote is expected to convert., id: int # The id of the Request Response., created: str # The timestamp when the Request Response was created., updated: str # The timestamp when the Request Response was last updated (will be updated when chat messages are received)., time_responded: str # The timestamp of when the RequestResponse was responded to., time_expiry: str # The timestamp of when the RequestResponse expired or will expire., time_refund_requested: str # The timestamp of when a refund request for the RequestResponse was claimed., time_refunded: str # The timestamp of when the RequestResponse was refunded., user_refund_requested: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, monetary_account_id: int # The id of the MonetaryAccount the RequestResponse was received on., amount_inquired: map{value: str, currency: str}, description: str # The description for the RequestResponse provided by the requesting party. Maximum 9000 characters., alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, attachment: [map{description: str, content_type: str, urls: [map]}] # The Attachments attached to the RequestResponse., minimum_age: int # The minimum age the user accepting the RequestResponse must have., require_address: str # Whether or not an address must be provided on accept., geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, type: str # The type of the RequestInquiry. Can be DIRECT_DEBIT, DIRECT_DEBIT_B2B, IDEAL, SOFORT or INTERNAL., sub_type: str # The subtype of the RequestInquiry. Can be ONCE or RECURRING for DIRECT_DEBIT RequestInquiries and NONE for all other., redirect_url: str # The URL which the user is sent to after accepting or rejecting the Request., credit_scheme_identifier: str # The credit scheme id provided by the counterparty for DIRECT_DEBIT inquiries., mandate_identifier: str # The mandate id provided by the counterparty for DIRECT_DEBIT inquiries., registration_action: str # Recommended registration action after IdealIssuerTransaction from iDEAL issuer transaction., eligible_whitelist_id: int # The whitelist id for this action or null., request_reference_split_the_bill: [map{type: str, id: int}] # The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch, event_id: int # The ID of the latest event for the request., monetary_account_preferred_id: int # The ID of the monetary account this user prefers to pay the request from.}
@returns(200) {Id: map{id: int}} # A RequestResponse is what a user on the other side of a RequestInquiry gets when he is sent one. So a RequestInquiry is the initiator and visible for the user that sent it and that wants to receive the money. A RequestResponse is what the other side sees, i.e. the user that pays the money to accept the request. The content is almost identical.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-response/{itemId}
@desc Get the details for a specific existing RequestResponse.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, time_responded: str, time_expiry: str, time_refund_requested: str, time_refunded: str, user_refund_requested: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, monetary_account_id: int, amount_inquired: map{value: str, currency: str}, amount_responded: map{value: str, currency: str}, status: str, description: str, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, attachment: [map], minimum_age: int, require_address: str, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, type: str, sub_type: str, redirect_url: str, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, credit_scheme_identifier: str, mandate_identifier: str, registration_action: str, eligible_whitelist_id: int, request_reference_split_the_bill: [map], event_id: int, monetary_account_preferred_id: int} # A RequestResponse is what a user on the other side of a RequestInquiry gets when he is sent one. So a RequestInquiry is the initiator and visible for the user that sent it and that wants to receive the money. A RequestResponse is what the other side sees, i.e. the user that pays the money to accept the request. The content is almost identical.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/request-response
@desc Get all RequestResponses for a MonetaryAccount.
@required {userID: int, monetary-accountID: int}
@returns(200) A RequestResponse is what a user on the other side of a RequestInquiry gets when he is sent one. So a RequestInquiry is the initiator and visible for the user that sent it and that wants to receive the money. A RequestResponse is what the other side sees, i.e. the user that pays the money to accept the request. The content is almost identical.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group sandbox-user-company
@endpoint POST /sandbox-user-company
@desc Used to create a sandbox userCompany.
@returns(200) {Id: map{id: int}} # Used to create a sandbox userCompany.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group sandbox-user-person
@endpoint POST /sandbox-user-person
@desc Used to create a sandbox userPerson.
@returns(200) {Id: map{id: int}} # Used to create a sandbox userPerson.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group user
@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule/{itemId}
@desc Get a specific schedule definition for a given monetary account.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map{Payment: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}, PaymentBatch: map{payments: map{Payment: [map]}}}} # view for reading the scheduled definitions.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule
@desc Get a collection of scheduled definition for a given monetary account. You can add the parameter type to filter the response. When type={SCHEDULE_DEFINITION_PAYMENT,SCHEDULE_DEFINITION_PAYMENT_BATCH} is provided only schedule definition object that relate to these definitions are returned.
@required {userID: int, monetary-accountID: int}
@returns(200) view for reading the scheduled definitions.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/schedule
@desc Get a collection of scheduled definition for all accessible monetary accounts of the user. You can add the parameter type to filter the response. When type={SCHEDULE_DEFINITION_PAYMENT,SCHEDULE_DEFINITION_PAYMENT_BATCH} is provided only schedule definition object that relate to these definitions are returned.
@required {userID: int}
@returns(200) view for reading the scheduled definitions.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{itemId}
@desc view for reading, updating and listing the scheduled instance.
@required {userID: int, monetary-accountID: int, scheduleID: int, itemId: int}
@returns(200) {state: str, time_start: str, time_end: str, error_message: [[map]], scheduled_object: map{Payment: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}, PaymentBatch: map{payments: map{Payment: [map]}}}, result_object: map{Payment: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}, PaymentBatch: map{payments: map{Payment: [map]}}}, request_reference_split_the_bill: [map]} # view for reading, updating and listing the scheduled instance.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{itemId}
@desc view for reading, updating and listing the scheduled instance.
@required {userID: int, monetary-accountID: int, scheduleID: int, itemId: int}
@optional {state: str # The state of the scheduleInstance. (FINISHED_SUCCESSFULLY, RETRY, FAILED_USER_ERROR), time_start: str # The schedule start time (UTC)., time_end: str # The schedule end time (UTC)., error_message: [[map{error_description: str, error_description_translated: str}]] # The message when the scheduled instance has run and failed due to user error., scheduled_object: map{Payment: map, PaymentBatch: map}, result_object: map{Payment: map, PaymentBatch: map}, request_reference_split_the_bill: [map{type: str, id: int}] # The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch}
@returns(200) {Id: map{id: int}} # view for reading, updating and listing the scheduled instance.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance
@desc view for reading, updating and listing the scheduled instance.
@required {userID: int, monetary-accountID: int, scheduleID: int}
@returns(200) view for reading, updating and listing the scheduled instance.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment
@desc Endpoint for schedule payments.
@required {userID: int, monetary-accountID: int}
@optional {payment: map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, alias: map}, schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map}, purpose: str # The schedule purpose., status: str # The schedule status, options: ACTIVE, FINISHED, CANCELLED.}
@returns(200) {Id: map{id: int}} # Endpoint for schedule payments.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment
@desc Endpoint for schedule payments.
@required {userID: int, monetary-accountID: int}
@returns(200) Endpoint for schedule payments.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{itemId}
@desc Endpoint for schedule payments.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) Endpoint for schedule payments.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{itemId}
@desc Endpoint for schedule payments.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {payment: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}}, schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map{Payment: map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map, type: str, sub_type: str, payment_arrival_expected: map, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map, address_billing: map, geolocation: map, request_reference_split_the_bill: [map], balance_after_mutation: map, payment_auto_allocate_instance: map, payment_suspended_outgoing: map, payment_fee: map}, PaymentBatch: map{payments: map}}}, status: str, purpose: str} # Endpoint for schedule payments.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{itemId}
@desc Endpoint for schedule payments.
@required {userID: int, monetary-accountID: int, itemId: int}
@optional {payment: map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, alias: map}, schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map}, purpose: str # The schedule purpose., status: str # The schedule status, options: ACTIVE, FINISHED, CANCELLED.}
@returns(200) {Id: map{id: int}} # Endpoint for schedule payments.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{itemId}
@desc Endpoint for schedule payment batches.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {payments: [map], schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map{Payment: map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map, type: str, sub_type: str, payment_arrival_expected: map, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map, address_billing: map, geolocation: map, request_reference_split_the_bill: [map], balance_after_mutation: map, payment_auto_allocate_instance: map, payment_suspended_outgoing: map, payment_fee: map}, PaymentBatch: map{payments: map}}}} # Endpoint for schedule payment batches.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{itemId}
@desc Endpoint for schedule payment batches.
@required {userID: int, monetary-accountID: int, itemId: int}
@optional {payments: [map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, alias: map}] # The payment details., schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map}}
@returns(200) {Id: map{id: int}} # Endpoint for schedule payment batches.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{itemId}
@desc Endpoint for schedule payment batches.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) Endpoint for schedule payment batches.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch
@desc Endpoint for schedule payment batches.
@required {userID: int, monetary-accountID: int}
@optional {payments: [map{amount: map, counterparty_alias: map, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, alias: map}] # The payment details., schedule: map{time_start: str, time_end: str, recurrence_unit: str, recurrence_size: int, status: str, object: map}}
@returns(200) {Id: map{id: int}} # Endpoint for schedule payment batches.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group server-error
@endpoint POST /server-error
@desc An endpoint that will always throw an error.
@returns(200) {Id: map{id: int}} # An endpoint that will always throw an error.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group installation
@endpoint GET /installation/{installationID}/server-public-key
@desc Show the ServerPublicKey for this Installation.
@required {installationID: int}
@returns(200) Using /installation/_/server-public-key you can request the ServerPublicKey again. This is done by referring to the id of the Installation.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group session
@endpoint DELETE /session/{itemId}
@desc Deletes the current session.
@required {itemId: int}
@returns(200) Endpoint for operations over the current session.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group session-server
@endpoint POST /session-server
@desc Create a new session for a DeviceServer. Provide the Installation token in the "X-Bunq-Client-Authentication" header. And don't forget to create the "X-Bunq-Client-Signature" header. The response contains a Session token that should be used for as the "X-Bunq-Client-Authentication" header for all future API calls. The ip address making this call needs to match the ip address bound to your API key.
@required {secret: str # The API key of the user you want to login. If your API key has not been used before, it will be bound to the ip address of this DeviceServer.}
@returns(200) {Id: map{id: int}, Token: map{id: int, token: str}, UserCompany: map{name: str, public_nick_name: str, avatar_uuid: str, address_main: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_postal: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, language: str, region: str, country: str, ubo: [map], chamber_of_commerce_number: str, legal_form: str, status: str, sub_status: str, session_timeout: int, daily_limit_without_confirmation_login: map{value: str, currency: str}, id: int, created: str, updated: str, public_uuid: str, display_name: str, alias: [map], type_of_business_entity: str, sector_of_industry: str, counter_bank_iban: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, version_terms_of_service: str, directors: [map], notification_filters: [map], customer: map{billing_account_id: str, invoice_notification_preference: str, id: int, created: str, updated: str}, customer_limit: map{limit_monetary_account: int, limit_monetary_account_remaining: int, limit_card_debit_maestro: int, limit_card_debit_mastercard: int, limit_card_debit_wildcard: int, limit_card_wildcard: int, limit_card_replacement: int, limit_amount_monthly: map{value: str, currency: str}, spent_amount_monthly: map{value: str, currency: str}}, billing_contract: [map], deny_reason: str, relations: [map], tax_resident: [map]}, UserPerson: map{subscription_type: str, first_name: str, middle_name: str, last_name: str, public_nick_name: str, address_main: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_postal: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, avatar_uuid: str, tax_resident: [map], document_type: str, document_number: str, document_country_of_issuance: str, document_front_attachment_id: int, document_back_attachment_id: int, date_of_birth: str, nationality: str, all_nationality: [str], language: str, region: str, gender: str, status: str, sub_status: str, legal_guardian_alias: map{type: str, value: str, name: str, service: str}, session_timeout: int, daily_limit_without_confirmation_login: map{value: str, currency: str}, display_name: str, signup_track_type: str, id: int, created: str, updated: str, public_uuid: str, legal_name: str, alias: [map], address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, place_of_birth: str, country_of_birth: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, version_terms_of_service: str, notification_filters: [map], relations: [map]}, UserApiKey: map{id: int, created: str, updated: str, requested_by_user: map{UserPerson: map{subscription_type: str, first_name: str, middle_name: str, last_name: str, public_nick_name: str, address_main: map, address_postal: map, avatar_uuid: str, tax_resident: [map], document_type: str, document_number: str, document_country_of_issuance: str, document_front_attachment_id: int, document_back_attachment_id: int, date_of_birth: str, nationality: str, all_nationality: [str], language: str, region: str, gender: str, status: str, sub_status: str, legal_guardian_alias: map, session_timeout: int, daily_limit_without_confirmation_login: map, display_name: str, signup_track_type: str, id: int, created: str, updated: str, public_uuid: str, legal_name: str, alias: [map], address_shipping: map, place_of_birth: str, country_of_birth: str, avatar: map, version_terms_of_service: str, notification_filters: [map], relations: [map]}, UserCompany: map{name: str, public_nick_name: str, avatar_uuid: str, address_main: map, address_postal: map, language: str, region: str, country: str, ubo: [map], chamber_of_commerce_number: str, legal_form: str, status: str, sub_status: str, session_timeout: int, daily_limit_without_confirmation_login: map, id: int, created: str, updated: str, public_uuid: str, display_name: str, alias: [map], type_of_business_entity: str, sector_of_industry: str, counter_bank_iban: str, avatar: map, address_shipping: map, version_terms_of_service: str, directors: [map], notification_filters: [map], customer: map, customer_limit: map, billing_contract: [map], deny_reason: str, relations: [map], tax_resident: [map]}, UserPaymentServiceProvider: map{id: int, created: str, updated: str, certificate_distinguished_name: str, alias: [map], avatar: map, status: str, sub_status: str, public_uuid: str, display_name: str, public_nick_name: str, language: str, region: str, session_timeout: int}}, granted_by_user: map{UserPerson: map{subscription_type: str, first_name: str, middle_name: str, last_name: str, public_nick_name: str, address_main: map, address_postal: map, avatar_uuid: str, tax_resident: [map], document_type: str, document_number: str, document_country_of_issuance: str, document_front_attachment_id: int, document_back_attachment_id: int, date_of_birth: str, nationality: str, all_nationality: [str], language: str, region: str, gender: str, status: str, sub_status: str, legal_guardian_alias: map, session_timeout: int, daily_limit_without_confirmation_login: map, display_name: str, signup_track_type: str, id: int, created: str, updated: str, public_uuid: str, legal_name: str, alias: [map], address_shipping: map, place_of_birth: str, country_of_birth: str, avatar: map, version_terms_of_service: str, notification_filters: [map], relations: [map]}, UserCompany: map{name: str, public_nick_name: str, avatar_uuid: str, address_main: map, address_postal: map, language: str, region: str, country: str, ubo: [map], chamber_of_commerce_number: str, legal_form: str, status: str, sub_status: str, session_timeout: int, daily_limit_without_confirmation_login: map, id: int, created: str, updated: str, public_uuid: str, display_name: str, alias: [map], type_of_business_entity: str, sector_of_industry: str, counter_bank_iban: str, avatar: map, address_shipping: map, version_terms_of_service: str, directors: [map], notification_filters: [map], customer: map, customer_limit: map, billing_contract: [map], deny_reason: str, relations: [map], tax_resident: [map]}, UserPaymentServiceProvider: map{id: int, created: str, updated: str, certificate_distinguished_name: str, alias: [map], avatar: map, status: str, sub_status: str, public_uuid: str, display_name: str, public_nick_name: str, language: str, region: str, session_timeout: int}}}, UserPaymentServiceProvider: map{id: int, created: str, updated: str, certificate_distinguished_name: str, alias: [map], avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, status: str, sub_status: str, public_uuid: str, display_name: str, public_nick_name: str, language: str, region: str, session_timeout: int}} # Once you have created an Installation and a DeviceServer with that Installation, then you are ready to start a session! A session expires after the same amount of time you have set for Auto Logout in your user account. By default this is 1 week. If a request is made 30 seconds before a session expires, it will be extended from that moment by your auto logout time, but never by more than 5 minutes.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group user
@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry
@desc [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.
@required {userID: int, monetary-accountID: int}
@optional {counter_user_alias: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, access_type: str # Type of access that is in place., draft_share_invite_bank_id: int # DEPRECATED: USE `access_type` INSTEAD | The id of the draft share invite bank., share_detail: map{payment: map, read_only: map, draft_payment: map}, status: str # The status of the share. Can be ACTIVE, REVOKED, REJECTED., relationship: str # The relationship: COMPANY_DIRECTOR, COMPANY_EMPLOYEE, etc, share_type: str # DEPRECATED: USE `access_type` INSTEAD | The share type, either STANDARD or MUTUAL., start_date: str # DEPRECATED: USE `access_type` INSTEAD | The start date of this share., end_date: str # DEPRECATED: USE `access_type` INSTEAD | The expiration date of this share., alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, user_alias_created: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, user_alias_revoked: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, monetary_account_id: int # The id of the monetary account the share applies to., id: int # The id of the newly created share invite.}
@returns(200) {id: int} # [DEPRECATED - use /share-invite-monetary-account-response] Used to share a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. Allow the creation of share inquiries that, in the same way as request inquiries, can be revoked by the user creating them or accepted/rejected by the other party.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry
@desc [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.
@required {userID: int, monetary-accountID: int}
@returns(200) [DEPRECATED - use /share-invite-monetary-account-response] Used to share a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. Allow the creation of share inquiries that, in the same way as request inquiries, can be revoked by the user creating them or accepted/rejected by the other party.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry/{itemId}
@desc [DEPRECATED - use /share-invite-monetary-account-response] Get the details of a specific share inquiry.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, user_alias_created: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, user_alias_revoked: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, counter_user_alias: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, monetary_account_id: int, status: str, access_type: str, relationship: str, id: int} # [DEPRECATED - use /share-invite-monetary-account-response] Used to share a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. Allow the creation of share inquiries that, in the same way as request inquiries, can be revoked by the user creating them or accepted/rejected by the other party.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry/{itemId}
@desc [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.
@required {userID: int, monetary-accountID: int, itemId: int}
@optional {counter_user_alias: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, access_type: str # Type of access that is in place., draft_share_invite_bank_id: int # DEPRECATED: USE `access_type` INSTEAD | The id of the draft share invite bank., share_detail: map{payment: map, read_only: map, draft_payment: map}, status: str # The status of the share. Can be ACTIVE, REVOKED, REJECTED., relationship: str # The relationship: COMPANY_DIRECTOR, COMPANY_EMPLOYEE, etc, share_type: str # DEPRECATED: USE `access_type` INSTEAD | The share type, either STANDARD or MUTUAL., start_date: str # DEPRECATED: USE `access_type` INSTEAD | The start date of this share., end_date: str # DEPRECATED: USE `access_type` INSTEAD | The expiration date of this share., alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, user_alias_created: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, user_alias_revoked: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, monetary_account_id: int # The id of the monetary account the share applies to., id: int # The id of the newly created share invite.}
@returns(200) {Id: map{id: int}} # [DEPRECATED - use /share-invite-monetary-account-response] Used to share a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. Allow the creation of share inquiries that, in the same way as request inquiries, can be revoked by the user creating them or accepted/rejected by the other party.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/share-invite-monetary-account-response/{itemId}
@desc Return the details of a specific share a user was invited to.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, counter_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, user_alias_cancelled: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, monetary_account_id: int, draft_share_invite_bank_id: int, share_detail: map{payment: map{make_payments: bool, make_draft_payments: bool, view_balance: bool, view_old_events: bool, view_new_events: bool}, read_only: map{view_balance: bool, view_old_events: bool, view_new_events: bool}, draft_payment: map{make_draft_payments: bool, view_balance: bool, view_old_events: bool, view_new_events: bool}}, access_type: str, status: str, relation_user: map{user_id: str, counter_user_id: str, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, counter_label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, relationship: str, status: str, user_status: str, counter_user_status: str, company_employee_setting_adyen_card_transaction: map{pointer_counter_user: map{type: str, value: str, name: str, service: str}, status: str, monetary_account_payout_id: int}, all_company_employee_card: [map]}, share_type: str, start_date: str, end_date: str, description: str} # Used to view or respond to shares a user was invited to. See 'share-invite-bank-inquiry' for more information about the inquiring endpoint.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/share-invite-monetary-account-response/{itemId}
@desc Accept or reject a share a user was invited to.
@required {userID: int, itemId: int}
@optional {status: str # The status of the share. Can be ACTIVE, REVOKED, REJECTED., card_id: int # The card to link to the shared monetary account. Used only if share_detail is ShareDetailCardPayment., id: int # The id of the ShareInviteBankResponse., created: str # The timestamp of the ShareInviteBankResponse creation., updated: str # The timestamp of the ShareInviteBankResponse last update., counter_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, user_alias_cancelled: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, monetary_account_id: int # The id of the monetary account the ACCEPTED share applies to. null otherwise., draft_share_invite_bank_id: int # The id of the draft share invite bank., share_detail: map{payment: map, read_only: map, draft_payment: map}, access_type: str # Type of access that is wanted, one of VIEW_BALANCE, VIEW_TRANSACTION, DRAFT_PAYMENT or FULL_TRANSIENT, relation_user: map{user_id: str, counter_user_id: str, label_user: map, counter_label_user: map, relationship: str, status: str, user_status: str, counter_user_status: str, company_employee_setting_adyen_card_transaction: map, all_company_employee_card: [map]}, share_type: str # The share type, either STANDARD or MUTUAL., start_date: str # The start date of this share., end_date: str # The expiration date of this share., description: str # The description of this share. It is basically the monetary account description.}
@returns(200) {Id: map{id: int}} # Used to view or respond to shares a user was invited to. See 'share-invite-bank-inquiry' for more information about the inquiring endpoint.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/share-invite-monetary-account-response
@desc Return all the shares a user was invited to.
@required {userID: int}
@returns(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.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{itemId}
@desc View for requesting Sofort transactions and polling their status.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, amount_guaranteed: map{value: str, currency: str}, amount_requested: map{value: str, currency: str}, issuer: str, issuer_authentication_url: str, status: str, error_message: [[map]], transaction_identifier: str} # View for requesting Sofort transactions and polling their status.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction
@desc View for requesting Sofort transactions and polling their status.
@required {userID: int, monetary-accountID: int}
@returns(200) View for requesting Sofort transactions and polling their status.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/monetary-account/{monetary-accountID}/event/{eventID}/statement
@desc Used to create a statement export of a single payment.
@required {userID: int, monetary-accountID: int, eventID: int}
@returns(200) {Id: map{id: int}} # Used to create a statement export of a single payment.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/event/{eventID}/statement/{itemId}
@desc Used to create a statement export of a single payment.
@required {userID: int, monetary-accountID: int, eventID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, status: str} # Used to create a statement export of a single payment.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{itemId}
@desc An incoming payment made towards an account of an external bank and redirected to a bunq account via switch service.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {bank_switch_service: map{alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, status: str, user_alias: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, sub_status: str, time_start_desired: str, time_start_actual: str, time_end: str, attachment: map{description: str, content_type: str, urls: [map]}, rejection_reason: str, rejection_reason_description: str, rejection_reason_description_translated: str, rejection_reason_together_url: str}, payment: map{amount: map{value: str, currency: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], merchant_reference: str, allow_bunqto: bool, id: int, created: str, updated: str, monetary_account_id: int, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, type: str, sub_type: str, payment_arrival_expected: map{status: str, time: str}, bunqto_status: str, bunqto_sub_status: str, bunqto_share_url: str, bunqto_expiry: str, bunqto_time_responded: str, batch_id: int, scheduled_id: int, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, request_reference_split_the_bill: [map], balance_after_mutation: map{value: str, currency: str}, payment_auto_allocate_instance: map{id: int, created: str, updated: str, payment_auto_allocate_id: int, status: str, error_message: [[map]], payment_batch: map{payments: map}, payment_id: int, all_ginmon_transaction_order: [map]}, payment_suspended_outgoing: map{status: str, monetary_account_id: str, time_execution: str}, payment_fee: map{value: str, currency: str, invoice_id: int}}} # An incoming payment made towards an account of an external bank and redirected to a bunq account via switch service.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/token-qr-request-ideal
@desc Create a request from an ideal transaction.
@required {userID: int, token: str # The token passed from a site or read from a QR code.}
@returns(200) {id: int, time_responded: str, time_expiry: str, monetary_account_id: int, amount_inquired: map{value: str, currency: str}, amount_responded: map{value: str, currency: str}, alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, description: str, attachment: [map], status: str, minimum_age: int, require_address: str, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_billing: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, geolocation: map{latitude: int, longitude: int, altitude: int, radius: int}, redirect_url: str, type: str, sub_type: str, eligible_whitelist_id: int} # Using this call you create a request for payment from an external token provided with an ideal transaction. Make sure your iDEAL payments are compliant with the iDEAL standards, by following the following manual: https:/www.bunq.com/terms-idealstandards. It's very important to keep these points in mind when you are using the endpoint to make iDEAL payments from your application.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/token-qr-request-sofort
@desc Create a request from an SOFORT transaction.
@required {userID: int, token: str # The token passed from a site or read from a QR code.}
@returns(200) {Id: map{id: int}} # Using this call you can create a SOFORT Request assigned to your User by providing the Token of the request.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/transferwise-currency
@desc Used to get a list of supported currencies for Transferwise.
@required {userID: int}
@returns(200) Used to get a list of supported currencies for Transferwise.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/transferwise-quote
@desc Used to get quotes from Transferwise. These can be used to initiate payments.
@required {userID: int, currency_source: str # The source currency., currency_target: str # The target currency.}
@optional {amount_source: map{value: str, currency: str}, amount_target: map{value: str, currency: str}, id: int # The id of the quote., created: str # The timestamp of the quote's creation., updated: str # The timestamp of the quote's last update., time_expiry: str # The expiration timestamp of the quote., quote_id: str # The quote id Transferwise needs., amount_fee: map{value: str, currency: str}, rate: str # The rate., time_delivery_estimate: str # The estimated delivery time.}
@returns(200) {Id: map{id: int}} # Used to get quotes from Transferwise. These can be used to initiate payments.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/transferwise-quote/{itemId}
@desc Used to get quotes from Transferwise. These can be used to initiate payments.
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, time_expiry: str, quote_id: str, amount_source: map{value: str, currency: str}, amount_target: map{value: str, currency: str}, amount_fee: map{value: str, currency: str}, rate: str, time_delivery_estimate: str} # Used to get quotes from Transferwise. These can be used to initiate payments.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/transferwise-quote-temporary
@desc Used to get temporary quotes from Transferwise. These cannot be used to initiate payments
@required {userID: int, currency_source: str # The source currency., currency_target: str # The target currency.}
@optional {amount_source: map{value: str, currency: str}, amount_target: map{value: str, currency: str}}
@returns(200) {Id: map{id: int}} # Used to get temporary quotes from Transferwise. These cannot be used to initiate payments
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/transferwise-quote-temporary/{itemId}
@desc Used to get temporary quotes from Transferwise. These cannot be used to initiate payments
@required {userID: int, itemId: int}
@returns(200) {id: int, created: str, updated: str, time_expiry: str, quote_id: str, amount_source: map{value: str, currency: str}, amount_target: map{value: str, currency: str}, rate: str} # Used to get temporary quotes from Transferwise. These cannot be used to initiate payments
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/transferwise-quote/{transferwise-quoteID}/transferwise-recipient
@desc Used to manage recipient accounts with Transferwise.
@required {userID: int, transferwise-quoteID: int, name_account_holder: str # The name of the account holder., type: str # The chosen recipient account type. The possible options are provided dynamically in the response endpoint.}
@optional {country: str # The country of the receiving account., detail: [map{key!: str, value!: str, name: str, group: map}] # The fields which were specified as "required" and have since been filled by the user. Always provide the full list.}
@returns(200) {Id: map{id: int}} # Used to manage recipient accounts with Transferwise.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/transferwise-quote/{transferwise-quoteID}/transferwise-recipient
@desc Used to manage recipient accounts with Transferwise.
@required {userID: int, transferwise-quoteID: int}
@returns(200) Used to manage recipient accounts with Transferwise.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/transferwise-quote/{transferwise-quoteID}/transferwise-recipient/{itemId}
@desc Used to manage recipient accounts with Transferwise.
@required {userID: int, transferwise-quoteID: int, itemId: int}
@returns(200) {account_id: str, currency: str, country: str, name_account_holder: str, account_number: str, bank_code: str} # Used to manage recipient accounts with Transferwise.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/transferwise-quote/{transferwise-quoteID}/transferwise-recipient/{itemId}
@desc Used to manage recipient accounts with Transferwise.
@required {userID: int, transferwise-quoteID: int, itemId: int}
@returns(200) Used to manage recipient accounts with Transferwise.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/transferwise-quote/{transferwise-quoteID}/transferwise-recipient-requirement
@desc Used to determine the recipient account requirements for Transferwise transfers.
@required {userID: int, transferwise-quoteID: int, name_account_holder: str # The name of the account holder., type: str # The chosen recipient account type. The possible options are provided dynamically in the response endpoint.}
@optional {country: str # The country of the receiving account., detail: [map{key!: str, value!: str, name: str, group: map}] # The fields which were specified as "required" and have since been filled by the user. Always provide the full list.}
@returns(200) {Id: map{id: int}} # Used to determine the recipient account requirements for Transferwise transfers.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/transferwise-quote/{transferwise-quoteID}/transferwise-recipient-requirement
@desc Used to determine the recipient account requirements for Transferwise transfers.
@required {userID: int, transferwise-quoteID: int}
@returns(200) Used to determine the recipient account requirements for Transferwise transfers.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/transferwise-quote/{transferwise-quoteID}/transferwise-transfer
@desc Used to create Transferwise payments.
@required {userID: int, transferwise-quoteID: int, monetary_account_id: str # The id of the monetary account the payment should be made from., recipient_id: str # The id of the target account.}
@optional {alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map, label_user: map, country: str, bunq_me: map, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, status: str # The status., sub_status: str # The subStatus., status_transferwise: str # The status as Transferwise reports it., status_transferwise_issue: str # A status to indicatie if Transferwise has an issue with this payment and requires more information., amount_source: map{value: str, currency: str}, amount_target: map{value: str, currency: str}, rate: str # The rate of the payment., reference: str # The reference of the payment., pay_in_reference: str # The Pay-In reference of the payment., time_delivery_estimate: str # The estimated delivery time., quote: map{currency_source!: str, currency_target!: str, amount_source: map, amount_target: map, id: int, created: str, updated: str, time_expiry: str, quote_id: str, amount_fee: map, rate: str, time_delivery_estimate: str}}
@returns(200) {Id: map{id: int}} # Used to create Transferwise payments.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/transferwise-quote/{transferwise-quoteID}/transferwise-transfer
@desc Used to create Transferwise payments.
@required {userID: int, transferwise-quoteID: int}
@returns(200) Used to create Transferwise payments.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/transferwise-quote/{transferwise-quoteID}/transferwise-transfer/{itemId}
@desc Used to create Transferwise payments.
@required {userID: int, transferwise-quoteID: int, itemId: int}
@returns(200) {alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, status: str, sub_status: str, status_transferwise: str, status_transferwise_issue: str, amount_source: map{value: str, currency: str}, amount_target: map{value: str, currency: str}, rate: str, reference: str, pay_in_reference: str, time_delivery_estimate: str, quote: map{currency_source: str, currency_target: str, amount_source: map{value: str, currency: str}, amount_target: map{value: str, currency: str}, id: int, created: str, updated: str, time_expiry: str, quote_id: str, amount_fee: map{value: str, currency: str}, rate: str, time_delivery_estimate: str}} # Used to create Transferwise payments.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/transferwise-quote/{transferwise-quoteID}/transferwise-transfer-requirement
@desc Used to determine the account requirements for Transferwise transfers.
@required {userID: int, transferwise-quoteID: int, recipient_id: str # The id of the target account.}
@optional {detail: [map{key!: str, value!: str, name: str, group: map}] # The fields which were specified as "required" and have since been filled by the user. Always provide the full list.}
@returns(200) {Id: map{id: int}} # Used to determine the account requirements for Transferwise transfers.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/transferwise-user
@desc Used to manage Transferwise users.
@required {userID: int}
@optional {oauth_code: str # The OAuth code returned by Transferwise we should be using to gain access to the user's Transferwise account.}
@returns(200) {Id: map{id: int}} # Used to manage Transferwise users.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/transferwise-user
@desc Used to manage Transferwise users.
@required {userID: int}
@returns(200) Used to manage Transferwise users.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/tree-progress
@desc See how many trees this user has planted.
@required {userID: int}
@returns(200) See how many trees this user has planted.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{itemId}
@desc Get a specific user.
@required {itemId: int}
@returns(200) {UserPerson: map{subscription_type: str, first_name: str, middle_name: str, last_name: str, public_nick_name: str, address_main: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_postal: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, avatar_uuid: str, tax_resident: [map], document_type: str, document_number: str, document_country_of_issuance: str, document_front_attachment_id: int, document_back_attachment_id: int, date_of_birth: str, nationality: str, all_nationality: [str], language: str, region: str, gender: str, status: str, sub_status: str, legal_guardian_alias: map{type: str, value: str, name: str, service: str}, session_timeout: int, daily_limit_without_confirmation_login: map{value: str, currency: str}, display_name: str, signup_track_type: str, id: int, created: str, updated: str, public_uuid: str, legal_name: str, alias: [map], address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, place_of_birth: str, country_of_birth: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, version_terms_of_service: str, notification_filters: [map], relations: [map]}, UserCompany: map{name: str, public_nick_name: str, avatar_uuid: str, address_main: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_postal: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, language: str, region: str, country: str, ubo: [map], chamber_of_commerce_number: str, legal_form: str, status: str, sub_status: str, session_timeout: int, daily_limit_without_confirmation_login: map{value: str, currency: str}, id: int, created: str, updated: str, public_uuid: str, display_name: str, alias: [map], type_of_business_entity: str, sector_of_industry: str, counter_bank_iban: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, version_terms_of_service: str, directors: [map], notification_filters: [map], customer: map{billing_account_id: str, invoice_notification_preference: str, id: int, created: str, updated: str}, customer_limit: map{limit_monetary_account: int, limit_monetary_account_remaining: int, limit_card_debit_maestro: int, limit_card_debit_mastercard: int, limit_card_debit_wildcard: int, limit_card_wildcard: int, limit_card_replacement: int, limit_amount_monthly: map{value: str, currency: str}, spent_amount_monthly: map{value: str, currency: str}}, billing_contract: [map], deny_reason: str, relations: [map], tax_resident: [map]}, UserApiKey: map{id: int, created: str, updated: str, requested_by_user: map{UserPerson: map{subscription_type: str, first_name: str, middle_name: str, last_name: str, public_nick_name: str, address_main: map, address_postal: map, avatar_uuid: str, tax_resident: [map], document_type: str, document_number: str, document_country_of_issuance: str, document_front_attachment_id: int, document_back_attachment_id: int, date_of_birth: str, nationality: str, all_nationality: [str], language: str, region: str, gender: str, status: str, sub_status: str, legal_guardian_alias: map, session_timeout: int, daily_limit_without_confirmation_login: map, display_name: str, signup_track_type: str, id: int, created: str, updated: str, public_uuid: str, legal_name: str, alias: [map], address_shipping: map, place_of_birth: str, country_of_birth: str, avatar: map, version_terms_of_service: str, notification_filters: [map], relations: [map]}, UserCompany: map{name: str, public_nick_name: str, avatar_uuid: str, address_main: map, address_postal: map, language: str, region: str, country: str, ubo: [map], chamber_of_commerce_number: str, legal_form: str, status: str, sub_status: str, session_timeout: int, daily_limit_without_confirmation_login: map, id: int, created: str, updated: str, public_uuid: str, display_name: str, alias: [map], type_of_business_entity: str, sector_of_industry: str, counter_bank_iban: str, avatar: map, address_shipping: map, version_terms_of_service: str, directors: [map], notification_filters: [map], customer: map, customer_limit: map, billing_contract: [map], deny_reason: str, relations: [map], tax_resident: [map]}, UserPaymentServiceProvider: map{id: int, created: str, updated: str, certificate_distinguished_name: str, alias: [map], avatar: map, status: str, sub_status: str, public_uuid: str, display_name: str, public_nick_name: str, language: str, region: str, session_timeout: int}}, granted_by_user: map{UserPerson: map{subscription_type: str, first_name: str, middle_name: str, last_name: str, public_nick_name: str, address_main: map, address_postal: map, avatar_uuid: str, tax_resident: [map], document_type: str, document_number: str, document_country_of_issuance: str, document_front_attachment_id: int, document_back_attachment_id: int, date_of_birth: str, nationality: str, all_nationality: [str], language: str, region: str, gender: str, status: str, sub_status: str, legal_guardian_alias: map, session_timeout: int, daily_limit_without_confirmation_login: map, display_name: str, signup_track_type: str, id: int, created: str, updated: str, public_uuid: str, legal_name: str, alias: [map], address_shipping: map, place_of_birth: str, country_of_birth: str, avatar: map, version_terms_of_service: str, notification_filters: [map], relations: [map]}, UserCompany: map{name: str, public_nick_name: str, avatar_uuid: str, address_main: map, address_postal: map, language: str, region: str, country: str, ubo: [map], chamber_of_commerce_number: str, legal_form: str, status: str, sub_status: str, session_timeout: int, daily_limit_without_confirmation_login: map, id: int, created: str, updated: str, public_uuid: str, display_name: str, alias: [map], type_of_business_entity: str, sector_of_industry: str, counter_bank_iban: str, avatar: map, address_shipping: map, version_terms_of_service: str, directors: [map], notification_filters: [map], customer: map, customer_limit: map, billing_contract: [map], deny_reason: str, relations: [map], tax_resident: [map]}, UserPaymentServiceProvider: map{id: int, created: str, updated: str, certificate_distinguished_name: str, alias: [map], avatar: map, status: str, sub_status: str, public_uuid: str, display_name: str, public_nick_name: str, language: str, region: str, session_timeout: int}}}, UserPaymentServiceProvider: map{id: int, created: str, updated: str, certificate_distinguished_name: str, alias: [map], avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, status: str, sub_status: str, public_uuid: str, display_name: str, public_nick_name: str, language: str, region: str, session_timeout: int}} # Using this call you can retrieve information of the user you are logged in as. This includes your user id, which is referred to in endpoints.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user
@desc Get a collection of all available users.
@returns(200) Using this call you can retrieve information of the user you are logged in as. This includes your user id, which is referred to in endpoints.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group user-company
@endpoint GET /user-company/{itemId}
@desc Get a specific company.
@required {itemId: int}
@returns(200) {id: int, created: str, updated: str, public_uuid: str, name: str, display_name: str, public_nick_name: str, alias: [map], chamber_of_commerce_number: str, legal_form: str, type_of_business_entity: str, sector_of_industry: str, counter_bank_iban: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, address_main: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_postal: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, version_terms_of_service: str, directors: [map], language: str, country: str, region: str, ubo: [map], status: str, sub_status: str, session_timeout: int, daily_limit_without_confirmation_login: map{value: str, currency: str}, notification_filters: [map], customer: map{billing_account_id: str, invoice_notification_preference: str, id: int, created: str, updated: str}, customer_limit: map{limit_monetary_account: int, limit_monetary_account_remaining: int, limit_card_debit_maestro: int, limit_card_debit_mastercard: int, limit_card_debit_wildcard: int, limit_card_wildcard: int, limit_card_replacement: int, limit_amount_monthly: map{value: str, currency: str}, spent_amount_monthly: map{value: str, currency: str}}, billing_contract: [map], deny_reason: str, relations: [map], tax_resident: [map]} # With UserCompany you can retrieve information regarding the authenticated UserCompany and update specific fields.Notification filters can be set on a UserCompany level to receive callbacks. For more information check the dedicated callbacks page.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user-company/{itemId}
@desc Modify a specific company's data.
@required {itemId: int}
@optional {name: str # The company name., public_nick_name: str # The company's public nick name., avatar_uuid: str # The public UUID of the company's avatar., address_main: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_postal: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, language: str # The person's preferred language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore., region: str # The person's preferred region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore., country: str # The country as an ISO 3166-1 alpha-2 country code., ubo: [map{name: str, date_of_birth: str, nationality: str}] # The names of the company's ultimate beneficiary owners. Minimum zero, maximum four., chamber_of_commerce_number: str # The company's chamber of commerce number., legal_form: str # The company's legal form., status: str # The user status. Can be: ACTIVE, SIGNUP, RECOVERY., sub_status: str # The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT., session_timeout: int # The setting for the session timeout of the company in seconds., daily_limit_without_confirmation_login: map{value: str, currency: str}, id: int # The id of the modified company., created: str # The timestamp of the company object's creation., updated: str # The timestamp of the company object's last update., public_uuid: str # The company's public UUID., display_name: str # The company's display name., alias: [map{type: str, value: str, name: str, service: str}] # The aliases of the account., type_of_business_entity: str # The type of business entity., sector_of_industry: str # The sector of industry., counter_bank_iban: str # The company's other bank account IBAN, through which we verify it., avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, version_terms_of_service: str # The version of the terms of service accepted by the user., directors: [map{uuid: str, display_name: str, country: str, avatar: map, public_nick_name: str}] # The existing bunq aliases for the company's directors., notification_filters: [map{notification_delivery_method: str, notification_target: str, category: str}] # The types of notifications that will result in a push notification or URL callback for this UserCompany., customer: map{billing_account_id: str, invoice_notification_preference: str, id: int, created: str, updated: str}, customer_limit: map{limit_monetary_account: int, limit_monetary_account_remaining: int, limit_card_debit_maestro: int, limit_card_debit_mastercard: int, limit_card_debit_wildcard: int, limit_card_wildcard: int, limit_card_replacement: int, limit_amount_monthly: map, spent_amount_monthly: map}, billing_contract: [map{subscription_type: str, id: int, created: str, updated: str, contract_date_start: str, contract_date_end: str, contract_version: int, subscription_type_downgrade: str, status: str, sub_status: str}] # The subscription of the company., deny_reason: str # The user deny reason., relations: [map{user_id: str, counter_user_id: str, label_user: map, counter_label_user: map, relationship: str, status: str, user_status: str, counter_user_status: str, company_employee_setting_adyen_card_transaction: map, all_company_employee_card: [map]}] # The relations for this user., tax_resident: [map{country: str, tax_number: str, status: str, id: int}] # The user's tax residence numbers for different countries.}
@returns(200) {id: int} # With UserCompany you can retrieve information regarding the authenticated UserCompany and update specific fields.Notification filters can be set on a UserCompany level to receive callbacks. For more information check the dedicated callbacks page.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group user-payment-service-provider
@endpoint GET /user-payment-service-provider/{itemId}
@desc Used to view UserPaymentServiceProvider for session creation.
@required {itemId: int}
@returns(200) {id: int, created: str, updated: str, certificate_distinguished_name: str, alias: [map], avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, status: str, sub_status: str, public_uuid: str, display_name: str, public_nick_name: str, language: str, region: str, session_timeout: int} # Used to view UserPaymentServiceProvider for session creation.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group user-person
@endpoint GET /user-person/{itemId}
@desc Get a specific person.
@required {itemId: int}
@returns(200) {id: int, created: str, updated: str, public_uuid: str, first_name: str, middle_name: str, last_name: str, legal_name: str, display_name: str, public_nick_name: str, alias: [map], tax_resident: [map], address_main: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_postal: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, date_of_birth: str, place_of_birth: str, country_of_birth: str, nationality: str, all_nationality: [str], language: str, region: str, gender: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, version_terms_of_service: str, status: str, sub_status: str, session_timeout: int, daily_limit_without_confirmation_login: map{value: str, currency: str}, notification_filters: [map], relations: [map]} # With UserPerson you can retrieve information regarding the authenticated UserPerson and update specific fields.Notification filters can be set on a UserPerson level to receive callbacks. For more information check the dedicated callbacks page.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user-person/{itemId}
@desc Modify a specific person object's data.
@required {itemId: int}
@optional {subscription_type: str # The subscription type the user should start on., first_name: str # The person's first name., middle_name: str # The person's middle name., last_name: str # The person's last name., public_nick_name: str # The public nick name for the person., address_main: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, address_postal: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, avatar_uuid: str # The public UUID of the user's avatar., tax_resident: [map{country: str, tax_number: str, status: str, id: int}] # The user's tax residence numbers for different countries., document_type: str # The type of identification document the person registered with., document_number: str # The identification document number the person registered with., document_country_of_issuance: str # The country which issued the identification document the person registered with., document_front_attachment_id: int # The reference to the uploaded picture/scan of the front side of the identification document., document_back_attachment_id: int # The reference to the uploaded picture/scan of the back side of the identification document., date_of_birth: str # The person's date of birth. Accepts ISO8601 date formats., nationality: str # The person's nationality. Formatted as a SO 3166-1 alpha-2 country code., all_nationality: [str] # All of the person's nationalities., language: str # The person's preferred language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore., region: str # The person's preferred region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore., gender: str # The person's gender. Can be MALE, FEMALE or UNKNOWN., status: str # The user status. The user status. Can be: ACTIVE, BLOCKED, SIGNUP, RECOVERY, DENIED or ABORTED., sub_status: str # The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT., legal_guardian_alias: map{type: str, value: str, name: str, service: str}, session_timeout: int # The setting for the session timeout of the user in seconds., daily_limit_without_confirmation_login: map{value: str, currency: str}, display_name: str # The display name for the person., signup_track_type: str # The type of signup track the user is following., id: int # The id of the modified person object., created: str # The timestamp of the person object's creation., updated: str # The timestamp of the person object's last update., public_uuid: str # The person's public UUID., legal_name: str # The person's legal name., alias: [map{type: str, value: str, name: str, service: str}] # The aliases of the user., address_shipping: map{street: str, house_number: str, po_box: str, postal_code: str, city: str, country: str, extra: str, mailbox_name: str, province: str, is_user_address_updated: bool}, place_of_birth: str # The person's place of birth., country_of_birth: str # The person's country of birth. Formatted as a SO 3166-1 alpha-2 country code., avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, version_terms_of_service: str # The version of the terms of service accepted by the user., notification_filters: [map{notification_delivery_method: str, notification_target: str, category: str}] # The types of notifications that will result in a push notification or URL callback for this UserPerson., relations: [map{user_id: str, counter_user_id: str, label_user: map, counter_label_user: map, relationship: str, status: str, user_status: str, counter_user_status: str, company_employee_setting_adyen_card_transaction: map, all_company_employee_card: [map]}] # The relations for this user.}
@returns(200) {id: int} # With UserPerson you can retrieve information regarding the authenticated UserPerson and update specific fields.Notification filters can be set on a UserPerson level to receive callbacks. For more information check the dedicated callbacks page.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@group user
@endpoint GET /user/{userID}/whitelist-sdd/{itemId}
@desc Get a specific recurring SDD whitelist entry.
@required {userID: int, itemId: int}
@returns(200) {id: int, monetary_account_incoming_id: int, monetary_account_paying_id: int, type: str, status: str, credit_scheme_identifier: str, mandate_identifier: str, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, maximum_amount_per_month: map{value: str, currency: str}, user_alias_created: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}} # Depreciated route, replaced with whitelist-sdd-recurring
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/whitelist-sdd
@desc Get a listing of all recurring SDD whitelist entries for a target monetary account.
@required {userID: int}
@returns(200) Depreciated route, replaced with whitelist-sdd-recurring
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/whitelist-sdd/{itemId}
@desc Get a specific SDD whitelist entry.
@required {userID: int, monetary-accountID: int, itemId: int}
@returns(200) {id: int, monetary_account_incoming_id: int, monetary_account_paying_id: int, type: str, status: str, credit_scheme_identifier: str, mandate_identifier: str, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, maximum_amount_per_month: map{value: str, currency: str}, user_alias_created: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}} # Whitelist an SDD so that when one comes in, it is automatically accepted.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/monetary-account/{monetary-accountID}/whitelist-sdd
@desc Get a listing of all SDD whitelist entries for a target monetary account.
@required {userID: int, monetary-accountID: int}
@returns(200) Whitelist an SDD so that when one comes in, it is automatically accepted.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/whitelist-sdd-one-off/{itemId}
@desc Get a specific one off SDD whitelist entry.
@required {userID: int, itemId: int}
@returns(200) {id: int, monetary_account_incoming_id: int, monetary_account_paying_id: int, type: str, status: str, credit_scheme_identifier: str, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, maximum_amount_per_month: map{value: str, currency: str}, maximum_amount_per_payment: map{value: str, currency: str}, user_alias_created: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, routing_type: str} # Whitelist an one off SDD so that when another one off SDD from the creditor comes in, it is automatically accepted.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/whitelist-sdd-one-off/{itemId}
@desc Whitelist an one off SDD so that when another one off SDD from the creditor comes in, it is automatically accepted.
@required {userID: int, itemId: int, monetary_account_paying_id: int # ID of the monetary account of which you want to pay from., request_id: int # ID of the request for which you want to whitelist the originating SDD.}
@optional {maximum_amount_per_month: map{value: str, currency: str}, maximum_amount_per_payment: map{value: str, currency: str}, routing_type: str # The type of routing for this whitelist. Should be changed to non-optional CIT/technical#12806.}
@returns(200) {Id: map{id: int}} # Whitelist an one off SDD so that when another one off SDD from the creditor comes in, it is automatically accepted.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/whitelist-sdd-one-off/{itemId}
@desc Whitelist an one off SDD so that when another one off SDD from the creditor comes in, it is automatically accepted.
@required {userID: int, itemId: int}
@returns(200) Whitelist an one off SDD so that when another one off SDD from the creditor comes in, it is automatically accepted.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/whitelist-sdd-one-off
@desc Create a new one off SDD whitelist entry.
@required {userID: int, monetary_account_paying_id: int # ID of the monetary account of which you want to pay from., request_id: int # ID of the request for which you want to whitelist the originating SDD.}
@optional {maximum_amount_per_month: map{value: str, currency: str}, maximum_amount_per_payment: map{value: str, currency: str}, routing_type: str # The type of routing for this whitelist. Should be changed to non-optional CIT/technical#12806.}
@returns(200) {Id: map{id: int}} # Whitelist an one off SDD so that when another one off SDD from the creditor comes in, it is automatically accepted.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/whitelist-sdd-one-off
@desc Get a listing of all one off SDD whitelist entries for a target monetary account.
@required {userID: int}
@returns(200) Whitelist an one off SDD so that when another one off SDD from the creditor comes in, it is automatically accepted.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/whitelist-sdd-recurring/{itemId}
@desc Get a specific recurring SDD whitelist entry.
@required {userID: int, itemId: int}
@returns(200) {id: int, monetary_account_incoming_id: int, monetary_account_paying_id: int, type: str, status: str, credit_scheme_identifier: str, mandate_identifier: str, counterparty_alias: map{iban: str, display_name: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, label_user: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, country: str, bunq_me: map{type: str, value: str, name: str, service: str}, is_light: bool, swift_bic: str, swift_account_number: str, transferwise_account_number: str, transferwise_bank_code: str, merchant_category_code: str}, maximum_amount_per_month: map{value: str, currency: str}, maximum_amount_per_payment: map{value: str, currency: str}, user_alias_created: map{uuid: str, display_name: str, country: str, avatar: map{uuid: str, anchor_uuid: str, image: [map], style: str}, public_nick_name: str}, routing_type: str} # Whitelist a recurring SDD so that when another recurrence comes in, it is automatically accepted.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint PUT /user/{userID}/whitelist-sdd-recurring/{itemId}
@desc Whitelist a recurring SDD so that when another recurrence comes in, it is automatically accepted.
@required {userID: int, itemId: int, monetary_account_paying_id: int # ID of the monetary account of which you want to pay from., request_id: int # ID of the request for which you want to whitelist the originating SDD.}
@optional {maximum_amount_per_month: map{value: str, currency: str}, maximum_amount_per_payment: map{value: str, currency: str}, routing_type: str # The type of routing for this whitelist. Should be changed to non-optional CIT/technical#12806.}
@returns(200) {Id: map{id: int}} # Whitelist a recurring SDD so that when another recurrence comes in, it is automatically accepted.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint DELETE /user/{userID}/whitelist-sdd-recurring/{itemId}
@desc Whitelist a recurring SDD so that when another recurrence comes in, it is automatically accepted.
@required {userID: int, itemId: int}
@returns(200) Whitelist a recurring SDD so that when another recurrence comes in, it is automatically accepted.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint POST /user/{userID}/whitelist-sdd-recurring
@desc Create a new recurring SDD whitelist entry.
@required {userID: int, monetary_account_paying_id: int # ID of the monetary account of which you want to pay from., request_id: int # ID of the request for which you want to whitelist the originating SDD.}
@optional {maximum_amount_per_month: map{value: str, currency: str}, maximum_amount_per_payment: map{value: str, currency: str}, routing_type: str # The type of routing for this whitelist. Should be changed to non-optional CIT/technical#12806.}
@returns(200) {Id: map{id: int}} # Whitelist a recurring SDD so that when another recurrence comes in, it is automatically accepted.
@errors {400: This is how the error response looks like for 4XX response codes}

@endpoint GET /user/{userID}/whitelist-sdd-recurring
@desc Get a listing of all recurring SDD whitelist entries for a target monetary account.
@required {userID: int}
@returns(200) Whitelist a recurring SDD so that when another recurrence comes in, it is automatically accepted.
@errors {400: This is how the error response looks like for 4XX response codes}

@endgroup

@end