# API Documentation

## bunq API documentation

- [Welcome to the bunq API documentation](https://doc.bunq.com/getting-started/readme.md)
- [Tools](https://doc.bunq.com/getting-started/tools.md)
- [Postman](https://doc.bunq.com/getting-started/tools/postman.md)
- [Android Emulator](https://doc.bunq.com/getting-started/tools/android-emulator.md)
- [Documents MCP](https://doc.bunq.com/getting-started/tools/documents-mcp.md)
- [Sandbox Users and Sandbox Money](https://doc.bunq.com/sandbox-users-and-sandbox-money.md)
- [Getting started](https://doc.bunq.com/basics/getting-started.md)
- [Authentication](https://doc.bunq.com/basics/authentication.md)
- [API Keys](https://doc.bunq.com/basics/authentication/api-keys.md)
- [OAuth](https://doc.bunq.com/basics/authentication/oauth.md)
- [Register OAuth Client](https://doc.bunq.com/basics/authentication/oauth/register-oauth-client.md)
- [Redirect Users to Authorize your app](https://doc.bunq.com/basics/authentication/oauth/redirect-users-to-authorize-your-app.md)
- [Handle the Authorization Code](https://doc.bunq.com/basics/authentication/oauth/handle-the-authorization-code.md)
- [Use the Access Token to get a user session](https://doc.bunq.com/basics/authentication/oauth/use-the-access-token-to-get-a-user-session.md)
- [Making API calls on behalf of bunq Users](https://doc.bunq.com/basics/authentication/oauth/making-api-calls-on-behalf-of-bunq-users.md)
- [Python Code Example PSD2 - OAuth integration](https://doc.bunq.com/basics/authentication/oauth/python-code-example-psd2-oauth-integration.md)
- [bunq API Objects](https://doc.bunq.com/basics/bunq-api-objects.md)
- [User](https://doc.bunq.com/basics/bunq-api-objects/user.md)
- [Monetary Account](https://doc.bunq.com/basics/bunq-api-objects/monetary-account.md)
- [Payment](https://doc.bunq.com/basics/bunq-api-objects/payment.md)
- [RequestInquiry](https://doc.bunq.com/basics/bunq-api-objects/requestinquiry.md)
- [Card](https://doc.bunq.com/basics/bunq-api-objects/card.md)
- [Attachment and Note Attachment](https://doc.bunq.com/basics/bunq-api-objects/attachment-and-note-attachment.md)
- [Callbacks (Webhooks)](https://doc.bunq.com/basics/callbacks-webhooks.md)
- [Errors](https://doc.bunq.com/basics/errors.md)
- [Geolocations](https://doc.bunq.com/basics/geolocations.md)
- [Headers](https://doc.bunq.com/basics/headers.md)
- [Moving to production](https://doc.bunq.com/basics/moving-to-production.md)
- [Pagination](https://doc.bunq.com/basics/pagination.md)
- [Querying Payments](https://doc.bunq.com/basics/querying-payments.md)
- [Rate Limits](https://doc.bunq.com/basics/rate-limits.md)
- [Response body formatting](https://doc.bunq.com/basics/response-body-formatting.md)
- [Signing](https://doc.bunq.com/basics/signing.md)
- [Python Code Example](https://doc.bunq.com/basics/signing/python-code-example.md)
- [Full main.py](https://doc.bunq.com/basics/signing/python-code-example/full-main.py.md)
- [Full bunq\_lib.py](https://doc.bunq.com/basics/signing/python-code-example/full-bunq_lib.py.md)
- [Full signing.py](https://doc.bunq.com/basics/signing/python-code-example/full-signing.py.md)
- [PHP Code Example](https://doc.bunq.com/basics/signing/php-code-example.md)
- [Whitelisting and Updating IP addresses](https://doc.bunq.com/basics/whitelisting-and-updating-ip-addresses.md)
- [Chapter 0 setting up the API context](https://doc.bunq.com/user-provisioning/chapter-0-setting-up-the-api-context.md)
- [Chapter 1 Setting up oauth client](https://doc.bunq.com/user-provisioning/chapter-1-setting-up-oauth-client.md)
- [Chapter 2 Creating a user provision](https://doc.bunq.com/user-provisioning/chapter-2-creating-a-user-provision.md)
- [Monitoring User Processing](https://doc.bunq.com/user-provisioning/chapter-2-creating-a-user-provision/monitoring-user-processing.md)
- [Monitoring oAuth Processing](https://doc.bunq.com/user-provisioning/chapter-2-creating-a-user-provision/monitoring-oauth-processing.md)
- [Monitoring Relation Processing](https://doc.bunq.com/user-provisioning/chapter-2-creating-a-user-provision/monitoring-relation-processing.md)
- [Created Provision](https://doc.bunq.com/user-provisioning/chapter-2-creating-a-user-provision/created-provision.md)
- [Closing a Provision](https://doc.bunq.com/user-provisioning/chapter-2-creating-a-user-provision/closing-a-provision.md)
- [Chapter 3 Onboarding](https://doc.bunq.com/user-provisioning/chapter-3-onboarding.md)
- [Creating a session on behalf of the user](https://doc.bunq.com/user-provisioning/chapter-3-onboarding/creating-a-session-on-behalf-of-the-user.md)
- [Creating User Onboarding](https://doc.bunq.com/user-provisioning/chapter-3-onboarding/creating-user-onboarding.md)
- [Complete Identity Verification with SDK](https://doc.bunq.com/user-provisioning/chapter-3-onboarding/complete-identity-verification-with-sdk.md)
- [Complete the rest of the fulfilments](https://doc.bunq.com/user-provisioning/chapter-3-onboarding/complete-the-rest-of-the-fulfilments.md)
- [Chapter 4 Webhooks / Callbacks](https://doc.bunq.com/user-provisioning/chapter-4-webhooks-callbacks.md)
- [Getting Started with Banking As A Service](https://doc.bunq.com/banking-as-a-service/getting-started-with-banking-as-a-service.md)
- [Introduction & Core Paradigms](https://doc.bunq.com/banking-as-a-service/getting-started-with-banking-as-a-service/introduction-and-core-paradigms.md): Before you make your first API call, it's worth spending a few minutes understanding how bunq thinks about banking. The API is consistent and predictable — but only once the underlying model clicks.
- [Overview](https://doc.bunq.com/banking-as-a-service/getting-started-with-banking-as-a-service/overview.md)
- [Cards - As a Service](https://doc.bunq.com/banking-as-a-service/cards-as-a-service.md)
- [Payments - As a Service](https://doc.bunq.com/banking-as-a-service/payments-as-a-service.md)
- [Bank Accounts - As a Service](https://doc.bunq.com/banking-as-a-service/bank-accounts-as-a-service.md)
- [Know Your Customer - As a Service](https://doc.bunq.com/banking-as-a-service/know-your-customer-as-a-service.md)
- [Are you a Third Party Provider (TPP)? Start here!](https://doc.bunq.com/psd2/are-you-a-third-party-provider-tpp-start-here.md)
- [Register as a TPP](https://doc.bunq.com/psd2/are-you-a-third-party-provider-tpp-start-here/register-as-a-tpp.md)
- [Change your avatar](https://doc.bunq.com/psd2/are-you-a-third-party-provider-tpp-start-here/change-your-avatar.md)
- [Account Information Service Provider (AISP)](https://doc.bunq.com/psd2/account-information-service-provider-aisp.md)
- [Payment Initiation Service Provider (PISP)](https://doc.bunq.com/psd2/payment-initiation-service-provider-pisp.md)
- [Card-Based Payment Instrument Issuer (CBPII)](https://doc.bunq.com/psd2/card-based-payment-instrument-issuer-cbpii.md)
- [Troubleshooting as a Third Party Provider (TPP)](https://doc.bunq.com/troubleshooting-as-a-third-party-provider-tpp.md)
- [API Support Team](https://doc.bunq.com/support/api-support-team.md)
- [FAQ](https://doc.bunq.com/support/faq.md)
- [Your first payment](https://doc.bunq.com/tutorials/your-first-payment.md)
- [Introduction](https://doc.bunq.com/tutorials/your-first-payment/introduction.md)
- [Creating a sandbox user and getting an API key](https://doc.bunq.com/tutorials/your-first-payment/creating-a-sandbox-user-and-getting-an-api-key.md)
- [Creating the API Context](https://doc.bunq.com/tutorials/your-first-payment/creating-the-api-context.md)
- [Creating the Installation](https://doc.bunq.com/tutorials/your-first-payment/creating-the-api-context/creating-the-installation.md)
- [Device Registration](https://doc.bunq.com/tutorials/your-first-payment/creating-the-api-context/device-registration.md)
- [Start a Session](https://doc.bunq.com/tutorials/your-first-payment/creating-the-api-context/start-a-session.md)
- [Setting up a sandbox user](https://doc.bunq.com/tutorials/your-first-payment/setting-up-a-sandbox-user.md): Let's update your user so that we can use it.
- [Retrieving my user details](https://doc.bunq.com/tutorials/your-first-payment/setting-up-a-sandbox-user/retrieving-my-user-details.md)
- [Getting sandbox money on the user account](https://doc.bunq.com/tutorials/your-first-payment/setting-up-a-sandbox-user/getting-sandbox-money-on-the-user-account.md)
- [Sandbox version of the bunq app](https://doc.bunq.com/tutorials/your-first-payment/setting-up-a-sandbox-user/sandbox-version-of-the-bunq-app.md)
- [First Payments](https://doc.bunq.com/tutorials/your-first-payment/first-payments.md)
- [How to do bulk payments](https://doc.bunq.com/tutorials/how-to-do-bulk-payments.md)
- [Receiving payments on your website using bunq.me](https://doc.bunq.com/tutorials/receiving-payments-on-your-website-using-bunq.me.md)
- [How to manage your cards](https://doc.bunq.com/tutorials/how-to-manage-your-cards.md)
- [Introduction](https://doc.bunq.com/tutorials/how-to-manage-your-cards/introduction.md)
- [Ordering a card](https://doc.bunq.com/tutorials/how-to-manage-your-cards/ordering-a-card.md)
- [Setting the card Limit and changing the PIN code](https://doc.bunq.com/tutorials/how-to-manage-your-cards/setting-the-card-limit-and-changing-the-pin-code.md)
- [Access end user acount information through OAuth](https://doc.bunq.com/tutorials/access-end-user-acount-information-through-oauth.md)
- [Setting up the Oauth Client](https://doc.bunq.com/tutorials/access-end-user-acount-information-through-oauth/setting-up-the-oauth-client.md)
- [Hidden references](https://doc.bunq.com/api-reference/hidden-references.md)
- [Company](https://doc.bunq.com/api-reference/hidden-references/company.md)
- [Challenge Request](https://doc.bunq.com/api-reference/hidden-references/challenge-request.md)
- [Credential Password IP](https://doc.bunq.com/api-reference/hidden-references/credential-password-ip.md)
- [Feature Announcement](https://doc.bunq.com/api-reference/hidden-references/feature-announcement.md)
- [Certificate Pinned](https://doc.bunq.com/api-reference/hidden-references/certificate-pinned.md)
- [Start here](https://doc.bunq.com/api-reference/start-here.md)
- [Additional Transaction Information Category](https://doc.bunq.com/api-reference/additional-transaction-information-category.md): Get the available categories.
- [Additional Transaction Information Category User Defined](https://doc.bunq.com/api-reference/additional-transaction-information-category-user-defined.md)
- [Attachment](https://doc.bunq.com/api-reference/attachment.md)
- [Attachment Public](https://doc.bunq.com/api-reference/attachment-public.md)
- [Avatar](https://doc.bunq.com/api-reference/avatar.md)
- [Billing Contract Subscription](https://doc.bunq.com/api-reference/billing-contract-subscription.md)
- [bunqme](https://doc.bunq.com/api-reference/bunqme.md)
- [bunqme Tab](https://doc.bunq.com/api-reference/bunqme/bunqme-tab.md)
- [bunqme Fundraiser Profile](https://doc.bunq.com/api-reference/bunqme/bunqme-fundraiser-profile.md)
- [bunqme Tab Response](https://doc.bunq.com/api-reference/bunqme/bunqme-tab-response.md)
- [bunqme Fundraiser Result](https://doc.bunq.com/api-reference/bunqme/bunqme-fundraiser-result.md)
- [Callback URL OAuth](https://doc.bunq.com/api-reference/callback-url-oauth.md)
- [Cards](https://doc.bunq.com/api-reference/cards.md)
- [Card](https://doc.bunq.com/api-reference/cards/card.md)
- [Card-Batch](https://doc.bunq.com/api-reference/cards/card-batch.md)
- [Card Credit](https://doc.bunq.com/api-reference/cards/card-credit.md)
- [Card Debit](https://doc.bunq.com/api-reference/cards/card-debit.md)
- [Card Name](https://doc.bunq.com/api-reference/cards/card-name.md)
- [Card Replace](https://doc.bunq.com/api-reference/cards/card-replace.md)
- [Confirmation Of Funds](https://doc.bunq.com/confirmation-of-funds.md)
- [Content and Exports](https://doc.bunq.com/content-and-exports.md)
- [Credential Password IP](https://doc.bunq.com/credential-password-ip.md)
- [Currency Cloud](https://doc.bunq.com/currency-cloud.md)
- [Currency cloud Benificiairy](https://doc.bunq.com/currency-cloud/currency-cloud-benificiairy.md)
- [Payment Quote](https://doc.bunq.com/currency-cloud/payment-quote.md)
- [Currency Conversion](https://doc.bunq.com/currency-conversion.md)
- [Convert](https://doc.bunq.com/currency-conversion/convert.md)
- [Quotes](https://doc.bunq.com/currency-conversion/quotes.md)
- [Customer Statements](https://doc.bunq.com/customer-statements.md)
- [Devices](https://doc.bunq.com/devices.md)
- [Draft Payment](https://doc.bunq.com/draft-payment.md)
- [Event](https://doc.bunq.com/event.md)
- [Exports](https://doc.bunq.com/exports.md)
- [Export Annual Overview](https://doc.bunq.com/exports/export-annual-overview.md)
- [Export RIB](https://doc.bunq.com/exports/export-rib.md)
- [Export Statement Card](https://doc.bunq.com/exports/export-statement-card.md)
- [Generated CVC2](https://doc.bunq.com/generated-cvc2.md)
- [\[DEPRECATED\] Ideal Merchant Transaction](https://doc.bunq.com/ideal-merchant-transaction.md)
- [Insights](https://doc.bunq.com/insights.md)
- [Installation](https://doc.bunq.com/installation.md)
- [Invoice](https://doc.bunq.com/invoice.md)
- [Invoice Export](https://doc.bunq.com/invoice-export.md)
- [Legal Name](https://doc.bunq.com/legal-name.md)
- [Limit](https://doc.bunq.com/limit.md)
- [Mastercard Action](https://doc.bunq.com/mastercard-action.md)
- [Monetary Account](https://doc.bunq.com/monetary-account.md)
- [Monetary Account Bank](https://doc.bunq.com/monetary-account/monetary-account-bank.md)
- [Monetary Account Card](https://doc.bunq.com/monetary-account/monetary-account-card.md)
- [Monetary Account External](https://doc.bunq.com/monetary-account/monetary-account-external.md)
- [Monetary Account External Savings](https://doc.bunq.com/monetary-account/monetary-account-external-savings.md)
- [Monetary Account Joint](https://doc.bunq.com/monetary-account/monetary-account-joint.md)
- [Monetary Account Savings](https://doc.bunq.com/monetary-account/monetary-account-savings.md)
- [Monetary Account Savings External](https://doc.bunq.com/monetary-account/monetary-account-savings-external.md)
- [Name](https://doc.bunq.com/name.md): Returns all the known (trade) names for a specific user company
- [Note Text & Attachment](https://doc.bunq.com/note-text-and-attachment.md)
- [Adyen Card Transaction](https://doc.bunq.com/note-text-and-attachment/adyen-card-transaction.md)
- [Switch Service Payment](https://doc.bunq.com/note-text-and-attachment/switch-service-payment.md)
- [bunqme fundraiser result](https://doc.bunq.com/note-text-and-attachment/bunqme-fundraiser-result.md)
- [Draft Payment](https://doc.bunq.com/note-text-and-attachment/draft-payment.md)
- [Ideal Merchant Transaction](https://doc.bunq.com/note-text-and-attachment/ideal-merchant-transaction.md)
- [Mastercard Action](https://doc.bunq.com/note-text-and-attachment/mastercard-action.md)
- [Open Banking Merchant](https://doc.bunq.com/note-text-and-attachment/open-banking-merchant.md)
- [Payment Batch](https://doc.bunq.com/note-text-and-attachment/payment-batch.md)
- [Payment Delayed](https://doc.bunq.com/note-text-and-attachment/payment-delayed.md)
- [Payment](https://doc.bunq.com/note-text-and-attachment/payment.md)
- [Request Inquiry Batch](https://doc.bunq.com/note-text-and-attachment/request-inquiry-batch.md)
- [Request Response](https://doc.bunq.com/note-text-and-attachment/request-response.md)
- [Schedule Payment](https://doc.bunq.com/note-text-and-attachment/schedule-payment.md)
- [Schedule Request](https://doc.bunq.com/note-text-and-attachment/schedule-request.md)
- [Sofort](https://doc.bunq.com/note-text-and-attachment/sofort.md)
- [Whitelist Result](https://doc.bunq.com/note-text-and-attachment/whitelist-result.md)
- [Notification Filter](https://doc.bunq.com/notification-filter.md)
- [Notification Filter Email](https://doc.bunq.com/notification-filter/notification-filter-email.md)
- [Notification Filter Failure](https://doc.bunq.com/notification-filter/notification-filter-failure.md)
- [Notification Filter Push](https://doc.bunq.com/notification-filter/notification-filter-push.md)
- [Notification Filter URL](https://doc.bunq.com/notification-filter/notification-filter-url.md)
- [OAuth](https://doc.bunq.com/oauth.md)
- [Payment](https://doc.bunq.com/payment.md)
- [Payment](https://doc.bunq.com/payment/payment.md)
- [Payment Auto Allocate](https://doc.bunq.com/payment/payment-auto-allocate.md)
- [Payment Batch](https://doc.bunq.com/payment/payment-batch.md)
- [Payment Auto Allocation](https://doc.bunq.com/payment-auto-allocation.md)
- [Payment Service Provider](https://doc.bunq.com/payment-service-provider.md)
- [Payment Service Provider Credential](https://doc.bunq.com/payment-service-provider/payment-service-provider-credential.md)
- [\[deprecated since 20260309\] Payment Service Provider Draft Payment](https://doc.bunq.com/payment-service-provider/deprecated-since-20260309-payment-service-provider-draft-payment.md): Please refer to
- [Payment Service Provider Issuer Transaction](https://doc.bunq.com/payment-service-provider/payment-service-provider-issuer-transaction.md)
- [Request](https://doc.bunq.com/request.md)
- [Request Inquiry](https://doc.bunq.com/request/request-inquiry.md)
- [Request Inquiry Batch](https://doc.bunq.com/request/request-inquiry-batch.md)
- [Request Response](https://doc.bunq.com/request/request-response.md)
- [Sandbox Users](https://doc.bunq.com/sandbox-users.md)
- [Schedule](https://doc.bunq.com/schedule.md)
- [Schedule Instance](https://doc.bunq.com/schedule/schedule-instance.md)
- [Schedule Payment](https://doc.bunq.com/schedule/schedule-payment.md)
- [Schedule Payment Batch](https://doc.bunq.com/schedule/schedule-payment-batch.md)
- [Server Error](https://doc.bunq.com/server-error.md)
- [Server Public Key](https://doc.bunq.com/server-public-key.md)
- [Session](https://doc.bunq.com/session.md)
- [Share Invite Monetary Account Inquiry](https://doc.bunq.com/share-invite-monetary-account-inquiry.md)
- [Share Invite Monetary Account Response](https://doc.bunq.com/share-invite-monetary-account-response.md)
- [Sofort Merchant Transaction](https://doc.bunq.com/sofort-merchant-transaction.md)
- [Statement](https://doc.bunq.com/statement.md)
- [Switch Service Payment](https://doc.bunq.com/switch-service-payment.md)
- [Token QR Request Sofort](https://doc.bunq.com/token-qr-request-sofort.md)
- [Transferwise](https://doc.bunq.com/transferwise.md)
- [Transferwise Currency](https://doc.bunq.com/transferwise/transferwise-currency.md)
- [Transferwise Quote](https://doc.bunq.com/transferwise/transferwise-quote.md)
- [Transferwise Recipient](https://doc.bunq.com/transferwise/transferwise-recipient.md)
- [Transferwise Recipient Requirement](https://doc.bunq.com/transferwise/transferwise-recipient-requirement.md)
- [Transferwise Transfer](https://doc.bunq.com/transferwise/transferwise-transfer.md)
- [Transferwise Transfer Requirement](https://doc.bunq.com/transferwise/transferwise-transfer-requirement.md)
- [Transferwise User](https://doc.bunq.com/transferwise/transferwise-user.md)
- [Tree Progress](https://doc.bunq.com/tree-progress.md)
- [User](https://doc.bunq.com/user.md)
- [User Person](https://doc.bunq.com/user/user-person.md)
- [User Company](https://doc.bunq.com/user/user-company.md)
- [User Payment Service Provider](https://doc.bunq.com/user/user-payment-service-provider.md)
- [Whitelist SSD](https://doc.bunq.com/whitelist-ssd.md)
- [Whitelist SSD One Off](https://doc.bunq.com/whitelist-ssd/whitelist-ssd-one-off.md)
- [Whitelist SSD Recurring](https://doc.bunq.com/whitelist-ssd/whitelist-ssd-recurring.md)
- [Content](https://doc.bunq.com/content.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://doc.bunq.com/getting-started/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.