--- title: "POST /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry" method: POST path: "/user/{userID}/monetary-account/{monetary-accountID}/request-inquiry" tags: ["request-inquiry"] --- # POST /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry `POST /user/{userID}/monetary-account/{monetary-accountID}/request-inquiry` Create a new payment request. ## Path parameters - `userID` integer, required - `monetary-accountID` integer, required ## Headers - `Cache-Control` string - `User-Agent` string, required - `X-Bunq-Language` string - `X-Bunq-Region` string - `X-Bunq-Client-Request-Id` string - `X-Bunq-Geolocation` string - `X-Bunq-Client-Authentication` string, required ## Request body - RequestInquiry - `amount_inquired` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `counterparty_alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `description` string — The description of the inquiry. - `attachment` BunqId[] — The attachments attached to the payment. - `id` integer — An integer ID of an object. Unique per object type. - `merchant_reference` string — The client's custom reference that was attached to the request and the mutation. - `status` string — The status of the request. - `minimum_age` integer — The minimum age the user accepting the RequestInquiry must have. - `require_address` string — Whether or not an address must be provided on accept. - `want_tip` boolean — [DEPRECATED] Whether or not the accepting user can give an extra tip on top of the requested Amount. Defaults to false. - `allow_amount_lower` boolean — [DEPRECATED] Whether or not the accepting user can choose to accept with a lower amount than requested. Defaults to false. - `allow_amount_higher` boolean — [DEPRECATED] Whether or not the accepting user can choose to accept with a higher amount than requested. Defaults to false. - `allow_bunqme` boolean, required — Whether or not sending a bunq.me request is allowed. - `redirect_url` string — The URL which the user is sent to after accepting or rejecting the Request. - `event_id` integer — The ID of the associated event if the request was made using 'split the bill'. - `id` integer — The id of the created RequestInquiry. - `created` string — The timestamp of the payment request's creation. - `updated` string — The timestamp of the payment request's last update. - `time_responded` string — The timestamp of when the payment request was responded to. - `time_expiry` string — The timestamp of when the payment request expired. - `monetary_account_id` integer — The id of the monetary account the request response applies to. - `amount_responded` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `user_alias_created` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `user_alias_revoked` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `batch_id` integer — The id of the batch if the request was part of a batch. - `scheduled_id` integer — The id of the scheduled job if the request was scheduled. - `bunqme_share_url` string — The url that points to the bunq.me request. - `address_shipping` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `address_billing` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `geolocation` Geolocation - `latitude` integer — The latitude for a geolocation restriction. - `longitude` integer — The longitude for a geolocation restriction. - `altitude` integer — The altitude for a geolocation restriction. - `radius` integer — The radius for a geolocation restriction. - `reference_split_the_bill` RequestReferenceSplitTheBillAnchorObject - `BillingInvoice` Invoice - `status` string — The invoice status. - `description` string, required — The description provided by the admin. - `external_url` string, required — The external url provided by the admin. - `id` integer — The id of the invoice object. - `created` string — The timestamp of the invoice object's creation. - `updated` string — The timestamp of the invoice object's last update. - `invoice_date` string — The invoice date. - `invoice_number` string — The invoice number. - `category` string — The category to display to the user. - `group` InvoiceItemGroup[] — The invoice item groups. - `type` string — The type of the invoice item group. - `type_description` string — The description of the type of the invoice item group. - `type_description_translated` string — The translated description of the type of the invoice item group. - `instance_description` string — The identifier of the invoice item group. - `product_vat_exclusive` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `product_vat_inclusive` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `item` InvoiceItem[] — The invoice items in the group. - `id` integer — The id of the invoice item. - `billing_date` string — The billing date of the item. - `type_description` string — The price description. - `type_description_translated` string — The translated price description. - `unit_vat_exclusive` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `unit_vat_inclusive` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `vat` integer — The VAT tax fraction. - `quantity` integer — The number of items priced. - `total_vat_exclusive` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `total_vat_inclusive` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `total_vat_inclusive` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `total_vat_exclusive` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `total_vat` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `address` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `counterparty_alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `counterparty_address` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `chamber_of_commerce_number` string — The company's chamber of commerce number. - `vat_number` string — The company's chamber of commerce number. - `request_reference_split_the_bill` RequestInquiryReference[] — The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch - `type` string — The type of request inquiry. Can be RequestInquiry or RequestInquiryBatch. - `id` integer — The id of the request inquiry (batch). - `DraftPayment` DraftPayment - `status` string — The status of the DraftPayment. - `entries` DraftPaymentEntry[], required — The list of entries in the DraftPayment. Each entry will result in a payment when the DraftPayment is accepted. - `amount` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `counterparty_alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `description` string — The description for the DraftPayment. Maximum 140 characters for DraftPayments to external IBANs, 9000 characters for DraftPayments to only other bunq MonetaryAccounts. - `merchant_reference` string — Optional data to be included with the Payment specific to the merchant. - `attachment` AttachmentMonetaryAccountPayment[] — The Attachments attached to the DraftPayment. - `id` integer — The id of the attached Attachment. - `monetary_account_id` integer — The id of the MonetaryAccount this Attachment is attached from. - `id` integer — The id of the draft payment entry. - `alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `type` string — The type of the draft payment entry. - `previous_updated_timestamp` string — The last updated_timestamp that you received for this DraftPayment. This needs to be provided to prevent race conditions. - `number_of_required_accepts` integer, required — The number of accepts that are required for the draft payment to receive status ACCEPTED. Currently only 1 is valid. - `schedule` Schedule - `time_start` string — The schedule start time (UTC). - `time_end` string — The schedule end time (UTC). - `recurrence_unit` string — The schedule recurrence unit, options: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY - `recurrence_size` integer — The schedule recurrence size. For example size 4 and unit WEEKLY means the recurrence is every 4 weeks. - `status` string — The schedule status, options: ACTIVE, FINISHED, CANCELLED. - `object` ScheduleAnchorObject - `Payment` Payment - `amount` Amount - … - `counterparty_alias` LabelMonetaryAccount - … - `description` string — The description for the Payment. Maximum 140 characters for Payments to external IBANs, 9000 characters for Payments to only other bunq MonetaryAccounts. - `attachment` AttachmentMonetaryAccountPayment[] — The Attachments attached to the Payment. - … - `merchant_reference` string — Optional data included with the Payment specific to the merchant. - `allow_bunqto` boolean — Whether or not sending a bunq.to payment is allowed. - `id` integer — The id of the created Payment. - `created` string — The timestamp when the Payment was done. - `updated` string — The timestamp when the Payment was last updated (will be updated when chat messages are received). - `monetary_account_id` integer — The id of the MonetaryAccount the Payment was made to or from (depending on whether this is an incoming or outgoing Payment). - `alias` LabelMonetaryAccount - … - `type` string — The type of Payment, can be BUNQ, EBA_SCT, EBA_SDD, IDEAL, SWIFT or FIS (card). - `sub_type` string — The sub-type of the Payment, can be PAYMENT, WITHDRAWAL, REVERSAL, REQUEST, BILLING, SCT, SDD or NLO. - `payment_arrival_expected` PaymentArrivalExpected - … - `bunqto_status` string — The status of the bunq.to payment. - `bunqto_sub_status` string — The sub status of the bunq.to payment. - `bunqto_share_url` string — The status of the bunq.to payment. - `bunqto_expiry` string — When bunq.to payment is about to expire. - `bunqto_time_responded` string — The timestamp of when the bunq.to payment was responded to. - `batch_id` integer — The id of the PaymentBatch if this Payment was part of one. - `scheduled_id` integer — The id of the JobScheduled if the Payment was scheduled. - `address_shipping` Address - … - `address_billing` Address - … - `geolocation` Geolocation - … - `request_reference_split_the_bill` RequestInquiryReference[] — The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch - … - `balance_after_mutation` Amount - … - `payment_auto_allocate_instance` PaymentAutoAllocateInstance - … - `payment_suspended_outgoing` PaymentSuspendedOutgoing - … - `payment_fee` PaymentFee - … - `PaymentBatch` PaymentBatch - `payments` PaymentBatchAnchoredPayment - … - `MasterCardAction` MasterCardAction - `id` integer — The id of the MastercardAction. - `monetary_account_id` integer — The id of the monetary account this action links to. - `card_id` integer — The id of the card this action links to. - `amount_local` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `amount_converted` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `amount_billing` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `amount_original_local` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `amount_original_billing` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `amount_fee` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `card_authorisation_id_response` string — The response code by which authorised transaction can be identified as authorised by bunq. - `decision` string — Why the transaction was denied, if it was denied, or just ALLOWED. - `payment_status` string — The payment status of the transaction. For example PAYMENT_SUCCESSFUL, for a successful payment. - `decision_description` string — Empty if allowed, otherwise a textual explanation of why it was denied. - `decision_description_translated` string — Empty if allowed, otherwise a textual explanation of why it was denied in user's language. - `decision_together_url` string — 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` string — The description for this transaction to display. - `authorisation_status` string — The status in the authorisation process. - `authorisation_type` string — The type of transaction that was delivered using the card. - `pan_entry_mode_user` string — The type of entry mode the user used. Can be 'ATM', 'ICC', 'MAGNETIC_STRIPE' or 'E_COMMERCE'. - `settlement_status` string — The setlement status in the authorisation process. - `clearing_status` string — The clearing status of the authorisation. Can be 'PENDING', 'FIRST_PRESENTMENT_COMPLETE' or 'REFUND_LENIENCY'. - `maturity_date` string — The maturity date. - `city` string — The city where the message originates from as announced by the terminal. - `alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `counterparty_alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `label_card` LabelCard - `uuid` string — The public UUID. - `type` string — The type of the card. - `second_line` string — The second line on the card. - `expiry_date` string — The date this card will expire. - `status` string — The status of the card. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `merchant_id` string — The identification string of the merchant. - `token_status` string — If this is a tokenisation action, this shows the status of the token. - `reservation_expiry_time` string — If this is a reservation, the moment the reservation will expire. - `clearing_expiry_time` string — The time when the processing of the clearing is expired, refunding the authorisation. - `applied_limit` string — 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. - `secure_code_id` integer — The secure code id for this mastercard action or null. - `wallet_provider_id` string — The ID of the wallet provider as defined by MasterCard. 420 = bunq Android app with Tap&Pay; 103 = Apple Pay. - `request_reference_split_the_bill` RequestInquiryReference[] — The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch - `type` string — The type of request inquiry. Can be RequestInquiry or RequestInquiryBatch. - `id` integer — The id of the request inquiry (batch). - `card_tokenization_event` Event - `id` integer — The id of the event. - `created` string — The timestamp of the event's creation. - `updated` string — The timestamp of the event's last update. - `action` string — The performed action. Can be: CREATE or UPDATE. - `user_id` string — The id of the user the event applied to (if it was a user event). - `monetary_account_id` string — The id of the monetary account the event applied to (if it was a monetary account event). - `object` EventObject - `BunqMeTab` BunqMeTab - `bunqme_tab_entry` BunqMeTabEntry, required - … - `status` string — The status of the bunq.me. Ignored in POST requests but can be used for cancelling the bunq.me by setting status as CANCELLED with a PUT request. - `event_id` integer — The ID of the related event if the bunqMeTab made by 'split' functionality. - `BunqMeTabResultResponse` BunqMeTabResultResponse - `payment` Payment - … - `BunqMeFundraiserResult` BunqMeFundraiserResult - `id` integer — The id of the bunq.me. - `created` string — The timestamp when the bunq.me was created. - `updated` string — The timestamp when the bunq.me was last updated. - `bunqme_fundraiser_profile` BunqMeFundraiserProfile - … - `payments` Payment[] — The list of payments, paid to the bunq.me fundraiser profile. - … - `Card` Card - `pin_code` string — The plaintext pin code. Requests require encryption to be enabled. - `activation_code` string — DEPRECATED: Activate a card by setting status to ACTIVE when the order_status is ACCEPTED_FOR_PRODUCTION. - `status` string — The status to set for the card. Can be ACTIVE, DEACTIVATED, LOST, STOLEN or CANCELLED, and can only be set to LOST/STOLEN/CANCELLED when order status is ACCEPTED_FOR_PRODUCTION/DELIVERED_TO_CUSTOMER/CARD_UPDATE_REQUESTED/CARD_UPDATE_SENT/CARD_UPDATE_ACCEPTED. Can only be set to DEACTIVATED after initial activation, i.e. order_status is DELIVERED_TO_CUSTOMER/CARD_UPDATE_REQUESTED/CARD_UPDATE_SENT/CARD_UPDATE_ACCEPTED. Mind that all the possible choices (apart from ACTIVE and DEACTIVATED) are permanent and cannot be changed after. - `order_status` string — The order status to set for the card. Set to CARD_REQUEST_PENDING to get a virtual card produced. - `card_limit` Amount - … - `card_limit_atm` Amount - … - `country_permission` CardCountryPermission[] — The countries for which to grant (temporary) permissions to use the card. - … - `pin_code_assignment` CardPinAssignment[] — Array of Types, PINs, account IDs assigned to the card. - … - `primary_account_numbers` CardPrimaryAccountNumber[] — Array of PANs and their attributes. - … - `monetary_account_id_fallback` integer — ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied. - `preferred_name_on_card` string — The user's preferred name as it will be on the card. - `second_line` string — The second line of text on the card - `cancellation_reason` string — The reason for card cancellation. - `CardDebit` CardDebit - `second_line` string, required — The second line of text on the card, used as name/description for it. It can contain at most 17 characters and it can be empty. - `name_on_card` string, required — The user's name as it will be on the card. Check 'card-name' for the available card names for a user. - `preferred_name_on_card` string — The user's preferred name that can be put on the card. - `alias` Pointer - … - `type` string, required — The type of card to order. Can be MAESTRO or MASTERCARD. - `product_type` string, required — The product type of the card to order. - `pin_code_assignment` CardPinAssignment[] — Array of Types, PINs, account IDs assigned to the card. - … - `monetary_account_id_fallback` integer — ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied. - `order_status` string — The order status of this card. Can be CARD_REQUEST_PENDING or VIRTUAL_DELIVERY. - `DraftPayment` DraftPayment - `status` string — The status of the DraftPayment. - `entries` DraftPaymentEntry[], required — The list of entries in the DraftPayment. Each entry will result in a payment when the DraftPayment is accepted. - … - `previous_updated_timestamp` string — The last updated_timestamp that you received for this DraftPayment. This needs to be provided to prevent race conditions. - `number_of_required_accepts` integer, required — The number of accepts that are required for the draft payment to receive status ACCEPTED. Currently only 1 is valid. - `schedule` Schedule - … - `FeatureAnnouncement` FeatureAnnouncement - `avatar` Avatar - … - `title` string — The event overview title of the feature display - `sub_title` string — The event overview subtitle of the feature display - `type` string — The type of the feature announcement so apps can override with their own stuff if desired - `IdealMerchantTransaction` IdealMerchantTransaction - `amount_requested` Amount - … - `issuer` string — The BIC of the issuer. - `monetary_account_id` integer — The id of the monetary account this ideal merchant transaction links to. - `alias` LabelMonetaryAccount - … - `counterparty_alias` LabelMonetaryAccount - … - `amount_guaranteed` Amount - … - `expiration` string — When the transaction will expire. - `issuer_name` string — The Name of the issuer. - `issuer_authentication_url` string — The URL to visit to - `purchase_identifier` string — The 'purchase ID' of the iDEAL transaction. - `status` string — The status of the transaction. - `status_timestamp` string — When the status was last updated. - `transaction_identifier` string — The 'transaction ID' of the iDEAL transaction. - `Invoice` Invoice - `status` string — The invoice status. - `description` string, required — The description provided by the admin. - `external_url` string, required — The external url provided by the admin. - `id` integer — The id of the invoice object. - `created` string — The timestamp of the invoice object's creation. - `updated` string — The timestamp of the invoice object's last update. - `invoice_date` string — The invoice date. - `invoice_number` string — The invoice number. - `category` string — The category to display to the user. - `group` InvoiceItemGroup[] — The invoice item groups. - … - `total_vat_inclusive` Amount - … - `total_vat_exclusive` Amount - … - `total_vat` Amount - … - `alias` LabelMonetaryAccount - … - `address` Address - … - `counterparty_alias` LabelMonetaryAccount - … - `counterparty_address` Address - … - `chamber_of_commerce_number` string — The company's chamber of commerce number. - `vat_number` string — The company's chamber of commerce number. - `request_reference_split_the_bill` RequestInquiryReference[] — The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch - … - `ScheduledPayment` SchedulePayment - `payment` SchedulePaymentEntry - … - `schedule` Schedule - … - `purpose` string — The schedule purpose. - `status` string — The schedule status, options: ACTIVE, FINISHED, CANCELLED. - `ScheduledPaymentBatch` SchedulePaymentBatch - `payments` SchedulePaymentEntry[] — The payment details. - … - `schedule` Schedule - … - `ScheduledInstance` ScheduleInstance - `state` string — The state of the scheduleInstance. (FINISHED_SUCCESSFULLY, RETRY, FAILED_USER_ERROR) - `time_start` string — The schedule start time (UTC). - `time_end` string — The schedule end time (UTC). - `error_message` Error[] — The message when the scheduled instance has run and failed due to user error. - … - `scheduled_object` ScheduleAnchorObject - … - `result_object` ScheduleInstanceAnchorObject - … - `request_reference_split_the_bill` RequestInquiryReference[] — The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch - … - `MasterCardAction` MasterCardAction — recursive - `BankSwitchServiceNetherlandsIncomingPayment` BankSwitchServiceNetherlandsIncomingPayment - `bank_switch_service` BankSwitchServiceNetherlandsIncoming - … - `payment` Payment - … - `Payment` Payment - `amount` Amount - … - `counterparty_alias` LabelMonetaryAccount - … - `description` string — The description for the Payment. Maximum 140 characters for Payments to external IBANs, 9000 characters for Payments to only other bunq MonetaryAccounts. - `attachment` AttachmentMonetaryAccountPayment[] — The Attachments attached to the Payment. - … - `merchant_reference` string — Optional data included with the Payment specific to the merchant. - `allow_bunqto` boolean — Whether or not sending a bunq.to payment is allowed. - `id` integer — The id of the created Payment. - `created` string — The timestamp when the Payment was done. - `updated` string — The timestamp when the Payment was last updated (will be updated when chat messages are received). - `monetary_account_id` integer — The id of the MonetaryAccount the Payment was made to or from (depending on whether this is an incoming or outgoing Payment). - `alias` LabelMonetaryAccount - … - `type` string — The type of Payment, can be BUNQ, EBA_SCT, EBA_SDD, IDEAL, SWIFT or FIS (card). - `sub_type` string — The sub-type of the Payment, can be PAYMENT, WITHDRAWAL, REVERSAL, REQUEST, BILLING, SCT, SDD or NLO. - `payment_arrival_expected` PaymentArrivalExpected - … - `bunqto_status` string — The status of the bunq.to payment. - `bunqto_sub_status` string — The sub status of the bunq.to payment. - `bunqto_share_url` string — The status of the bunq.to payment. - `bunqto_expiry` string — When bunq.to payment is about to expire. - `bunqto_time_responded` string — The timestamp of when the bunq.to payment was responded to. - `batch_id` integer — The id of the PaymentBatch if this Payment was part of one. - `scheduled_id` integer — The id of the JobScheduled if the Payment was scheduled. - `address_shipping` Address - … - `address_billing` Address - … - `geolocation` Geolocation - … - `request_reference_split_the_bill` RequestInquiryReference[] — The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch - … - `balance_after_mutation` Amount - … - `payment_auto_allocate_instance` PaymentAutoAllocateInstance - … - `payment_suspended_outgoing` PaymentSuspendedOutgoing - … - `payment_fee` PaymentFee - … - `PaymentBatch` PaymentBatch - `payments` PaymentBatchAnchoredPayment - … - `RequestInquiryBatch` RequestInquiryBatch - `request_inquiries` RequestInquiry[] — The list of requests that were made. - `status` string — The status of the request. - `total_amount_inquired` Amount - … - `event_id` integer — The ID of the associated event if the request batch was made using 'split the bill'. - `reference_split_the_bill` RequestReferenceSplitTheBillAnchorObject — recursive - `RequestInquiry` RequestInquiry — recursive - `RequestResponse` RequestResponse - `amount_responded` Amount - … - `status` string — The status of the RequestResponse. Can be ACCEPTED, PENDING, REJECTED, REFUND_REQUESTED, REFUNDED or REVOKED. - `address_shipping` Address - … - `address_billing` Address - … - `currency_conversion_quote_id` integer — When the request is accepted on a monetary account with a different currency, a quote is expected to convert. - `id` integer — The id of the Request Response. - `created` string — The timestamp when the Request Response was created. - `updated` string — The timestamp when the Request Response was last updated (will be updated when chat messages are received). - `time_responded` string — The timestamp of when the RequestResponse was responded to. - `time_expiry` string — The timestamp of when the RequestResponse expired or will expire. - `time_refund_requested` string — The timestamp of when a refund request for the RequestResponse was claimed. - `time_refunded` string — The timestamp of when the RequestResponse was refunded. - `user_refund_requested` LabelUser - … - `monetary_account_id` integer — The id of the MonetaryAccount the RequestResponse was received on. - `amount_inquired` Amount - … - `description` string — The description for the RequestResponse provided by the requesting party. Maximum 9000 characters. - `alias` LabelMonetaryAccount - … - `counterparty_alias` LabelMonetaryAccount - … - `attachment` Attachment[] — The Attachments attached to the RequestResponse. - … - `minimum_age` integer — The minimum age the user accepting the RequestResponse must have. - `require_address` string — Whether or not an address must be provided on accept. - `geolocation` Geolocation - … - `type` string — The type of the RequestInquiry. Can be DIRECT_DEBIT, DIRECT_DEBIT_B2B, IDEAL, SOFORT or INTERNAL. - `sub_type` string — The subtype of the RequestInquiry. Can be ONCE or RECURRING for DIRECT_DEBIT RequestInquiries and NONE for all other. - `redirect_url` string — The URL which the user is sent to after accepting or rejecting the Request. - `credit_scheme_identifier` string — The credit scheme id provided by the counterparty for DIRECT_DEBIT inquiries. - `mandate_identifier` string — The mandate id provided by the counterparty for DIRECT_DEBIT inquiries. - `registration_action` string — Recommended registration action after IdealIssuerTransaction from iDEAL issuer transaction. - `eligible_whitelist_id` integer — The whitelist id for this action or null. - `request_reference_split_the_bill` RequestInquiryReference[] — The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch - … - `event_id` integer — The ID of the latest event for the request. - `monetary_account_preferred_id` integer — The ID of the monetary account this user prefers to pay the request from. - `ShareInviteBankInquiry` ShareInviteMonetaryAccountInquiry - `counter_user_alias` LabelUser - … - `access_type` string — Type of access that is in place. - `draft_share_invite_bank_id` integer — DEPRECATED: USE `access_type` INSTEAD | The id of the draft share invite bank. - `share_detail` ShareDetail - … - `status` string — The status of the share. Can be ACTIVE, REVOKED, REJECTED. - `relationship` string — The relationship: COMPANY_DIRECTOR, COMPANY_EMPLOYEE, etc - `share_type` string — DEPRECATED: USE `access_type` INSTEAD | The share type, either STANDARD or MUTUAL. - `start_date` string — DEPRECATED: USE `access_type` INSTEAD | The start date of this share. - `end_date` string — DEPRECATED: USE `access_type` INSTEAD | The expiration date of this share. - `alias` LabelMonetaryAccount - … - `user_alias_created` LabelUser - … - `user_alias_revoked` LabelUser - … - `monetary_account_id` integer — The id of the monetary account the share applies to. - `id` integer — The id of the newly created share invite. - `ShareInviteBankResponse` ShareInviteMonetaryAccountResponse - `status` string — The status of the share. Can be ACTIVE, REVOKED, REJECTED. - `card_id` integer — The card to link to the shared monetary account. Used only if share_detail is ShareDetailCardPayment. - `id` integer — The id of the ShareInviteBankResponse. - `created` string — The timestamp of the ShareInviteBankResponse creation. - `updated` string — The timestamp of the ShareInviteBankResponse last update. - `counter_alias` LabelMonetaryAccount - … - `user_alias_cancelled` LabelUser - … - `monetary_account_id` integer — The id of the monetary account the ACCEPTED share applies to. null otherwise. - `draft_share_invite_bank_id` integer — The id of the draft share invite bank. - `share_detail` ShareDetail - … - `access_type` string — Type of access that is wanted, one of VIEW_BALANCE, VIEW_TRANSACTION, DRAFT_PAYMENT or FULL_TRANSIENT - `relation_user` RelationUser - … - `share_type` string — The share type, either STANDARD or MUTUAL. - `start_date` string — The start date of this share. - `end_date` string — The expiration date of this share. - `description` string — The description of this share. It is basically the monetary account description. - `SofortMerchantTransaction` SofortMerchantTransaction - `amount_requested` Amount - … - `issuer` string — The BIC of the issuer. - `monetary_account_id` integer — The id of the monetary account this sofort merchant transaction links to. - `alias` LabelMonetaryAccount - … - `counterparty_alias` LabelMonetaryAccount - … - `amount_guaranteed` Amount - … - `issuer_authentication_url` string — The URL to visit to - `status` string — The status of the transaction. - `error_message` Error[] — The error message of the transaction. - … - `transaction_identifier` string — The 'transaction ID' of the Sofort transaction. - `TransferwisePayment` TransferwiseTransfer - `monetary_account_id` string, required — The id of the monetary account the payment should be made from. - `recipient_id` string, required — The id of the target account. - `alias` LabelMonetaryAccount - … - `counterparty_alias` LabelMonetaryAccount - … - `status` string — The status. - `sub_status` string — The subStatus. - `status_transferwise` string — The status as Transferwise reports it. - `status_transferwise_issue` string — A status to indicatie if Transferwise has an issue with this payment and requires more information. - `amount_source` Amount - … - `amount_target` Amount - … - `rate` string — The rate of the payment. - `reference` string — The reference of the payment. - `pay_in_reference` string — The Pay-In reference of the payment. - `time_delivery_estimate` string — The estimated delivery time. - `quote` TransferwiseQuote - … - `status` string — 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. - `object_data_at_event` EventObject - `BunqMeTab` BunqMeTab - `bunqme_tab_entry` BunqMeTabEntry, required - … - `status` string — The status of the bunq.me. Ignored in POST requests but can be used for cancelling the bunq.me by setting status as CANCELLED with a PUT request. - `event_id` integer — The ID of the related event if the bunqMeTab made by 'split' functionality. - `BunqMeTabResultResponse` BunqMeTabResultResponse - `payment` Payment - … - `BunqMeFundraiserResult` BunqMeFundraiserResult - `id` integer — The id of the bunq.me. - `created` string — The timestamp when the bunq.me was created. - `updated` string — The timestamp when the bunq.me was last updated. - `bunqme_fundraiser_profile` BunqMeFundraiserProfile - … - `payments` Payment[] — The list of payments, paid to the bunq.me fundraiser profile. - … - `Card` Card - `pin_code` string — The plaintext pin code. Requests require encryption to be enabled. - `activation_code` string — DEPRECATED: Activate a card by setting status to ACTIVE when the order_status is ACCEPTED_FOR_PRODUCTION. - `status` string — The status to set for the card. Can be ACTIVE, DEACTIVATED, LOST, STOLEN or CANCELLED, and can only be set to LOST/STOLEN/CANCELLED when order status is ACCEPTED_FOR_PRODUCTION/DELIVERED_TO_CUSTOMER/CARD_UPDATE_REQUESTED/CARD_UPDATE_SENT/CARD_UPDATE_ACCEPTED. Can only be set to DEACTIVATED after initial activation, i.e. order_status is DELIVERED_TO_CUSTOMER/CARD_UPDATE_REQUESTED/CARD_UPDATE_SENT/CARD_UPDATE_ACCEPTED. Mind that all the possible choices (apart from ACTIVE and DEACTIVATED) are permanent and cannot be changed after. - `order_status` string — The order status to set for the card. Set to CARD_REQUEST_PENDING to get a virtual card produced. - `card_limit` Amount - … - `card_limit_atm` Amount - … - `country_permission` CardCountryPermission[] — The countries for which to grant (temporary) permissions to use the card. - … - `pin_code_assignment` CardPinAssignment[] — Array of Types, PINs, account IDs assigned to the card. - … - `primary_account_numbers` CardPrimaryAccountNumber[] — Array of PANs and their attributes. - … - `monetary_account_id_fallback` integer — ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied. - `preferred_name_on_card` string — The user's preferred name as it will be on the card. - `second_line` string — The second line of text on the card - `cancellation_reason` string — The reason for card cancellation. - `CardDebit` CardDebit - `second_line` string, required — The second line of text on the card, used as name/description for it. It can contain at most 17 characters and it can be empty. - `name_on_card` string, required — The user's name as it will be on the card. Check 'card-name' for the available card names for a user. - `preferred_name_on_card` string — The user's preferred name that can be put on the card. - `alias` Pointer - … - `type` string, required — The type of card to order. Can be MAESTRO or MASTERCARD. - `product_type` string, required — The product type of the card to order. - `pin_code_assignment` CardPinAssignment[] — Array of Types, PINs, account IDs assigned to the card. - … - `monetary_account_id_fallback` integer — ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied. - `order_status` string — The order status of this card. Can be CARD_REQUEST_PENDING or VIRTUAL_DELIVERY. - `DraftPayment` DraftPayment - `status` string — The status of the DraftPayment. - `entries` DraftPaymentEntry[], required — The list of entries in the DraftPayment. Each entry will result in a payment when the DraftPayment is accepted. - … - `previous_updated_timestamp` string — The last updated_timestamp that you received for this DraftPayment. This needs to be provided to prevent race conditions. - `number_of_required_accepts` integer, required — The number of accepts that are required for the draft payment to receive status ACCEPTED. Currently only 1 is valid. - `schedule` Schedule - … - `FeatureAnnouncement` FeatureAnnouncement - `avatar` Avatar - … - `title` string — The event overview title of the feature display - `sub_title` string — The event overview subtitle of the feature display - `type` string — The type of the feature announcement so apps can override with their own stuff if desired - `IdealMerchantTransaction` IdealMerchantTransaction - `amount_requested` Amount - … - `issuer` string — The BIC of the issuer. - `monetary_account_id` integer — The id of the monetary account this ideal merchant transaction links to. - `alias` LabelMonetaryAccount - … - `counterparty_alias` LabelMonetaryAccount - … - `amount_guaranteed` Amount - … - `expiration` string — When the transaction will expire. - `issuer_name` string — The Name of the issuer. - `issuer_authentication_url` string — The URL to visit to - `purchase_identifier` string — The 'purchase ID' of the iDEAL transaction. - `status` string — The status of the transaction. - `status_timestamp` string — When the status was last updated. - `transaction_identifier` string — The 'transaction ID' of the iDEAL transaction. - `Invoice` Invoice - `status` string — The invoice status. - `description` string, required — The description provided by the admin. - `external_url` string, required — The external url provided by the admin. - `id` integer — The id of the invoice object. - `created` string — The timestamp of the invoice object's creation. - `updated` string — The timestamp of the invoice object's last update. - `invoice_date` string — The invoice date. - `invoice_number` string — The invoice number. - `category` string — The category to display to the user. - `group` InvoiceItemGroup[] — The invoice item groups. - … - `total_vat_inclusive` Amount - … - `total_vat_exclusive` Amount - … - `total_vat` Amount - … - `alias` LabelMonetaryAccount - … - `address` Address - … - `counterparty_alias` LabelMonetaryAccount - … - `counterparty_address` Address - … - `chamber_of_commerce_number` string — The company's chamber of commerce number. - `vat_number` string — The company's chamber of commerce number. - `request_reference_split_the_bill` RequestInquiryReference[] — The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch - … - `ScheduledPayment` SchedulePayment - `payment` SchedulePaymentEntry - … - `schedule` Schedule - … - `purpose` string — The schedule purpose. - `status` string — The schedule status, options: ACTIVE, FINISHED, CANCELLED. - `ScheduledPaymentBatch` SchedulePaymentBatch - `payments` SchedulePaymentEntry[] — The payment details. - … - `schedule` Schedule - … - `ScheduledInstance` ScheduleInstance - `state` string — The state of the scheduleInstance. (FINISHED_SUCCESSFULLY, RETRY, FAILED_USER_ERROR) - `time_start` string — The schedule start time (UTC). - `time_end` string — The schedule end time (UTC). - `error_message` Error[] — The message when the scheduled instance has run and failed due to user error. - … - `scheduled_object` ScheduleAnchorObject - … - `result_object` ScheduleInstanceAnchorObject - … - `request_reference_split_the_bill` RequestInquiryReference[] — The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch - … - `MasterCardAction` MasterCardAction — recursive - `BankSwitchServiceNetherlandsIncomingPayment` BankSwitchServiceNetherlandsIncomingPayment - `bank_switch_service` BankSwitchServiceNetherlandsIncoming - … - `payment` Payment - … - `Payment` Payment - `amount` Amount - … - `counterparty_alias` LabelMonetaryAccount - … - `description` string — The description for the Payment. Maximum 140 characters for Payments to external IBANs, 9000 characters for Payments to only other bunq MonetaryAccounts. - `attachment` AttachmentMonetaryAccountPayment[] — The Attachments attached to the Payment. - … - `merchant_reference` string — Optional data included with the Payment specific to the merchant. - `allow_bunqto` boolean — Whether or not sending a bunq.to payment is allowed. - `id` integer — The id of the created Payment. - `created` string — The timestamp when the Payment was done. - `updated` string — The timestamp when the Payment was last updated (will be updated when chat messages are received). - `monetary_account_id` integer — The id of the MonetaryAccount the Payment was made to or from (depending on whether this is an incoming or outgoing Payment). - `alias` LabelMonetaryAccount - … - `type` string — The type of Payment, can be BUNQ, EBA_SCT, EBA_SDD, IDEAL, SWIFT or FIS (card). - `sub_type` string — The sub-type of the Payment, can be PAYMENT, WITHDRAWAL, REVERSAL, REQUEST, BILLING, SCT, SDD or NLO. - `payment_arrival_expected` PaymentArrivalExpected - … - `bunqto_status` string — The status of the bunq.to payment. - `bunqto_sub_status` string — The sub status of the bunq.to payment. - `bunqto_share_url` string — The status of the bunq.to payment. - `bunqto_expiry` string — When bunq.to payment is about to expire. - `bunqto_time_responded` string — The timestamp of when the bunq.to payment was responded to. - `batch_id` integer — The id of the PaymentBatch if this Payment was part of one. - `scheduled_id` integer — The id of the JobScheduled if the Payment was scheduled. - `address_shipping` Address - … - `address_billing` Address - … - `geolocation` Geolocation - … - `request_reference_split_the_bill` RequestInquiryReference[] — The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch - … - `balance_after_mutation` Amount - … - `payment_auto_allocate_instance` PaymentAutoAllocateInstance - … - `payment_suspended_outgoing` PaymentSuspendedOutgoing - … - `payment_fee` PaymentFee - … - `PaymentBatch` PaymentBatch - `payments` PaymentBatchAnchoredPayment - … - `RequestInquiryBatch` RequestInquiryBatch - `request_inquiries` RequestInquiry[] — The list of requests that were made. - `status` string — The status of the request. - `total_amount_inquired` Amount - … - `event_id` integer — The ID of the associated event if the request batch was made using 'split the bill'. - `reference_split_the_bill` RequestReferenceSplitTheBillAnchorObject — recursive - `RequestInquiry` RequestInquiry — recursive - `RequestResponse` RequestResponse - `amount_responded` Amount - … - `status` string — The status of the RequestResponse. Can be ACCEPTED, PENDING, REJECTED, REFUND_REQUESTED, REFUNDED or REVOKED. - `address_shipping` Address - … - `address_billing` Address - … - `currency_conversion_quote_id` integer — When the request is accepted on a monetary account with a different currency, a quote is expected to convert. - `id` integer — The id of the Request Response. - `created` string — The timestamp when the Request Response was created. - `updated` string — The timestamp when the Request Response was last updated (will be updated when chat messages are received). - `time_responded` string — The timestamp of when the RequestResponse was responded to. - `time_expiry` string — The timestamp of when the RequestResponse expired or will expire. - `time_refund_requested` string — The timestamp of when a refund request for the RequestResponse was claimed. - `time_refunded` string — The timestamp of when the RequestResponse was refunded. - `user_refund_requested` LabelUser - … - `monetary_account_id` integer — The id of the MonetaryAccount the RequestResponse was received on. - `amount_inquired` Amount - … - `description` string — The description for the RequestResponse provided by the requesting party. Maximum 9000 characters. - `alias` LabelMonetaryAccount - … - `counterparty_alias` LabelMonetaryAccount - … - `attachment` Attachment[] — The Attachments attached to the RequestResponse. - … - `minimum_age` integer — The minimum age the user accepting the RequestResponse must have. - `require_address` string — Whether or not an address must be provided on accept. - `geolocation` Geolocation - … - `type` string — The type of the RequestInquiry. Can be DIRECT_DEBIT, DIRECT_DEBIT_B2B, IDEAL, SOFORT or INTERNAL. - `sub_type` string — The subtype of the RequestInquiry. Can be ONCE or RECURRING for DIRECT_DEBIT RequestInquiries and NONE for all other. - `redirect_url` string — The URL which the user is sent to after accepting or rejecting the Request. - `credit_scheme_identifier` string — The credit scheme id provided by the counterparty for DIRECT_DEBIT inquiries. - `mandate_identifier` string — The mandate id provided by the counterparty for DIRECT_DEBIT inquiries. - `registration_action` string — Recommended registration action after IdealIssuerTransaction from iDEAL issuer transaction. - `eligible_whitelist_id` integer — The whitelist id for this action or null. - `request_reference_split_the_bill` RequestInquiryReference[] — The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch - … - `event_id` integer — The ID of the latest event for the request. - `monetary_account_preferred_id` integer — The ID of the monetary account this user prefers to pay the request from. - `ShareInviteBankInquiry` ShareInviteMonetaryAccountInquiry - `counter_user_alias` LabelUser - … - `access_type` string — Type of access that is in place. - `draft_share_invite_bank_id` integer — DEPRECATED: USE `access_type` INSTEAD | The id of the draft share invite bank. - `share_detail` ShareDetail - … - `status` string — The status of the share. Can be ACTIVE, REVOKED, REJECTED. - `relationship` string — The relationship: COMPANY_DIRECTOR, COMPANY_EMPLOYEE, etc - `share_type` string — DEPRECATED: USE `access_type` INSTEAD | The share type, either STANDARD or MUTUAL. - `start_date` string — DEPRECATED: USE `access_type` INSTEAD | The start date of this share. - `end_date` string — DEPRECATED: USE `access_type` INSTEAD | The expiration date of this share. - `alias` LabelMonetaryAccount - … - `user_alias_created` LabelUser - … - `user_alias_revoked` LabelUser - … - `monetary_account_id` integer — The id of the monetary account the share applies to. - `id` integer — The id of the newly created share invite. - `ShareInviteBankResponse` ShareInviteMonetaryAccountResponse - `status` string — The status of the share. Can be ACTIVE, REVOKED, REJECTED. - `card_id` integer — The card to link to the shared monetary account. Used only if share_detail is ShareDetailCardPayment. - `id` integer — The id of the ShareInviteBankResponse. - `created` string — The timestamp of the ShareInviteBankResponse creation. - `updated` string — The timestamp of the ShareInviteBankResponse last update. - `counter_alias` LabelMonetaryAccount - … - `user_alias_cancelled` LabelUser - … - `monetary_account_id` integer — The id of the monetary account the ACCEPTED share applies to. null otherwise. - `draft_share_invite_bank_id` integer — The id of the draft share invite bank. - `share_detail` ShareDetail - … - `access_type` string — Type of access that is wanted, one of VIEW_BALANCE, VIEW_TRANSACTION, DRAFT_PAYMENT or FULL_TRANSIENT - `relation_user` RelationUser - … - `share_type` string — The share type, either STANDARD or MUTUAL. - `start_date` string — The start date of this share. - `end_date` string — The expiration date of this share. - `description` string — The description of this share. It is basically the monetary account description. - `SofortMerchantTransaction` SofortMerchantTransaction - `amount_requested` Amount - … - `issuer` string — The BIC of the issuer. - `monetary_account_id` integer — The id of the monetary account this sofort merchant transaction links to. - `alias` LabelMonetaryAccount - … - `counterparty_alias` LabelMonetaryAccount - … - `amount_guaranteed` Amount - … - `issuer_authentication_url` string — The URL to visit to - `status` string — The status of the transaction. - `error_message` Error[] — The error message of the transaction. - … - `transaction_identifier` string — The 'transaction ID' of the Sofort transaction. - `TransferwisePayment` TransferwiseTransfer - `monetary_account_id` string, required — The id of the monetary account the payment should be made from. - `recipient_id` string, required — The id of the target account. - `alias` LabelMonetaryAccount - … - `counterparty_alias` LabelMonetaryAccount - … - `status` string — The status. - `sub_status` string — The subStatus. - `status_transferwise` string — The status as Transferwise reports it. - `status_transferwise_issue` string — A status to indicatie if Transferwise has an issue with this payment and requires more information. - `amount_source` Amount - … - `amount_target` Amount - … - `rate` string — The rate of the payment. - `reference` string — The reference of the payment. - `pay_in_reference` string — The Pay-In reference of the payment. - `time_delivery_estimate` string — The estimated delivery time. - `quote` TransferwiseQuote - … - `is_event_latest_for_object` boolean — Indicator whether this is the latest event for the object. - `is_event_reassignable` boolean — Indicator whether this is event can be reassigned to another Monetary Account. - `all_mastercard_action_refund` MasterCardActionRefund[] — A reference to the Refunds if they exist. - `type` string — Type of this refund. Can de REFUND or CHARGEBACK - `sub_type` string — The sub type of this refund indicating whether the chargeback will be FULL or PARTIAL. - `amount` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `category` string — The category of the refund, required for chargeback. - `reason` string — The reason of the refund. Can be REFUND_EXPIRED_TRANSACTION, REFUND_REQUESTED, REFUND_MERCHANT, REFUND_CHARGEBACK. - `comment` string — Comment about the refund. - `attachment` AttachmentMasterCardActionRefund[] — The Attachments to attach to the refund request. - `id` integer — The id of the attached Attachment. - `terms_and_conditions` string — Proof that the user acknowledged the terms and conditions for chargebacks. - `id` integer — The id of the refund. - `created` string — The timestamp of the refund's creation. - `updated` string — The timestamp of the refund's last update. - `label_user_creator` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `status` string — The status of the refunded mastercard action. Can be AUTO_APPROVED, AUTO_APPROVED_WAITING_FOR_EXPIRY, PENDING_APPROVAL, APPROVED, REFUNDED, DENIED or FAILED - `reference_mastercard_action_event` MasterCardActionReference[] — The reference to the object this refund applies to. - `event_id` integer — The id of the event. - `mastercard_action_id` integer — The id of mastercard action being refunded. - `alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `counterparty_alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `description` string — The description for this transaction to display. - `label_card` LabelCard - `uuid` string — The public UUID. - `type` string — The type of the card. - `second_line` string — The second line on the card. - `expiry_date` string — The date this card will expire. - `status` string — The status of the card. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `time_refund` string — The time the refund will take place. - `additional_information` AdditionalInformation - `category` string — The category of the refund, required for chargeback. - `reason` string — The reason to refund, required for chargeback. - `comment` string — Comment about the refund. - `attachment` AttachmentMasterCardActionRefund[] — The Attachments to attach to the refund request. - `id` integer — The id of the attached Attachment. - `terms_and_conditions` string — Proof that the user acknowledged the terms and conditions for chargebacks. - `status_description` string — Description of the refund's current status. - `status_description_translated` string — Description of the refund's current status, translated in user's language. - `status_together_url` string — Together topic concerning the refund's current status. - `pos_card_presence` string — The Card Presence type of the POS. - `pos_card_holder_presence` string — The Card Holder Presence type of the POS. - `eligible_whitelist_id` integer — The whitelist id for this action or null. - `cashback_payout_item` CashbackPayoutItem - `status` string — The status of the cashback payout item. - `amount` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `rate_applied` string — The cashback rate. - `transaction_category` AdditionalTransactionInformationCategory - `category` string — The category. - `type` string — Who created this category. - `status` string — Whether this category is active. Only relevant for user-defined categories. - `order` integer — The sort order of the category. - `description` string — The description of the category. - `description_translated` string — The translation of the description of the category. - `color` string — The color of the category. - `icon` string — The icon of the category. - `user_partner_promotion` UserPartnerPromotionCashback - `promotion_code` string, required — The promotion code used in signup to indicate the partner that referred the user. - `status` string — The status of the user partner promotion. - `number_of_transaction_remaining` integer — The number of transactions that are still eligible for this promotion. - `partner_promotion` PartnerPromotionCashback - `public_uuid` string — The public UUID of the cashback promotion. - `status` string — The status of the cashback promotion. - `promotion_code` string — The promotion code used in signup to indicate the partner that referred the user. - `amount_cashback_per_transaction_maximum` Amount - … - `number_of_transaction_maximum` integer — The maximum number of transactions that can be made. - `amount_transaction_minimum` Amount - … - `url_together` string — The URL to the Together page with FAQs about this promotion. - `deeplink` string — The deeplink to the cashback promotion. - `partner_name` string — The name of the partner. - `partner_avatar` Avatar - … - `promotion_title_short` string[] — The short title of the promotion. - `promotion_title_long` string[] — The long title of the promotion. - `promotion_description` string[] — The description of the promotion. - `point_mutation` PointMutation - `number_of_point` integer — The number of points earned. - `blacklist` UserBlocklistMasterCardMerchant - `merchant_name` string — The name of the merchant. - `merchant_id` string — The blocklisted merchant. - `merchant_identifier` string — Identifier of the merchant we are blocklisting. - `mastercard_merchant_id` string — The blocklisted merchant. - `external_merchant_id` string — Externally provided merchant identification. - `id` integer — The id of the blocklist. - `created` string — The timestamp of the object's creation. - `updated` string — The timestamp of the object's last update. - `status` string — The status of the the blocklist. - `merchant_hash` string — Hash of the merchant we are blocklisting. - `merchant_avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `blocklist` UserBlocklistMasterCardMerchant - `merchant_name` string — The name of the merchant. - `merchant_id` string — The blocklisted merchant. - `merchant_identifier` string — Identifier of the merchant we are blocklisting. - `mastercard_merchant_id` string — The blocklisted merchant. - `external_merchant_id` string — Externally provided merchant identification. - `id` integer — The id of the blocklist. - `created` string — The timestamp of the object's creation. - `updated` string — The timestamp of the object's last update. - `status` string — The status of the the blocklist. - `merchant_hash` string — Hash of the merchant we are blocklisting. - `merchant_avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `additional_authentication_status` string — The status of the additional authentication performed (3ds) by the user for this transaction. - `pin_status` string — Status checking the provided PIN. - `mastercard_action_report` MasterCardActionReport - `mastercard_action_id` integer — The id of mastercard action being reported. - `type` string — The id of mastercard action being reported. - `status` string — The id of mastercard action being reported. - `merchant_id` string — The reported merchant. - `merchant_name` string — The name of the merchant. - `counterparty_alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `merchant_category_code` string — The MCC provided. - `company_employee_card_receipt` CompanyEmployeeCardReceipt - `status` string — The status of the receipt. - `Payment` Payment - `amount` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `counterparty_alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `description` string — The description for the Payment. Maximum 140 characters for Payments to external IBANs, 9000 characters for Payments to only other bunq MonetaryAccounts. - `attachment` AttachmentMonetaryAccountPayment[] — The Attachments attached to the Payment. - `id` integer — The id of the attached Attachment. - `monetary_account_id` integer — The id of the MonetaryAccount this Attachment is attached from. - `merchant_reference` string — Optional data included with the Payment specific to the merchant. - `allow_bunqto` boolean — Whether or not sending a bunq.to payment is allowed. - `id` integer — The id of the created Payment. - `created` string — The timestamp when the Payment was done. - `updated` string — The timestamp when the Payment was last updated (will be updated when chat messages are received). - `monetary_account_id` integer — The id of the MonetaryAccount the Payment was made to or from (depending on whether this is an incoming or outgoing Payment). - `alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `type` string — The type of Payment, can be BUNQ, EBA_SCT, EBA_SDD, IDEAL, SWIFT or FIS (card). - `sub_type` string — The sub-type of the Payment, can be PAYMENT, WITHDRAWAL, REVERSAL, REQUEST, BILLING, SCT, SDD or NLO. - `payment_arrival_expected` PaymentArrivalExpected - `status` string — Indicates when we expect the payment to arrive. - `time` string — The time when the payment is expected to arrive. - `bunqto_status` string — The status of the bunq.to payment. - `bunqto_sub_status` string — The sub status of the bunq.to payment. - `bunqto_share_url` string — The status of the bunq.to payment. - `bunqto_expiry` string — When bunq.to payment is about to expire. - `bunqto_time_responded` string — The timestamp of when the bunq.to payment was responded to. - `batch_id` integer — The id of the PaymentBatch if this Payment was part of one. - `scheduled_id` integer — The id of the JobScheduled if the Payment was scheduled. - `address_shipping` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `address_billing` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `geolocation` Geolocation - `latitude` integer — The latitude for a geolocation restriction. - `longitude` integer — The longitude for a geolocation restriction. - `altitude` integer — The altitude for a geolocation restriction. - `radius` integer — The radius for a geolocation restriction. - `request_reference_split_the_bill` RequestInquiryReference[] — The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch - `type` string — The type of request inquiry. Can be RequestInquiry or RequestInquiryBatch. - `id` integer — The id of the request inquiry (batch). - `balance_after_mutation` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `payment_auto_allocate_instance` PaymentAutoAllocateInstance - `id` integer — The id of the PaymentAutoAllocateInstance. - `created` string — The timestamp when the PaymentAutoAllocateInstance was created. - `updated` string — The timestamp when the PaymentAutoAllocateInstance was last updated. - `payment_auto_allocate_id` integer — The ID of the payment auto allocate this instance belongs to. - `status` string — The status of the payment auto allocate instance. SUCCEEDED or FAILED. - `error_message` Error[] — The error message, if the payment auto allocating failed. - object[] - `error_description` string — The error description in English. - `error_description_translated` string — The error description translated to the user's language. - `payment_batch` PaymentBatch - `payments` PaymentBatchAnchoredPayment - `Payment` Payment[] - `payment_id` integer — The ID of the payment that triggered the allocating of the payments. - `all_ginmon_transaction_order` GinmonTransaction[] — All Ginmon transaction orders executed with this instance. - `status` string — The status of the transaction. - `status_description` string — The status of the transaction. - `status_description_translated` string — The translated status of the transaction. - `amount_billing` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `amount_billing_original` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `isin` string — The ISIN of the security. - `external_identifier` string — External identifier of this order at Ginmon. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - … - `public_nick_name` string — The current nickname of the user. - `label_monetary_account` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - … - `label_user` LabelUser - … - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - … - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `counter_label_monetary_account` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - … - `label_user` LabelUser - … - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - … - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `event_id` integer — The id of the event of transaction. - `payment_suspended_outgoing` PaymentSuspendedOutgoing - `status` string — The status of the payment. - `monetary_account_id` string — The ID of the monetary account the payment was sent from. - `time_execution` string — The time this payment should be executed. - `payment_fee` PaymentFee - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `invoice_id` integer — The id of the invoice related to possible payment fee. - `PaymentBatch` PaymentBatch - `payments` PaymentBatchAnchoredPayment - `Payment` Payment[] - `amount` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `counterparty_alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - … - `label_user` LabelUser - … - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - … - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `description` string — The description for the Payment. Maximum 140 characters for Payments to external IBANs, 9000 characters for Payments to only other bunq MonetaryAccounts. - `attachment` AttachmentMonetaryAccountPayment[] — The Attachments attached to the Payment. - `id` integer — The id of the attached Attachment. - `monetary_account_id` integer — The id of the MonetaryAccount this Attachment is attached from. - `merchant_reference` string — Optional data included with the Payment specific to the merchant. - `allow_bunqto` boolean — Whether or not sending a bunq.to payment is allowed. - `id` integer — The id of the created Payment. - `created` string — The timestamp when the Payment was done. - `updated` string — The timestamp when the Payment was last updated (will be updated when chat messages are received). - `monetary_account_id` integer — The id of the MonetaryAccount the Payment was made to or from (depending on whether this is an incoming or outgoing Payment). - `alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - … - `label_user` LabelUser - … - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - … - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `type` string — The type of Payment, can be BUNQ, EBA_SCT, EBA_SDD, IDEAL, SWIFT or FIS (card). - `sub_type` string — The sub-type of the Payment, can be PAYMENT, WITHDRAWAL, REVERSAL, REQUEST, BILLING, SCT, SDD or NLO. - `payment_arrival_expected` PaymentArrivalExpected - `status` string — Indicates when we expect the payment to arrive. - `time` string — The time when the payment is expected to arrive. - `bunqto_status` string — The status of the bunq.to payment. - `bunqto_sub_status` string — The sub status of the bunq.to payment. - `bunqto_share_url` string — The status of the bunq.to payment. - `bunqto_expiry` string — When bunq.to payment is about to expire. - `bunqto_time_responded` string — The timestamp of when the bunq.to payment was responded to. - `batch_id` integer — The id of the PaymentBatch if this Payment was part of one. - `scheduled_id` integer — The id of the JobScheduled if the Payment was scheduled. - `address_shipping` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `address_billing` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `geolocation` Geolocation - `latitude` integer — The latitude for a geolocation restriction. - `longitude` integer — The longitude for a geolocation restriction. - `altitude` integer — The altitude for a geolocation restriction. - `radius` integer — The radius for a geolocation restriction. - `request_reference_split_the_bill` RequestInquiryReference[] — The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch - `type` string — The type of request inquiry. Can be RequestInquiry or RequestInquiryBatch. - `id` integer — The id of the request inquiry (batch). - `balance_after_mutation` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `payment_auto_allocate_instance` PaymentAutoAllocateInstance - `id` integer — The id of the PaymentAutoAllocateInstance. - `created` string — The timestamp when the PaymentAutoAllocateInstance was created. - `updated` string — The timestamp when the PaymentAutoAllocateInstance was last updated. - `payment_auto_allocate_id` integer — The ID of the payment auto allocate this instance belongs to. - `status` string — The status of the payment auto allocate instance. SUCCEEDED or FAILED. - `error_message` Error[] — The error message, if the payment auto allocating failed. - … - `payment_batch` PaymentBatch — recursive - `payment_id` integer — The ID of the payment that triggered the allocating of the payments. - `all_ginmon_transaction_order` GinmonTransaction[] — All Ginmon transaction orders executed with this instance. - … - `payment_suspended_outgoing` PaymentSuspendedOutgoing - `status` string — The status of the payment. - `monetary_account_id` string — The ID of the monetary account the payment was sent from. - `time_execution` string — The time this payment should be executed. - `payment_fee` PaymentFee - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `invoice_id` integer — The id of the invoice related to possible payment fee. - `RequestResponse` RequestResponse - `amount_responded` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `status` string — The status of the RequestResponse. Can be ACCEPTED, PENDING, REJECTED, REFUND_REQUESTED, REFUNDED or REVOKED. - `address_shipping` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `address_billing` Address - `street` string — The street. - `house_number` string — The house number. - `po_box` string — The PO box. - `postal_code` string — The postal code. - `city` string — The city. - `country` string — The country as an ISO 3166-1 alpha-2 country code. - `extra` string — The apartment, building or other extra information for addresses. - `mailbox_name` string — The name on the mailbox (only used for Postal and Shipping addresses). - `province` string — The province according to local standard. - `is_user_address_updated` boolean — To show whether user created or updated her address for app event listing. - `currency_conversion_quote_id` integer — When the request is accepted on a monetary account with a different currency, a quote is expected to convert. - `id` integer — The id of the Request Response. - `created` string — The timestamp when the Request Response was created. - `updated` string — The timestamp when the Request Response was last updated (will be updated when chat messages are received). - `time_responded` string — The timestamp of when the RequestResponse was responded to. - `time_expiry` string — The timestamp of when the RequestResponse expired or will expire. - `time_refund_requested` string — The timestamp of when a refund request for the RequestResponse was claimed. - `time_refunded` string — The timestamp of when the RequestResponse was refunded. - `user_refund_requested` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `monetary_account_id` integer — The id of the MonetaryAccount the RequestResponse was received on. - `amount_inquired` Amount - `value` string — The amount formatted to two decimal places. - `currency` string — The currency of the amount. It is an ISO 4217 formatted currency code. - `description` string — The description for the RequestResponse provided by the requesting party. Maximum 9000 characters. - `alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `counterparty_alias` LabelMonetaryAccount - `iban` string — The IBAN of the monetary account. - `display_name` string — The name to display with this monetary account. - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - `attachment_public_uuid` string — The public UUID of the public attachment containing the image. - `content_type` string — The content-type as a MIME filetype. - `height` integer — The image height in pixels. - `width` integer — The image width in pixels. - `style` string — The style (if applicable) for this Avatar. - `label_user` LabelUser - `uuid` string — The public UUID of the label-user. - `display_name` string — The name to be displayed for this user, as it was given on the request. - `country` string — The country of the user. 000 stands for "unknown" - `avatar` Avatar - `uuid` string — The public UUID of the avatar. - `anchor_uuid` string — The public UUID of object this avatar is anchored to. - `image` Image[] — The actual image information of this avatar. - … - `style` string — The style (if applicable) for this Avatar. - `public_nick_name` string — The current nickname of the user. - `country` string — The country of the user. Formatted as a ISO 3166-1 alpha-2 country code. - `bunq_me` Pointer - `type` string — The alias type, can be: EMAIL|PHONE_NUMBER|IBAN. - `value` string — The alias value. - `name` string — The alias name. - `service` string — The pointer service. Only required for external counterparties. - `is_light` boolean — Whether or not the monetary account is light. - `swift_bic` string — The BIC used for a SWIFT payment. - `swift_account_number` string — The account number used for a SWIFT payment. May or may not be an IBAN. - `transferwise_account_number` string — The account number used for a Transferwise payment. May or may not be an IBAN. - `transferwise_bank_code` string — The bank code used for a Transferwise payment. May or may not be a BIC. - `merchant_category_code` string — The merchant category code. - `attachment` Attachment[] — The Attachments attached to the RequestResponse. - `description` string — The description of the attachment. - `content_type` string — The content type of the attachment's file. - `urls` AttachmentUrl[] — The URLs where the file can be downloaded. - `type` string — The file type of attachment. - `url` string — The URL where the attachment can be downloaded. - `minimum_age` integer — The minimum age the user accepting the RequestResponse must have. - `require_address` string — Whether or not an address must be provided on accept. - `geolocation` Geolocation - … truncated; see the full OpenAPI document linked below ## Response `200` RequestInquiry, aka 'RFP' (Request for Payment), is one of the innovative features that bunq offers. To request payment from another bunq account a new Request Inquiry is created. As with payments you can add attachments to a RFP. Requests for Payment are the foundation for a number of consumer features like 'Split the bill' and 'Request forwarding'. We invite you to invent your own based on the bunq api! - RequestInquiryCreate - `id` integer — The id of the created RequestInquiry. ## Other responses - `400` — This is how the error response looks like for 4XX response codes --- [API](https://skmtc.net/bunq/apis/bunq-api.md) · [All operations](https://skmtc.net/bunq/apis/bunq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bunq/bunq-api/revisions/369477c7bd26/schema)