openapi: 3.0.0
info:
title: 'Bunq user/{userID}/monetary-account'
description: Needs description.
termsOfService: http://bunq.com/terms-api/
contact:
name: bunq Developer Support
url: http://bunq.com/developer
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: '1.0'
servers:
- url: https://public-api.sandbox.bunq.com/{basePath}
description: Sandbox server
variables:
basePath:
default: v1
- url: https://api.bunq.com/{basePath}
description: Production server
variables:
basePath:
default: v1
components:
schemas:
AttachmentMonetaryAccountCreate:
type: object
properties:
id:
type: integer
description: The ID of the attachment created.
readOnly: true
writeOnly: false
BunqMeFundraiserResultRead:
type: object
properties:
id:
type: integer
description: The id of the bunq.me.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp when the bunq.me was created.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp when the bunq.me was last updated.
readOnly: true
writeOnly: false
bunqme_fundraiser_profile:
type: object
description: The bunq.me fundraiser profile.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqMeFundraiserProfile'
payments:
type: array
description: The list of payments, paid to the bunq.me fundraiser profile.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/Payment'
BunqMeTabCreate:
type: object
properties:
id:
type: integer
description: The id of the created bunq.me.
readOnly: true
writeOnly: false
BunqMeTabUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
BunqMeTabRead:
type: object
properties:
id:
type: integer
description: The id of the created bunq.me.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp when the bunq.me was created.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp when the bunq.me was last updated.
readOnly: true
writeOnly: false
time_expiry:
type: string
description: The timestamp of when the bunq.me expired or will expire.
readOnly: true
writeOnly: false
monetary_account_id:
type: integer
description: The id of the MonetaryAccount the bunq.me was sent from.
readOnly: true
writeOnly: false
status:
type: string
description: >-
The status of the bunq.me. Can be WAITING_FOR_PAYMENT, CANCELLED or
EXPIRED.
readOnly: true
writeOnly: false
type:
type: string
description: The type of the bunq.me Tab. Should be BUNQ_ME
readOnly: true
writeOnly: false
alias_monetary_account:
type: object
description: >-
The LabelMonetaryAccount with the public information of the User and
the MonetaryAccount that created the bunq.me link.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
bunqme_tab_share_url:
type: string
description: The url that points to the bunq.me page.
readOnly: true
writeOnly: false
bunqme_tab_entry:
type: object
description: The bunq.me entry containing the payment information.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqMeTabEntry'
bunqme_tab_entries:
type: array
description: The bunq.me tab entries attached to this bunq.me Tab.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/BunqMeTabEntry'
result_inquiries:
type: array
description: The list of bunq.me result Inquiries successfully made and paid.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/BunqMeTabResultInquiry'
BunqMeTabResultResponseRead:
type: object
properties:
payment:
type: object
description: The payment made for the bunq.me tab.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Payment'
CurrencyCloudPaymentQuoteCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
CurrencyConversionRead:
type: object
properties:
id:
type: integer
description: The id of the conversion.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the conversion's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the conversion's last update.
readOnly: true
writeOnly: false
status:
type: string
description: The status of the conversion.
readOnly: true
writeOnly: false
date_delivery_expected:
type: string
description: The expected delivery date of the conversion.
readOnly: true
writeOnly: false
rate:
type: string
description: The rate of the conversion.
readOnly: true
writeOnly: false
amount:
type: object
description: The amount of the conversion.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
counter_amount:
type: object
description: The amount of the counter conversion.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
group_uuid:
type: string
description: The group uuid of the conversion.
readOnly: true
writeOnly: false
type:
type: string
description: The type of this conversion.
readOnly: true
writeOnly: false
order_type:
type: string
description: The order type, buying or selling.
readOnly: true
writeOnly: false
label_monetary_account:
type: object
description: The label of the monetary account.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
counter_label_monetary_account:
type: object
description: The label of the counter monetary account.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
payment:
type: object
description: The payment associated with this conversion.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Payment'
CurrencyConversionQuoteCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
CurrencyConversionQuoteRead:
type: object
properties:
id:
type: integer
description: The id of the quote.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the quote's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the quote's last update.
readOnly: true
writeOnly: false
status:
type: string
description: The status of the quote.
readOnly: true
writeOnly: false
amount_source:
type: object
description: The amount to convert.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
amount_target:
type: object
description: The amount to convert to.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
rate:
type: string
description: The conversion rate.
readOnly: true
writeOnly: false
time_expiry:
type: string
description: >-
Timestamp for when this quote expires and the user should request a
new one.
readOnly: true
writeOnly: false
CurrencyConversionQuoteUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
ExportStatementCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
ExportStatementRead:
type: object
properties:
id:
type: integer
description: The id of the customer statement model.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the statement model's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the statement model's last update.
readOnly: true
writeOnly: false
date_start:
type: string
description: The date from when this statement shows transactions.
readOnly: true
writeOnly: false
date_end:
type: string
description: The date until which statement shows transactions.
readOnly: true
writeOnly: false
status:
type: string
description: The status of the export.
readOnly: true
writeOnly: false
statement_number:
type: integer
description: MT940 Statement number. Unique per monetary account.
readOnly: true
writeOnly: false
statement_format:
type: string
description: The format of statement.
readOnly: true
writeOnly: false
regional_format:
type: string
description: The regional format of a CSV statement.
readOnly: true
writeOnly: false
alias_monetary_account:
type: object
description: The monetary account for which this statement was created.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
ExportStatementDelete:
type: object
DraftPaymentCreate:
type: object
properties:
id:
type: integer
description: The id of the created DrafPayment.
readOnly: true
writeOnly: false
DraftPaymentUpdate:
type: object
properties:
id:
type: integer
description: The id of the created DrafPayment.
readOnly: true
writeOnly: false
DraftPaymentRead:
type: object
properties:
id:
type: integer
description: The id of the created DrafPayment.
readOnly: true
writeOnly: false
monetary_account_id:
type: integer
description: The id of the MonetaryAccount the DraftPayment applies to.
readOnly: true
writeOnly: false
user_alias_created:
type: object
description: The label of the User who created the DraftPayment.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
responses:
type: array
description: All responses to this draft payment.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/DraftPaymentResponse'
status:
type: string
description: The status of the DraftPayment.
readOnly: true
writeOnly: false
type:
type: string
description: The type of the DraftPayment.
readOnly: true
writeOnly: false
entries:
type: array
description: The entries in the DraftPayment.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/DraftPaymentEntry'
object:
type: object
description: >-
The Payment or PaymentBatch. This will only be present after the
DraftPayment has been accepted.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/DraftPaymentAnchorObject'
request_reference_split_the_bill:
type: array
description: >-
The reference to the object used for split the bill. Can be
RequestInquiry or RequestInquiryBatch
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/RequestInquiryReference'
schedule:
type: object
description: The schedule details.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Schedule'
ExportRibCreate:
type: object
properties:
id:
type: integer
description: The id of the rib as created on the server.
readOnly: true
writeOnly: false
ExportRibRead:
type: object
properties:
id:
type: integer
description: The id of the rib as created on the server.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the RIB's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the RIB's last update.
readOnly: true
writeOnly: false
ExportRibDelete:
type: object
IdealMerchantTransactionCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
IdealMerchantTransactionRead:
type: object
properties:
monetary_account_id:
type: integer
description: >-
The id of the monetary account this ideal merchant transaction links
to.
readOnly: true
writeOnly: false
alias:
type: object
description: The alias of the monetary account to add money to.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
counterparty_alias:
type: object
description: The alias of the monetary account the money comes from.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
amount_guaranteed:
type: object
description: >-
In case of a successful transaction, the amount of money that will
be transferred.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
amount_requested:
type: object
description: The requested amount of money to add.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
expiration:
type: string
description: When the transaction will expire.
readOnly: true
writeOnly: false
issuer:
type: string
description: The BIC of the issuer.
readOnly: true
writeOnly: false
issuer_name:
type: string
description: The Name of the issuer.
readOnly: true
writeOnly: false
issuer_authentication_url:
type: string
description: 'The URL to visit to '
readOnly: true
writeOnly: false
purchase_identifier:
type: string
description: The 'purchase ID' of the iDEAL transaction.
readOnly: true
writeOnly: false
status:
type: string
description: The status of the transaction.
readOnly: true
writeOnly: false
status_timestamp:
type: string
description: When the status was last updated.
readOnly: true
writeOnly: false
transaction_identifier:
type: string
description: The 'transaction ID' of the iDEAL transaction.
readOnly: true
writeOnly: false
PaymentAutoAllocateInstanceRead:
type: object
properties:
id:
type: integer
description: The id of the PaymentAutoAllocateInstance.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp when the PaymentAutoAllocateInstance was created.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp when the PaymentAutoAllocateInstance was last updated.
readOnly: true
writeOnly: false
payment_auto_allocate_id:
type: integer
description: The ID of the payment auto allocate this instance belongs to.
readOnly: true
writeOnly: false
status:
type: string
description: >-
The status of the payment auto allocate instance. SUCCEEDED or
FAILED.
readOnly: true
writeOnly: false
error_message:
type: array
description: The error message, if the payment auto allocating failed.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/Error'
payment_batch:
type: object
description: The payment batch allocating all the payments.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/PaymentBatch'
payment_id:
type: integer
description: The ID of the payment that triggered the allocating of the payments.
readOnly: true
writeOnly: false
InvoiceRead:
type: object
properties:
id:
type: integer
description: The id of the invoice object.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the invoice object's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the invoice object's last update.
readOnly: true
writeOnly: false
invoice_date:
type: string
description: The invoice date.
readOnly: true
writeOnly: false
invoice_number:
type: string
description: The invoice number.
readOnly: true
writeOnly: false
status:
type: string
description: The invoice status.
readOnly: true
writeOnly: false
category:
type: string
description: The category to display to the user.
readOnly: true
writeOnly: false
group:
type: array
description: The invoice item groups.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/InvoiceItemGroup'
total_vat_inclusive:
type: object
description: The total discounted item price including VAT.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
total_vat_exclusive:
type: object
description: The total discounted item price excluding VAT.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
total_vat:
type: object
description: The VAT on the total discounted item price.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
alias:
type: object
description: >-
The label that's displayed to the counterparty with the invoice.
Includes user.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
address:
type: object
description: The customer's address.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Address'
counterparty_alias:
type: object
description: The label of the counterparty of the invoice. Includes user.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
counterparty_address:
type: object
description: The company's address.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Address'
chamber_of_commerce_number:
type: string
description: The company's chamber of commerce number.
readOnly: true
writeOnly: false
vat_number:
type: string
description: The company's chamber of commerce number.
readOnly: true
writeOnly: false
request_reference_split_the_bill:
type: array
description: >-
The reference to the object used for split the bill. Can be
RequestInquiry or RequestInquiryBatch
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/RequestInquiryReference'
MasterCardActionRead:
type: object
properties:
id:
type: integer
description: The id of the MastercardAction.
readOnly: true
writeOnly: false
monetary_account_id:
type: integer
description: The id of the monetary account this action links to.
readOnly: true
writeOnly: false
card_id:
type: integer
description: The id of the card this action links to.
readOnly: true
writeOnly: false
amount_local:
type: object
description: The amount of the transaction in local currency.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
amount_converted:
type: object
description: The amount of the transaction in local currency.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
amount_billing:
type: object
description: The amount of the transaction in the monetary account's currency.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
amount_original_local:
type: object
description: The original amount in local currency.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
amount_original_billing:
type: object
description: The original amount in the monetary account's currency.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
amount_fee:
type: object
description: The fee amount as charged by the merchant, if applicable.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
card_authorisation_id_response:
type: string
description: >-
The response code by which authorised transaction can be identified
as authorised by bunq.
readOnly: true
writeOnly: false
decision:
type: string
description: Why the transaction was denied, if it was denied, or just ALLOWED.
readOnly: true
writeOnly: false
payment_status:
type: string
description: >-
The payment status of the transaction. For example
PAYMENT_SUCCESSFUL, for a successful payment.
readOnly: true
writeOnly: false
decision_description:
type: string
description: >-
Empty if allowed, otherwise a textual explanation of why it was
denied.
readOnly: true
writeOnly: false
decision_description_translated:
type: string
description: >-
Empty if allowed, otherwise a textual explanation of why it was
denied in user's language.
readOnly: true
writeOnly: false
decision_together_url:
type: string
description: >-
Empty if allowed or if no relevant Together topic exists, otherwise
contains the URL for a Together topic with more information about
the decision.
readOnly: true
writeOnly: false
description:
type: string
description: The description for this transaction to display.
readOnly: true
writeOnly: false
authorisation_status:
type: string
description: The status in the authorisation process.
readOnly: true
writeOnly: false
authorisation_type:
type: string
description: The type of transaction that was delivered using the card.
readOnly: true
writeOnly: false
pan_entry_mode_user:
type: string
description: >-
The type of entry mode the user used. Can be 'ATM', 'ICC',
'MAGNETIC_STRIPE' or 'E_COMMERCE'.
readOnly: true
writeOnly: false
settlement_status:
type: string
description: The setlement status in the authorisation process.
readOnly: true
writeOnly: false
clearing_status:
type: string
description: >-
The clearing status of the authorisation. Can be 'PENDING',
'FIRST_PRESENTMENT_COMPLETE' or 'REFUND_LENIENCY'.
readOnly: true
writeOnly: false
maturity_date:
type: string
description: The maturity date.
readOnly: true
writeOnly: false
city:
type: string
description: >-
The city where the message originates from as announced by the
terminal.
readOnly: true
writeOnly: false
alias:
type: object
description: >-
The monetary account label of the account that this action is
created for.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
counterparty_alias:
type: object
description: The monetary account label of the counterparty.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
label_card:
type: object
description: The label of the card.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelCard'
merchant_id:
type: string
description: The identification string of the merchant.
readOnly: true
writeOnly: false
token_status:
type: string
description: >-
If this is a tokenisation action, this shows the status of the
token.
readOnly: true
writeOnly: false
reservation_expiry_time:
type: string
description: If this is a reservation, the moment the reservation will expire.
readOnly: true
writeOnly: false
clearing_expiry_time:
type: string
description: >-
The time when the processing of the clearing is expired, refunding
the authorisation.
readOnly: true
writeOnly: false
applied_limit:
type: string
description: >-
The type of the limit applied to validate if this MasterCardAction
was within the spending limits. The returned string matches the
limit types as defined in the card endpoint.
readOnly: true
writeOnly: false
secure_code_id:
type: integer
description: The secure code id for this mastercard action or null.
readOnly: true
writeOnly: false
wallet_provider_id:
type: string
description: >-
The ID of the wallet provider as defined by MasterCard. 420 = bunq
Android app with Tap&Pay; 103 = Apple Pay.
readOnly: true
writeOnly: false
request_reference_split_the_bill:
type: array
description: >-
The reference to the object used for split the bill. Can be
RequestInquiry or RequestInquiryBatch
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/RequestInquiryReference'
all_mastercard_action_refund:
type: array
description: A reference to the Refunds if they exist.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/MasterCardActionRefund'
pos_card_presence:
type: string
description: The Card Presence type of the POS.
readOnly: true
writeOnly: false
pos_card_holder_presence:
type: string
description: The Card Holder Presence type of the POS.
readOnly: true
writeOnly: false
eligible_whitelist_id:
type: integer
description: The whitelist id for this action or null.
readOnly: true
writeOnly: false
cashback_payout_item:
type: object
description: The cashback payout item for this action or null
readOnly: true
writeOnly: false
$ref: '#/components/schemas/CashbackPayoutItem'
blacklist:
type: object
description: The blacklist enabled for the merchant of this transaction
readOnly: true
writeOnly: false
$ref: '#/components/schemas/UserBlacklistMasterCardMerchant'
additional_authentication_status:
type: string
description: >-
The status of the additional authentication performed (3ds) by the
user for this transaction.
readOnly: true
writeOnly: false
pin_status:
type: string
description: Status checking the provided PIN.
readOnly: true
writeOnly: false
mastercard_action_report:
type: object
description: The report for this transaction
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MasterCardActionReport'
merchant_category_code:
type: string
description: The MCC provided.
readOnly: true
writeOnly: false
MonetaryAccountRead:
type: object
properties:
MonetaryAccountBank:
type: object
description: ''
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountBank'
MonetaryAccountJoint:
type: object
description: ''
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountJoint'
MonetaryAccountLight:
type: object
description: ''
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountLight'
MonetaryAccountSavings:
type: object
description: ''
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountSavings'
MonetaryAccountExternal:
type: object
description: ''
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountExternal'
MonetaryAccountInvestment:
type: object
description: ''
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountInvestment'
MonetaryAccountExternalSavings:
type: object
description: ''
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountExternalSavings'
MonetaryAccountBankCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
MonetaryAccountBankRead:
type: object
properties:
id:
type: integer
description: The id of the MonetaryAccountBank.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the MonetaryAccountBank's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the MonetaryAccountBank's last update.
readOnly: true
writeOnly: false
avatar:
type: object
description: The Avatar of the MonetaryAccountBank.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Avatar'
currency:
type: string
description: >-
The currency of the MonetaryAccountBank as an ISO 4217 formatted
currency code.
readOnly: true
writeOnly: false
description:
type: string
description: >-
The description of the MonetaryAccountBank. Defaults to 'bunq
account'.
readOnly: true
writeOnly: false
daily_limit:
type: object
description: >-
The daily spending limit Amount of the MonetaryAccountBank. Defaults
to 1000 EUR. Currency must match the MonetaryAccountBank's currency.
Limited to 10000 EUR.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
overdraft_limit:
type: object
description: The maximum Amount the MonetaryAccountBank can be 'in the red'.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
balance:
type: object
description: The current available balance Amount of the MonetaryAccountBank.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
alias:
type: array
description: The Aliases for the MonetaryAccountBank.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/Pointer'
public_uuid:
type: string
description: The MonetaryAccountBank's public UUID.
readOnly: true
writeOnly: false
status:
type: string
description: >-
The status of the MonetaryAccountBank. Can be: ACTIVE, BLOCKED,
CANCELLED or PENDING_REOPEN
readOnly: true
writeOnly: false
sub_status:
type: string
description: >-
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.
readOnly: true
writeOnly: false
reason:
type: string
description: >-
The reason for voluntarily cancelling (closing) the
MonetaryAccountBank, can only be OTHER.
readOnly: true
writeOnly: false
reason_description:
type: string
description: >-
The optional free-form reason for voluntarily cancelling (closing)
the MonetaryAccountBank. Can be any user provided message.
readOnly: true
writeOnly: false
user_id:
type: integer
description: The id of the User who owns the MonetaryAccountBank.
readOnly: true
writeOnly: false
monetary_account_profile:
type: object
description: The profile of the account.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountProfile'
display_name:
type: string
description: The legal name of the user / company using this monetary account.
readOnly: true
writeOnly: false
setting:
type: object
description: The settings of the MonetaryAccountBank.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountSetting'
all_auto_save_id:
type: array
description: The ids of the AutoSave.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/BunqId'
MonetaryAccountBankUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
MonetaryAccountCardRead:
type: object
properties:
id:
type: integer
description: The id of the MonetaryAccountCard.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the MonetaryAccountCard's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the MonetaryAccountCard's last update.
readOnly: true
writeOnly: false
currency:
type: string
description: >-
The currency of the MonetaryAccountCard as an ISO 4217 formatted
currency code.
readOnly: true
writeOnly: false
description:
type: string
description: >-
The description of the MonetaryAccountCard. Defaults to 'prepaid
credit card'.
readOnly: true
writeOnly: false
daily_limit:
type: object
description: The daily spending limit Amount of the MonetaryAccountCard.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
balance:
type: object
description: The current available balance Amount of the MonetaryAccountCard.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
alias:
type: array
description: The Aliases for the MonetaryAccountCard.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/Pointer'
public_uuid:
type: string
description: The MonetaryAccountCard's public UUID.
readOnly: true
writeOnly: false
status:
type: string
description: The status of the MonetaryAccountCard.
readOnly: true
writeOnly: false
sub_status:
type: string
description: >-
The sub-status of the MonetaryAccountCard providing extra
information regarding the status.
readOnly: true
writeOnly: false
user_id:
type: integer
description: The id of the User who owns the MonetaryAccountCard.
readOnly: true
writeOnly: false
MonetaryAccountCardUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
MonetaryAccountExternalCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
MonetaryAccountExternalRead:
type: object
properties:
id:
type: integer
description: The id of the MonetaryAccountExternal.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the MonetaryAccountExternal's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the MonetaryAccountExternal's last update.
readOnly: true
writeOnly: false
avatar:
type: object
description: The Avatar of the MonetaryAccountExternal.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Avatar'
currency:
type: string
description: >-
The currency of the MonetaryAccountExternal as an ISO 4217 formatted
currency code.
readOnly: true
writeOnly: false
description:
type: string
description: >-
The description of the MonetaryAccountExternal. Defaults to 'bunq
account'.
readOnly: true
writeOnly: false
daily_limit:
type: object
description: >-
The daily spending limit Amount of the MonetaryAccountExternal.
Defaults to 1000 EUR. Currency must match the
MonetaryAccountExternal's currency. Limited to 10000 EUR.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
overdraft_limit:
type: object
description: The maximum Amount the MonetaryAccountExternal can be 'in the red'.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
balance:
type: object
description: The current available balance Amount of the MonetaryAccountExternal.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
alias:
type: array
description: The Aliases for the MonetaryAccountExternal.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/Pointer'
public_uuid:
type: string
description: The MonetaryAccountExternal's public UUID.
readOnly: true
writeOnly: false
status:
type: string
description: >-
The status of the MonetaryAccountExternal. Can be: ACTIVE, BLOCKED,
CANCELLED or PENDING_REOPEN
readOnly: true
writeOnly: false
sub_status:
type: string
description: >-
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.
readOnly: true
writeOnly: false
reason:
type: string
description: >-
The reason for voluntarily cancelling (closing) the
MonetaryAccountExternal, can only be OTHER.
readOnly: true
writeOnly: false
reason_description:
type: string
description: >-
The optional free-form reason for voluntarily cancelling (closing)
the MonetaryAccountExternal. Can be any user provided message.
readOnly: true
writeOnly: false
user_id:
type: integer
description: The id of the User who owns the MonetaryAccountExternal.
readOnly: true
writeOnly: false
monetary_account_profile:
type: object
description: The profile of the account.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountProfile'
display_name:
type: string
description: The legal name of the user / company using this monetary account.
readOnly: true
writeOnly: false
setting:
type: object
description: The settings of the MonetaryAccountExternal.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountSetting'
all_auto_save_id:
type: array
description: The ids of the AutoSave.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/BunqId'
MonetaryAccountExternalUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
MonetaryAccountExternalSavingsCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
MonetaryAccountExternalSavingsRead:
type: object
properties:
id:
type: integer
description: The id of the MonetaryAccountExternalSavings.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the MonetaryAccountExternalSavings's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the MonetaryAccountExternalSavings's last update.
readOnly: true
writeOnly: false
avatar:
type: object
description: The Avatar of the MonetaryAccountExternalSavings.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Avatar'
currency:
type: string
description: >-
The currency of the MonetaryAccountExternalSavings as an ISO 4217
formatted currency code.
readOnly: true
writeOnly: false
description:
type: string
description: >-
The description of the MonetaryAccountExternalSavings. Defaults to
'bunq account'.
readOnly: true
writeOnly: false
daily_limit:
type: object
description: >-
The daily spending limit Amount of the
MonetaryAccountExternalSavings. Defaults to 1000 EUR. Currency must
match the MonetaryAccountExternalSavings's currency. Limited to
10000 EUR.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
balance:
type: object
description: >-
The current available balance Amount of the
MonetaryAccountExternalSavings.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
alias:
type: array
description: The Aliases for the MonetaryAccountExternalSavings.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/Pointer'
public_uuid:
type: string
description: The MonetaryAccountExternalSavings's public UUID.
readOnly: true
writeOnly: false
status:
type: string
description: >-
The status of the MonetaryAccountExternalSavings. Can be: ACTIVE,
BLOCKED, CANCELLED or PENDING_REOPEN
readOnly: true
writeOnly: false
sub_status:
type: string
description: >-
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.
readOnly: true
writeOnly: false
reason:
type: string
description: >-
The reason for voluntarily cancelling (closing) the
MonetaryAccountExternalSavings, can only be OTHER.
readOnly: true
writeOnly: false
reason_description:
type: string
description: >-
The optional free-form reason for voluntarily cancelling (closing)
the MonetaryAccountExternalSavings. Can be any user provided
message.
readOnly: true
writeOnly: false
user_id:
type: integer
description: The id of the User who owns the MonetaryAccountExternalSavings.
readOnly: true
writeOnly: false
monetary_account_profile:
type: object
description: The profile of the account.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountProfile'
display_name:
type: string
description: The legal name of the user / company using this monetary account.
readOnly: true
writeOnly: false
setting:
type: object
description: The settings of the MonetaryAccountExternalSavings.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountSetting'
all_auto_save_id:
type: array
description: The ids of the AutoSave.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/BunqId'
savings_goal:
type: object
description: The Savings Goal set for this MonetaryAccountExternalSavings.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
savings_goal_progress:
type: integer
description: >-
The progress in percentages for the Savings Goal set for this
MonetaryAccountExternalSavings.
readOnly: true
writeOnly: false
number_of_payment_remaining:
type: string
description: The number of payments that can be made from this savings account
readOnly: true
writeOnly: false
MonetaryAccountExternalSavingsUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
MonetaryAccountJointCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
MonetaryAccountJointRead:
type: object
properties:
id:
type: integer
description: The id of the MonetaryAccountJoint.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the MonetaryAccountJoint's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the MonetaryAccountJoint's last update.
readOnly: true
writeOnly: false
avatar:
type: object
description: The Avatar of the MonetaryAccountJoint.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Avatar'
currency:
type: string
description: >-
The currency of the MonetaryAccountJoint as an ISO 4217 formatted
currency code.
readOnly: true
writeOnly: false
description:
type: string
description: >-
The description of the MonetaryAccountJoint. Defaults to 'bunq
account'.
readOnly: true
writeOnly: false
daily_limit:
type: object
description: >-
The daily spending limit Amount of the MonetaryAccountJoint.
Defaults to 1000 EUR. Currency must match the MonetaryAccountJoint's
currency. Limited to 10000 EUR.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
overdraft_limit:
type: object
description: The maximum Amount the MonetaryAccountJoint can be 'in the red'.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
balance:
type: object
description: The current available balance Amount of the MonetaryAccountJoint.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
alias:
type: array
description: The Aliases for the MonetaryAccountJoint.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/Pointer'
public_uuid:
type: string
description: The MonetaryAccountJoint's public UUID.
readOnly: true
writeOnly: false
status:
type: string
description: >-
The status of the MonetaryAccountJoint. Can be: ACTIVE, BLOCKED,
CANCELLED or PENDING_REOPEN
readOnly: true
writeOnly: false
sub_status:
type: string
description: >-
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.
readOnly: true
writeOnly: false
reason:
type: string
description: >-
The reason for voluntarily cancelling (closing) the
MonetaryAccountJoint, can only be OTHER.
readOnly: true
writeOnly: false
reason_description:
type: string
description: >-
The optional free-form reason for voluntarily cancelling (closing)
the MonetaryAccountJoint. Can be any user provided message.
readOnly: true
writeOnly: false
all_co_owner:
type: array
description: The users the account will be joint with.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/CoOwner'
user_id:
type: integer
description: The id of the User who owns the MonetaryAccountJoint.
readOnly: true
writeOnly: false
monetary_account_profile:
type: object
description: The profile of the account.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountProfile'
setting:
type: object
description: The settings of the MonetaryAccountJoint.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountSetting'
all_auto_save_id:
type: array
description: The ids of the AutoSave.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/BunqId'
MonetaryAccountJointUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
MonetaryAccountSavingsCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
MonetaryAccountSavingsRead:
type: object
properties:
id:
type: integer
description: The id of the MonetaryAccountSavings.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the MonetaryAccountSavings's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the MonetaryAccountSavings's last update.
readOnly: true
writeOnly: false
avatar:
type: object
description: The Avatar of the MonetaryAccountSavings.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Avatar'
currency:
type: string
description: >-
The currency of the MonetaryAccountSavings as an ISO 4217 formatted
currency code.
readOnly: true
writeOnly: false
description:
type: string
description: >-
The description of the MonetaryAccountSavings. Defaults to 'bunq
account'.
readOnly: true
writeOnly: false
daily_limit:
type: object
description: >-
The daily spending limit Amount of the MonetaryAccountSavings.
Defaults to 1000 EUR. Currency must match the
MonetaryAccountSavings's currency. Limited to 10000 EUR.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
balance:
type: object
description: The current available balance Amount of the MonetaryAccountSavings.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
alias:
type: array
description: The Aliases for the MonetaryAccountSavings.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/Pointer'
public_uuid:
type: string
description: The MonetaryAccountSavings's public UUID.
readOnly: true
writeOnly: false
status:
type: string
description: >-
The status of the MonetaryAccountSavings. Can be: ACTIVE, BLOCKED,
CANCELLED or PENDING_REOPEN
readOnly: true
writeOnly: false
sub_status:
type: string
description: >-
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.
readOnly: true
writeOnly: false
reason:
type: string
description: >-
The reason for voluntarily cancelling (closing) the
MonetaryAccountSavings, can only be OTHER.
readOnly: true
writeOnly: false
reason_description:
type: string
description: >-
The optional free-form reason for voluntarily cancelling (closing)
the MonetaryAccountSavings. Can be any user provided message.
readOnly: true
writeOnly: false
all_co_owner:
type: array
description: The users the account will be joint with.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/CoOwner'
user_id:
type: integer
description: The id of the User who owns the MonetaryAccountSavings.
readOnly: true
writeOnly: false
monetary_account_profile:
type: object
description: The profile of the account.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountProfile'
setting:
type: object
description: The settings of the MonetaryAccountSavings.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/MonetaryAccountSetting'
savings_goal:
type: object
description: The Savings Goal set for this MonetaryAccountSavings.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
savings_goal_progress:
type: integer
description: >-
The progress in percentages for the Savings Goal set for this
MonetaryAccountSavings.
readOnly: true
writeOnly: false
number_of_payment_remaining:
type: string
description: The number of payments that can be made from this savings account
readOnly: true
writeOnly: false
all_auto_save_id:
type: array
description: The ids of the AutoSave.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/BunqId'
MonetaryAccountSavingsUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentAdyenCardTransactionCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentAdyenCardTransactionUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentAdyenCardTransactionDelete:
type: object
NoteAttachmentAdyenCardTransactionRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentDelete:
type: object
NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentBunqMeFundraiserResultCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentBunqMeFundraiserResultUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentBunqMeFundraiserResultDelete:
type: object
NoteAttachmentBunqMeFundraiserResultRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentDraftPaymentCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentDraftPaymentUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentDraftPaymentDelete:
type: object
NoteAttachmentDraftPaymentRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentIdealMerchantTransactionCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentIdealMerchantTransactionUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentIdealMerchantTransactionDelete:
type: object
NoteAttachmentIdealMerchantTransactionRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentMasterCardActionCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentMasterCardActionUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentMasterCardActionDelete:
type: object
NoteAttachmentMasterCardActionRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentPaymentBatchCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentPaymentBatchUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentPaymentBatchDelete:
type: object
NoteAttachmentPaymentBatchRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentPaymentCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentPaymentUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentPaymentDelete:
type: object
NoteAttachmentPaymentRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentRequestInquiryBatchCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentRequestInquiryBatchUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentRequestInquiryBatchDelete:
type: object
NoteAttachmentRequestInquiryBatchRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentRequestInquiryCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentRequestInquiryUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentRequestInquiryDelete:
type: object
NoteAttachmentRequestInquiryRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentRequestResponseCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentRequestResponseUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentRequestResponseDelete:
type: object
NoteAttachmentRequestResponseRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentScheduleInstanceCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentScheduleInstanceUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentScheduleInstanceDelete:
type: object
NoteAttachmentScheduleInstanceRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentSchedulePaymentBatchCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentSchedulePaymentBatchUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentSchedulePaymentBatchDelete:
type: object
NoteAttachmentSchedulePaymentBatchRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentSchedulePaymentCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentSchedulePaymentUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentSchedulePaymentDelete:
type: object
NoteAttachmentSchedulePaymentRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentSofortMerchantTransactionCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentSofortMerchantTransactionUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentSofortMerchantTransactionDelete:
type: object
NoteAttachmentSofortMerchantTransactionRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteAttachmentWhitelistResultCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentWhitelistResultUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteAttachmentWhitelistResultDelete:
type: object
NoteAttachmentWhitelistResultRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
description:
type: string
description: Optional description of the attachment.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachment attached to the note.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
NoteTextAdyenCardTransactionCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextAdyenCardTransactionUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextAdyenCardTransactionDelete:
type: object
NoteTextAdyenCardTransactionRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextBankSwitchServiceNetherlandsIncomingPaymentCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextBankSwitchServiceNetherlandsIncomingPaymentUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextBankSwitchServiceNetherlandsIncomingPaymentDelete:
type: object
NoteTextBankSwitchServiceNetherlandsIncomingPaymentRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextBunqMeFundraiserResultCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextBunqMeFundraiserResultUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextBunqMeFundraiserResultDelete:
type: object
NoteTextBunqMeFundraiserResultRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextDraftPaymentCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextDraftPaymentUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextDraftPaymentDelete:
type: object
NoteTextDraftPaymentRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextIdealMerchantTransactionCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextIdealMerchantTransactionUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextIdealMerchantTransactionDelete:
type: object
NoteTextIdealMerchantTransactionRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextMasterCardActionCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextMasterCardActionUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextMasterCardActionDelete:
type: object
NoteTextMasterCardActionRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextPaymentBatchCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextPaymentBatchUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextPaymentBatchDelete:
type: object
NoteTextPaymentBatchRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextPaymentCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextPaymentUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextPaymentDelete:
type: object
NoteTextPaymentRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextRequestInquiryBatchCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextRequestInquiryBatchUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextRequestInquiryBatchDelete:
type: object
NoteTextRequestInquiryBatchRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextRequestInquiryCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextRequestInquiryUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextRequestInquiryDelete:
type: object
NoteTextRequestInquiryRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextRequestResponseCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextRequestResponseUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextRequestResponseDelete:
type: object
NoteTextRequestResponseRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextScheduleInstanceCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextScheduleInstanceUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextScheduleInstanceDelete:
type: object
NoteTextScheduleInstanceRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextSchedulePaymentBatchCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextSchedulePaymentBatchUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextSchedulePaymentBatchDelete:
type: object
NoteTextSchedulePaymentBatchRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextSchedulePaymentCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextSchedulePaymentUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextSchedulePaymentDelete:
type: object
NoteTextSchedulePaymentRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextSofortMerchantTransactionCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextSofortMerchantTransactionUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextSofortMerchantTransactionDelete:
type: object
NoteTextSofortMerchantTransactionRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NoteTextWhitelistResultCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextWhitelistResultUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
NoteTextWhitelistResultDelete:
type: object
NoteTextWhitelistResultRead:
type: object
properties:
id:
type: integer
description: The id of the note.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the note's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the note's last update.
readOnly: true
writeOnly: false
label_user_creator:
type: object
description: The label of the user who created this note.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
content:
type: string
description: The content of the note.
readOnly: true
writeOnly: false
NotificationFilterUrlMonetaryAccountCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
PaymentCreate:
type: object
properties:
id:
type: integer
description: The id of the created Payment.
readOnly: true
writeOnly: false
PaymentRead:
type: object
properties:
id:
type: integer
description: The id of the created Payment.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp when the Payment was done.
readOnly: true
writeOnly: false
updated:
type: string
description: >-
The timestamp when the Payment was last updated (will be updated
when chat messages are received).
readOnly: true
writeOnly: false
monetary_account_id:
type: integer
description: >-
The id of the MonetaryAccount the Payment was made to or from
(depending on whether this is an incoming or outgoing Payment).
readOnly: true
writeOnly: false
amount:
type: object
description: >-
The Amount transferred by the Payment. Will be negative for outgoing
Payments and positive for incoming Payments (relative to the
MonetaryAccount indicated by monetary_account_id).
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
alias:
type: object
description: >-
The LabelMonetaryAccount containing the public information of 'this'
(party) side of the Payment.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
counterparty_alias:
type: object
description: >-
The LabelMonetaryAccount containing the public information of the
other (counterparty) side of the Payment.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
description:
type: string
description: >-
The description for the Payment. Maximum 140 characters for Payments
to external IBANs, 9000 characters for Payments to only other bunq
MonetaryAccounts.
readOnly: true
writeOnly: false
type:
type: string
description: >-
The type of Payment, can be BUNQ, EBA_SCT, EBA_SDD, IDEAL, SWIFT or
FIS (card).
readOnly: true
writeOnly: false
sub_type:
type: string
description: >-
The sub-type of the Payment, can be PAYMENT, WITHDRAWAL, REVERSAL,
REQUEST, BILLING, SCT, SDD or NLO.
readOnly: true
writeOnly: false
bunqto_status:
type: string
description: The status of the bunq.to payment.
readOnly: true
writeOnly: false
bunqto_sub_status:
type: string
description: The sub status of the bunq.to payment.
readOnly: true
writeOnly: false
bunqto_share_url:
type: string
description: The status of the bunq.to payment.
readOnly: true
writeOnly: false
bunqto_expiry:
type: string
description: When bunq.to payment is about to expire.
readOnly: true
writeOnly: false
bunqto_time_responded:
type: string
description: The timestamp of when the bunq.to payment was responded to.
readOnly: true
writeOnly: false
attachment:
type: array
description: The Attachments attached to the Payment.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountPayment'
merchant_reference:
type: string
description: Optional data included with the Payment specific to the merchant.
readOnly: true
writeOnly: false
batch_id:
type: integer
description: The id of the PaymentBatch if this Payment was part of one.
readOnly: true
writeOnly: false
scheduled_id:
type: integer
description: The id of the JobScheduled if the Payment was scheduled.
readOnly: true
writeOnly: false
address_shipping:
type: object
description: A shipping Address provided with the Payment, currently unused.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Address'
address_billing:
type: object
description: A billing Address provided with the Payment, currently unused.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Address'
geolocation:
type: object
description: The Geolocation where the Payment was done from.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Geolocation'
request_reference_split_the_bill:
type: array
description: >-
The reference to the object used for split the bill. Can be
RequestInquiry or RequestInquiryBatch
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/RequestInquiryReference'
balance_after_mutation:
type: object
description: The new balance of the monetary account after the mutation.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
payment_auto_allocate_instance:
type: object
description: A reference to the PaymentAutoAllocateInstance if it exists.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/PaymentAutoAllocateInstance'
PaymentAutoAllocateCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
PaymentAutoAllocateRead:
type: object
properties:
id:
type: integer
description: The id of the PaymentAutoAllocate.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp when the PaymentAutoAllocate was created.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp when the PaymentAutoAllocate was last updated.
readOnly: true
writeOnly: false
type:
type: string
description: The type.
readOnly: true
writeOnly: false
status:
type: string
description: The status.
readOnly: true
writeOnly: false
trigger_amount:
type: object
description: The amount on which this payment auto allocate will be triggered.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
payment:
type: object
description: 'DEPRECATED: superseded by `payment_original` and `payment_latest`'
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Payment'
payment_original:
type: object
description: >-
The payment that was used to define the triggers for this payment
auto allocate.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Payment'
payment_latest:
type: object
description: The latest payment allocated using this payment auto allocate.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Payment'
PaymentAutoAllocateUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
PaymentAutoAllocateDelete:
type: object
PaymentBatchCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
PaymentBatchUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
PaymentBatchRead:
type: object
properties:
payments:
type: object
description: The list of mutations that were made.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/PaymentBatchAnchoredPayment'
RequestInquiryCreate:
type: object
properties:
id:
type: integer
description: The id of the created RequestInquiry.
readOnly: true
writeOnly: false
RequestInquiryUpdate:
type: object
properties:
id:
type: integer
description: The id of the payment request.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the payment request's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the payment request's last update.
readOnly: true
writeOnly: false
time_responded:
type: string
description: The timestamp of when the payment request was responded to.
readOnly: true
writeOnly: false
time_expiry:
type: string
description: The timestamp of when the payment request expired.
readOnly: true
writeOnly: false
monetary_account_id:
type: integer
description: The id of the monetary account the request response applies to.
readOnly: true
writeOnly: false
amount_inquired:
type: object
description: The requested amount.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
amount_responded:
type: object
description: The responded amount.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
user_alias_created:
type: object
description: >-
The label that's displayed to the counterparty with the mutation.
Includes user.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
user_alias_revoked:
type: object
description: >-
The label that's displayed to the counterparty with the mutation.
Includes user.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
counterparty_alias:
type: object
description: >-
The LabelMonetaryAccount with the public information of the
MonetaryAccount the money was requested from.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
description:
type: string
description: The description of the inquiry.
readOnly: true
writeOnly: false
merchant_reference:
type: string
description: >-
The client's custom reference that was attached to the request and
the mutation.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachments attached to the payment.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/BunqId'
status:
type: string
description: The status of the request.
readOnly: true
writeOnly: false
batch_id:
type: integer
description: The id of the batch if the request was part of a batch.
readOnly: true
writeOnly: false
scheduled_id:
type: integer
description: The id of the scheduled job if the request was scheduled.
readOnly: true
writeOnly: false
minimum_age:
type: integer
description: The minimum age the user accepting the RequestInquiry must have.
readOnly: true
writeOnly: false
require_address:
type: string
description: Whether or not an address must be provided on accept.
readOnly: true
writeOnly: false
address_shipping:
type: object
description: >-
The shipping address provided by the accepting user if an address
was requested.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Address'
address_billing:
type: object
description: >-
The billing address provided by the accepting user if an address was
requested.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Address'
geolocation:
type: object
description: The geolocation where the payment was done.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Geolocation'
reference_split_the_bill:
type: object
description: >-
The reference to the object used for split the bill. Can be Payment,
PaymentBatch, ScheduleInstance, RequestResponse and MasterCardAction
readOnly: true
writeOnly: false
$ref: '#/components/schemas/RequestReferenceSplitTheBillAnchorObject'
RequestInquiryRead:
type: object
properties:
id:
type: integer
description: The id of the created RequestInquiry.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the payment request's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the payment request's last update.
readOnly: true
writeOnly: false
time_responded:
type: string
description: The timestamp of when the payment request was responded to.
readOnly: true
writeOnly: false
time_expiry:
type: string
description: The timestamp of when the payment request expired.
readOnly: true
writeOnly: false
monetary_account_id:
type: integer
description: The id of the monetary account the request response applies to.
readOnly: true
writeOnly: false
amount_inquired:
type: object
description: The requested amount.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
amount_responded:
type: object
description: The responded amount.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
user_alias_created:
type: object
description: >-
The label that's displayed to the counterparty with the mutation.
Includes user.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
user_alias_revoked:
type: object
description: >-
The label that's displayed to the counterparty with the mutation.
Includes user.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
counterparty_alias:
type: object
description: >-
The LabelMonetaryAccount with the public information of the
MonetaryAccount the money was requested from.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
description:
type: string
description: The description of the inquiry.
readOnly: true
writeOnly: false
merchant_reference:
type: string
description: >-
The client's custom reference that was attached to the request and
the mutation.
readOnly: true
writeOnly: false
attachment:
type: array
description: The attachments attached to the payment.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/BunqId'
status:
type: string
description: The status of the request.
readOnly: true
writeOnly: false
batch_id:
type: integer
description: The id of the batch if the request was part of a batch.
readOnly: true
writeOnly: false
scheduled_id:
type: integer
description: The id of the scheduled job if the request was scheduled.
readOnly: true
writeOnly: false
minimum_age:
type: integer
description: The minimum age the user accepting the RequestInquiry must have.
readOnly: true
writeOnly: false
require_address:
type: string
description: Whether or not an address must be provided on accept.
readOnly: true
writeOnly: false
bunqme_share_url:
type: string
description: The url that points to the bunq.me request.
readOnly: true
writeOnly: false
redirect_url:
type: string
description: >-
The URL which the user is sent to after accepting or rejecting the
Request.
readOnly: true
writeOnly: false
address_shipping:
type: object
description: >-
The shipping address provided by the accepting user if an address
was requested.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Address'
address_billing:
type: object
description: >-
The billing address provided by the accepting user if an address was
requested.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Address'
geolocation:
type: object
description: The geolocation where the payment was done.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Geolocation'
reference_split_the_bill:
type: object
description: >-
The reference to the object used for split the bill. Can be Payment,
PaymentBatch, ScheduleInstance, RequestResponse and MasterCardAction
readOnly: true
writeOnly: false
$ref: '#/components/schemas/RequestReferenceSplitTheBillAnchorObject'
RequestInquiryBatchCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
RequestInquiryBatchUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
RequestInquiryBatchRead:
type: object
properties:
request_inquiries:
type: array
description: The list of requests that were made.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/RequestInquiry'
total_amount_inquired:
type: object
description: The total amount originally inquired for this batch.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
reference_split_the_bill:
type: object
description: >-
The reference to the object used for split the bill. Can be Payment,
PaymentBatch, ScheduleInstance, RequestResponse and MasterCardAction
readOnly: true
writeOnly: false
$ref: '#/components/schemas/RequestReferenceSplitTheBillAnchorObject'
RequestResponseUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
RequestResponseRead:
type: object
properties:
id:
type: integer
description: The id of the Request Response.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp when the Request Response was created.
readOnly: true
writeOnly: false
updated:
type: string
description: >-
The timestamp when the Request Response was last updated (will be
updated when chat messages are received).
readOnly: true
writeOnly: false
time_responded:
type: string
description: The timestamp of when the RequestResponse was responded to.
readOnly: true
writeOnly: false
time_expiry:
type: string
description: The timestamp of when the RequestResponse expired or will expire.
readOnly: true
writeOnly: false
time_refund_requested:
type: string
description: >-
The timestamp of when a refund request for the RequestResponse was
claimed.
readOnly: true
writeOnly: false
time_refunded:
type: string
description: The timestamp of when the RequestResponse was refunded.
readOnly: true
writeOnly: false
user_refund_requested:
type: object
description: The label of the user that requested the refund.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
monetary_account_id:
type: integer
description: The id of the MonetaryAccount the RequestResponse was received on.
readOnly: true
writeOnly: false
amount_inquired:
type: object
description: The requested Amount.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
amount_responded:
type: object
description: The Amount the RequestResponse was accepted with.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
status:
type: string
description: >-
The status of the RequestResponse. Can be ACCEPTED, PENDING,
REJECTED, REFUND_REQUESTED, REFUNDED or REVOKED.
readOnly: true
writeOnly: false
description:
type: string
description: >-
The description for the RequestResponse provided by the requesting
party. Maximum 9000 characters.
readOnly: true
writeOnly: false
alias:
type: object
description: >-
The LabelMonetaryAccount with the public information of the
MonetaryAccount this RequestResponse was received on.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
counterparty_alias:
type: object
description: >-
The LabelMonetaryAccount with the public information of the
MonetaryAccount that is requesting money with this RequestResponse.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
attachment:
type: array
description: The Attachments attached to the RequestResponse.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/Attachment'
minimum_age:
type: integer
description: The minimum age the user accepting the RequestResponse must have.
readOnly: true
writeOnly: false
require_address:
type: string
description: Whether or not an address must be provided on accept.
readOnly: true
writeOnly: false
geolocation:
type: object
description: The Geolocation where the RequestResponse was created.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Geolocation'
type:
type: string
description: >-
The type of the RequestInquiry. Can be DIRECT_DEBIT,
DIRECT_DEBIT_B2B, IDEAL, SOFORT or INTERNAL.
readOnly: true
writeOnly: false
sub_type:
type: string
description: >-
The subtype of the RequestInquiry. Can be ONCE or RECURRING for
DIRECT_DEBIT RequestInquiries and NONE for all other.
readOnly: true
writeOnly: false
redirect_url:
type: string
description: >-
The URL which the user is sent to after accepting or rejecting the
Request.
readOnly: true
writeOnly: false
address_billing:
type: object
description: >-
The billing address provided by the accepting user if an address was
requested.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Address'
address_shipping:
type: object
description: >-
The shipping address provided by the accepting user if an address
was requested.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Address'
credit_scheme_identifier:
type: string
description: >-
The credit scheme id provided by the counterparty for DIRECT_DEBIT
inquiries.
readOnly: true
writeOnly: false
mandate_identifier:
type: string
description: >-
The mandate id provided by the counterparty for DIRECT_DEBIT
inquiries.
readOnly: true
writeOnly: false
eligible_whitelist_id:
type: integer
description: The whitelist id for this action or null.
readOnly: true
writeOnly: false
request_reference_split_the_bill:
type: array
description: >-
The reference to the object used for split the bill. Can be
RequestInquiry or RequestInquiryBatch
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/RequestInquiryReference'
event_id:
type: integer
description: The ID of the latest event for the request.
readOnly: true
writeOnly: false
monetary_account_preferred_id:
type: integer
description: >-
The ID of the monetary account this user prefers to pay the request
from.
readOnly: true
writeOnly: false
ScheduleRead:
type: object
properties:
time_start:
type: string
description: The schedule start time (UTC).
readOnly: true
writeOnly: false
time_end:
type: string
description: The schedule end time (UTC).
readOnly: true
writeOnly: false
recurrence_unit:
type: string
description: >-
The schedule recurrence unit, options: ONCE, HOURLY, DAILY, WEEKLY,
MONTHLY, YEARLY
readOnly: true
writeOnly: false
recurrence_size:
type: integer
description: >-
The schedule recurrence size. For example size 4 and unit WEEKLY
means the recurrence is every 4 weeks.
readOnly: true
writeOnly: false
status:
type: string
description: 'The schedule status, options: ACTIVE, FINISHED, CANCELLED.'
readOnly: true
writeOnly: false
object:
type: object
description: The scheduled object. (Payment, PaymentBatch)
readOnly: true
writeOnly: false
$ref: '#/components/schemas/ScheduleAnchorObject'
ScheduleInstanceRead:
type: object
properties:
state:
type: string
description: >-
The state of the scheduleInstance. (FINISHED_SUCCESSFULLY, RETRY,
FAILED_USER_ERROR)
readOnly: true
writeOnly: false
time_start:
type: string
description: The schedule start time (UTC).
readOnly: true
writeOnly: false
time_end:
type: string
description: The schedule end time (UTC).
readOnly: true
writeOnly: false
error_message:
type: array
description: >-
The message when the scheduled instance has run and failed due to
user error.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/Error'
scheduled_object:
type: object
description: The scheduled object. (Payment, PaymentBatch)
readOnly: true
writeOnly: false
$ref: '#/components/schemas/ScheduleAnchorObject'
result_object:
type: object
description: The result object of this schedule instance. (Payment, PaymentBatch)
readOnly: true
writeOnly: false
$ref: '#/components/schemas/ScheduleInstanceAnchorObject'
request_reference_split_the_bill:
type: array
description: >-
The reference to the object used for split the bill. Can be
RequestInquiry or RequestInquiryBatch
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/RequestInquiryReference'
ScheduleInstanceUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
SchedulePaymentCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
SchedulePaymentDelete:
type: object
SchedulePaymentRead:
type: object
properties:
payment:
type: object
description: The payment details.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/SchedulePaymentEntry'
schedule:
type: object
description: The schedule details.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Schedule'
status:
type: string
description: 'The schedule status, options: ACTIVE, FINISHED, CANCELLED.'
readOnly: true
writeOnly: false
SchedulePaymentUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
SchedulePaymentBatchRead:
type: object
properties:
payments:
type: array
description: The payment details.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/SchedulePaymentEntry'
schedule:
type: object
description: The schedule details.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Schedule'
SchedulePaymentBatchUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
SchedulePaymentBatchDelete:
type: object
SchedulePaymentBatchCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
ShareInviteMonetaryAccountInquiryCreate:
type: object
properties:
id:
type: integer
description: The id of the newly created share invite.
readOnly: true
writeOnly: false
ShareInviteMonetaryAccountInquiryRead:
type: object
properties:
alias:
type: object
description: The label of the monetary account that's being shared.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
user_alias_created:
type: object
description: The user who created the share.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
user_alias_revoked:
type: object
description: The user who revoked the share.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
counter_user_alias:
type: object
description: The label of the user to share with.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
monetary_account_id:
type: integer
description: The id of the monetary account the share applies to.
readOnly: true
writeOnly: false
status:
type: string
description: The status of the share. Can be ACTIVE, REVOKED, REJECTED.
readOnly: true
writeOnly: false
access_type:
type: string
description: Type of access that is in place.
readOnly: true
writeOnly: false
relationship:
type: string
description: 'The relationship: COMPANY_DIRECTOR, COMPANY_EMPLOYEE, etc'
readOnly: true
writeOnly: false
id:
type: integer
description: The id of the newly created share invite.
readOnly: true
writeOnly: false
ShareInviteMonetaryAccountInquiryUpdate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
SofortMerchantTransactionRead:
type: object
properties:
monetary_account_id:
type: integer
description: >-
The id of the monetary account this sofort merchant transaction
links to.
readOnly: true
writeOnly: false
alias:
type: object
description: The alias of the monetary account to add money to.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
counterparty_alias:
type: object
description: The alias of the monetary account the money comes from.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
amount_guaranteed:
type: object
description: >-
In case of a successful transaction, the amount of money that will
be transferred.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
amount_requested:
type: object
description: The requested amount of money to add.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
issuer:
type: string
description: The BIC of the issuer.
readOnly: true
writeOnly: false
issuer_authentication_url:
type: string
description: 'The URL to visit to '
readOnly: true
writeOnly: false
status:
type: string
description: The status of the transaction.
readOnly: true
writeOnly: false
error_message:
type: array
description: The error message of the transaction.
readOnly: true
writeOnly: false
items:
$ref: '#/components/schemas/Error'
transaction_identifier:
type: string
description: The 'transaction ID' of the Sofort transaction.
readOnly: true
writeOnly: false
ExportStatementPaymentCreate:
type: object
properties:
Id:
type: object
description: The id of the created item
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BunqId'
ExportStatementPaymentRead:
type: object
properties:
id:
type: integer
description: The id of the single payment statement model.
readOnly: true
writeOnly: false
created:
type: string
description: The timestamp of the statement model's creation.
readOnly: true
writeOnly: false
updated:
type: string
description: The timestamp of the statement model's last update.
readOnly: true
writeOnly: false
status:
type: string
description: The status of the export.
readOnly: true
writeOnly: false
BankSwitchServiceNetherlandsIncomingPaymentRead:
type: object
properties:
bank_switch_service:
type: object
description: The bank switch service details.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/BankSwitchServiceNetherlandsIncoming'
payment:
type: object
description: The payment made using bank switch service.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Payment'
WhitelistSddMonetaryAccountPayingRead:
type: object
properties:
id:
type: integer
description: The ID of the whitelist entry.
readOnly: true
writeOnly: false
monetary_account_incoming_id:
type: integer
description: >-
The account to which payments will come in before possibly being
'redirected' by the whitelist.
readOnly: true
writeOnly: false
monetary_account_paying_id:
type: integer
description: >-
The account from which payments will be deducted when a transaction
is matched with this whitelist.
readOnly: true
writeOnly: false
type:
type: string
description: The type of the SDD whitelist, can be CORE or B2B.
readOnly: true
writeOnly: false
status:
type: string
description: The status of the whitelist.
readOnly: true
writeOnly: false
credit_scheme_identifier:
type: string
description: The credit scheme ID provided by the counterparty.
readOnly: true
writeOnly: false
mandate_identifier:
type: string
description: The mandate ID provided by the counterparty.
readOnly: true
writeOnly: false
counterparty_alias:
type: object
description: The account to which payments will be paid.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelMonetaryAccount'
maximum_amount_per_month:
type: object
description: >-
The monthly maximum amount that can be deducted from the target
account.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/Amount'
user_alias_created:
type: object
description: The user who created the whitelist entry.
readOnly: true
writeOnly: false
$ref: '#/components/schemas/LabelUser'
paths:
/user/{userID}/monetary-account/{monetary-accountID}/attachment:
post:
tags:
- User
summary: ''
operationId: CREATE_Attachment_for_User_MonetaryAccount
description: >-
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.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AttachmentMonetaryAccount'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
$ref: '#/components/schemas/AttachmentMonetaryAccountCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_BunqmeFundraiserResult_for_User_MonetaryAccount
description: bunq.me fundraiser result containing all payments.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: bunq.me fundraiser result containing all payments.
content:
application/json:
schema:
$ref: '#/components/schemas/BunqMeFundraiserResultRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/bunqme-tab:
post:
tags:
- User
summary: ''
operationId: CREATE_BunqmeTab_for_User_MonetaryAccount
description: >-
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.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BunqMeTab'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
$ref: '#/components/schemas/BunqMeTabCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_BunqmeTab_for_User_MonetaryAccount
description: >-
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.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BunqMeTabListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/bunqme-tab/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_BunqmeTab_for_User_MonetaryAccount
description: >-
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.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BunqMeTab'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
$ref: '#/components/schemas/BunqMeTabUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_BunqmeTab_for_User_MonetaryAccount
description: >-
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.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
$ref: '#/components/schemas/BunqMeTabRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/bunqme-tab-result-response/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_BunqmeTabResultResponse_for_User_MonetaryAccount
description: >-
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.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
$ref: '#/components/schemas/BunqMeTabResultResponseRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/attachment/{attachmentID}/content:
get:
tags:
- User
summary: ''
operationId: List_all_Content_for_User_MonetaryAccount_Attachment
description: Get the raw content of a specific attachment.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: attachmentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AttachmentMonetaryAccountContentListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/export-rib/{export-ribID}/content:
get:
tags:
- User
summary: ''
operationId: List_all_Content_for_User_MonetaryAccount_ExportRib
description: Used to retrieve the raw content of an RIB.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: export-ribID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Fetch the raw content of an RIB. The RIB is always in PDF format.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExportRibContentListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/customer-statement/{customer-statementID}/content:
get:
tags:
- User
summary: ''
operationId: List_all_Content_for_User_MonetaryAccount_CustomerStatement
description: >-
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.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: customer-statementID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExportStatementContentListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/event/{eventID}/statement/{statementID}/content:
get:
tags:
- User
summary: ''
operationId: List_all_Content_for_User_MonetaryAccount_Event_Statement
description: Fetch the raw content of a payment statement export.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: eventID
description: ''
required: true
schema:
type: integer
- in: path
name: statementID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Fetch the raw content of a payment statement export.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExportStatementPaymentContentListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/currency-cloud-payment-quote:
post:
tags:
- User
summary: ''
operationId: CREATE_CurrencyCloudPaymentQuote_for_User_MonetaryAccount
description: Endpoint for managing currency conversions.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CurrencyCloudPaymentQuote'
responses:
'200':
description: Endpoint for managing currency conversions.
content:
application/json:
schema:
$ref: '#/components/schemas/CurrencyCloudPaymentQuoteCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/currency-conversion:
get:
tags:
- User
summary: ''
operationId: List_all_CurrencyConversion_for_User_MonetaryAccount
description: Endpoint for managing currency conversions.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Endpoint for managing currency conversions.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CurrencyConversionListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/currency-conversion/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_CurrencyConversion_for_User_MonetaryAccount
description: Endpoint for managing currency conversions.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Endpoint for managing currency conversions.
content:
application/json:
schema:
$ref: '#/components/schemas/CurrencyConversionRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/currency-conversion-quote:
post:
tags:
- User
summary: ''
operationId: CREATE_CurrencyConversionQuote_for_User_MonetaryAccount
description: Endpoint to create a quote for currency conversions.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CurrencyConversionQuote'
responses:
'200':
description: Endpoint to create a quote for currency conversions.
content:
application/json:
schema:
$ref: '#/components/schemas/CurrencyConversionQuoteCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/currency-conversion-quote/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_CurrencyConversionQuote_for_User_MonetaryAccount
description: Endpoint to create a quote for currency conversions.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Endpoint to create a quote for currency conversions.
content:
application/json:
schema:
$ref: '#/components/schemas/CurrencyConversionQuoteRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
put:
tags:
- User
summary: ''
operationId: UPDATE_CurrencyConversionQuote_for_User_MonetaryAccount
description: Endpoint to create a quote for currency conversions.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CurrencyConversionQuote'
responses:
'200':
description: Endpoint to create a quote for currency conversions.
content:
application/json:
schema:
$ref: '#/components/schemas/CurrencyConversionQuoteUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/customer-statement:
post:
tags:
- User
summary: ''
operationId: CREATE_CustomerStatement_for_User_MonetaryAccount
description: >-
Used to create new and read existing statement exports. Statement
exports can be created in either CSV, MT940 or PDF file format.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExportStatement'
responses:
'200':
description: >-
Used to create new and read existing statement exports. Statement
exports can be created in either CSV, MT940 or PDF file format.
content:
application/json:
schema:
$ref: '#/components/schemas/ExportStatementCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_CustomerStatement_for_User_MonetaryAccount
description: >-
Used to create new and read existing statement exports. Statement
exports can be created in either CSV, MT940 or PDF file format.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
Used to create new and read existing statement exports. Statement
exports can be created in either CSV, MT940 or PDF file format.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExportStatementListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/customer-statement/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_CustomerStatement_for_User_MonetaryAccount
description: >-
Used to create new and read existing statement exports. Statement
exports can be created in either CSV, MT940 or PDF file format.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
Used to create new and read existing statement exports. Statement
exports can be created in either CSV, MT940 or PDF file format.
content:
application/json:
schema:
$ref: '#/components/schemas/ExportStatementRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_CustomerStatement_for_User_MonetaryAccount
description: >-
Used to create new and read existing statement exports. Statement
exports can be created in either CSV, MT940 or PDF file format.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
Used to create new and read existing statement exports. Statement
exports can be created in either CSV, MT940 or PDF file format.
content:
application/json:
schema:
$ref: '#/components/schemas/ExportStatementDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate/{payment-auto-allocateID}/definition:
get:
tags:
- User
summary: ''
operationId: List_all_Definition_for_User_MonetaryAccount_PaymentAutoAllocate
description: List all the definitions in a payment auto allocate.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: payment-auto-allocateID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: List all the definitions in a payment auto allocate.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PaymentAutoAllocateDefinitionListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/draft-payment:
post:
tags:
- User
summary: ''
operationId: CREATE_DraftPayment_for_User_MonetaryAccount
description: Create a new DraftPayment.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DraftPayment'
responses:
'200':
description: >-
A DraftPayment is like a regular Payment, but it needs to be
accepted by the sending party before the actual Payment is done.
content:
application/json:
schema:
$ref: '#/components/schemas/DraftPaymentCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_DraftPayment_for_User_MonetaryAccount
description: Get a listing of all DraftPayments from a given MonetaryAccount.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
A DraftPayment is like a regular Payment, but it needs to be
accepted by the sending party before the actual Payment is done.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DraftPaymentListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_DraftPayment_for_User_MonetaryAccount
description: Update a DraftPayment.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DraftPayment'
responses:
'200':
description: >-
A DraftPayment is like a regular Payment, but it needs to be
accepted by the sending party before the actual Payment is done.
content:
application/json:
schema:
$ref: '#/components/schemas/DraftPaymentUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_DraftPayment_for_User_MonetaryAccount
description: Get a specific DraftPayment.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
A DraftPayment is like a regular Payment, but it needs to be
accepted by the sending party before the actual Payment is done.
content:
application/json:
schema:
$ref: '#/components/schemas/DraftPaymentRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/export-rib:
post:
tags:
- User
summary: ''
operationId: CREATE_ExportRib_for_User_MonetaryAccount
description: Create a new RIB.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExportRib'
responses:
'200':
description: Used to create new and read existing RIBs of a monetary account
content:
application/json:
schema:
$ref: '#/components/schemas/ExportRibCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_ExportRib_for_User_MonetaryAccount
description: List all the RIBs for a monetary account.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to create new and read existing RIBs of a monetary account
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExportRibListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/export-rib/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_ExportRib_for_User_MonetaryAccount
description: Get a RIB for a monetary account by its id.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to create new and read existing RIBs of a monetary account
content:
application/json:
schema:
$ref: '#/components/schemas/ExportRibRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_ExportRib_for_User_MonetaryAccount
description: Used to create new and read existing RIBs of a monetary account
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to create new and read existing RIBs of a monetary account
content:
application/json:
schema:
$ref: '#/components/schemas/ExportRibDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction:
post:
tags:
- User
summary: ''
operationId: CREATE_IdealMerchantTransaction_for_User_MonetaryAccount
description: View for requesting iDEAL transactions and polling their status.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IdealMerchantTransaction'
responses:
'200':
description: View for requesting iDEAL transactions and polling their status.
content:
application/json:
schema:
$ref: '#/components/schemas/IdealMerchantTransactionCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_IdealMerchantTransaction_for_User_MonetaryAccount
description: View for requesting iDEAL transactions and polling their status.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: View for requesting iDEAL transactions and polling their status.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IdealMerchantTransactionListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_IdealMerchantTransaction_for_User_MonetaryAccount
description: View for requesting iDEAL transactions and polling their status.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: View for requesting iDEAL transactions and polling their status.
content:
application/json:
schema:
$ref: '#/components/schemas/IdealMerchantTransactionRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate/{payment-auto-allocateID}/instance:
get:
tags:
- User
summary: ''
operationId: List_all_Instance_for_User_MonetaryAccount_PaymentAutoAllocate
description: List all the times a users payment was automatically allocated.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: payment-auto-allocateID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: List all the times a users payment was automatically allocated.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PaymentAutoAllocateInstanceListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate/{payment-auto-allocateID}/instance/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_Instance_for_User_MonetaryAccount_PaymentAutoAllocate
description: List all the times a users payment was automatically allocated.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: payment-auto-allocateID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: List all the times a users payment was automatically allocated.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentAutoAllocateInstanceRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/invoice:
get:
tags:
- User
summary: ''
operationId: List_all_Invoice_for_User_MonetaryAccount
description: Used to view a bunq invoice.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to view a bunq invoice.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/InvoiceListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/invoice/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_Invoice_for_User_MonetaryAccount
description: Used to view a bunq invoice.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to view a bunq invoice.
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_MastercardAction_for_User_MonetaryAccount
description: MasterCard transaction view.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: MasterCard transaction view.
content:
application/json:
schema:
$ref: '#/components/schemas/MasterCardActionRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/mastercard-action:
get:
tags:
- User
summary: ''
operationId: List_all_MastercardAction_for_User_MonetaryAccount
description: MasterCard transaction view.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: MasterCard transaction view.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MasterCardActionListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_MonetaryAccount_for_User
description: Get a specific MonetaryAccount.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account:
get:
tags:
- User
summary: ''
operationId: List_all_MonetaryAccount_for_User
description: Get a collection of all your MonetaryAccounts.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MonetaryAccountListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account-bank:
post:
tags:
- User
summary: ''
operationId: CREATE_MonetaryAccountBank_for_User
description: Create new MonetaryAccountBank.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountBank'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountBankCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_MonetaryAccountBank_for_User
description: Gets a listing of all MonetaryAccountBanks of a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MonetaryAccountBankListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account-bank/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_MonetaryAccountBank_for_User
description: Get a specific MonetaryAccountBank.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountBankRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
put:
tags:
- User
summary: ''
operationId: UPDATE_MonetaryAccountBank_for_User
description: Update a specific existing MonetaryAccountBank.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountBank'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountBankUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account-card/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_MonetaryAccountCard_for_User
description: Get a specific MonetaryAccountCard.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountCardRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
put:
tags:
- User
summary: ''
operationId: UPDATE_MonetaryAccountCard_for_User
description: Update a specific existing MonetaryAccountCard.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountCard'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountCardUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account-card:
get:
tags:
- User
summary: ''
operationId: List_all_MonetaryAccountCard_for_User
description: Gets a listing of all MonetaryAccountCard of a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MonetaryAccountCardListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account-external:
post:
tags:
- User
summary: ''
operationId: CREATE_MonetaryAccountExternal_for_User
description: >-
Endpoint for managing monetary accounts which are connected to external
services.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountExternal'
responses:
'200':
description: >-
Endpoint for managing monetary accounts which are connected to
external services.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountExternalCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_MonetaryAccountExternal_for_User
description: >-
Endpoint for managing monetary accounts which are connected to external
services.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
Endpoint for managing monetary accounts which are connected to
external services.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MonetaryAccountExternalListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account-external/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_MonetaryAccountExternal_for_User
description: >-
Endpoint for managing monetary accounts which are connected to external
services.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
Endpoint for managing monetary accounts which are connected to
external services.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountExternalRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
put:
tags:
- User
summary: ''
operationId: UPDATE_MonetaryAccountExternal_for_User
description: >-
Endpoint for managing monetary accounts which are connected to external
services.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountExternal'
responses:
'200':
description: >-
Endpoint for managing monetary accounts which are connected to
external services.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountExternalUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account-external-savings:
post:
tags:
- User
summary: ''
operationId: CREATE_MonetaryAccountExternalSavings_for_User
description: >-
Endpoint for managing monetary account savings which are connected to
external services.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountExternalSavings'
responses:
'200':
description: >-
Endpoint for managing monetary account savings which are connected
to external services.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountExternalSavingsCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_MonetaryAccountExternalSavings_for_User
description: >-
Endpoint for managing monetary account savings which are connected to
external services.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
Endpoint for managing monetary account savings which are connected
to external services.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MonetaryAccountExternalSavingsListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account-external-savings/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_MonetaryAccountExternalSavings_for_User
description: >-
Endpoint for managing monetary account savings which are connected to
external services.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
Endpoint for managing monetary account savings which are connected
to external services.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountExternalSavingsRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
put:
tags:
- User
summary: ''
operationId: UPDATE_MonetaryAccountExternalSavings_for_User
description: >-
Endpoint for managing monetary account savings which are connected to
external services.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountExternalSavings'
responses:
'200':
description: >-
Endpoint for managing monetary account savings which are connected
to external services.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountExternalSavingsUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account-joint:
post:
tags:
- User
summary: ''
operationId: CREATE_MonetaryAccountJoint_for_User
description: The endpoint for joint monetary accounts.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountJoint'
responses:
'200':
description: The endpoint for joint monetary accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountJointCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_MonetaryAccountJoint_for_User
description: The endpoint for joint monetary accounts.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: The endpoint for joint monetary accounts.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MonetaryAccountJointListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account-joint/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_MonetaryAccountJoint_for_User
description: The endpoint for joint monetary accounts.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: The endpoint for joint monetary accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountJointRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
put:
tags:
- User
summary: ''
operationId: UPDATE_MonetaryAccountJoint_for_User
description: The endpoint for joint monetary accounts.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountJoint'
responses:
'200':
description: The endpoint for joint monetary accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountJointUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account-savings:
post:
tags:
- User
summary: ''
operationId: CREATE_MonetaryAccountSavings_for_User
description: Create new MonetaryAccountSavings.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountSavings'
responses:
'200':
description: With MonetaryAccountSavings you can create a new savings account.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountSavingsCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_MonetaryAccountSavings_for_User
description: Gets a listing of all MonetaryAccountSavingss of a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: With MonetaryAccountSavings you can create a new savings account.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MonetaryAccountSavingsListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account-savings/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_MonetaryAccountSavings_for_User
description: Get a specific MonetaryAccountSavings.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: With MonetaryAccountSavings you can create a new savings account.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountSavingsRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
put:
tags:
- User
summary: ''
operationId: UPDATE_MonetaryAccountSavings_for_User
description: Update a specific existing MonetaryAccountSavings.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountSavings'
responses:
'200':
description: With MonetaryAccountSavings you can create a new savings account.
content:
application/json:
schema:
$ref: '#/components/schemas/MonetaryAccountSavingsUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/adyen-card-transaction/{adyen-card-transactionID}/note-attachment:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_AdyenCardTransaction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: adyen-card-transactionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentAdyenCardTransaction'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentAdyenCardTransactionCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteAttachment_for_User_MonetaryAccount_AdyenCardTransaction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: adyen-card-transactionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/NoteAttachmentAdyenCardTransactionListing
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/adyen-card-transaction/{adyen-card-transactionID}/note-attachment/{itemId}
: put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_AdyenCardTransaction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: adyen-card-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentAdyenCardTransaction'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentAdyenCardTransactionUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_AdyenCardTransaction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: adyen-card-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentAdyenCardTransactionDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_AdyenCardTransaction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: adyen-card-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentAdyenCardTransactionRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{switch-service-paymentID}/note-attachment:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: switch-service-paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentBankSwitchServiceNetherlandsIncomingPayment
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentCreate
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: switch-service-paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentListing
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{switch-service-paymentID}/note-attachment/{itemId}
: put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: switch-service-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentBankSwitchServiceNetherlandsIncomingPayment
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentUpdate
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: switch-service-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentDelete
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: switch-service-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentRead
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{bunqme-fundraiser-resultID}/note-attachment:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: bunqme-fundraiser-resultID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentBunqMeFundraiserResult'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentBunqMeFundraiserResultCreate
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: bunqme-fundraiser-resultID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/NoteAttachmentBunqMeFundraiserResultListing
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{bunqme-fundraiser-resultID}/note-attachment/{itemId}
: put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: bunqme-fundraiser-resultID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentBunqMeFundraiserResult'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentBunqMeFundraiserResultUpdate
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: bunqme-fundraiser-resultID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentBunqMeFundraiserResultDelete
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: bunqme-fundraiser-resultID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentBunqMeFundraiserResultRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{draft-paymentID}/note-attachment:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_DraftPayment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: draft-paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentDraftPayment'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentDraftPaymentCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteAttachment_for_User_MonetaryAccount_DraftPayment
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: draft-paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteAttachmentDraftPaymentListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{draft-paymentID}/note-attachment/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_DraftPayment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: draft-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentDraftPayment'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentDraftPaymentUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_DraftPayment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: draft-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentDraftPaymentDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_DraftPayment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: draft-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentDraftPaymentRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{ideal-merchant-transactionID}/note-attachment
: post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: ideal-merchant-transactionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentIdealMerchantTransaction'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentIdealMerchantTransactionCreate
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: >-
List_all_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: ideal-merchant-transactionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/NoteAttachmentIdealMerchantTransactionListing
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{ideal-merchant-transactionID}/note-attachment/{itemId}
: put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: ideal-merchant-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentIdealMerchantTransaction'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentIdealMerchantTransactionUpdate
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: ideal-merchant-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentIdealMerchantTransactionDelete
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: ideal-merchant-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentIdealMerchantTransactionRead
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/note-attachment:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_MastercardAction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: mastercard-actionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentMasterCardAction'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentMasterCardActionCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteAttachment_for_User_MonetaryAccount_MastercardAction
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: mastercard-actionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteAttachmentMasterCardActionListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/note-attachment/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_MastercardAction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: mastercard-actionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentMasterCardAction'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentMasterCardActionUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_MastercardAction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: mastercard-actionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentMasterCardActionDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_MastercardAction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: mastercard-actionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentMasterCardActionRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{payment-batchID}/note-attachment:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_PaymentBatch
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: payment-batchID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentPaymentBatch'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentPaymentBatchCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteAttachment_for_User_MonetaryAccount_PaymentBatch
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: payment-batchID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteAttachmentPaymentBatchListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{payment-batchID}/note-attachment/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_PaymentBatch
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: payment-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentPaymentBatch'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentPaymentBatchUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_PaymentBatch
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: payment-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentPaymentBatchDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_PaymentBatch
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: payment-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentPaymentBatchRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment/{paymentID}/note-attachment:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_Payment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentPayment'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentPaymentCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteAttachment_for_User_MonetaryAccount_Payment
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteAttachmentPaymentListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment/{paymentID}/note-attachment/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_Payment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentPayment'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentPaymentUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_Payment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentPaymentDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_Payment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentPaymentRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{request-inquiry-batchID}/note-attachment:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiry-batchID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestInquiryBatch'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestInquiryBatchCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiry-batchID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/NoteAttachmentRequestInquiryBatchListing
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{request-inquiry-batchID}/note-attachment/{itemId}
: put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiry-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestInquiryBatch'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestInquiryBatchUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiry-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestInquiryBatchDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiry-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestInquiryBatchRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{request-inquiryID}/note-attachment:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_RequestInquiry
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiryID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestInquiry'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestInquiryCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteAttachment_for_User_MonetaryAccount_RequestInquiry
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiryID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteAttachmentRequestInquiryListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{request-inquiryID}/note-attachment/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_RequestInquiry
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiryID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestInquiry'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestInquiryUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_RequestInquiry
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiryID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestInquiryDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_RequestInquiry
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiryID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestInquiryRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-response/{request-responseID}/note-attachment:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_RequestResponse
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-responseID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestResponse'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestResponseCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteAttachment_for_User_MonetaryAccount_RequestResponse
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-responseID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteAttachmentRequestResponseListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-response/{request-responseID}/note-attachment/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_RequestResponse
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-responseID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestResponse'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestResponseUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_RequestResponse
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-responseID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestResponseDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_RequestResponse
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-responseID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentRequestResponseRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{schedule-instanceID}/note-attachment
: post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: scheduleID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-instanceID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentScheduleInstance'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentScheduleInstanceCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: >-
List_all_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: scheduleID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-instanceID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteAttachmentScheduleInstanceListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{schedule-instanceID}/note-attachment/{itemId}
: put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: scheduleID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-instanceID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentScheduleInstance'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentScheduleInstanceUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: scheduleID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-instanceID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentScheduleInstanceDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: scheduleID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-instanceID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentScheduleInstanceRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{schedule-payment-batchID}/note-attachment:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-payment-batchID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentSchedulePaymentBatch'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentSchedulePaymentBatchCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-payment-batchID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/NoteAttachmentSchedulePaymentBatchListing
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{schedule-payment-batchID}/note-attachment/{itemId}
: put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-payment-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentSchedulePaymentBatch'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentSchedulePaymentBatchUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-payment-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentSchedulePaymentBatchDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-payment-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentSchedulePaymentBatchRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{schedule-paymentID}/note-attachment:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_SchedulePayment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentSchedulePayment'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentSchedulePaymentCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteAttachment_for_User_MonetaryAccount_SchedulePayment
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteAttachmentSchedulePaymentListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{schedule-paymentID}/note-attachment/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_SchedulePayment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentSchedulePayment'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentSchedulePaymentUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_SchedulePayment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentSchedulePaymentDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_SchedulePayment
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentSchedulePaymentRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{sofort-merchant-transactionID}/note-attachment
: post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: sofort-merchant-transactionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentSofortMerchantTransaction'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentSofortMerchantTransactionCreate
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: >-
List_all_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: sofort-merchant-transactionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/NoteAttachmentSofortMerchantTransactionListing
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{sofort-merchant-transactionID}/note-attachment/{itemId}
: put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: sofort-merchant-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentSofortMerchantTransaction'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentSofortMerchantTransactionUpdate
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: sofort-merchant-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentSofortMerchantTransactionDelete
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: sofort-merchant-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteAttachmentSofortMerchantTransactionRead
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/whitelist/{whitelistID}/whitelist-result/{whitelist-resultID}/note-attachment
: post:
tags:
- User
summary: ''
operationId: CREATE_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelistID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelist-resultID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentWhitelistResult'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentWhitelistResultCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: >-
List_all_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelistID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelist-resultID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteAttachmentWhitelistResultListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/whitelist/{whitelistID}/whitelist-result/{whitelist-resultID}/note-attachment/{itemId}
: put:
tags:
- User
summary: ''
operationId: UPDATE_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelistID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelist-resultID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentWhitelistResult'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentWhitelistResultUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelistID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelist-resultID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentWhitelistResultDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult
description: Used to manage attachment notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelistID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelist-resultID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage attachment notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteAttachmentWhitelistResultRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/adyen-card-transaction/{adyen-card-transactionID}/note-text:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_AdyenCardTransaction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: adyen-card-transactionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextAdyenCardTransaction'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextAdyenCardTransactionCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_AdyenCardTransaction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: adyen-card-transactionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteTextAdyenCardTransactionListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/adyen-card-transaction/{adyen-card-transactionID}/note-text/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_AdyenCardTransaction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: adyen-card-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextAdyenCardTransaction'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextAdyenCardTransactionUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_AdyenCardTransaction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: adyen-card-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextAdyenCardTransactionDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_AdyenCardTransaction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: adyen-card-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextAdyenCardTransactionRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{switch-service-paymentID}/note-text:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_SwitchServicePayment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: switch-service-paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteTextBankSwitchServiceNetherlandsIncomingPayment
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteTextBankSwitchServiceNetherlandsIncomingPaymentCreate
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_SwitchServicePayment
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: switch-service-paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/NoteTextBankSwitchServiceNetherlandsIncomingPaymentListing
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{switch-service-paymentID}/note-text/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_SwitchServicePayment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: switch-service-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteTextBankSwitchServiceNetherlandsIncomingPayment
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteTextBankSwitchServiceNetherlandsIncomingPaymentUpdate
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_SwitchServicePayment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: switch-service-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteTextBankSwitchServiceNetherlandsIncomingPaymentDelete
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_SwitchServicePayment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: switch-service-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NoteTextBankSwitchServiceNetherlandsIncomingPaymentRead
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{bunqme-fundraiser-resultID}/note-text:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: bunqme-fundraiser-resultID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextBunqMeFundraiserResult'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextBunqMeFundraiserResultCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: bunqme-fundraiser-resultID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteTextBunqMeFundraiserResultListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/bunqme-fundraiser-result/{bunqme-fundraiser-resultID}/note-text/{itemId}
: put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: bunqme-fundraiser-resultID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextBunqMeFundraiserResult'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextBunqMeFundraiserResultUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: bunqme-fundraiser-resultID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextBunqMeFundraiserResultDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: bunqme-fundraiser-resultID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextBunqMeFundraiserResultRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{draft-paymentID}/note-text:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_DraftPayment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: draft-paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextDraftPayment'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextDraftPaymentCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_DraftPayment
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: draft-paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteTextDraftPaymentListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/draft-payment/{draft-paymentID}/note-text/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_DraftPayment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: draft-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextDraftPayment'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextDraftPaymentUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_DraftPayment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: draft-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextDraftPaymentDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_DraftPayment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: draft-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextDraftPaymentRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{ideal-merchant-transactionID}/note-text:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: ideal-merchant-transactionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextIdealMerchantTransaction'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextIdealMerchantTransactionCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: ideal-merchant-transactionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteTextIdealMerchantTransactionListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/ideal-merchant-transaction/{ideal-merchant-transactionID}/note-text/{itemId}
: put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: ideal-merchant-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextIdealMerchantTransaction'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextIdealMerchantTransactionUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: ideal-merchant-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextIdealMerchantTransactionDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: ideal-merchant-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextIdealMerchantTransactionRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/note-text:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_MastercardAction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: mastercard-actionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextMasterCardAction'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextMasterCardActionCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_MastercardAction
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: mastercard-actionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteTextMasterCardActionListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/note-text/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_MastercardAction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: mastercard-actionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextMasterCardAction'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextMasterCardActionUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_MastercardAction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: mastercard-actionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextMasterCardActionDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_MastercardAction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: mastercard-actionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextMasterCardActionRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{payment-batchID}/note-text:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_PaymentBatch
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: payment-batchID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextPaymentBatch'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextPaymentBatchCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_PaymentBatch
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: payment-batchID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteTextPaymentBatchListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{payment-batchID}/note-text/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_PaymentBatch
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: payment-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextPaymentBatch'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextPaymentBatchUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_PaymentBatch
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: payment-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextPaymentBatchDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_PaymentBatch
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: payment-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextPaymentBatchRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment/{paymentID}/note-text:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_Payment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextPayment'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextPaymentCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_Payment
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteTextPaymentListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment/{paymentID}/note-text/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_Payment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextPayment'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextPaymentUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_Payment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextPaymentDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_Payment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextPaymentRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{request-inquiry-batchID}/note-text:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_RequestInquiryBatch
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiry-batchID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestInquiryBatch'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestInquiryBatchCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_RequestInquiryBatch
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiry-batchID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteTextRequestInquiryBatchListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{request-inquiry-batchID}/note-text/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_RequestInquiryBatch
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiry-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestInquiryBatch'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestInquiryBatchUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_RequestInquiryBatch
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiry-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestInquiryBatchDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_RequestInquiryBatch
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiry-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestInquiryBatchRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{request-inquiryID}/note-text:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_RequestInquiry
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiryID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestInquiry'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestInquiryCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_RequestInquiry
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiryID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteTextRequestInquiryListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{request-inquiryID}/note-text/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_RequestInquiry
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiryID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestInquiry'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestInquiryUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_RequestInquiry
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiryID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestInquiryDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_RequestInquiry
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-inquiryID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestInquiryRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-response/{request-responseID}/note-text:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_RequestResponse
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-responseID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestResponse'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestResponseCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_RequestResponse
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-responseID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteTextRequestResponseListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-response/{request-responseID}/note-text/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_RequestResponse
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-responseID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestResponse'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestResponseUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_RequestResponse
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-responseID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestResponseDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_RequestResponse
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: request-responseID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextRequestResponseRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{schedule-instanceID}/note-text
: post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: scheduleID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-instanceID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextScheduleInstance'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextScheduleInstanceCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: scheduleID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-instanceID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteTextScheduleInstanceListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{schedule-instanceID}/note-text/{itemId}
: put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: scheduleID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-instanceID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextScheduleInstance'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextScheduleInstanceUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: scheduleID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-instanceID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextScheduleInstanceDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: scheduleID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-instanceID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextScheduleInstanceRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{schedule-payment-batchID}/note-text:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-payment-batchID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSchedulePaymentBatch'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSchedulePaymentBatchCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-payment-batchID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteTextSchedulePaymentBatchListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{schedule-payment-batchID}/note-text/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-payment-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSchedulePaymentBatch'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSchedulePaymentBatchUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-payment-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSchedulePaymentBatchDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-payment-batchID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSchedulePaymentBatchRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{schedule-paymentID}/note-text:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_SchedulePayment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSchedulePayment'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSchedulePaymentCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_SchedulePayment
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-paymentID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteTextSchedulePaymentListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{schedule-paymentID}/note-text/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_SchedulePayment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSchedulePayment'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSchedulePaymentUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_SchedulePayment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSchedulePaymentDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_SchedulePayment
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: schedule-paymentID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSchedulePaymentRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{sofort-merchant-transactionID}/note-text:
post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: sofort-merchant-transactionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSofortMerchantTransaction'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSofortMerchantTransactionCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: sofort-merchant-transactionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/NoteTextSofortMerchantTransactionListing
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{sofort-merchant-transactionID}/note-text/{itemId}
: put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: sofort-merchant-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSofortMerchantTransaction'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSofortMerchantTransactionUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: sofort-merchant-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSofortMerchantTransactionDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: sofort-merchant-transactionID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextSofortMerchantTransactionRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/whitelist/{whitelistID}/whitelist-result/{whitelist-resultID}/note-text
: post:
tags:
- User
summary: ''
operationId: CREATE_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelistID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelist-resultID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextWhitelistResult'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextWhitelistResultCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult
description: Manage the notes for a given user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelistID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelist-resultID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteTextWhitelistResultListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
? /user/{userID}/monetary-account/{monetary-accountID}/whitelist/{whitelistID}/whitelist-result/{whitelist-resultID}/note-text/{itemId}
: put:
tags:
- User
summary: ''
operationId: UPDATE_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelistID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelist-resultID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextWhitelistResult'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextWhitelistResultUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelistID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelist-resultID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextWhitelistResultDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult
description: Used to manage text notes.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelistID
description: ''
required: true
schema:
type: integer
- in: path
name: whitelist-resultID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to manage text notes.
content:
application/json:
schema:
$ref: '#/components/schemas/NoteTextWhitelistResultRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/notification-filter-url:
post:
tags:
- User
summary: ''
operationId: CREATE_NotificationFilterUrl_for_User_MonetaryAccount
description: Manage the url notification filters for a user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationFilterUrlMonetaryAccount'
responses:
'200':
description: Manage the url notification filters for a user.
content:
application/json:
schema:
$ref: >-
#/components/schemas/NotificationFilterUrlMonetaryAccountCreate
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_NotificationFilterUrl_for_User_MonetaryAccount
description: Manage the url notification filters for a user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Manage the url notification filters for a user.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/NotificationFilterUrlMonetaryAccountListing
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment:
post:
tags:
- User
summary: ''
operationId: CREATE_Payment_for_User_MonetaryAccount
description: Create a new Payment.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Payment'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_Payment_for_User_MonetaryAccount
description: >-
Get a listing of all Payments performed on a given MonetaryAccount
(incoming and outgoing).
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PaymentListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_Payment_for_User_MonetaryAccount
description: Get a specific previous Payment.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/mastercard-action/{mastercard-actionID}/payment:
get:
tags:
- User
summary: ''
operationId: List_all_Payment_for_User_MonetaryAccount_MastercardAction
description: MasterCard transaction view.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: mastercard-actionID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: MasterCard transaction view.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MasterCardPaymentListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate:
post:
tags:
- User
summary: ''
operationId: CREATE_PaymentAutoAllocate_for_User_MonetaryAccount
description: Manage a users automatic payment auto allocated settings.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentAutoAllocate'
responses:
'200':
description: Manage a users automatic payment auto allocated settings.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentAutoAllocateCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_PaymentAutoAllocate_for_User_MonetaryAccount
description: Manage a users automatic payment auto allocated settings.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Manage a users automatic payment auto allocated settings.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PaymentAutoAllocateListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment-auto-allocate/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_PaymentAutoAllocate_for_User_MonetaryAccount
description: Manage a users automatic payment auto allocated settings.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Manage a users automatic payment auto allocated settings.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentAutoAllocateRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
put:
tags:
- User
summary: ''
operationId: UPDATE_PaymentAutoAllocate_for_User_MonetaryAccount
description: Manage a users automatic payment auto allocated settings.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentAutoAllocate'
responses:
'200':
description: Manage a users automatic payment auto allocated settings.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentAutoAllocateUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_PaymentAutoAllocate_for_User_MonetaryAccount
description: Manage a users automatic payment auto allocated settings.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Manage a users automatic payment auto allocated settings.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentAutoAllocateDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment-batch:
post:
tags:
- User
summary: ''
operationId: CREATE_PaymentBatch_for_User_MonetaryAccount
description: >-
Create a payment batch by sending an array of single payment objects,
that will become part of the batch.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentBatch'
responses:
'200':
description: >-
Create a payment batch, or show the payment batches of a monetary
account.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentBatchCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_PaymentBatch_for_User_MonetaryAccount
description: Return all the payment batches for a monetary account.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
Create a payment batch, or show the payment batches of a monetary
account.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PaymentBatchListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/payment-batch/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_PaymentBatch_for_User_MonetaryAccount
description: >-
Revoke a bunq.to payment batch. The status of all the payments will be
set to REVOKED.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentBatch'
responses:
'200':
description: >-
Create a payment batch, or show the payment batches of a monetary
account.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentBatchUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_PaymentBatch_for_User_MonetaryAccount
description: Return the details of a specific payment batch.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
Create a payment batch, or show the payment batches of a monetary
account.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentBatchRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry:
post:
tags:
- User
summary: ''
operationId: CREATE_RequestInquiry_for_User_MonetaryAccount
description: Create a new payment request.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RequestInquiry'
responses:
'200':
description: >-
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!
content:
application/json:
schema:
$ref: '#/components/schemas/RequestInquiryCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_RequestInquiry_for_User_MonetaryAccount
description: >-
Get all payment requests for a user's monetary account. bunqme_share_url
is always null if the counterparty is a bunq user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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!
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RequestInquiryListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_RequestInquiry_for_User_MonetaryAccount
description: Revoke a request for payment, by updating the status to REVOKED.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RequestInquiry'
responses:
'200':
description: >-
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!
content:
application/json:
schema:
$ref: '#/components/schemas/RequestInquiryUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_RequestInquiry_for_User_MonetaryAccount
description: >-
Get the details of a specific payment request, including its status.
bunqme_share_url is always null if the counterparty is a bunq user.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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!
content:
application/json:
schema:
$ref: '#/components/schemas/RequestInquiryRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch:
post:
tags:
- User
summary: ''
operationId: CREATE_RequestInquiryBatch_for_User_MonetaryAccount
description: >-
Create a request batch by sending an array of single request objects,
that will become part of the batch.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RequestInquiryBatch'
responses:
'200':
description: >-
Create a batch of requests for payment, or show the request batches
of a monetary account.
content:
application/json:
schema:
$ref: '#/components/schemas/RequestInquiryBatchCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_RequestInquiryBatch_for_User_MonetaryAccount
description: Return all the request batches for a monetary account.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
Create a batch of requests for payment, or show the request batches
of a monetary account.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RequestInquiryBatchListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry-batch/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_RequestInquiryBatch_for_User_MonetaryAccount
description: >-
Revoke a request batch. The status of all the requests will be set to
REVOKED.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RequestInquiryBatch'
responses:
'200':
description: >-
Create a batch of requests for payment, or show the request batches
of a monetary account.
content:
application/json:
schema:
$ref: '#/components/schemas/RequestInquiryBatchUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_RequestInquiryBatch_for_User_MonetaryAccount
description: Return the details of a specific request batch.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
Create a batch of requests for payment, or show the request batches
of a monetary account.
content:
application/json:
schema:
$ref: '#/components/schemas/RequestInquiryBatchRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-response/{itemId}:
put:
tags:
- User
summary: ''
operationId: UPDATE_RequestResponse_for_User_MonetaryAccount
description: Update the status to accept or reject the RequestResponse.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RequestResponse'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
$ref: '#/components/schemas/RequestResponseUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_RequestResponse_for_User_MonetaryAccount
description: Get the details for a specific existing RequestResponse.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
$ref: '#/components/schemas/RequestResponseRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/request-response:
get:
tags:
- User
summary: ''
operationId: List_all_RequestResponse_for_User_MonetaryAccount
description: Get all RequestResponses for a MonetaryAccount.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
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.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RequestResponseListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_Schedule_for_User_MonetaryAccount
description: Get a specific schedule definition for a given monetary account.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: view for reading the scheduled definitions.
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule:
get:
tags:
- User
summary: ''
operationId: List_all_Schedule_for_User_MonetaryAccount
description: >-
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.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: view for reading the scheduled definitions.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ScheduleListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_ScheduleInstance_for_User_MonetaryAccount_Schedule
description: view for reading, updating and listing the scheduled instance.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: scheduleID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: view for reading, updating and listing the scheduled instance.
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleInstanceRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
put:
tags:
- User
summary: ''
operationId: UPDATE_ScheduleInstance_for_User_MonetaryAccount_Schedule
description: view for reading, updating and listing the scheduled instance.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: scheduleID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleInstance'
responses:
'200':
description: view for reading, updating and listing the scheduled instance.
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleInstanceUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule/{scheduleID}/schedule-instance:
get:
tags:
- User
summary: ''
operationId: List_all_ScheduleInstance_for_User_MonetaryAccount_Schedule
description: view for reading, updating and listing the scheduled instance.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: scheduleID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: view for reading, updating and listing the scheduled instance.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ScheduleInstanceListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule-payment:
post:
tags:
- User
summary: ''
operationId: CREATE_SchedulePayment_for_User_MonetaryAccount
description: Endpoint for schedule payments.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulePayment'
responses:
'200':
description: Endpoint for schedule payments.
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulePaymentCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_SchedulePayment_for_User_MonetaryAccount
description: Endpoint for schedule payments.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Endpoint for schedule payments.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SchedulePaymentListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule-payment/{itemId}:
delete:
tags:
- User
summary: ''
operationId: DELETE_SchedulePayment_for_User_MonetaryAccount
description: Endpoint for schedule payments.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Endpoint for schedule payments.
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulePaymentDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: READ_SchedulePayment_for_User_MonetaryAccount
description: Endpoint for schedule payments.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Endpoint for schedule payments.
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulePaymentRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
put:
tags:
- User
summary: ''
operationId: UPDATE_SchedulePayment_for_User_MonetaryAccount
description: Endpoint for schedule payments.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulePayment'
responses:
'200':
description: Endpoint for schedule payments.
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulePaymentUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_SchedulePaymentBatch_for_User_MonetaryAccount
description: Endpoint for schedule payment batches.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Endpoint for schedule payment batches.
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulePaymentBatchRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
put:
tags:
- User
summary: ''
operationId: UPDATE_SchedulePaymentBatch_for_User_MonetaryAccount
description: Endpoint for schedule payment batches.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulePaymentBatch'
responses:
'200':
description: Endpoint for schedule payment batches.
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulePaymentBatchUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
delete:
tags:
- User
summary: ''
operationId: DELETE_SchedulePaymentBatch_for_User_MonetaryAccount
description: Endpoint for schedule payment batches.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Endpoint for schedule payment batches.
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulePaymentBatchDelete'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch:
post:
tags:
- User
summary: ''
operationId: CREATE_SchedulePaymentBatch_for_User_MonetaryAccount
description: Endpoint for schedule payment batches.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulePaymentBatch'
responses:
'200':
description: Endpoint for schedule payment batches.
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulePaymentBatchCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry:
post:
tags:
- User
summary: ''
operationId: CREATE_ShareInviteMonetaryAccountInquiry_for_User_MonetaryAccount
description: >-
[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.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ShareInviteMonetaryAccountInquiry'
responses:
'200':
description: >-
[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.
content:
application/json:
schema:
$ref: '#/components/schemas/ShareInviteMonetaryAccountInquiryCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
get:
tags:
- User
summary: ''
operationId: List_all_ShareInviteMonetaryAccountInquiry_for_User_MonetaryAccount
description: >-
[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.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
[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.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/ShareInviteMonetaryAccountInquiryListing
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/share-invite-monetary-account-inquiry/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_ShareInviteMonetaryAccountInquiry_for_User_MonetaryAccount
description: >-
[DEPRECATED - use /share-invite-monetary-account-response] Get the
details of a specific share inquiry.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
[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.
content:
application/json:
schema:
$ref: '#/components/schemas/ShareInviteMonetaryAccountInquiryRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
put:
tags:
- User
summary: ''
operationId: UPDATE_ShareInviteMonetaryAccountInquiry_for_User_MonetaryAccount
description: >-
[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.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ShareInviteMonetaryAccountInquiry'
responses:
'200':
description: >-
[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.
content:
application/json:
schema:
$ref: '#/components/schemas/ShareInviteMonetaryAccountInquiryUpdate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_SofortMerchantTransaction_for_User_MonetaryAccount
description: View for requesting Sofort transactions and polling their status.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: View for requesting Sofort transactions and polling their status.
content:
application/json:
schema:
$ref: '#/components/schemas/SofortMerchantTransactionRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/sofort-merchant-transaction:
get:
tags:
- User
summary: ''
operationId: List_all_SofortMerchantTransaction_for_User_MonetaryAccount
description: View for requesting Sofort transactions and polling their status.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: View for requesting Sofort transactions and polling their status.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SofortMerchantTransactionListing'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/event/{eventID}/statement:
post:
tags:
- User
summary: ''
operationId: CREATE_Statement_for_User_MonetaryAccount_Event
description: Used to create a statement export of a single payment.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: eventID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExportStatementPayment'
responses:
'200':
description: Used to create a statement export of a single payment.
content:
application/json:
schema:
$ref: '#/components/schemas/ExportStatementPaymentCreate'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/event/{eventID}/statement/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_Statement_for_User_MonetaryAccount_Event
description: Used to create a statement export of a single payment.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: eventID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: Used to create a statement export of a single payment.
content:
application/json:
schema:
$ref: '#/components/schemas/ExportStatementPaymentRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/switch-service-payment/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_SwitchServicePayment_for_User_MonetaryAccount
description: >-
An incoming payment made towards an account of an external bank and
redirected to a bunq account via switch service.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
An incoming payment made towards an account of an external bank and
redirected to a bunq account via switch service.
content:
application/json:
schema:
$ref: >-
#/components/schemas/BankSwitchServiceNetherlandsIncomingPaymentRead
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/whitelist-sdd/{itemId}:
get:
tags:
- User
summary: ''
operationId: READ_WhitelistSdd_for_User_MonetaryAccount
description: Get a specific SDD whitelist entry.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- in: path
name: itemId
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
Whitelist an SDD so that when one comes in, it is automatically
accepted.
content:
application/json:
schema:
$ref: '#/components/schemas/WhitelistSddMonetaryAccountPayingRead'
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
/user/{userID}/monetary-account/{monetary-accountID}/whitelist-sdd:
get:
tags:
- User
summary: ''
operationId: List_all_WhitelistSdd_for_User_MonetaryAccount
description: >-
Get a listing of all SDD whitelist entries for a target monetary
account.
parameters:
- in: path
name: userID
description: ''
required: true
schema:
type: integer
- in: path
name: monetary-accountID
description: ''
required: true
schema:
type: integer
- $ref: '#/components/parameters/Cache-Control'
- $ref: '#/components/parameters/User-Agent'
- $ref: '#/components/parameters/X-Bunq-Language'
- $ref: '#/components/parameters/X-Bunq-Region'
- $ref: '#/components/parameters/X-Bunq-Client-Request-Id'
- $ref: '#/components/parameters/X-Bunq-Geolocation'
- $ref: '#/components/parameters/X-Bunq-Client-Authentication'
responses:
'200':
description: >-
Whitelist an SDD so that when one comes in, it is automatically
accepted.
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/WhitelistSddMonetaryAccountPayingListing
headers:
X-Bunq-Client-Response-Id:
$ref: '#/components/headers/X-Bunq-Client-Response-Id'
X-Bunq-Client-Request-Id:
$ref: '#/components/headers/X-Bunq-Client-Request-Id'
X-Bunq-Server-Signature:
$ref: '#/components/headers/X-Bunq-Server-Signature'
'400':
$ref: '#/components/responses/GenericError'
tags:
- name: User