bunq API
*UPDATE:* *We have released a [beta version of the new bunq API documentation.](https://beta.doc.bunq.com)* *NOTICE:* *We have updated the sandbox base url to…
Finance & banking#openapi#financial
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
*UPDATE:* We have released a beta version of the new bunq API documentation.
*NOTICE:* We have updated the sandbox base url to https://public-api.sandbox.bunq.com/v1/. Please update your applications accordingly. Check here: for more info.
*PSD2 NOTICE:* The second Payment Services Directive (PSD2) may affect your current or planned usage of our public API, as some of the API services are now subject to a permit. Please be aware that using our public API without the required PSD2 permit is at your own risk and take notice of our updated API Terms and Conditions on for more information.
Introduction
Welcome to bunq!
- The bunq API is organised around REST. JSON will be returned in almost all responses from the API, including errors but excluding binary (image) files.
- Please configure your implementation to send its API requests to
https://public-api.sandbox.bunq.com/v1/ - There is a version of the Android app that connects to the bunq Sandbox environment. To create accounts for the Sandbox app, please follow the steps in the Android Emulator section.
Getting started
Before you start sending API requests, you need to get an API key and activate it. API activation happens when you install the API key and link your IP address and device to it (create an API context). The steps below will guide you through what you need to do to start sending custom API requests.
Here is an overview of what you can use to get started with the bunq API:
- Create an API key. You can do it either in our developer portal or in the bunq app (Profile → Security & Settings → Developers → API keys). If you want to test our sandbox first, our bunq Developer is the best place to start.
- Register a device. A device can be a phone (private), computer or a server (public). You can register a new device by using the
POST /installationandPOST /device-servercalls. This will activate your API key. You only need to do this once. - Open a session. Sessions are temporary and expire after the auto-logout time set for the user account. It can be changed by the account owner in the bunq app.
- Make your first call!
Versioning
Developments in the financial sector, changing regulatory regimes and new feature requests require us to be flexible. This means we can iterate quickly to improve the API and related tooling. Therefore, we have chosen not to attach any version numbers to the changes just yet.
We will inform you in a timely manner of any important changes we make before they are deployed on together.bunq.com. You can also subscribe to our API newsletter to make sure you don't miss any important updates.
OAuth
What is OAuth?
OAuth 2.0 is a protocol that will let your app connect to bunq users in a safe and easy way. Please be aware that if you will gain access to the account information of other bunq users or initiate a payment for them, you may require a PSD2 permit.
Get started with OAuth for bunq
To initiate authorization into the bunq user accounts, you need to create an OAuth Client and register at least 1 redirect URL for it.
You can have 1 OAuth Client at a time. Reuse your OAuth credentials for every authorization request.
The list of steps below will help you to get started:
- Register an OAuth Client by creating an app in bunq Developer_._
- Add one or more Redirect URLs.
- Get your
client_idandsecretfrom your app information tab in bunq Developer. - Redirect your users to the OAuth authorization request URL.
- If the user accepts the authorization request, they will be redirected to the previously specified
redirect_uriwith an authorizationcodeparameter. - Use the token endpoint to exchange the authorization
codefor anaccess_token. - Use the
access_tokenas a normal API Key. Open a session or use our SDKs to get started.
You can set up an OAuth Client and add redirect URLs to it using the dedicated endpoints too. Follow the flow below to do it programmatically.
ℹ️ As a PSD2 user, you cannot log in to the bunq app. You need to follow the flow below to register an OAuth Client for your application.
What can my apps do with OAuth?
We decided to launch OAuth with a default permission that allows you to perform the following actions:
- read and create Monetary Accounts;
- read Payments & Transactions;
- create Payments between…
Endpoints 400
attachment
- GETREAD_Attachment_for_User
/user/:userID/attachment/:itemIdGet a specific attachment. The header of the response contains the content-type of the attachment. - POSTCREATE_Attachment_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/attachmentCreate a new monetary account attachment. Create a POST request with a payload that contains the binary representation of the file, without any JSON wrapping.…
attachment-public
- POSTCREATE_AttachmentPublic
/attachment-publicCreate a new public attachment. Create a POST request with a payload that contains a binary representation of the file, without any JSON wrapping. Make sure… - GETREAD_AttachmentPublic
/attachment-public/:itemIdGet a specific attachment's metadata through its UUID. The Content-Type header of the response will describe the MIME type of the attachment file.
avatar
- POSTCREATE_Avatar
/avatarAvatars are public images used to represent you or your company. Avatars are used to represent users, monetary accounts and cash registers. Avatars cannot be… - GETREAD_Avatar
/avatar/:itemIdAvatars are public images used to represent you or your company. Avatars are used to represent users, monetary accounts and cash registers. Avatars cannot be…
billing-contract-subscription
- GETList_all_BillingContractSubscription_for_User
/user/:userID/billing-contract-subscriptionGet all subscription billing contract for the authenticated user.
bunqme-fundraiser-profile
- GETList_all_BunqmeFundraiserProfile_for_User
/user/:userID/bunqme-fundraiser-profilebunq.me public profile of the user. - GETREAD_BunqmeFundraiserProfile_for_User
/user/:userID/bunqme-fundraiser-profile/:itemIdbunq.me public profile of the user.
bunqme-fundraiser-result
- GETREAD_BunqmeFundraiserResult_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/bunqme-fundraiser-result/:itemIdbunq.me fundraiser result containing all payments.
bunqme-tab
- GETList_all_BunqmeTab_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/bunqme-tabbunq.me tabs allows you to create a payment request and share the link through e-mail, chat, etc. Multiple persons are able to respond to the payment request… - POSTCREATE_BunqmeTab_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/bunqme-tabbunq.me tabs allows you to create a payment request and share the link through e-mail, chat, etc. Multiple persons are able to respond to the payment request… - GETREAD_BunqmeTab_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/bunqme-tab/:itemIdbunq.me tabs allows you to create a payment request and share the link through e-mail, chat, etc. Multiple persons are able to respond to the payment request… - PUTUPDATE_BunqmeTab_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/bunqme-tab/:itemIdbunq.me tabs allows you to create a payment request and share the link through e-mail, chat, etc. Multiple persons are able to respond to the payment request…
bunqme-tab-result-response
- GETREAD_BunqmeTabResultResponse_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/bunqme-tab-result-response/:itemIdUsed to view bunq.me TabResultResponse objects belonging to a tab. A TabResultResponse is an object that holds details on a tab which has been paid from the…
callback-url
- GETList_all_CallbackUrl_for_User_OauthClient
/user/:userID/oauth-client/:oauth-clientID/callback-urlUsed for managing OAuth Client Callback URLs. - POSTCREATE_CallbackUrl_for_User_OauthClient
/user/:userID/oauth-client/:oauth-clientID/callback-urlUsed for managing OAuth Client Callback URLs. - GETREAD_CallbackUrl_for_User_OauthClient
/user/:userID/oauth-client/:oauth-clientID/callback-url/:itemIdUsed for managing OAuth Client Callback URLs. - PUTUPDATE_CallbackUrl_for_User_OauthClient
/user/:userID/oauth-client/:oauth-clientID/callback-url/:itemIdUsed for managing OAuth Client Callback URLs. - DELETEDELETE_CallbackUrl_for_User_OauthClient
/user/:userID/oauth-client/:oauth-clientID/callback-url/:itemIdUsed for managing OAuth Client Callback URLs.
card
- GETList_all_Card_for_User
/user/:userID/cardReturn all the cards available to the user. - GETREAD_Card_for_User
/user/:userID/card/:itemIdReturn the details of a specific card. - PUTUPDATE_Card_for_User
/user/:userID/card/:itemIdUpdate the card details. Allow to change pin code, status, limits, country permissions and the monetary account connected to the card. When the card has been…
card-batch
- POSTCREATE_CardBatch_for_User
/user/:userID/card-batchUsed to update multiple cards in a batch.
card-batch-replace
- POSTCREATE_CardBatchReplace_for_User
/user/:userID/card-batch-replaceUsed to replace multiple cards in a batch.
card-credit
- POSTCREATE_CardCredit_for_User
/user/:userID/card-creditCreate a new credit card request.
card-debit
- POSTCREATE_CardDebit_for_User
/user/:userID/card-debitCreate a new debit card request.
card-name
- GETList_all_CardName_for_User
/user/:userID/card-nameReturn all the accepted card names for a specific user.
certificate-pinned
- GETList_all_CertificatePinned_for_User
/user/:userID/certificate-pinnedList all the pinned certificate chain for the given user. - POSTCREATE_CertificatePinned_for_User
/user/:userID/certificate-pinnedPin the certificate chain. - GETREAD_CertificatePinned_for_User
/user/:userID/certificate-pinned/:itemIdGet the pinned certificate chain with the specified ID. - DELETEDELETE_CertificatePinned_for_User
/user/:userID/certificate-pinned/:itemIdRemove the pinned certificate chain with the specific ID.
challenge-request
- GETREAD_ChallengeRequest_for_User
/user/:userID/challenge-request/:itemIdEndpoint for apps to fetch a challenge request. - PUTUPDATE_ChallengeRequest_for_User
/user/:userID/challenge-request/:itemIdEndpoint for apps to fetch a challenge request.
company
- GETList_all_Company_for_User
/user/:userID/companyCreate and manage companies. - POSTCREATE_Company_for_User
/user/:userID/companyCreate and manage companies. - GETREAD_Company_for_User
/user/:userID/company/:itemIdCreate and manage companies. - PUTUPDATE_Company_for_User
/user/:userID/company/:itemIdCreate and manage companies.
confirmation-of-funds
- POSTCREATE_ConfirmationOfFunds_for_User
/user/:userID/confirmation-of-fundsUsed to confirm availability of funds on an account.
content
- GETList_all_Content_for_AttachmentPublic
/attachment-public/:attachment-publicUUID/contentGet the raw content of a specific attachment. - GETList_all_Content_for_PlaceLookup_Photo
/place-lookup/:place-lookupID/photo/:photoID/contentView endpoint for place opening periods. - GETList_all_Content_for_User_Attachment
/user/:userID/attachment/:attachmentID/contentGet the raw content of a specific attachment. - GETList_all_Content_for_User_Card_ExportStatementCard
/user/:userID/card/:cardID/export-statement-card/:export-statement-cardID/contentFetch the raw content of a card statement export. The returned file format could be CSV or PDF depending on the statement format specified during the… - GETList_all_Content_for_User_ChatConversation_Attachment
/user/:userID/chat-conversation/:chat-conversationID/attachment/:attachmentID/contentGet the raw content of a specific attachment. - GETList_all_Content_for_User_ExportAnnualOverview
/user/:userID/export-annual-overview/:export-annual-overviewID/contentUsed to retrieve the raw content of an annual overview. - GETList_all_Content_for_User_MonetaryAccount_Attachment
/user/:userID/monetary-account/:monetary-accountID/attachment/:attachmentID/contentGet the raw content of a specific attachment. - GETList_all_Content_for_User_MonetaryAccount_CustomerStatement
/user/:userID/monetary-account/:monetary-accountID/customer-statement/:customer-statementID/contentFetch the raw content of a statement export. The returned file format could be MT940, CSV or PDF depending on the statement format specified during the… - GETList_all_Content_for_User_MonetaryAccount_Event_Statement
/user/:userID/monetary-account/:monetary-accountID/event/:eventID/statement/:statementID/contentFetch the raw content of a payment statement export. - GETList_all_Content_for_User_MonetaryAccount_ExportRib
/user/:userID/monetary-account/:monetary-accountID/export-rib/:export-ribID/contentUsed to retrieve the raw content of an RIB.
credential-password-ip
- GETList_all_CredentialPasswordIp_for_User
/user/:userID/credential-password-ipCreate a credential of a user for server authentication, or delete the credential of a user for server authentication. - GETREAD_CredentialPasswordIp_for_User
/user/:userID/credential-password-ip/:itemIdCreate a credential of a user for server authentication, or delete the credential of a user for server authentication.
currency-cloud-beneficiary
- GETList_all_CurrencyCloudBeneficiary_for_User
/user/:userID/currency-cloud-beneficiaryEndpoint to manage CurrencyCloud beneficiaries. - POSTCREATE_CurrencyCloudBeneficiary_for_User
/user/:userID/currency-cloud-beneficiaryEndpoint to manage CurrencyCloud beneficiaries. - GETREAD_CurrencyCloudBeneficiary_for_User
/user/:userID/currency-cloud-beneficiary/:itemIdEndpoint to manage CurrencyCloud beneficiaries.
currency-cloud-beneficiary-requirement
- GETList_all_CurrencyCloudBeneficiaryRequirement_for_User
/user/:userID/currency-cloud-beneficiary-requirementEndpoint to list requirements for CurrencyCloud beneficiaries.
currency-cloud-payment-quote
- POSTCREATE_CurrencyCloudPaymentQuote_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/currency-cloud-payment-quoteEndpoint for managing currency conversions.
currency-conversion
- GETList_all_CurrencyConversion_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/currency-conversionEndpoint for managing currency conversions. - GETREAD_CurrencyConversion_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/currency-conversion/:itemIdEndpoint for managing currency conversions.
currency-conversion-quote
- POSTCREATE_CurrencyConversionQuote_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/currency-conversion-quoteEndpoint to create a quote for currency conversions. - GETREAD_CurrencyConversionQuote_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/currency-conversion-quote/:itemIdEndpoint to create a quote for currency conversions. - PUTUPDATE_CurrencyConversionQuote_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/currency-conversion-quote/:itemIdEndpoint to create a quote for currency conversions.
customer-statement
- GETList_all_CustomerStatement_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/customer-statementUsed to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format. - POSTCREATE_CustomerStatement_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/customer-statementUsed to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format. - GETREAD_CustomerStatement_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/customer-statement/:itemIdUsed to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format. - DELETEDELETE_CustomerStatement_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/customer-statement/:itemIdUsed to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.
definition
- GETList_all_Definition_for_User_MonetaryAccount_PaymentAutoAllocate
/user/:userID/monetary-account/:monetary-accountID/payment-auto-allocate/:payment-auto-allocateID/definitionList all the definitions in a payment auto allocate.
device
- GETList_all_Device
/deviceGet a collection of Devices. A Device is either a DevicePhone or a DeviceServer. - GETREAD_Device
/device/:itemIdGet a single Device. A Device is either a DevicePhone or a DeviceServer.
device-server
- GETList_all_DeviceServer
/device-serverGet a collection of all the DeviceServers you have created. - POSTCREATE_DeviceServer
/device-serverCreate a new DeviceServer providing the installation token in the header and signing the request with the private part of the key you used to create the… - GETREAD_DeviceServer
/device-server/:itemIdGet one of your DeviceServers.
draft-payment
- GETList_all_DraftPayment_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/draft-paymentGet a listing of all DraftPayments from a given MonetaryAccount. - POSTCREATE_DraftPayment_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/draft-paymentCreate a new DraftPayment. - GETREAD_DraftPayment_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/draft-payment/:itemIdGet a specific DraftPayment. - PUTUPDATE_DraftPayment_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/draft-payment/:itemIdUpdate a DraftPayment.
event
- GETList_all_Event_for_User
/user/:userID/eventGet a collection of events for a given user. You can add query the parameters monetary_account_id, status and/or display_user_event to filter the response.… - GETREAD_Event_for_User
/user/:userID/event/:itemIdGet a specific event for a given user.
export-annual-overview
- GETList_all_ExportAnnualOverview_for_User
/user/:userID/export-annual-overviewList all the annual overviews for a user. - POSTCREATE_ExportAnnualOverview_for_User
/user/:userID/export-annual-overviewCreate a new annual overview for a specific year. An overview can be generated only for a past year. - GETREAD_ExportAnnualOverview_for_User
/user/:userID/export-annual-overview/:itemIdGet an annual overview for a user by its id. - DELETEDELETE_ExportAnnualOverview_for_User
/user/:userID/export-annual-overview/:itemIdUsed to create new and read existing annual overviews of all the user's monetary accounts. Once created, annual overviews can be downloaded in PDF format via…
export-rib
- GETList_all_ExportRib_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/export-ribList all the RIBs for a monetary account. - POSTCREATE_ExportRib_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/export-ribCreate a new RIB. - GETREAD_ExportRib_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/export-rib/:itemIdGet a RIB for a monetary account by its id. - DELETEDELETE_ExportRib_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/export-rib/:itemIdUsed to create new and read existing RIBs of a monetary account
export-statement-card
- GETList_all_ExportStatementCard_for_User_Card
/user/:userID/card/:cardID/export-statement-cardUsed to create new and read existing card statement exports. Statement exports can be created in either CSV or PDF file format. - GETREAD_ExportStatementCard_for_User_Card
/user/:userID/card/:cardID/export-statement-card/:itemIdUsed to create new and read existing card statement exports. Statement exports can be created in either CSV or PDF file format.
export-statement-card-csv
- GETList_all_ExportStatementCardCsv_for_User_Card
/user/:userID/card/:cardID/export-statement-card-csvUsed to serialize ExportStatementCardCsv - POSTCREATE_ExportStatementCardCsv_for_User_Card
/user/:userID/card/:cardID/export-statement-card-csvUsed to serialize ExportStatementCardCsv - GETREAD_ExportStatementCardCsv_for_User_Card
/user/:userID/card/:cardID/export-statement-card-csv/:itemIdUsed to serialize ExportStatementCardCsv - DELETEDELETE_ExportStatementCardCsv_for_User_Card
/user/:userID/card/:cardID/export-statement-card-csv/:itemIdUsed to serialize ExportStatementCardCsv
export-statement-card-pdf
- GETList_all_ExportStatementCardPdf_for_User_Card
/user/:userID/card/:cardID/export-statement-card-pdfUsed to serialize ExportStatementCardPdf - POSTCREATE_ExportStatementCardPdf_for_User_Card
/user/:userID/card/:cardID/export-statement-card-pdfUsed to serialize ExportStatementCardPdf - GETREAD_ExportStatementCardPdf_for_User_Card
/user/:userID/card/:cardID/export-statement-card-pdf/:itemIdUsed to serialize ExportStatementCardPdf - DELETEDELETE_ExportStatementCardPdf_for_User_Card
/user/:userID/card/:cardID/export-statement-card-pdf/:itemIdUsed to serialize ExportStatementCardPdf
feature-announcement
- GETREAD_FeatureAnnouncement_for_User
/user/:userID/feature-announcement/:itemIdview for updating the feature display.
generated-cvc2
- GETList_all_GeneratedCvc2_for_User_Card
/user/:userID/card/:cardID/generated-cvc2Get all generated CVC2 codes for a card. - POSTCREATE_GeneratedCvc2_for_User_Card
/user/:userID/card/:cardID/generated-cvc2Generate a new CVC2 code for a card. - GETREAD_GeneratedCvc2_for_User_Card
/user/:userID/card/:cardID/generated-cvc2/:itemIdGet the details for a specific generated CVC2 code. - PUTUPDATE_GeneratedCvc2_for_User_Card
/user/:userID/card/:cardID/generated-cvc2/:itemIdEndpoint for generating and retrieving a new CVC2 code.
ideal-merchant-transaction
- GETList_all_IdealMerchantTransaction_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/ideal-merchant-transactionView for requesting iDEAL transactions and polling their status. - POSTCREATE_IdealMerchantTransaction_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/ideal-merchant-transactionView for requesting iDEAL transactions and polling their status. - GETREAD_IdealMerchantTransaction_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/ideal-merchant-transaction/:itemIdView for requesting iDEAL transactions and polling their status.
insight-preference-date
- GETList_all_InsightPreferenceDate_for_User
/user/:userID/insight-preference-dateUsed to allow users to set insight/budget preferences.
insights
- GETList_all_Insights_for_User
/user/:userID/insightsUsed to get insights about transactions between given time range.
insights-search
- GETList_all_InsightsSearch_for_User
/user/:userID/insights-searchUsed to get events based on time and insight category.
installation
- GETList_all_Installation
/installationYou must have an active session to make this call. This call returns the Id of the the Installation you are using in your session. - POSTCREATE_Installation
/installationThis is the only API call that does not require you to use the "X-Bunq-Client-Authentication" and "X-Bunq-Client-Signature" headers. You provide the server… - GETREAD_Installation
/installation/:itemIdYou must have an active session to make this call. This call is used to check whether the Id you provide is the Id of your current installation or not.
instance
- GETList_all_Instance_for_User_MonetaryAccount_PaymentAutoAllocate
/user/:userID/monetary-account/:monetary-accountID/payment-auto-allocate/:payment-auto-allocateID/instanceList all the times a users payment was automatically allocated. - GETREAD_Instance_for_User_MonetaryAccount_PaymentAutoAllocate
/user/:userID/monetary-account/:monetary-accountID/payment-auto-allocate/:payment-auto-allocateID/instance/:itemIdList all the times a users payment was automatically allocated.
invoice
- GETList_all_Invoice_for_User
/user/:userID/invoiceUsed to list bunq invoices by user. - GETREAD_Invoice_for_User
/user/:userID/invoice/:itemIdUsed to list bunq invoices by user. - GETList_all_Invoice_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/invoiceUsed to view a bunq invoice. - GETREAD_Invoice_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/invoice/:itemIdUsed to view a bunq invoice.
ip
- GETList_all_Ip_for_User_CredentialPasswordIp
/user/:userID/credential-password-ip/:credential-password-ipID/ipManage the IPs which may be used for a credential of a user for server authentication. - POSTCREATE_Ip_for_User_CredentialPasswordIp
/user/:userID/credential-password-ip/:credential-password-ipID/ipManage the IPs which may be used for a credential of a user for server authentication. - GETREAD_Ip_for_User_CredentialPasswordIp
/user/:userID/credential-password-ip/:credential-password-ipID/ip/:itemIdManage the IPs which may be used for a credential of a user for server authentication. - PUTUPDATE_Ip_for_User_CredentialPasswordIp
/user/:userID/credential-password-ip/:credential-password-ipID/ip/:itemIdManage the IPs which may be used for a credential of a user for server authentication.
legal-name
- GETList_all_LegalName_for_User
/user/:userID/legal-nameEndpoint for getting available legal names that can be used by the user.
limit
- GETList_all_Limit_for_User
/user/:userID/limitGet all limits for the authenticated user.
mastercard-action
- GETList_all_MastercardAction_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/mastercard-actionMasterCard transaction view. - GETREAD_MastercardAction_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/mastercard-action/:itemIdMasterCard transaction view.
monetary-account
- GETList_all_MonetaryAccount_for_User
/user/:userID/monetary-accountGet a collection of all your MonetaryAccounts. - GETREAD_MonetaryAccount_for_User
/user/:userID/monetary-account/:itemIdGet a specific MonetaryAccount.
monetary-account-bank
- GETList_all_MonetaryAccountBank_for_User
/user/:userID/monetary-account-bankGets a listing of all MonetaryAccountBanks of a given user. - POSTCREATE_MonetaryAccountBank_for_User
/user/:userID/monetary-account-bankCreate new MonetaryAccountBank. - GETREAD_MonetaryAccountBank_for_User
/user/:userID/monetary-account-bank/:itemIdGet a specific MonetaryAccountBank. - PUTUPDATE_MonetaryAccountBank_for_User
/user/:userID/monetary-account-bank/:itemIdUpdate a specific existing MonetaryAccountBank.
monetary-account-external
- GETList_all_MonetaryAccountExternal_for_User
/user/:userID/monetary-account-externalEndpoint for managing monetary accounts which are connected to external services. - GETREAD_MonetaryAccountExternal_for_User
/user/:userID/monetary-account-external/:itemIdEndpoint for managing monetary accounts which are connected to external services.
monetary-account-joint
- GETList_all_MonetaryAccountJoint_for_User
/user/:userID/monetary-account-jointThe endpoint for joint monetary accounts. - POSTCREATE_MonetaryAccountJoint_for_User
/user/:userID/monetary-account-jointThe endpoint for joint monetary accounts. - GETREAD_MonetaryAccountJoint_for_User
/user/:userID/monetary-account-joint/:itemIdThe endpoint for joint monetary accounts. - PUTUPDATE_MonetaryAccountJoint_for_User
/user/:userID/monetary-account-joint/:itemIdThe endpoint for joint monetary accounts.
monetary-account-savings
- GETList_all_MonetaryAccountSavings_for_User
/user/:userID/monetary-account-savingsGets a listing of all MonetaryAccountSavingss of a given user. - POSTCREATE_MonetaryAccountSavings_for_User
/user/:userID/monetary-account-savingsCreate new MonetaryAccountSavings. - GETREAD_MonetaryAccountSavings_for_User
/user/:userID/monetary-account-savings/:itemIdGet a specific MonetaryAccountSavings. - PUTUPDATE_MonetaryAccountSavings_for_User
/user/:userID/monetary-account-savings/:itemIdUpdate a specific existing MonetaryAccountSavings.
name
- GETList_all_Name_for_UserCompany
/user-company/:user-companyID/nameReturn all the known (trade) names for a specific user company.
note-attachment
- GETList_all_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult
/user/:userID/monetary-account/:monetary-accountID/bunqme-fundraiser-result/:bunqme-fundraiser-resultID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult
/user/:userID/monetary-account/:monetary-accountID/bunqme-fundraiser-result/:bunqme-fundraiser-resultID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult
/user/:userID/monetary-account/:monetary-accountID/bunqme-fundraiser-result/:bunqme-fundraiser-resultID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult
/user/:userID/monetary-account/:monetary-accountID/bunqme-fundraiser-result/:bunqme-fundraiser-resultID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult
/user/:userID/monetary-account/:monetary-accountID/bunqme-fundraiser-result/:bunqme-fundraiser-resultID/note-attachment/:itemIdUsed to manage attachment notes. - GETList_all_NoteAttachment_for_User_MonetaryAccount_DraftPayment
/user/:userID/monetary-account/:monetary-accountID/draft-payment/:draft-paymentID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_DraftPayment
/user/:userID/monetary-account/:monetary-accountID/draft-payment/:draft-paymentID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_DraftPayment
/user/:userID/monetary-account/:monetary-accountID/draft-payment/:draft-paymentID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_DraftPayment
/user/:userID/monetary-account/:monetary-accountID/draft-payment/:draft-paymentID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_DraftPayment
/user/:userID/monetary-account/:monetary-accountID/draft-payment/:draft-paymentID/note-attachment/:itemIdUsed to manage attachment notes. - GETList_all_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/ideal-merchant-transaction/:ideal-merchant-transactionID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/ideal-merchant-transaction/:ideal-merchant-transactionID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/ideal-merchant-transaction/:ideal-merchant-transactionID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/ideal-merchant-transaction/:ideal-merchant-transactionID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/ideal-merchant-transaction/:ideal-merchant-transactionID/note-attachment/:itemIdUsed to manage attachment notes. - GETList_all_NoteAttachment_for_User_MonetaryAccount_MastercardAction
/user/:userID/monetary-account/:monetary-accountID/mastercard-action/:mastercard-actionID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_MastercardAction
/user/:userID/monetary-account/:monetary-accountID/mastercard-action/:mastercard-actionID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_MastercardAction
/user/:userID/monetary-account/:monetary-accountID/mastercard-action/:mastercard-actionID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_MastercardAction
/user/:userID/monetary-account/:monetary-accountID/mastercard-action/:mastercard-actionID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_MastercardAction
/user/:userID/monetary-account/:monetary-accountID/mastercard-action/:mastercard-actionID/note-attachment/:itemIdUsed to manage attachment notes. - GETList_all_NoteAttachment_for_User_MonetaryAccount_PaymentBatch
/user/:userID/monetary-account/:monetary-accountID/payment-batch/:payment-batchID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_PaymentBatch
/user/:userID/monetary-account/:monetary-accountID/payment-batch/:payment-batchID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_PaymentBatch
/user/:userID/monetary-account/:monetary-accountID/payment-batch/:payment-batchID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_PaymentBatch
/user/:userID/monetary-account/:monetary-accountID/payment-batch/:payment-batchID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_PaymentBatch
/user/:userID/monetary-account/:monetary-accountID/payment-batch/:payment-batchID/note-attachment/:itemIdUsed to manage attachment notes. - GETList_all_NoteAttachment_for_User_MonetaryAccount_Payment
/user/:userID/monetary-account/:monetary-accountID/payment/:paymentID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_Payment
/user/:userID/monetary-account/:monetary-accountID/payment/:paymentID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_Payment
/user/:userID/monetary-account/:monetary-accountID/payment/:paymentID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_Payment
/user/:userID/monetary-account/:monetary-accountID/payment/:paymentID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_Payment
/user/:userID/monetary-account/:monetary-accountID/payment/:paymentID/note-attachment/:itemIdUsed to manage attachment notes. - GETList_all_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch
/user/:userID/monetary-account/:monetary-accountID/request-inquiry-batch/:request-inquiry-batchID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch
/user/:userID/monetary-account/:monetary-accountID/request-inquiry-batch/:request-inquiry-batchID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch
/user/:userID/monetary-account/:monetary-accountID/request-inquiry-batch/:request-inquiry-batchID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch
/user/:userID/monetary-account/:monetary-accountID/request-inquiry-batch/:request-inquiry-batchID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch
/user/:userID/monetary-account/:monetary-accountID/request-inquiry-batch/:request-inquiry-batchID/note-attachment/:itemIdUsed to manage attachment notes. - GETList_all_NoteAttachment_for_User_MonetaryAccount_RequestInquiry
/user/:userID/monetary-account/:monetary-accountID/request-inquiry/:request-inquiryID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_RequestInquiry
/user/:userID/monetary-account/:monetary-accountID/request-inquiry/:request-inquiryID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_RequestInquiry
/user/:userID/monetary-account/:monetary-accountID/request-inquiry/:request-inquiryID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_RequestInquiry
/user/:userID/monetary-account/:monetary-accountID/request-inquiry/:request-inquiryID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_RequestInquiry
/user/:userID/monetary-account/:monetary-accountID/request-inquiry/:request-inquiryID/note-attachment/:itemIdUsed to manage attachment notes. - GETList_all_NoteAttachment_for_User_MonetaryAccount_RequestResponse
/user/:userID/monetary-account/:monetary-accountID/request-response/:request-responseID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_RequestResponse
/user/:userID/monetary-account/:monetary-accountID/request-response/:request-responseID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_RequestResponse
/user/:userID/monetary-account/:monetary-accountID/request-response/:request-responseID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_RequestResponse
/user/:userID/monetary-account/:monetary-accountID/request-response/:request-responseID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_RequestResponse
/user/:userID/monetary-account/:monetary-accountID/request-response/:request-responseID/note-attachment/:itemIdUsed to manage attachment notes. - GETList_all_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch
/user/:userID/monetary-account/:monetary-accountID/schedule-payment-batch/:schedule-payment-batchID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch
/user/:userID/monetary-account/:monetary-accountID/schedule-payment-batch/:schedule-payment-batchID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch
/user/:userID/monetary-account/:monetary-accountID/schedule-payment-batch/:schedule-payment-batchID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch
/user/:userID/monetary-account/:monetary-accountID/schedule-payment-batch/:schedule-payment-batchID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch
/user/:userID/monetary-account/:monetary-accountID/schedule-payment-batch/:schedule-payment-batchID/note-attachment/:itemIdUsed to manage attachment notes. - GETList_all_NoteAttachment_for_User_MonetaryAccount_SchedulePayment
/user/:userID/monetary-account/:monetary-accountID/schedule-payment/:schedule-paymentID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_SchedulePayment
/user/:userID/monetary-account/:monetary-accountID/schedule-payment/:schedule-paymentID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_SchedulePayment
/user/:userID/monetary-account/:monetary-accountID/schedule-payment/:schedule-paymentID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_SchedulePayment
/user/:userID/monetary-account/:monetary-accountID/schedule-payment/:schedule-paymentID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_SchedulePayment
/user/:userID/monetary-account/:monetary-accountID/schedule-payment/:schedule-paymentID/note-attachment/:itemIdUsed to manage attachment notes. - GETList_all_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance
/user/:userID/monetary-account/:monetary-accountID/schedule/:scheduleID/schedule-instance/:schedule-instanceID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance
/user/:userID/monetary-account/:monetary-accountID/schedule/:scheduleID/schedule-instance/:schedule-instanceID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance
/user/:userID/monetary-account/:monetary-accountID/schedule/:scheduleID/schedule-instance/:schedule-instanceID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance
/user/:userID/monetary-account/:monetary-accountID/schedule/:scheduleID/schedule-instance/:schedule-instanceID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance
/user/:userID/monetary-account/:monetary-accountID/schedule/:scheduleID/schedule-instance/:schedule-instanceID/note-attachment/:itemIdUsed to manage attachment notes. - GETList_all_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/sofort-merchant-transaction/:sofort-merchant-transactionID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/sofort-merchant-transaction/:sofort-merchant-transactionID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/sofort-merchant-transaction/:sofort-merchant-transactionID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/sofort-merchant-transaction/:sofort-merchant-transactionID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/sofort-merchant-transaction/:sofort-merchant-transactionID/note-attachment/:itemIdUsed to manage attachment notes. - GETList_all_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment
/user/:userID/monetary-account/:monetary-accountID/switch-service-payment/:switch-service-paymentID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment
/user/:userID/monetary-account/:monetary-accountID/switch-service-payment/:switch-service-paymentID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment
/user/:userID/monetary-account/:monetary-accountID/switch-service-payment/:switch-service-paymentID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment
/user/:userID/monetary-account/:monetary-accountID/switch-service-payment/:switch-service-paymentID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment
/user/:userID/monetary-account/:monetary-accountID/switch-service-payment/:switch-service-paymentID/note-attachment/:itemIdUsed to manage attachment notes. - GETList_all_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult
/user/:userID/monetary-account/:monetary-accountID/whitelist/:whitelistID/whitelist-result/:whitelist-resultID/note-attachmentManage the notes for a given user. - POSTCREATE_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult
/user/:userID/monetary-account/:monetary-accountID/whitelist/:whitelistID/whitelist-result/:whitelist-resultID/note-attachmentUsed to manage attachment notes. - GETREAD_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult
/user/:userID/monetary-account/:monetary-accountID/whitelist/:whitelistID/whitelist-result/:whitelist-resultID/note-attachment/:itemIdUsed to manage attachment notes. - PUTUPDATE_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult
/user/:userID/monetary-account/:monetary-accountID/whitelist/:whitelistID/whitelist-result/:whitelist-resultID/note-attachment/:itemIdUsed to manage attachment notes. - DELETEDELETE_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult
/user/:userID/monetary-account/:monetary-accountID/whitelist/:whitelistID/whitelist-result/:whitelist-resultID/note-attachment/:itemIdUsed to manage attachment notes.
note-text
- GETList_all_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult
/user/:userID/monetary-account/:monetary-accountID/bunqme-fundraiser-result/:bunqme-fundraiser-resultID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult
/user/:userID/monetary-account/:monetary-accountID/bunqme-fundraiser-result/:bunqme-fundraiser-resultID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult
/user/:userID/monetary-account/:monetary-accountID/bunqme-fundraiser-result/:bunqme-fundraiser-resultID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult
/user/:userID/monetary-account/:monetary-accountID/bunqme-fundraiser-result/:bunqme-fundraiser-resultID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult
/user/:userID/monetary-account/:monetary-accountID/bunqme-fundraiser-result/:bunqme-fundraiser-resultID/note-text/:itemIdUsed to manage text notes. - GETList_all_NoteText_for_User_MonetaryAccount_DraftPayment
/user/:userID/monetary-account/:monetary-accountID/draft-payment/:draft-paymentID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_DraftPayment
/user/:userID/monetary-account/:monetary-accountID/draft-payment/:draft-paymentID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_DraftPayment
/user/:userID/monetary-account/:monetary-accountID/draft-payment/:draft-paymentID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_DraftPayment
/user/:userID/monetary-account/:monetary-accountID/draft-payment/:draft-paymentID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_DraftPayment
/user/:userID/monetary-account/:monetary-accountID/draft-payment/:draft-paymentID/note-text/:itemIdUsed to manage text notes. - GETList_all_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/ideal-merchant-transaction/:ideal-merchant-transactionID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/ideal-merchant-transaction/:ideal-merchant-transactionID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/ideal-merchant-transaction/:ideal-merchant-transactionID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/ideal-merchant-transaction/:ideal-merchant-transactionID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/ideal-merchant-transaction/:ideal-merchant-transactionID/note-text/:itemIdUsed to manage text notes. - GETList_all_NoteText_for_User_MonetaryAccount_MastercardAction
/user/:userID/monetary-account/:monetary-accountID/mastercard-action/:mastercard-actionID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_MastercardAction
/user/:userID/monetary-account/:monetary-accountID/mastercard-action/:mastercard-actionID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_MastercardAction
/user/:userID/monetary-account/:monetary-accountID/mastercard-action/:mastercard-actionID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_MastercardAction
/user/:userID/monetary-account/:monetary-accountID/mastercard-action/:mastercard-actionID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_MastercardAction
/user/:userID/monetary-account/:monetary-accountID/mastercard-action/:mastercard-actionID/note-text/:itemIdUsed to manage text notes. - GETList_all_NoteText_for_User_MonetaryAccount_PaymentBatch
/user/:userID/monetary-account/:monetary-accountID/payment-batch/:payment-batchID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_PaymentBatch
/user/:userID/monetary-account/:monetary-accountID/payment-batch/:payment-batchID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_PaymentBatch
/user/:userID/monetary-account/:monetary-accountID/payment-batch/:payment-batchID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_PaymentBatch
/user/:userID/monetary-account/:monetary-accountID/payment-batch/:payment-batchID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_PaymentBatch
/user/:userID/monetary-account/:monetary-accountID/payment-batch/:payment-batchID/note-text/:itemIdUsed to manage text notes. - GETList_all_NoteText_for_User_MonetaryAccount_Payment
/user/:userID/monetary-account/:monetary-accountID/payment/:paymentID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_Payment
/user/:userID/monetary-account/:monetary-accountID/payment/:paymentID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_Payment
/user/:userID/monetary-account/:monetary-accountID/payment/:paymentID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_Payment
/user/:userID/monetary-account/:monetary-accountID/payment/:paymentID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_Payment
/user/:userID/monetary-account/:monetary-accountID/payment/:paymentID/note-text/:itemIdUsed to manage text notes. - GETList_all_NoteText_for_User_MonetaryAccount_RequestInquiryBatch
/user/:userID/monetary-account/:monetary-accountID/request-inquiry-batch/:request-inquiry-batchID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_RequestInquiryBatch
/user/:userID/monetary-account/:monetary-accountID/request-inquiry-batch/:request-inquiry-batchID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_RequestInquiryBatch
/user/:userID/monetary-account/:monetary-accountID/request-inquiry-batch/:request-inquiry-batchID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_RequestInquiryBatch
/user/:userID/monetary-account/:monetary-accountID/request-inquiry-batch/:request-inquiry-batchID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_RequestInquiryBatch
/user/:userID/monetary-account/:monetary-accountID/request-inquiry-batch/:request-inquiry-batchID/note-text/:itemIdUsed to manage text notes. - GETList_all_NoteText_for_User_MonetaryAccount_RequestInquiry
/user/:userID/monetary-account/:monetary-accountID/request-inquiry/:request-inquiryID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_RequestInquiry
/user/:userID/monetary-account/:monetary-accountID/request-inquiry/:request-inquiryID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_RequestInquiry
/user/:userID/monetary-account/:monetary-accountID/request-inquiry/:request-inquiryID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_RequestInquiry
/user/:userID/monetary-account/:monetary-accountID/request-inquiry/:request-inquiryID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_RequestInquiry
/user/:userID/monetary-account/:monetary-accountID/request-inquiry/:request-inquiryID/note-text/:itemIdUsed to manage text notes. - GETList_all_NoteText_for_User_MonetaryAccount_RequestResponse
/user/:userID/monetary-account/:monetary-accountID/request-response/:request-responseID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_RequestResponse
/user/:userID/monetary-account/:monetary-accountID/request-response/:request-responseID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_RequestResponse
/user/:userID/monetary-account/:monetary-accountID/request-response/:request-responseID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_RequestResponse
/user/:userID/monetary-account/:monetary-accountID/request-response/:request-responseID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_RequestResponse
/user/:userID/monetary-account/:monetary-accountID/request-response/:request-responseID/note-text/:itemIdUsed to manage text notes. - GETList_all_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch
/user/:userID/monetary-account/:monetary-accountID/schedule-payment-batch/:schedule-payment-batchID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch
/user/:userID/monetary-account/:monetary-accountID/schedule-payment-batch/:schedule-payment-batchID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch
/user/:userID/monetary-account/:monetary-accountID/schedule-payment-batch/:schedule-payment-batchID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch
/user/:userID/monetary-account/:monetary-accountID/schedule-payment-batch/:schedule-payment-batchID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch
/user/:userID/monetary-account/:monetary-accountID/schedule-payment-batch/:schedule-payment-batchID/note-text/:itemIdUsed to manage text notes. - GETList_all_NoteText_for_User_MonetaryAccount_SchedulePayment
/user/:userID/monetary-account/:monetary-accountID/schedule-payment/:schedule-paymentID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_SchedulePayment
/user/:userID/monetary-account/:monetary-accountID/schedule-payment/:schedule-paymentID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_SchedulePayment
/user/:userID/monetary-account/:monetary-accountID/schedule-payment/:schedule-paymentID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_SchedulePayment
/user/:userID/monetary-account/:monetary-accountID/schedule-payment/:schedule-paymentID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_SchedulePayment
/user/:userID/monetary-account/:monetary-accountID/schedule-payment/:schedule-paymentID/note-text/:itemIdUsed to manage text notes. - GETList_all_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance
/user/:userID/monetary-account/:monetary-accountID/schedule/:scheduleID/schedule-instance/:schedule-instanceID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance
/user/:userID/monetary-account/:monetary-accountID/schedule/:scheduleID/schedule-instance/:schedule-instanceID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance
/user/:userID/monetary-account/:monetary-accountID/schedule/:scheduleID/schedule-instance/:schedule-instanceID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance
/user/:userID/monetary-account/:monetary-accountID/schedule/:scheduleID/schedule-instance/:schedule-instanceID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance
/user/:userID/monetary-account/:monetary-accountID/schedule/:scheduleID/schedule-instance/:schedule-instanceID/note-text/:itemIdUsed to manage text notes. - GETList_all_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/sofort-merchant-transaction/:sofort-merchant-transactionID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/sofort-merchant-transaction/:sofort-merchant-transactionID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/sofort-merchant-transaction/:sofort-merchant-transactionID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/sofort-merchant-transaction/:sofort-merchant-transactionID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction
/user/:userID/monetary-account/:monetary-accountID/sofort-merchant-transaction/:sofort-merchant-transactionID/note-text/:itemIdUsed to manage text notes. - GETList_all_NoteText_for_User_MonetaryAccount_SwitchServicePayment
/user/:userID/monetary-account/:monetary-accountID/switch-service-payment/:switch-service-paymentID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_SwitchServicePayment
/user/:userID/monetary-account/:monetary-accountID/switch-service-payment/:switch-service-paymentID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_SwitchServicePayment
/user/:userID/monetary-account/:monetary-accountID/switch-service-payment/:switch-service-paymentID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_SwitchServicePayment
/user/:userID/monetary-account/:monetary-accountID/switch-service-payment/:switch-service-paymentID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_SwitchServicePayment
/user/:userID/monetary-account/:monetary-accountID/switch-service-payment/:switch-service-paymentID/note-text/:itemIdUsed to manage text notes. - GETList_all_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult
/user/:userID/monetary-account/:monetary-accountID/whitelist/:whitelistID/whitelist-result/:whitelist-resultID/note-textManage the notes for a given user. - POSTCREATE_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult
/user/:userID/monetary-account/:monetary-accountID/whitelist/:whitelistID/whitelist-result/:whitelist-resultID/note-textUsed to manage text notes. - GETREAD_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult
/user/:userID/monetary-account/:monetary-accountID/whitelist/:whitelistID/whitelist-result/:whitelist-resultID/note-text/:itemIdUsed to manage text notes. - PUTUPDATE_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult
/user/:userID/monetary-account/:monetary-accountID/whitelist/:whitelistID/whitelist-result/:whitelist-resultID/note-text/:itemIdUsed to manage text notes. - DELETEDELETE_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult
/user/:userID/monetary-account/:monetary-accountID/whitelist/:whitelistID/whitelist-result/:whitelist-resultID/note-text/:itemIdUsed to manage text notes.
notification-filter-email
- GETList_all_NotificationFilterEmail_for_User
/user/:userID/notification-filter-emailManage the email notification filters for a user. - POSTCREATE_NotificationFilterEmail_for_User
/user/:userID/notification-filter-emailManage the email notification filters for a user.
notification-filter-push
- GETList_all_NotificationFilterPush_for_User
/user/:userID/notification-filter-pushManage the push notification filters for a user. - POSTCREATE_NotificationFilterPush_for_User
/user/:userID/notification-filter-pushManage the push notification filters for a user.
notification-filter-url
- GETList_all_NotificationFilterUrl_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/notification-filter-urlManage the url notification filters for a user. - POSTCREATE_NotificationFilterUrl_for_User_MonetaryAccount
/user/:userID/monetary-account/:monetary-accountID/notification-filter-urlManage the url notification filters for a user. - GETList_all_NotificationFilterUrl_for_User
/user/:userID/notification-filter-urlManage the url notification filters for a user. - POSTCREATE_NotificationFilterUrl_for_User
/user/:userID/notification-filter-urlManage the url notification filters for a user.
oauth-client
- GETList_all_OauthClient_for_User
/user/:userID/oauth-clientUsed for managing OAuth Clients. - POSTCREATE_OauthClient_for_User
/user/:userID/oauth-clientUsed for managing OAuth Clients.
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://public-api.sandbox.bunq.com/{basePath}https://api.bunq.com/{basePath}- Authentication
- None declared in the description
- Operations
- 421 operations on 250 pathsGET 226POST 93PUT 58DELETE 44
- Main resources
- note-attachment 75note-text 75content 10payment-auto-allocate 6callback-url 5schedule-payment 5whitelist-sdd-one-off 5whitelist-sdd-recurring 5bunqme-tab 4certificate-pinned 4
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
1.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the bunq API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the bunq API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “READ_Attachment_for_User” (GET /user/:userID/attachment/:itemId), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the bunq API?
*UPDATE:* *We have released a [beta version of the new bunq API documentation.](https://beta.doc.bunq.com)* *NOTICE:* *We have updated the sandbox base url to… It is listed under Finance & banking and has 421 endpoints.
Who publishes the bunq API?
It is listed from bunq's public API description (an OpenAPI document), not published by bunq on Swastik Codes. Anyone who controls bunq.com can claim the profile by adding a DNS TXT record.
What is the base URL of the bunq API?
Its description lists 2 base URLs: https://public-api.sandbox.bunq.com/{basePath}, https://api.bunq.com/{basePath}. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the bunq API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the bunq API have?
421 operations on 250 paths (226 GET, 93 POST, 58 PUT, 44 DELETE). The largest groups are note-attachment, note-text, content, payment-auto-allocate. This listing's collection holds the first 400.
Is forking the bunq API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.