action bunq_list_all_insights_search_for_user { description: "Used to get events based on time and insight category." provider: bunq method: GET path: "/user/{userID}/insights-search" encoding: json input: { type: "object" properties: { userID: { type: "integer" } } required: ["userID"] additionalProperties: false } output: { type: "array" items: { type: "object" properties: { action: { type: "string" description: "The performed action. Can be: CREATE or UPDATE." } created: { type: "string" description: "The timestamp of the event's creation." } id: { type: "integer" description: "The id of the event." } monetary_account_id: { type: "string" description: "The id of the monetary account the event applied to (if it was a monetary account event)." } object: { type: "object" properties: { BankSwitchServiceNetherlandsIncomingPayment: { type: "object" properties: { bank_switch_service: { type: "object" properties: { alias: { type: "object" properties: { avatar: { type: "object" properties: { anchor_uuid: { type: "string" description: "The public UUID of object this avatar is anchored to." } image: { type: "array" description: "The actual image information of this avatar." items: { type: "object" additionalProperties: true } } style: { type: "string" description: "The style (if applicable) for this Avatar." } uuid: { type: "string" description: "The public UUID of the avatar." } } } bunq_me: { type: "object" properties: { name: { type: "string" description: "The alias name." } service: { type: "string" description: "The pointer service. Only required for external counterparties." } type: { type: "string" description: "The alias type, can be: EMAIL|PHONE_NUMBER|IBAN." } value: { type: "string" description: "The alias value." } } } country: { type: "string" description: "The country of the user. Formatted as a ISO 3166-1 alpha-2 country code." } display_name: { type: "string" description: "The name to display with this monetary account." } iban: { type: "string" description: "The IBAN of the monetary account." } is_light: { type: "boolean" description: "Whether or not the monetary account is light." } label_user: { type: "object" properties: { avatar: { type: "object" additionalProperties: true } country: { type: "string" description: "The country of the user. 000 stands for \"unknown\"" } display_name: { type: "string" description: "The name to be displayed for this user, as it was given on the request." } public_nick_name: { type: "string" description: "The current nickname of the user." } uuid: { type: "string" description: "The public UUID of the label-user." } } } merchant_category_code: { type: "string" description: "The merchant category code." } swift_account_number: { type: "string" description: "The account number used for a SWIFT payment. May or may not be an IBAN." } swift_bic: { type: "string" description: "The BIC used for a SWIFT payment." } transferwise_account_number: { type: "string" description: "The account number used for a Transferwise payment. May or may not be an IBAN." } transferwise_bank_code: { type: "string" description: "The bank code used for a Transferwise payment. May or may not be a BIC." } } } attachment: { type: "object" properties: { content_type: { type: "string" description: "The content type of the attachment's file." } description: { type: "string" description: "The description of the attachment." } urls: { type: "array" description: "The URLs where the file can be downloaded." items: { type: "object" properties: { type: { type: "object" additionalProperties: true } url: { type: "object" additionalProperties: true } } } } } } counterparty_alias: { type: "object" additionalProperties: true } status: { type: "string" description: "The status of the switch service." } sub_status: { type: "string" description: "The sub status of the switch service." } time_end: { type: "string" description: "The timestamp when the switch service ends." } time_start_actual: { type: "string" description: "The timestamp when the switch service actually starts." } time_start_desired: { type: "string" description: "The timestamp when the switch service desired to be start." } user_alias: { type: "object" additionalProperties: true } } } payment: { type: "object" properties: { address_billing: { type: "object" properties: { city: { type: "string" description: "The city." } country: { type: "string" description: "The country as an ISO 3166-1 alpha-2 country code." } extra: { type: "string" description: "The apartment, building or other extra information for addresses." } house_number: { type: "string" description: "The house number." } is_user_address_updated: { type: "boolean" description: "To show whether user created or updated her address for app event listing." } mailbox_name: { type: "string" description: "The name on the mailbox (only used for Postal addresses)." } po_box: { type: "string" description: "The PO box." } postal_code: { type: "string" description: "The postal code." } province: { type: "string" description: "The province according to local standard." } street: { type: "string" description: "The street." } } } address_shipping: { type: "object" additionalProperties: true } alias: { type: "object" additionalProperties: true } allow_bunqto: { type: "boolean" description: "Whether or not sending a bunq.to payment is allowed." } amount: { type: "object" properties: { currency: { type: "string" description: "The currency of the amount. It is an ISO 4217 formatted currency code." } value: { type: "string" description: "The amount formatted to two decimal places." } } } attachment: { type: "array" description: "The Attachments attached to the Payment." items: { type: "object" properties: { id: { type: "integer" description: "The id of the attached Attachment." } monetary_account_id: { type: "integer" description: "The id of the MonetaryAccount this Attachment is attached from." } } } } balance_after_mutation: { type: "object" additionalProperties: true } batch_id: { type: "integer" description: "The id of the PaymentBatch if this Payment was part of one." } bunqto_expiry: { type: "string" description: "When bunq.to payment is about to expire." } bunqto_share_url: { type: "string" description: "The status of the bunq.to payment." } bunqto_status: { type: "string" description: "The status of the bunq.to payment." } bunqto_sub_status: { type: "string" description: "The sub status of the bunq.to payment." } bunqto_time_responded: { type: "string" description: "The timestamp of when the bunq.to payment was responded to." } counterparty_alias: { type: "object" additionalProperties: true } created: { type: "string" description: "The timestamp when the Payment was done." } 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." } geolocation: { type: "object" properties: { altitude: { type: "integer" description: "The altitude for a geolocation restriction." } latitude: { type: "integer" description: "The latitude for a geolocation restriction." } longitude: { type: "integer" description: "The longitude for a geolocation restriction." } radius: { type: "integer" description: "The radius for a geolocation restriction." } } } id: { type: "integer" description: "The id of the created Payment." } merchant_reference: { type: "string" description: "Optional data included with the Payment specific to the merchant." } 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)." } payment_auto_allocate_instance: { type: "object" properties: { created: { type: "string" description: "The timestamp when the PaymentAutoAllocateInstance was created." } error_message: { type: "array" description: "The error message, if the payment auto allocating failed." items: { type: "array" items: { type: "object" additionalProperties: true } } } id: { type: "integer" description: "The id of the PaymentAutoAllocateInstance." } payment_auto_allocate_id: { type: "integer" description: "The ID of the payment auto allocate this instance belongs to." } payment_batch: { type: "object" properties: { payments: { type: "object" properties: { Payment: { type: "object" additionalProperties: true } } } } } payment_id: { type: "integer" description: "The ID of the payment that triggered the allocating of the payments." } status: { type: "string" description: "The status of the payment auto allocate instance. SUCCEEDED or FAILED." } updated: { type: "string" description: "The timestamp when the PaymentAutoAllocateInstance was last updated." } } } request_reference_split_the_bill: { type: "array" description: "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch" items: { type: "object" properties: { id: { type: "integer" description: "The id of the request inquiry (batch)." } type: { type: "string" description: "The type of request inquiry. Can be RequestInquiry or RequestInquiryBatch." } } } } scheduled_id: { type: "integer" description: "The id of the JobScheduled if the Payment was scheduled." } sub_type: { type: "string" description: "The sub-type of the Payment, can be PAYMENT, WITHDRAWAL, REVERSAL, REQUEST, BILLING, SCT, SDD or NLO." } type: { type: "string" description: "The type of Payment, can be BUNQ, EBA_SCT, EBA_SDD, IDEAL, SWIFT or FIS (card)." } updated: { type: "string" description: "The timestamp when the Payment was last updated (will be updated when chat messages are received)." } } } } } BunqMeFundraiserResult: { type: "object" properties: { bunqme_fundraiser_profile: { type: "object" properties: { alias: { type: "object" additionalProperties: true } attachment: { type: "object" } color: { type: "string" description: "The color chosen for the bunq.me fundraiser profile in hexadecimal format." } currency: { type: "string" description: "The currency of the MonetaryAccount that created the bunq.me fundraiser profile." } description: { type: "string" description: "The description of the bunq.me fundraiser profile." } invite_profile_name: { type: "string" description: "Provided if the user has enabled their invite link." } pointer: { type: "object" additionalProperties: true } redirect_url: { type: "string" description: "The URL which the user is sent to when a payment is completed." } status: { type: "string" description: "The status of the bunq.me fundraiser profile, can be ACTIVE or DEACTIVATED." } } } created: { type: "string" description: "The timestamp when the bunq.me was created." } id: { type: "integer" description: "The id of the bunq.me." } payments: { type: "array" description: "The list of payments, paid to the bunq.me fundraiser profile." items: { type: "object" additionalProperties: true } } updated: { type: "string" description: "The timestamp when the bunq.me was last updated." } } } BunqMeTab: { type: "object" required: ["bunqme_tab_entry"] properties: { bunqme_tab_entry: { type: "object" properties: { alias: { type: "object" additionalProperties: true } amount_inquired: { type: "object" additionalProperties: true } description: { type: "string" description: "The description for the bunq.me. Maximum 9000 characters." } invite_profile_name: { type: "string" description: "Provided if the user has enabled their invite link." } merchant_available: { type: "array" description: "List of available merchants." items: { type: "object" properties: { available: { type: "boolean" description: "Whether or not the merchant is available for the user." } merchant_type: { type: "string" description: "A merchant type supported by bunq.me." } } } } redirect_url: { type: "string" description: "The URL which the user is sent to when a payment is completed." } status: { type: "string" description: "The status of the bunq.me. Can be WAITING_FOR_PAYMENT, CANCELLED or EXPIRED." } uuid: { type: "string" description: "The uuid of the bunq.me." } } } status: { type: "string" description: "The status of the bunq.me. Ignored in POST requests but can be used for cancelling the bunq.me by setting status as CANCELLED with a PUT request." } } } BunqMeTabResultResponse: { type: "object" properties: { payment: { type: "object" additionalProperties: true } } } Card: { type: "object" properties: { activation_code: { type: "string" description: "DEPRECATED: Activate a card by setting status to ACTIVE when the order_status is ACCEPTED_FOR_PRODUCTION." } card_limit: { type: "object" additionalProperties: true } card_limit_atm: { type: "object" additionalProperties: true } country_permission: { type: "array" description: "The countries for which to grant (temporary) permissions to use the card." items: { type: "object" properties: { country: { type: "string" description: "The country to allow transactions in (e.g. NL, DE)." } expiry_time: { type: "string" description: "Expiry time of this rule." } id: { type: "integer" description: "The id of the card country permission entry." } } } } monetary_account_id_fallback: { type: "integer" description: "ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied." } order_status: { type: "string" description: "The order status to set for the card. Set to CARD_REQUEST_PENDING to get a virtual card produced." } pin_code: { type: "string" description: "The plaintext pin code. Requests require encryption to be enabled." } pin_code_assignment: { type: "array" description: "Array of Types, PINs, account IDs assigned to the card." items: { type: "object" properties: { monetary_account_id: { type: "integer" description: "The ID of the monetary account to assign to this pin for the card." } pin_code: { type: "string" description: "The 4 digit PIN to be assigned to this account." } routing_type: { type: "string" description: "Routing type. Can be MANUAL or AUTOMATIC" } type: { type: "string" description: "PIN type. Can be PRIMARY, SECONDARY or TERTIARY" } } } } primary_account_numbers: { type: "array" description: "Array of PANs and their attributes." items: { type: "object" properties: { description: { type: "string" description: "The description for this PAN." } four_digit: { type: "string" description: "The last four digits of the PAN." } id: { type: "integer" description: "The ID for this Virtual PAN." } monetary_account_id: { type: "integer" description: "The ID of the monetary account to assign to this PAN, only for Online Cards." } status: { type: "string" description: "The status for this PAN, only for Online Cards." } uuid: { type: "string" description: "The UUID for this Virtual PAN." } } } } status: { type: "string" description: "The status to set for the card. Can be ACTIVE, DEACTIVATED, LOST, STOLEN or CANCELLED, and can only be set to LOST/STOLEN/CANCELLED when order status is ACCEPTED_FOR_PRODUCTION/DELIVERED_TO_CUSTOMER/CARD_UPDATE_REQUESTED/CARD_UPDATE_SENT/CARD_UPDATE_ACCEPTED. Can only be set to DEACTIVATED after initial activation, i.e. order_status is DELIVERED_TO_CUSTOMER/CARD_UPDATE_REQUESTED/CARD_UPDATE_SENT/CARD_UPDATE_ACCEPTED. Mind that all the possible choices (apart from ACTIVE and DEACTIVATED) are permanent and cannot be changed after." } } } CardDebit: { type: "object" required: ["second_line", "name_on_card", "type", "product_type"] properties: { alias: { type: "object" additionalProperties: true } monetary_account_id_fallback: { type: "integer" description: "ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied." } name_on_card: { type: "string" description: "The user's name as it will be on the card. Check 'card-name' for the available card names for a user." } order_status: { type: "string" description: "The order status of this card. Can be CARD_REQUEST_PENDING or VIRTUAL_DELIVERY." } pin_code_assignment: { type: "array" description: "Array of Types, PINs, account IDs assigned to the card." items: { type: "object" additionalProperties: true } } preferred_name_on_card: { type: "string" description: "The user's preferred name that can be put on the card." } product_type: { type: "string" description: "The product type of the card to order." } second_line: { type: "string" description: "The second line of text on the card, used as name/description for it. It can contain at most 17 characters and it can be empty." } type: { type: "string" description: "The type of card to order. Can be MAESTRO or MASTERCARD." } } } DraftPayment: { type: "object" required: ["entries", "number_of_required_accepts"] properties: { entries: { type: "array" description: "The list of entries in the DraftPayment. Each entry will result in a payment when the DraftPayment is accepted." items: { type: "object" properties: { alias: { type: "object" additionalProperties: true } amount: { type: "object" additionalProperties: true } attachment: { type: "array" description: "The Attachments attached to the DraftPayment." items: { type: "object" additionalProperties: true } } counterparty_alias: { type: "object" additionalProperties: true } description: { type: "string" description: "The description for the DraftPayment. Maximum 140 characters for DraftPayments to external IBANs, 9000 characters for DraftPayments to only other bunq MonetaryAccounts." } id: { type: "integer" description: "The id of the draft payment entry." } merchant_reference: { type: "string" description: "Optional data to be included with the Payment specific to the merchant." } type: { type: "string" description: "The type of the draft payment entry." } } } } number_of_required_accepts: { type: "integer" description: "The number of accepts that are required for the draft payment to receive status ACCEPTED. Currently only 1 is valid." } previous_updated_timestamp: { type: "string" description: "The last updated_timestamp that you received for this DraftPayment. This needs to be provided to prevent race conditions." } schedule: { type: "object" properties: { object: { type: "object" properties: { Payment: { type: "object" additionalProperties: true } PaymentBatch: { type: "object" additionalProperties: true } } } recurrence_size: { type: "integer" description: "The schedule recurrence size. For example size 4 and unit WEEKLY means the recurrence is every 4 weeks." } recurrence_unit: { type: "string" description: "The schedule recurrence unit, options: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY" } status: { type: "string" description: "The schedule status, options: ACTIVE, FINISHED, CANCELLED." } time_end: { type: "string" description: "The schedule end time (UTC)." } time_start: { type: "string" description: "The schedule start time (UTC)." } } } status: { type: "string" description: "The status of the DraftPayment." } } } FeatureAnnouncement: { type: "object" properties: { avatar: { type: "object" additionalProperties: true } sub_title: { type: "string" description: "The event overview subtitle of the feature display" } title: { type: "string" description: "The event overview title of the feature display" } type: { type: "string" description: "The type of the feature announcement so apps can override with their own stuff if desired" } } } IdealMerchantTransaction: { type: "object" properties: { alias: { type: "object" additionalProperties: true } amount_guaranteed: { type: "object" additionalProperties: true } amount_requested: { type: "object" additionalProperties: true } counterparty_alias: { type: "object" additionalProperties: true } expiration: { type: "string" description: "When the transaction will expire." } issuer: { type: "string" description: "The BIC of the issuer." } issuer_authentication_url: { type: "string" description: "The URL to visit to " } issuer_name: { type: "string" description: "The Name of the issuer." } monetary_account_id: { type: "integer" description: "The id of the monetary account this ideal merchant transaction links to." } purchase_identifier: { type: "string" description: "The 'purchase ID' of the iDEAL transaction." } status: { type: "string" description: "The status of the transaction." } status_timestamp: { type: "string" description: "When the status was last updated." } transaction_identifier: { type: "string" description: "The 'transaction ID' of the iDEAL transaction." } } } Invoice: { type: "object" required: ["description", "external_url"] properties: { address: { type: "object" additionalProperties: true } alias: { type: "object" additionalProperties: true } category: { type: "string" description: "The category to display to the user." } chamber_of_commerce_number: { type: "string" description: "The company's chamber of commerce number." } counterparty_address: { type: "object" additionalProperties: true } counterparty_alias: { type: "object" additionalProperties: true } created: { type: "string" description: "The timestamp of the invoice object's creation." } description: { type: "string" description: "The description provided by the admin." } external_url: { type: "string" description: "The external url provided by the admin." } group: { type: "array" description: "The invoice item groups." items: { type: "object" properties: { instance_description: { type: "string" description: "The identifier of the invoice item group." } item: { type: "array" description: "The invoice items in the group." items: { type: "object" properties: { billing_date: { type: "object" additionalProperties: true } id: { type: "object" additionalProperties: true } quantity: { type: "object" additionalProperties: true } total_vat_exclusive: { type: "object" additionalProperties: true } total_vat_inclusive: { type: "object" additionalProperties: true } type_description: { type: "object" additionalProperties: true } type_description_translated: { type: "object" additionalProperties: true } unit_vat_exclusive: { type: "object" additionalProperties: true } unit_vat_inclusive: { type: "object" additionalProperties: true } vat: { type: "object" additionalProperties: true } } } } product_vat_exclusive: { type: "object" additionalProperties: true } product_vat_inclusive: { type: "object" additionalProperties: true } type: { type: "string" description: "The type of the invoice item group." } type_description: { type: "string" description: "The description of the type of the invoice item group." } type_description_translated: { type: "string" description: "The translated description of the type of the invoice item group." } } } } id: { type: "integer" description: "The id of the invoice object." } invoice_date: { type: "string" description: "The invoice date." } invoice_number: { type: "string" description: "The invoice number." } request_reference_split_the_bill: { type: "array" description: "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch" items: { type: "object" additionalProperties: true } } status: { type: "string" description: "The invoice status." } total_vat: { type: "object" additionalProperties: true } total_vat_exclusive: { type: "object" additionalProperties: true } total_vat_inclusive: { type: "object" additionalProperties: true } updated: { type: "string" description: "The timestamp of the invoice object's last update." } vat_number: { type: "string" description: "The company's chamber of commerce number." } } } MasterCardAction: { type: "object" properties: { alias: { type: "object" additionalProperties: true } all_mastercard_action_refund: { type: "array" description: "A reference to the Refunds if they exist." items: { type: "object" properties: { additional_information: { type: "object" properties: { attachment: { type: "array" description: "The Attachments to attach to the refund request." items: { type: "object" additionalProperties: true } } category: { type: "string" description: "The category of the refund, required for chargeback." } comment: { type: "string" description: "Comment about the refund." } reason: { type: "string" description: "The reason to refund, required for chargeback." } terms_and_conditions: { type: "string" description: "Proof that the user acknowledged the terms and conditions for chargebacks." } } } alias: { type: "object" additionalProperties: true } amount: { type: "object" additionalProperties: true } attachment: { type: "array" description: "The Attachments to attach to the refund request." items: { type: "object" additionalProperties: true } } category: { type: "string" description: "The category of the refund, required for chargeback." } comment: { type: "string" description: "Comment about the refund." } counterparty_alias: { type: "object" additionalProperties: true } created: { type: "string" description: "The timestamp of the refund's creation." } description: { type: "string" description: "The description for this transaction to display." } id: { type: "integer" description: "The id of the refund." } label_card: { type: "object" properties: { expiry_date: { type: "string" description: "The date this card will expire." } label_user: { type: "object" additionalProperties: true } second_line: { type: "string" description: "The second line on the card." } status: { type: "string" description: "The status of the card." } type: { type: "string" description: "The type of the card." } uuid: { type: "string" description: "The public UUID." } } } label_user_creator: { type: "object" additionalProperties: true } mastercard_action_id: { type: "integer" description: "The id of mastercard action being refunded." } reason: { type: "string" description: "The reason of the refund. Can be REFUND_EXPIRED_TRANSACTION, REFUND_REQUESTED, REFUND_MERCHANT, REFUND_CHARGEBACK." } reference_mastercard_action_event: { type: "array" description: "The reference to the object this refund applies to." items: { type: "object" properties: { event_id: { type: "object" additionalProperties: true } } } } status: { type: "string" description: "The status of the refunded mastercard action. Can be AUTO_APPROVED, AUTO_APPROVED_WAITING_FOR_EXPIRY, PENDING_APPROVAL, APPROVED, REFUNDED, DENIED or FAILED" } status_description: { type: "string" description: "Description of the refund's current status." } status_description_translated: { type: "string" description: "Description of the refund's current status, translated in user's language." } status_together_url: { type: "string" description: "Together topic concerning the refund's current status." } sub_type: { type: "string" description: "The sub type of this refund indicating whether the chargeback will be FULL or PARTIAL." } terms_and_conditions: { type: "string" description: "Proof that the user acknowledged the terms and conditions for chargebacks." } time_refund: { type: "string" description: "The time the refund will take place." } type: { type: "string" description: "Type of this refund. Can de REFUND or CHARGEBACK" } updated: { type: "string" description: "The timestamp of the refund's last update." } } } } amount_billing: { type: "object" additionalProperties: true } amount_converted: { type: "object" additionalProperties: true } amount_fee: { type: "object" additionalProperties: true } amount_local: { type: "object" additionalProperties: true } amount_original_billing: { type: "object" additionalProperties: true } amount_original_local: { type: "object" additionalProperties: true } 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." } authorisation_status: { type: "string" description: "The status in the authorisation process." } authorisation_type: { type: "string" description: "The type of transaction that was delivered using the card." } card_authorisation_id_response: { type: "string" description: "The response code by which authorised transaction can be identified as authorised by bunq." } card_id: { type: "integer" description: "The id of the card this action links to." } city: { type: "string" description: "The city where the message originates from as announced by the terminal." } clearing_expiry_time: { type: "string" description: "The time when the processing of the clearing is expired, refunding the authorisation." } clearing_status: { type: "string" description: "The clearing status of the authorisation. Can be 'PENDING', 'FIRST_PRESENTMENT_COMPLETE' or 'REFUND_LENIENCY'." } counterparty_alias: { type: "object" additionalProperties: true } decision: { type: "string" description: "Why the transaction was denied, if it was denied, or just ALLOWED." } decision_description: { type: "string" description: "Empty if allowed, otherwise a textual explanation of why it was denied." } decision_description_translated: { type: "string" description: "Empty if allowed, otherwise a textual explanation of why it was denied in user's language." } 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." } description: { type: "string" description: "The description for this transaction to display." } eligible_whitelist_id: { type: "integer" description: "The whitelist id for this action or null." } id: { type: "integer" description: "The id of the MastercardAction." } label_card: { type: "object" additionalProperties: true } maturity_date: { type: "string" description: "The maturity date." } monetary_account_id: { type: "integer" description: "The id of the monetary account this action links to." } pan_entry_mode_user: { type: "string" description: "The type of entry mode the user used. Can be 'ATM', 'ICC', 'MAGNETIC_STRIPE' or 'E_COMMERCE'." } payment_status: { type: "string" description: "The payment status of the transaction. For example PAYMENT_SUCCESSFUL, for a successful payment." } pos_card_holder_presence: { type: "string" description: "The Card Holder Presence type of the POS." } pos_card_presence: { type: "string" description: "The Card Presence type of the POS." } request_reference_split_the_bill: { type: "array" description: "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch" items: { type: "object" additionalProperties: true } } reservation_expiry_time: { type: "string" description: "If this is a reservation, the moment the reservation will expire." } secure_code_id: { type: "integer" description: "The secure code id for this mastercard action or null." } settlement_status: { type: "string" description: "The setlement status in the authorisation process." } token_status: { type: "string" description: "If this is a tokenisation action, this shows the status of the token." } 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." } } } Payment: { type: "object" additionalProperties: true } PaymentBatch: { type: "object" additionalProperties: true } RequestInquiry: { type: "object" required: ["allow_bunqme"] properties: { address_billing: { type: "object" additionalProperties: true } address_shipping: { type: "object" additionalProperties: true } allow_amount_higher: { type: "boolean" description: "[DEPRECATED] Whether or not the accepting user can choose to accept with a higher amount than requested. Defaults to false." } allow_amount_lower: { type: "boolean" description: "[DEPRECATED] Whether or not the accepting user can choose to accept with a lower amount than requested. Defaults to false." } allow_bunqme: { type: "boolean" description: "Whether or not sending a bunq.me request is allowed." } amount_inquired: { type: "object" additionalProperties: true } amount_responded: { type: "object" additionalProperties: true } attachment: { type: "array" description: "The attachments attached to the payment." items: { type: "object" properties: { id: { type: "integer" description: "An integer ID of an object. Unique per object type." } } } } batch_id: { type: "integer" description: "The id of the batch if the request was part of a batch." } bunqme_share_url: { type: "string" description: "The url that points to the bunq.me request." } counterparty_alias: { type: "object" additionalProperties: true } created: { type: "string" description: "The timestamp of the payment request's creation." } description: { type: "string" description: "The description of the inquiry." } event_id: { type: "integer" description: "The ID of the associated event if the request was made using 'split the bill'." } geolocation: { type: "object" additionalProperties: true } id: { type: "integer" description: "The id of the created RequestInquiry." } merchant_reference: { type: "string" description: "The client's custom reference that was attached to the request and the mutation." } minimum_age: { type: "integer" description: "The minimum age the user accepting the RequestInquiry must have." } monetary_account_id: { type: "integer" description: "The id of the monetary account the request response applies to." } redirect_url: { type: "string" description: "The URL which the user is sent to after accepting or rejecting the Request." } reference_split_the_bill: { type: "object" properties: { BillingInvoice: { type: "object" additionalProperties: true } DraftPayment: { type: "object" additionalProperties: true } MasterCardAction: { type: "object" additionalProperties: true } Payment: { type: "object" additionalProperties: true } PaymentBatch: { type: "object" additionalProperties: true } RequestResponse: { type: "object" properties: { address_billing: { type: "object" additionalProperties: true } address_shipping: { type: "object" additionalProperties: true } alias: { type: "object" additionalProperties: true } amount_inquired: { type: "object" additionalProperties: true } amount_responded: { type: "object" additionalProperties: true } attachment: { type: "array" description: "The Attachments attached to the RequestResponse." items: { type: "object" additionalProperties: true } } counterparty_alias: { type: "object" additionalProperties: true } created: { type: "string" description: "The timestamp when the Request Response was created." } credit_scheme_identifier: { type: "string" description: "The credit scheme id provided by the counterparty for DIRECT_DEBIT inquiries." } description: { type: "string" description: "The description for the RequestResponse provided by the requesting party. Maximum 9000 characters." } eligible_whitelist_id: { type: "integer" description: "The whitelist id for this action or null." } event_id: { type: "integer" description: "The ID of the latest event for the request." } geolocation: { type: "object" additionalProperties: true } id: { type: "integer" description: "The id of the Request Response." } mandate_identifier: { type: "string" description: "The mandate id provided by the counterparty for DIRECT_DEBIT inquiries." } minimum_age: { type: "integer" description: "The minimum age the user accepting the RequestResponse must have." } monetary_account_id: { type: "integer" description: "The id of the MonetaryAccount the RequestResponse was received on." } redirect_url: { type: "string" description: "The URL which the user is sent to after accepting or rejecting the Request." } request_reference_split_the_bill: { type: "array" description: "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch" items: { type: "object" additionalProperties: true } } require_address: { type: "string" description: "Whether or not an address must be provided on accept." } status: { type: "string" description: "The status of the RequestResponse. Can be ACCEPTED, PENDING, REJECTED, REFUND_REQUESTED, REFUNDED or REVOKED." } sub_type: { type: "string" description: "The subtype of the RequestInquiry. Can be ONCE or RECURRING for DIRECT_DEBIT RequestInquiries and NONE for all other." } time_expiry: { type: "string" description: "The timestamp of when the RequestResponse expired or will expire." } time_refund_requested: { type: "string" description: "The timestamp of when a refund request for the RequestResponse was claimed." } time_refunded: { type: "string" description: "The timestamp of when the RequestResponse was refunded." } time_responded: { type: "string" description: "The timestamp of when the RequestResponse was responded to." } type: { type: "string" description: "The type of the RequestInquiry. Can be DIRECT_DEBIT, DIRECT_DEBIT_B2B, IDEAL, SOFORT or INTERNAL." } updated: { type: "string" description: "The timestamp when the Request Response was last updated (will be updated when chat messages are received)." } user_refund_requested: { type: "object" additionalProperties: true } } } ScheduleInstance: { type: "object" properties: { error_message: { type: "array" description: "The message when the scheduled instance has run and failed due to user error." items: { type: "object" additionalProperties: true } } request_reference_split_the_bill: { type: "array" description: "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch" items: { type: "object" additionalProperties: true } } result_object: { type: "object" properties: { Payment: { type: "object" additionalProperties: true } PaymentBatch: { type: "object" additionalProperties: true } } } scheduled_object: { type: "object" additionalProperties: true } state: { type: "string" description: "The state of the scheduleInstance. (FINISHED_SUCCESSFULLY, RETRY, FAILED_USER_ERROR)" } time_end: { type: "string" description: "The schedule end time (UTC)." } time_start: { type: "string" description: "The schedule start time (UTC)." } } } TransferwisePayment: { type: "object" required: ["monetary_account_id", "recipient_id"] properties: { alias: { type: "object" additionalProperties: true } amount_source: { type: "object" additionalProperties: true } amount_target: { type: "object" additionalProperties: true } counterparty_alias: { type: "object" additionalProperties: true } monetary_account_id: { type: "string" description: "The id of the monetary account the payment should be made from." } pay_in_reference: { type: "string" description: "The Pay-In reference of the payment." } quote: { type: "object" required: ["currency_source", "currency_target"] properties: { amount_fee: { type: "object" additionalProperties: true } amount_source: { type: "object" additionalProperties: true } amount_target: { type: "object" additionalProperties: true } created: { type: "string" description: "The timestamp of the quote's creation." } currency_source: { type: "string" description: "The source currency." } currency_target: { type: "string" description: "The target currency." } id: { type: "integer" description: "The id of the quote." } quote_id: { type: "string" description: "The quote id Transferwise needs." } rate: { type: "string" description: "The rate." } time_delivery_estimate: { type: "string" description: "The estimated delivery time." } time_expiry: { type: "string" description: "The expiration timestamp of the quote." } updated: { type: "string" description: "The timestamp of the quote's last update." } } } rate: { type: "string" description: "The rate of the payment." } recipient_id: { type: "string" description: "The id of the target account." } reference: { type: "string" description: "The reference of the payment." } status: { type: "string" description: "The status." } status_transferwise: { type: "string" description: "The status as Transferwise reports it." } status_transferwise_issue: { type: "string" description: "A status to indicatie if Transferwise has an issue with this payment and requires more information." } sub_status: { type: "string" description: "The subStatus." } time_delivery_estimate: { type: "string" description: "The estimated delivery time." } } } WhitelistResult: { type: "object" properties: { error_message: { type: "array" description: "The message when the whitelist result has failed due to user error." items: { type: "object" additionalProperties: true } } id: { type: "integer" description: "The ID of the whitelist entry." } monetary_account_paying_id: { type: "integer" description: "The account from which payments will be deducted when a transaction is matched with this whitelist." } object: { type: "object" properties: { draftPayment: { type: "object" additionalProperties: true } id: { type: "integer" description: "The ID of the whitelist entry." } requestResponse: { type: "object" additionalProperties: true } } } request_reference_split_the_bill: { type: "array" description: "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch" items: { type: "object" additionalProperties: true } } status: { type: "string" description: "The status of the WhitelistResult." } sub_status: { type: "string" description: "The subStatus of the WhitelistResult." } whitelist: { type: "object" } } } } } require_address: { type: "string" description: "Whether or not an address must be provided on accept." } scheduled_id: { type: "integer" description: "The id of the scheduled job if the request was scheduled." } status: { type: "string" description: "The status of the request." } time_expiry: { type: "string" description: "The timestamp of when the payment request expired." } time_responded: { type: "string" description: "The timestamp of when the payment request was responded to." } updated: { type: "string" description: "The timestamp of the payment request's last update." } user_alias_created: { type: "object" additionalProperties: true } user_alias_revoked: { type: "object" additionalProperties: true } want_tip: { type: "boolean" description: "[DEPRECATED] Whether or not the accepting user can give an extra tip on top of the requested Amount. Defaults to false." } } } RequestInquiryBatch: { type: "object" properties: { event_id: { type: "integer" description: "The ID of the associated event if the request batch was made using 'split the bill'." } reference_split_the_bill: { type: "object" additionalProperties: true } request_inquiries: { type: "array" description: "The list of requests that were made." items: { type: "object" additionalProperties: true } } status: { type: "string" description: "The status of the request." } total_amount_inquired: { type: "object" additionalProperties: true } } } RequestResponse: { type: "object" additionalProperties: true } RewardRecipient: { type: "object" properties: { amount_reward: { type: "object" additionalProperties: true } counterparty_alias: { type: "object" additionalProperties: true } created: { type: "string" description: "The time the reward was created." } id: { type: "integer" description: "The id of the reward." } status: { type: "string" description: "The status of the reward." } sub_status: { type: "string" description: "The subStatus of the reward." } type: { type: "string" description: "The type of the reward." } updated: { type: "string" description: "The time the reward was last updated." } } } RewardSender: { type: "object" properties: { amount_reward: { type: "object" additionalProperties: true } counterparty_alias: { type: "object" additionalProperties: true } created: { type: "string" description: "The time the reward was created." } id: { type: "integer" description: "The id of the reward." } status: { type: "string" description: "The status of the reward." } sub_status: { type: "string" description: "The subStatus of the reward." } type: { type: "string" description: "The type of the reward." } updated: { type: "string" description: "The time the reward was last updated." } } } ScheduledInstance: { type: "object" additionalProperties: true } ScheduledPayment: { type: "object" properties: { payment: { type: "object" properties: { alias: { type: "object" additionalProperties: true } allow_bunqto: { type: "boolean" description: "Whether or not sending a bunq.to payment is allowed." } amount: { type: "object" additionalProperties: true } attachment: { type: "array" description: "The Attachments attached to the Payment." items: { type: "object" additionalProperties: true } } counterparty_alias: { type: "object" additionalProperties: true } 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." } merchant_reference: { type: "string" description: "Optional data included with the Payment specific to the merchant." } } } schedule: { type: "object" additionalProperties: true } status: { type: "string" description: "The schedule status, options: ACTIVE, FINISHED, CANCELLED." } } } ScheduledPaymentBatch: { type: "object" properties: { payments: { type: "array" description: "The payment details." items: { type: "object" additionalProperties: true } } schedule: { type: "object" additionalProperties: true } } } ShareInviteBankInquiry: { type: "object" properties: { access_type: { type: "string" description: "Type of access that is in place." } alias: { type: "object" additionalProperties: true } counter_user_alias: { type: "object" additionalProperties: true } draft_share_invite_bank_id: { type: "integer" description: "DEPRECATED: USE `access_type` INSTEAD | The id of the draft share invite bank." } end_date: { type: "string" description: "DEPRECATED: USE `access_type` INSTEAD | The expiration date of this share." } id: { type: "integer" description: "The id of the newly created share invite." } monetary_account_id: { type: "integer" description: "The id of the monetary account the share applies to." } relationship: { type: "string" description: "The relationship: COMPANY_DIRECTOR, COMPANY_EMPLOYEE, etc" } share_detail: { type: "object" properties: { draft_payment: { type: "object" properties: { make_draft_payments: { type: "boolean" description: "If set to true, the invited user will be able to make draft payments from the shared account." } view_balance: { type: "boolean" description: "If set to true, the invited user will be able to view the account balance." } view_new_events: { type: "boolean" description: "If set to true, the invited user will be able to view events starting from the time the share became active." } view_old_events: { type: "boolean" description: "If set to true, the invited user will be able to view events from before the share was active." } } } payment: { type: "object" properties: { make_draft_payments: { type: "boolean" description: "If set to true, the invited user will be able to make draft payments from the shared account." } make_payments: { type: "boolean" description: "If set to true, the invited user will be able to make payments from the shared account." } view_balance: { type: "boolean" description: "If set to true, the invited user will be able to view the account balance." } view_new_events: { type: "boolean" description: "If set to true, the invited user will be able to view events starting from the time the share became active." } view_old_events: { type: "boolean" description: "If set to true, the invited user will be able to view events from before the share was active." } } } read_only: { type: "object" properties: { view_balance: { type: "boolean" description: "If set to true, the invited user will be able to view the account balance." } view_new_events: { type: "boolean" description: "If set to true, the invited user will be able to view events starting from the time the share became active." } view_old_events: { type: "boolean" description: "If set to true, the invited user will be able to view events from before the share was active." } } } } } share_type: { type: "string" description: "DEPRECATED: USE `access_type` INSTEAD | The share type, either STANDARD or MUTUAL." } start_date: { type: "string" description: "DEPRECATED: USE `access_type` INSTEAD | The start date of this share." } status: { type: "string" description: "The status of the share. Can be ACTIVE, REVOKED, REJECTED." } user_alias_created: { type: "object" additionalProperties: true } user_alias_revoked: { type: "object" additionalProperties: true } } } ShareInviteBankResponse: { type: "object" properties: { access_type: { type: "string" description: "Type of access that is wanted, one of VIEW_BALANCE, VIEW_TRANSACTION, DRAFT_PAYMENT or FULL_TRANSIENT" } card_id: { type: "integer" description: "The card to link to the shared monetary account. Used only if share_detail is ShareDetailCardPayment." } counter_alias: { type: "object" additionalProperties: true } created: { type: "string" description: "The timestamp of the ShareInviteBankResponse creation." } description: { type: "string" description: "The description of this share. It is basically the monetary account description." } draft_share_invite_bank_id: { type: "integer" description: "The id of the draft share invite bank." } end_date: { type: "string" description: "The expiration date of this share." } id: { type: "integer" description: "The id of the ShareInviteBankResponse." } monetary_account_id: { type: "integer" description: "The id of the monetary account the ACCEPTED share applies to. null otherwise." } relation_user: { type: "object" properties: { counter_label_user: { type: "object" additionalProperties: true } counter_user_id: { type: "string" description: "The counter user's ID." } counter_user_status: { type: "string" description: "The account status of a user" } label_user: { type: "object" additionalProperties: true } relationship: { type: "string" description: "The requested relation type." } status: { type: "string" description: "The request's status, only for UPDATE." } user_id: { type: "string" description: "The user's ID." } user_status: { type: "string" description: "The account status of a user" } } } share_detail: { type: "object" additionalProperties: true } share_type: { type: "string" description: "The share type, either STANDARD or MUTUAL." } start_date: { type: "string" description: "The start date of this share." } status: { type: "string" description: "The status of the share. Can be ACTIVE, REVOKED, REJECTED." } updated: { type: "string" description: "The timestamp of the ShareInviteBankResponse last update." } user_alias_cancelled: { type: "object" additionalProperties: true } } } SofortMerchantTransaction: { type: "object" properties: { alias: { type: "object" additionalProperties: true } amount_guaranteed: { type: "object" additionalProperties: true } amount_requested: { type: "object" additionalProperties: true } counterparty_alias: { type: "object" additionalProperties: true } error_message: { type: "array" description: "The error message of the transaction." items: { type: "object" additionalProperties: true } } issuer: { type: "string" description: "The BIC of the issuer." } issuer_authentication_url: { type: "string" description: "The URL to visit to " } monetary_account_id: { type: "integer" description: "The id of the monetary account this sofort merchant transaction links to." } status: { type: "string" description: "The status of the transaction." } transaction_identifier: { type: "string" description: "The 'transaction ID' of the Sofort transaction." } } } TransferwisePayment: { type: "object" additionalProperties: true } } } status: { type: "string" description: "The event status. Can be: FINALIZED or AWAITING_REPLY. An example of FINALIZED event is a payment received event, while an AWAITING_REPLY event is a request received event." } updated: { type: "string" description: "The timestamp of the event's last update." } user_id: { type: "string" description: "The id of the user the event applied to (if it was a user event)." } } } } }