--- title: "POST /user/{userID}/monetary-account-external" method: POST path: "/user/{userID}/monetary-account-external" tags: ["monetary-account-external"] --- # POST /user/{userID}/monetary-account-external `POST /user/{userID}/monetary-account-external` Endpoint for managing monetary accounts which are connected to external services. ## Path parameters - `userID` 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 - MonetaryAccountExternal - `currency` string — The currency of the MonetaryAccountExternal as an ISO 4217 formatted currency code. - `service` string — The external service the Monetary Account is connected with. - `description` string — The description of the MonetaryAccountExternal. Defaults to 'bunq account'. - `daily_limit` 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. - `avatar_uuid` string — The UUID of the Avatar of the MonetaryAccountExternal. - `status` string — The status of the MonetaryAccountExternal. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN - `sub_status` string — The sub-status of the MonetaryAccountExternal providing extra information regarding the status. Will be NONE for ACTIVE or PENDING_REOPEN, COMPLETELY or ONLY_ACCEPTING_INCOMING for BLOCKED and REDEMPTION_INVOLUNTARY, REDEMPTION_VOLUNTARY or PERMANENT for CANCELLED. - `reason` string — The reason for voluntarily cancelling (closing) the MonetaryAccountExternal, can only be OTHER. - `reason_description` string — The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountExternal. Can be any user provided message. - `display_name` string — The legal name of the user / company using this monetary account. - `setting` MonetaryAccountSetting - `color` string — The color chosen for the MonetaryAccount. - `icon` string — The icon chosen for the MonetaryAccount. - `default_avatar_status` string — The status of the avatar. Can be either AVATAR_DEFAULT, AVATAR_CUSTOM or AVATAR_UNDETERMINED. - `restriction_chat` string — The chat restriction. Possible values are ALLOW_INCOMING or BLOCK_INCOMING - `sdd_expiration_action` string — The preference for this monetary account on whether to automatically accept or reject expiring SDDs. - `id` integer — The id of the MonetaryAccountExternal. - `created` string — The timestamp of the MonetaryAccountExternal's creation. - `updated` string — The timestamp of the MonetaryAccountExternal's last update. - `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. - `overdraft_limit` 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. - `balance` 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` Pointer[] — The Aliases for the MonetaryAccountExternal. - `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. - `public_uuid` string — The MonetaryAccountExternal's public UUID. - `user_id` integer — The id of the User who owns the MonetaryAccountExternal. - `monetary_account_profile` MonetaryAccountProfile - `profile_fill` MonetaryAccountProfileFill - `status` string — The status of the profile. - `balance_preferred` 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. - `balance_threshold_low` 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. - `issuer` Issuer - `bic` string — The BIC code. - `name` string — The name of the bank. - `profile_drain` MonetaryAccountProfileDrain - `status` string — The status of the profile. - `balance_preferred` 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. - `balance_threshold_high` 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. - `savings_account_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. - `all_auto_save_id` BunqId[] — The ids of the AutoSave. - `id` integer — An integer ID of an object. Unique per object type. - `open_banking_account` OpenBankingAccount - `status` string — The status of this account. - `iban` string — The iban of this account. - `time_synced_last` string — The timestamp of the last time the account was synced with our open banking partner. - `provider_bank` OpenBankingProviderBank - `account_information_service_status` string — Whether we support Open Banking budgeting using the bank provider. - `payment_information_service_status` string — Whether we support top ups using the bank provider. - `name` string — The name of the bank provider. - `aiia_provider_id` string — The external identifier for this bank. - `country` string — Country of provider - `all_payment_method_allowed_sepa` string[] — All payment methods allowed for Sepa payments. - `all_payment_method_allowed_domestic` string[] — All payment methods allowed for Domestic payments. - `audience_business_status` boolean — Whether business banking is supported by the provider. - `audience_private_status` boolean — Whether personal banking is supported by the provider. - `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. - `balance_booked` 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. - `balance_available` 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. ## Response `200` Endpoint for managing monetary accounts which are connected to external services. - MonetaryAccountExternalCreate - `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)