--- title: "POST /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch" method: POST path: "/user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch" tags: ["schedule-payment-batch"] --- # POST /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch `POST /user/{userID}/monetary-account/{monetary-accountID}/schedule-payment-batch` Endpoint for schedule payment batches. ## 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 - SchedulePaymentBatch - `payments` SchedulePaymentEntry[] — The payment details. - `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. - `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 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. - `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. - `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 - `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 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. - … - `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 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[] - … - `payment_batch` PaymentBatch - `payments` PaymentBatchAnchoredPayment - … - `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 - … - `amount_billing_original` Amount - … - `isin` string — The ISIN of the security. - `external_identifier` string — External identifier of this order at Ginmon. - `label_user` LabelUser - … - `label_monetary_account` LabelMonetaryAccount - … - `counter_label_monetary_account` LabelMonetaryAccount - … - `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 - … - `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 - … ## Response `200` Endpoint for schedule payment batches. - SchedulePaymentBatchCreate - `Id` BunqId - `id` integer — An integer ID of an object. Unique per object type. ## 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/versions/369477c7bd26/schema)