{ "openapi": "3.0.0", "info": { "title": "bunq API", "description": "***UPDATE:*** *We have released a [beta version of the new bunq API documentation.](https:\/\/medium.com\/bunq-developers-corner\/bunq-api-documentation-update-new-version-beta-release-fe587cccd1fd)*\n\n***NOTICE:*** *We have updated the sandbox base url to\u00a0`https:\/\/public-api.sandbox.bunq.com\/v1\/`. Please update your applications accordingly. Check here: for more info.*\n\n***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.*\n\n# Introduction<\/span>\n\nWelcome to bunq!\n\n- 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.\n- Please configure your implementation to send its API requests to `https:\/\/public-api.sandbox.bunq.com\/v1\/`\n- There is a version of the [Android app](https:\/\/appstore.bunq.com\/api\/android\/builds\/bunq-android-sandbox-master.apk) that connects to the bunq Sandbox environment. To create accounts for the Sandbox app, please follow the steps in the [Android Emulator](#android-emulator) section.\n\n## Get started<\/span>\n\n1. Create a user account with your phone. Afterwards, you can use this account to create an API key from which you can make API calls. You can find API key management under 'Profile' -\\> 'Security'.\n2. Register a device. A device can be a phone (private), computer or a server (public). You can register a new device by using the installation and device-server calls.\n3. Open a session. Sessions are temporary and expire after the same amount of time you have set for auto logout in your user account.\n4. Make your first call!\n\n## Versioning<\/span>\n\nDevelopments 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. This also allows us to quickly process your feedback (which we are happy to receive!). 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.\n\nOnce the speed of iteration slows down and more developers start using the API and its sandbox we will start versioning the API using the version number in the HTTP URLs (i.e. the `\/v1` part of the path). We will inform you when this happens.\n\n# OAuth<\/span>\n\n## What is OAuth?<\/span>\n\n[OAuth 2.0](https:\/\/www.oauth.com\/oauth2-servers\/getting-ready\/) 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 account information of other bunq users or initiate a payment for them, you require a PSD2 permit.\n\n## Get started with OAuth for bunq<\/span>\n\nFollow these steps to get started with OAuth:\n1. Register your OAuth Client in the bunq app, you will find the option within \"Security & Settings > Developers\".\n2. Add one or more Redirect URLs.\n3. Get your Client ID and Client Secret from the bunq app.\n4. Redirect your users to the OAuth authorization URL as described [here](#oauth-authorization-request).\n5. If the user accepts your Connection request then he will be redirected to the previously specified `redirect_uri` with an authorization Code parameter.\n6. Use the [token endpoint](#oauth-token-exchange) to exchange the authorization Code for an Access Token.\n7. The Access Token can be used as a normal API Key, open a session with the bunq API or use our SDKs and get started!\n\n## What can my apps do with OAuth?<\/span>\n\nWe decided to launch OAuth with a default permission that allows you to perform the following actions:\n- Read only access to the Monetary Accounts.\n- Read access to Payments & Transactions.\n- Create new Payments, but only between Monetary Accounts belonging to the same user.\n- Create new Draft-Payments.\n- Change the primary monetary to which a Card is linked to.\n- Read only access to Request-Inquiries and Request-Responses.\n\n## Authorization request<\/span>\n\nYour web or mobile app should redirect users to the following URL:\n\n`https:\/\/oauth.bunq.com\/auth`\n\nThe following parameters should be passed:\n\n- `response_type` - bunq supports the authorization code grant, provide `code` as parameter (required)\n- `client_id` - your Client ID, get it from the bunq app (required)\n- `redirect_uri` - the URL you wish the user to be redirected after the authorization, make sure you register the Redirect URL in the bunq app (required)\n- `state` - a unique string to be passed back upon completion (optional)\n\n**Authorization request example:**\n\n```\nhttps:\/\/oauth.bunq.com\/auth?response_type=code\n&client_id=1cc540b6e7a4fa3a862620d0751771500ed453b0bef89cd60e36b7db6260f813\n&redirect_uri=https:\/\/www.bunq.com\n&state=594f5548-6dfb-4b02-8620-08e03a9469e6\n```\n\n**Authorization request response:**\n\n```\nhttps:\/\/www.bunq.com\/?code=7d272be434a75933f40c13d56aef6c31496005b653074f7d6ac57029d9995d30\n&state=594f5548-6dfb-4b02-8620-08e03a9469e6\n```\n## Token exchange<\/span>\n\nIf everything went well then you can exchange the authorization Code that we returned you for an Access Token to use with the bunq API.\n\nMake a POST call to the following endpoint:\n\n`https:\/\/api.oauth.bunq.com\/v1\/token`\n\nThe following parameters should be passed as GET variables:\n\n- `grant_type` - the grant type used, `authorization_code` for now (required)\n- `code` - the authorization code received from bunq (required)\n- `redirect_uri` - the same Redirect URL used in the authorisation request (required)\n- `client_id` - your Client ID (required)\n- `client_secret` - your Client Secret (required)\n\n**Token request example:**\n\n```\nhttps:\/\/api.oauth.bunq.com\/v1\/token?grant_type=authorization_code\n&code=7d272be434a75933f40c13d56aef6c31496005b653074f7d6ac57029d9995d30\n&redirect_uri=https:\/\/www.bunq.com\/\n&client_id=1cc540b6e7a4fa3a862620d0751771500ed453b0bef89cd60e36b7db6260f813\n&client_secret=184f969765f6f74f53bf563ae3e9f891aec9179157601d25221d57f2f1151fd5\n```\n\nNote: the request only contains URL parameters.\n\n**Example successful response:**\n\n```json\n{\n \"access_token\": \"8baec0ac1aafca3345d5b811042feecfe0272514c5d09a69b5fbc84cb1c06029\",\n \"token_type\": \"bearer\",\n \"state\": \"594f5548-6dfb-4b02-8620-08e03a9469e6\"\n}\n```\n\n**Example error response:**\n\n```json\n{\n \"error\": \"invalid_grant\",\n \"error_description\": \"The authorization code is invalid or expired.\"\n}\n```\n\n## Using the Connect button<\/span>\n\nAll good? Ready to connect to your bunq users? Refer to our style guide and use the following assets when implementing the **Connect to bunq** button.\n\n- [Style guide](https:\/\/bunq.com\/info\/oauth-styleguide)\n- [Connect button assets](https:\/\/bunq.com\/info\/oauth-connect-buttons)\n\n## What's next?<\/span>\n\nThe `access_token` you've received can be used as a normal API key. Please continue with [Authentication](#authentication).\n\nVisit us on together.bunq.com, share your creations, ask question and build your very own bunq app!\n\n# Authentication<\/span>\n\n- We use encryption for all API calls. This means that all requests must use HTTPS. The HTTP standard calls will fail. You should also use SSL Certificate Pinning and Hostname Verification to ensure a secure connection with bunq.\n- In order to make API calls you need to register a device and open a session.\n- We use RSA Keys for signatures headers and encryption.\n- API calls must contain a valid authentication token in the headers.\n- The auto logout time that you've set for your user account is also effective for your sessions. If a request is made 30 minutes before a session expires, the session will automatically be extended.\n\n## Device registration<\/span>\n\n### Using our SDKs<\/span>\n\n1. In order to start making calls with the bunq API, you must first register your API key and device and create a session.\n2. In the SDKs, we group these actions and call it \"creating an API context\".\n3. You can find more information on our [GitHub](https:\/\/github.com\/bunq) page.\n\n### Using our API<\/span>\n\n1. Create an Installation with the installation POST call and provide a new public key. After doing so you receive an authentication token which you can use for the API calls in the next steps.\n2. Create a DeviceServer with the device-server POST call and provide a description and API key.\n3. Create a SessionServer with the session-server POST call. After doing so you receive a new authentication token which you can use for the API calls during this active Session.\u200b\n\n### IP addresses<\/span>\n\nWhen using a standard API Key the DeviceServer and Installation that are created in this process are bound to the IP address they are created from. Afterwards it is only possible to add IP addresses via the Permitted IP endpoint.\n\nUsing a Wildcard API Key gives you the freedom to make API calls from any IP address after the POST device-server. You can switch to a Wildcard API Key by tapping on \u201cAllow All IP Addresses\u201d in your API Key menu inside the bunq app. You can also programatically switch to a Wildcard API Key by passing your current ip and a `*` (asterisk) in the `permitted_ips` field of the device-server POST call. E.g: `[\"1.2.3.4\", \"*\"]`.\n\nFind out more at this link https:\/\/bunq.com\/en\/apikey-dynamic-ip.\n\n# Connect as a PSD2 service provider<\/span>\n\nAs a service provider, either an Account Information Service Provider (AISP) or Payment Initiation Service Provider (PISP), you have obtained or are planning to obtain a licence from your local supervisor. You will need your unique eIDAS certificate number to start using the PSD2-compliant bunq API on production.\n\n**NOTE: You can test how it works in our sandbox. It is currently not available on production.** We currently accept pseudo certificates so you could test the flow. You are free to create the certificate yourself but make sure to follow these criteria:\n- Up to 64 characters\n- PISP and\/or AISP used in the end\n\n## Register as a service provider<\/span>\n\nBefore you can read information on bunq users or initiate payments, you need to register a PSD2 account and receive credentials that will enable you to access the bunq user accounts. \n\n1. Execute `POST v1\/installation` and get your installation *Token* with a unique random key pair.\n1. Use the installation *Token* and your unique PSD2 certificate to call `POST v1\/payment-service-provider-credential`. This will register your software. \n1. Receive your API key in return. It will identify you as a PSD2 bunq API user. You will use it to start an OAuth flow. The session will last 90 days. After it closes, start a new session using the same API key.\n1. Register a device by using `POST v1\/device-server` using the API key for the secret and passing the installation *Token* in the `X-Bunq-Client-Authentication` header. \n1. Create your first session by executing `POST v1\/session-server`. Provide the installation *Token* in the `X-Bunq-Client-Authentication` header. You will receive a session *Token*. Use it in any following request in the `X-Bunq-Client-Authentication` header.\n\n**NOTE.** The first session will last 1 hour. Start a new session within 60 minutes.\n\n![bunq_PSD_party_identification](https:\/\/static.bunq.com\/assets\/doc\/20190313_PSD_party_identification.jpg)\n\n## Register your application<\/span>\n\nBefore you can start authenticating on behalf of a bunq user, you need to get *Client ID* and *Client Secret*, which will identify you in requests to the user accounts.\n\n1. Call `POST \/v1\/user\/{userID}\/oauth-client`\n1. Call `GET \/v1\/user\/{userID}\/oauth-client\/{oauth-clientID}`. We will return your *Client ID* and *Client Secret*.\n1. Call `POST \/v1\/user\/{userID}\/oauth-client\/{oauth-clientID}\/callback-url`. Include the OAuth callback URL of your application.\n1. You are ready to initiate authorization requests.\n\n![bunq_OAuth](https:\/\/static.bunq.com\/assets\/doc\/20190313_OAuth_flows.jpg)\n\n## Access user accounts as an AISP<\/span>\n\nAs an AISP, you are allowed to authenticate in a user\u2019s account with the following permissions:\n\n* access account information (read):\n\t1. legal name\n\t2. IBAN\n\t3. nationality\n\t4. card validity data\n\t5. transaction history\n\t6. account balance\n\nOnce a bunq user has confirmed they want to connect their account via your application, you can initiate the authorization flow.\n0. Open a session on the bunq server.\n1. Initiate an authorization request. If your identity is validated, we send you a confirmation upon its creation. Pass the following parameters with the request:\n\t- *response_type*\n\t- *client_id* (here *response_type=code&client_id*)\n\t- *redirect_uri\n\t- *state\n2. If the bunq user confirms their will to let your application connect to their account, we return you a Code. \n3. Exchange the *Code* for an *Access Token*. Make a `POST` call to `https:\/\/api.oauth.bunq.com\/v1\/token` passing the following parameters:\n\t- *code (at this stage, grant_type=authorization_code&code)*\n\t- *redirect_uri*\n\t- *client_id*\n\t- *client_secret*\n4. We return the *Access Token*. Use it every time you interact with the bunq user\u2019s account. You can use it to start a session to interact with the monetary accounts the user allows you to access.\n\n![bunq_AISP](https:\/\/static.bunq.com\/assets\/doc\/20190313_AISP_flow.jpg)\n\n## Make payments as a PISP<\/span>\n\nAs a PISP, you are allowed to authenticate in a user\u2019s account with the following permissions:\n1. read account information \n\t- legal name\n\t- IBAN\n2. initiate payments (create draft payments)\n3. confirm that the account balance is sufficient for covering the payment *(will be available in upcoming releases)*\n\nOnce a bunq user has confirmed they want to make a payment via your application, you can initiate the payment confirmation flow.\n\n0. Open a session to the bunq server.\n1. Get the id of the account you want to use to receive the money from the bunq users:\n\t- Call `GET monetary-account`. Check the ids of the accounts and save the id of the account you want to transfer customer money to.\n2. Create a draft payment.\n\t- Call `POST draft-payment` and pass the following parameters:\n\t\t1. monetary-accountID\n\t\t2. userID\n\t\t3. the customer\u2019s email address, phone number or IBAN in the *counterparty_alias*\n3. If the user confirms their intent to make the payment, we carry out the transaction.\n4. Check the status of the payment via `GET draft-payment` using the draft payment id parameter returned in the previous step.\n![bunq_PISP](https:\/\/static.bunq.com\/assets\/doc\/20190313_PISP_flow.jpg)\n\n\n# Signing<\/span>\n\nTo avoid modification of API call data while in transit (i.e. man-in-the-middle attacks), we use a request\/response signing system. The signature ensures that the data is coming from the party that has the correct private key.\n\nWhile this system is already implemented in our SDKs, you should always follow the guidelines on this page when using the bunq API to make sure you correctly sign your calls.\n\nThe signatures are created using the SHA256 cryptographic hash function and included (encoded in base 64) in the\u00a0`X-Bunq-Client-Signature`\u00a0request header and\u00a0`X-Bunq-Server-Signature`\u00a0response header. The data to sign is the following:\n\n- For requests: the request method, capitalized, and request endpoint URL (including the query string, if any). Do not use the full URL. `POST \/v1\/user` works; `POST https:\/\/sandbox.public.api.bunq.com\/v1\/user` will not.\n- For responses: the response code.\n- A `\\n` (linefeed) newline separator.\n- Headers, sorted alphabetically by key, with key and value separated by `:\u00a0` (a colon followed by a space) and only including `Cache-Control`, `User-Agent` and headers starting with `X-Bunq-`. The headers should be separated from each other with a `\\n` (linefeed) newline. For a full list of required call headers, see the headers page.\n- Two `\\n` (linefeed) newlines (even when there is no body).\n- The request or response body.\n- For signing requests, the client must use the private key corresponding to the public key that was sent to the server in the installation API call. That public key is what the server will use to verify the signature when it receives the request. In that same call the server will respond with a server side public key, which the client must use to verify the server's signatures. The generated RSA key pair must have key lengths of 2048 bits and adhere to the PKCS #8 standard.\n\n## Request signing example<\/span>\n\nConsider the following request, a\u00a0`POST`\u00a0to\u00a0`\/v1\/user\/126\/monetary-account\/222\/payment`\u00a0(the JSON is formatted with newlines and indentations to make it more readable):\n\n\n \n \n \n \n \n \n \n \n \n \n \n
Header<\/th>\n Value<\/th>\n <\/tr>\n <\/thead>\n
Cache-Control:<\/td>\n no-cache<\/td>\n <\/tr>\n
User-Agent:<\/td>\n bunq-TestServer\/1.00 sandbox\/0.17b3<\/td>\n <\/tr>\n
X-Bunq-Client-Authentication:<\/td>\n f15f1bbe1feba25efb00802fa127042b54101c8ec0a524c36464f5bb143d3b8b<\/td>\n <\/tr>\n
X-Bunq-Client-Request-Id:<\/td>\n 57061b04b67ef<\/td>\n <\/tr>\n
X-Bunq-Client-Signature:<\/td>\n UINaaJELGHekiye4JExGx6TCs2lKMta74oVlZlwVNuVD6xPpH7RS6H58C21MmiQ75\/MSVjUePC8gBjtARW2HpUKN7hANJqo\/UtDb7mgDMsuz7Cf\/hKeUCX0T55w2X+NC3i1T+QOQVQ1gALBT1Eif6qgyyY1wpWJUYft0MmCGEYg\/ao9r3g026DNlRmRpBVxXtyJiOUImuHbq\/rWpoDZRQTfvGL4KH4iKV4Lcb+o9lw11xOl4LQvNOHq3EsrfnTIa5g80pg9TS6G0SvjWmFAXBmDXatqfVhImuKZtd1dQI12JNK\/++isBsP79eNtK1F5rSksmsTfAeHMy7HbfAQSDbg==<\/td>\n <\/tr>\n
X-Bunq-Geolocation:<\/td>\n 0 0 0 0 NL<\/td>\n <\/tr>\n
X-Bunq-Language:<\/td>\n en_US<\/td>\n <\/tr>\n
X-Bunq-Region:<\/td>\n en_US<\/td>\n <\/tr>\n <\/tbody>\n<\/table>\n\n```json\n{\n\t\"amount\":\u00a0{\n\t\t\"value\":\u00a0\"12.50\",\n\t\t\"currency\":\u00a0\"EUR\"\n\t},\n\t\"counterparty_alias\":\u00a0{\n\t\t\"type\":\u00a0\"EMAIL\",\n\t\t\"value\":\u00a0\"bravo@bunq.com\"\n\t},\n\t\"description\":\u00a0\"Payment for drinks.\"\n}\n```\n\nLet's sign that request. First create a variable `$dataToSign`, starting with the type and endpoint url. Follow that by a list of headers only including\u00a0`Cache-Control`,\u00a0`User-Agent`\u00a0and headers starting with\u00a0`X-Bunq-`. Add an extra (so double) linefeed after the list of headers. Finally end with the body of the request:\n\n`POST \/v1\/user\/126\/monetary-account\/222\/payment`\n\n\n \n \n \n \n \n \n \n \n \n \n \n
Header<\/th>\n Value<\/th>\n <\/tr>\n <\/thead>\n
Cache-Control:<\/td>\n no-cache<\/td>\n <\/tr>\n
User-Agent:<\/td>\n bunq-TestServer\/1.00 sandbox\/0.17b3<\/td>\n <\/tr>\n
X-Bunq-Client-Authentication:<\/td>\n f15f1bbe1feba25efb00802fa127042b54101c8ec0a524c36464f5bb143d3b8b<\/td>\n <\/tr>\n
X-Bunq-Client-Request-Id:<\/td>\n 57061b04b67ef<\/td>\n <\/tr>\n
X-Bunq-Client-Signature:<\/td>\n UINaaJELGHekiye4JExGx6TCs2lKMta74oVlZlwVNuVD6xPpH7RS6H58C21MmiQ75\/MSVjUePC8gBjtARW2HpUKN7hANJqo\/UtDb7mgDMsuz7Cf\/hKeUCX0T55w2X+NC3i1T+QOQVQ1gALBT1Eif6qgyyY1wpWJUYft0MmCGEYg\/ao9r3g026DNlRmRpBVxXtyJiOUImuHbq\/rWpoDZRQTfvGL4KH4iKV4Lcb+o9lw11xOl4LQvNOHq3EsrfnTIa5g80pg9TS6G0SvjWmFAXBmDXatqfVhImuKZtd1dQI12JNK\/++isBsP79eNtK1F5rSksmsTfAeHMy7HbfAQSDbg==<\/td>\n <\/tr>\n
X-Bunq-Geolocation:<\/td>\n 0 0 0 0 NL<\/td>\n <\/tr>\n
X-Bunq-Language:<\/td>\n en_US<\/td>\n <\/tr>\n
X-Bunq-Region:<\/td>\n en_US<\/td>\n <\/tr>\n <\/tbody>\n<\/table>\n\n```json\n{\n \"amount\": {\n \"value\": \"12.50\",\n \"currency\": \"EUR\"\n },\n \"counterparty_alias\": {\n \"type\": \"EMAIL\",\n \"value\": \"bravo@bunq.com\"\n },\n \"description\": \"Payment for drinks.\"\n}\n```\nNext, create the signature of\u00a0`$dataToSign`\u00a0using the SHA256 algorithm and the private key\u00a0`$privateKey`\u00a0of the Installation's key pair. In PHP, use the following to create a signature. The signature will be passed by reference into\u00a0`$signature`.\n\n`openssl_sign($dataToSign, $signature, $privateKey, OPENSSL_ALGO_SHA256);`\n\nEncode the resulting\u00a0`$signature`\u00a0using\u00a0base64, and add the resulting value to the request under the header\u00a0`X-Bunq-Client-Signature`. You have now signed your request, and can send it!\n\n## Response verifying example<\/span>\n\nThe response to the previous request is as follows (the JSON is formatted with newlines and indentations to make it more readable):\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n
Header<\/th>\n Value<\/th>\n <\/tr>\n <\/thead>\n
Access-Control-Allow-Origin:<\/td>\n *<\/td>\n <\/tr>\n
Content-Type:<\/td>\n application\/json<\/td>\n <\/tr>\n
Date:<\/td>\n Thu, 07 Apr 2016 08:32:04 GMT<\/td>\n <\/tr>\n
Server:<\/td>\n APACHE<\/td>\n <\/tr>\n
Strict-Transport-Security:<\/td>\n max-age=31536000<\/td>\n <\/tr>\n
Transfer-Encoding:<\/td>\n chunked<\/td>\n <\/tr>\n
X-Bunq-Client-Response-Id:<\/td>\n 89dcaa5c-fa55-4068-9822-3f87985d2268<\/td>\n <\/tr>\n
X-Bunq-Client-Request-Id:<\/td>\n 57061b04b67ef<\/td>\n <\/tr>\n
X-Bunq-Server-Signature:<\/td>\n ee9sDfzEhQ2L6Rquyh2XmJyNWdSBOBo6Z2eUYuM4bAOBCn9N5vjs6k6RROpagxXFXdGI9sT15tYCaLe5FS9aciIuJmrVW\/SZCDWq\/nOvSThi7+BwD9JFdG7zfR4afC8qfVABmjuMrtjaUFSrthyHS\/5wEuDuax9qUZn6sVXcgZEq49hy4yHrV8257I4sSQIHRmgds4BXcGhPp266Z6pxjzAJbfyzt5JgJ8\/suxgKvm\/nYhnOfsgIIYCgcyh4DRrQltohiSon6x1ZsRIfQnCDlDDghaIxbryLfinT5Y4eU1eiCkFB4D69S4HbFXYyAxlqtX2W6Tvax6rIM2MMPNOh4Q==<\/td>\n <\/tr>\n
X-Frame-Options:<\/td>\n SAMEORIGIN<\/td>\n <\/tr>\n <\/tbody>\n<\/table>\n\n```json\n{\n\t\"Response\":\u00a0[\n\t\t{\n\t\t\t\"Id\":\u00a0{\n\t\t\t\t\"id\":\u00a01561\n\t\t\t}\n\t\t}\n\t]\n}\n```\nNow we need to verify that this response actually came from the server and not from a man-in-the-middle. So, first we built the data that is to be verified, starting with the response code (200). Follow this by a list of the bunq headers (sorted alphabetically and excluding the signature header itself).\u00a0Note:\u00a0you should only include headers starting with\u00a0X-Bunq-, so omit headers like\u00a0Cache-Control\u00a0for the verification of the response. Finally, add two line feeds followed by the response body.\u00a0Note:\u00a0The headers might change in transit from\u00a0`X-Header-Capitalization-Style`\u00a0to\u00a0`x-header-non-capitalization-style`. Make sure you change them to\u00a0`X-Header-Capitalization-Style`\u00a0before verifying the response signature.\n```\n200\nX-Bunq-Client-Request-Id: 57061b04b67ef\nX-Bunq-Server-Response-Id: 89dcaa5c-fa55-4068-9822-3f87985d2268\n\n{\"Response\":[{\"Id\":{\"id\":1561}}]}\n```\nNow, verify the signature of\u00a0`$dataToVerify`\u00a0using the SHA256 algorithm and the public key\u00a0`$publicKey`\u00a0of the server. In PHP, use the following to verify the signature.\n\n`openssl_sign($dataToVerify, $signature, $publicKey, OPENSSL_ALGO_SHA256);`\n\n## Troubleshooting<\/span>\n\nIf you get an error telling you \"The request signature is invalid\", please check the following:\n\n- There are no redundant characters (extra spaces, trailing line breaks, etc.) in the data to sign.\n- In your data to sign, you have used only the endpoint URL, for instance\u00a0POST \/v1\/user, and not the full url, for instance\u00a0`POST https:\/\/sandbox.public.api.bunq.com\/v1\/user`\n- You only added the headers\u00a0`Cache-Control`,\u00a0`User-Agent`\u00a0and headers starting with\u00a0`X-Bunq-`.\n- In your data to sign, you have sorted the headers alphabetically by key, ascending.\n- There is a colon followed by a space\u00a0`:\u00a0` separating the header key and value in your data to sign.\n- There is an extra line break after the list of headers in the data to sign, regardless of whether there is a request body.\n- Make sure the body is appended to the data to sign exactly as you're adding it to the request.\n- In your data to sign, you have not added the\u00a0`X-Bunq-Client-Signature`\u00a0header to the list of headers (that would also be impossible).\n- You have added the full body to the data to sign.\n- You use the data to sign to create a SHA256 hash signature.\n- You have base64 encoded the SHA256 hash signature before adding it to the request under\u00a0`X-Bunq-Client-Signature`.\n\n# Headers<\/span>\n\nHTTP headers allow your client and bunq to pass on additional information along with the request or response.\n\nWhile this is already implemented in our [SDKs](https:\/\/github.com\/bunq), please follow these instructions to make sure you set appropriate headers for calls if using bunq API directly.\n\n## Request headers<\/span>\n\n### Mandatory request headers<\/span>\n\n#### Cache-Control\n\n`Cache-Control: no-cache`\n\nThe standard HTTP Cache-Control header is required for all requests.\n\n#### User-Agent\n\n`User-Agent: bunq-TestServer\/1.00 sandbox\/0.17b3`\n\nThe User-Agent header field should contain information about the user agent originating the request. There are no restrictions on the value of this header.\n\n#### X-Bunq-Language\n\n`X-Bunq-Language: en_US`\n\nThe X-Bunq-Language header must contain a preferred language indication. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore.\n\nCurrently only the languages en_US and nl_NL are supported. Anything else will default to en_US.\n\n#### X-Bunq-Region\n\n`X-Bunq-Region: en_US`\n\nThe X-Bunq-Region header must contain the region (country) of the client device. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore.\n\n#### X-Bunq-Client-Request-Id\n\n`X-Bunq-Client-Request-Id: a4f0de`\n\nThis header must specify an ID with each request that is unique for the logged in user. There are no restrictions for the format of this ID. However, the server will respond with an error when the same ID is used again on the same DeviceServer.\n\n#### X-Bunq-Geolocation\n\n`X-Bunq-Geolocation: 4.89 53.2 12 100 NL`\n\n`X-Bunq-Geolocation: 0 0 0 0 000`\n\nThis header must specify the geolocation of the device. The format of this value is longitude latitude altitude radius country. The country is expected to be formatted of an ISO 3166-1 alpha-2 country code. When no geolocation is available or known the header must still be included but can be zero valued.\n\n#### X-Bunq-Client-Signature\n\n`X-Bunq-Client-Signature: XLOwEdyjF1d+tT2w7a7Epv4Yj7w74KncvVfq9mDJVvFRlsUaMLR2q4ISgT+5mkwQsSygRRbooxBqydw7IkqpuJay9g8eOngsFyIxSgf2vXGAQatLm47tLoUFGSQsRiYoKiTKkgBwA+\/3dIpbDWd+Z7LEYVbHaHRKkEY9TJ22PpDlVgLLVaf2KGRiZ+9\/+0OUsiiF1Fkd9aukv0iWT6N2n1P0qxpjW0aw8mC1nBSJuuk5yKtDCyQpqNyDQSOpQ8V56LNWM4Px5l6SQMzT8r6zk5DvrMAB9DlcRdUDcp\/U9cg9kACXIgfquef3s7R8uyOWfKLSNBQpdVIpzljwNKI1Q`\n\nThe signature header is included for all API calls except for POST \/v1\/installation. See the signing page for details on how to create this signature.\n\n#### X-Bunq-Client-Authentication\n\n`X-Bunq-Client-Authentication: 622749ac8b00c81719ad0c7d822d3552e8ff153e3447eabed1a6713993749440`\n\nThe authentication token is used to authenticate the source of the API call. It is required by all API calls except for POST \/v1\/installation. It is important to note that the device and session calls are using the token from the response of the installation call, while all the other calls use the token from the response of the session-server call\n\n### Attachment headers<\/span>\n\n#### Content-Type\n\n`Content-Type: image\/jpeg`\n\nThis header should be used when uploading an attachment to pass its MIME type. Supported types are: image\/png, image\/jpeg and image\/gif.\n\n#### X-Bunq-Attachment-Description\nX-Bunq-Attachment-Description: Check out these cookies.\nThis header should be used when uploading an Attachment's content to give it a description.\n\n## Response headers<\/span>\n\n### All Responses<\/span>\n\n#### X-Bunq-Client-Request-Id\n\n`X-Bunq-Client-Request-Id: a4f0de`\n\nThe same ID that was provided in the request's X-Bunq-Client-Request-Id header. Is included in the response (and request) signature, so can be used to ensure this is the response for the sent request.\n\n#### X-Bunq-Client-Response-Id\n\n`X-Bunq-Client-Response-Id: 76cc7772-4b23-420a-9586-8721dcdde174`\n\nA unique ID for the response formatted as a UUID. Clients can use it to add extra protection against replay attacks.\n\n#### X-Bunq-Server-Signature\n\n`X-Bunq-Server-Signature: XBBwfDaOZJapvcBpAIBT1UOmczKqJXLSpX9ZWHsqXwrf1p+H+eON+TktYksAbmkSkI4gQghw1AUQSJh5i2c4+CTuKdZ4YuFT0suYG4sltiKnmtwODOFtu1IBGuE5XcfGEDDSFC+zqxypMi9gmTqjl1KI3WP2gnySRD6PBJCXfDxJnXwjRkk4kpG8Ng9nyxJiFG9vcHNrtRBj9ZXNdUAjxXZZFmtdhmJGDahGn2bIBWsCEudW3rBefycL1DlpJZw6yRLoDltxeBo7MjgROBpIeElh5qAz9vxUFLqIQC7EDONBGbSBjaXS0wWrq9s2MGuOi9kJxL2LQm\/Olj2g==`\n\nThe server's signature for this response. See the signing page for details on how to verify this signature.\n\n### Warning header<\/span>\n\n#### X-Bunq-Warning\n\n`X-Bunq-Warning: \"You have a negative balance. Please check the app for more details.\"`\n\nUsed to inform you on situations that might impact your bunq account and API access.\n\n# Errors<\/span>\n\nFamiliar HTTP response codes are used to indicate the success or failure of an API request.\n\nGenerally speaking, codes in the 2xx range indicate success, while codes in the 4xx range indicate an error having to do with provided information (e.g. a required parameter was missing, insufficient funds, etc.).\n\nFinally, codes in the 5xx range indicate an error with bunq servers. If this is the case, please stop by the support chat and report it to us.\n\n## Response codes<\/span>\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Code<\/th>\n Error<\/th>\n Description<\/th>\n <\/tr>\n <\/thead>\n
200<\/td>\n OK<\/td>\n Successful HTTP request<\/td>\n <\/tr>\n
399<\/td>\n NOT MODIFIED<\/td>\n Same as a 304, it implies you have a local cached copy of the data<\/td>\n <\/tr>\n
400<\/td>\n BAD REQUEST<\/td>\n Most likely a parameter is missing or invalid<\/td>\n <\/tr>\n
401<\/td>\n UNAUTHORISED<\/td>\n Token or signature provided is not valid<\/td>\n <\/tr>\n
403<\/td>\n FORBIDDEN<\/td>\n You're not allowed to make this call<\/td>\n <\/tr>\n
404<\/td>\n NOT FOUND<\/td>\n The object you're looking for cannot be found<\/td>\n <\/tr>\n
405<\/td>\n METHOD NOT ALLOWED<\/td>\n The method you are using is not allowed for this endpoint<\/td>\n <\/tr>\n
429<\/td>\n RATE LIMIT<\/td>\n Too many API calls have been made in a too short period<\/td>\n <\/tr>\n
490<\/td>\n USER ERROR<\/td>\n Most likely a parameter is missing or invalid<\/td>\n <\/tr>\n
491<\/td>\n MAINTENANCE ERROR<\/td>\n bunq is in maintenance mode<\/td>\n <\/tr>\n
500<\/td>\n INTERNAL SERVER ERROR<\/td>\n Something went wrong on bunq's end<\/td>\n <\/tr>\n <\/tbody>\n<\/table>\n\nAll errors 4xx code errors will include a JSON body explaining what went wrong.\n\n## Rate limits<\/span>\n\nIf you are receiving the error 429, please make sure you are sending requests at rates that are below our rate limits.\n\nOur rate limits per IP address per endpoint:\n\n- GET requests: 3 within any 3 consecutive seconds\n- POST requests: 5 within any 3 consecutive seconds\n- PUT requests: 2 within any 3 consecutive seconds\n\nWe have a lower rate limit for `\/session-server`: 1 request within 30 consecutive seconds.\n\n# API conventions<\/span>\n\nMake sure to follow these indications when using the bunq API or get started with our SDKs.\n\n## Responses<\/span>\n\nAll JSON responses have one top level object. In this object will be a Response field of which the value is always an array, even for responses that only contain one object.\n\nExample response body\n\n```json\n{\n\t\"Response\": [\n\t\t{\n\t\t\t\"DataObject\": {}\n\t\t}\n\t]\n}\n```\n\n## Errors<\/span>\n\n- Error responses also have one top level Error object.\n- The contents of the array will be a JSON object with an error_description and error_description_translated field.\n- The error_description is an English text indicating the error and the error_description_translated field can be shown to end users and is translated into the language from the X-Bunq-Language header, defaulting to en_US.\n- When using bunq SDKs, error responses will be always raised in form of an exception.\n\nExample response body\n```json\n{\n\t\"Error\": [\n\t\t{\n\t\t\t\"error_description\": \"Error description\",\n\t\t\t\"error_description_translated\": \"User facing error description\"\n\t\t}\n\t]\n}\n```\n\n## Object Type indications<\/span>\n\nWhen the API returns different types of objects for the same field, they will be nested in another JSON object that includes a specific field for each one of them. Within bunq SDKs a BunqResponse object will be returned as the top level object.\n\nIn this example there is a field content, which can have multiple types of objects as value such as \u2014 in this case \u2014 ChatMessageContentText. Be sure to follow this convention or use bunq SDKs instead.\n\n```json\n{\n\t\"content\": {\n\t\t\"ChatMessageContentText\": {\n\t\t\t\"text\": \"Hi! This is an automated security message. We saw you just logged in on an My Device Description. If you believe someone else logged in with your account, please get in touch with Support.\"\n\t\t}\n\t}\n}\n```\n\n## Time formats<\/span>\n\nTimes and dates being sent to and from the API are in UTC. The format that should be used is `YYYY-MM-DD hh:mm:ss.ssssss`, where the letters have the meaning as specified in ISO 8601. For example: `2017-01-13 13:19:16.215235`.\n\n# Callbacks<\/span>\n\nCallbacks are used to send information about events on your bunq account to a URL of your choice, so that you can receive real-time updates.\n\n## Notification Filters<\/span>\n\nIn order to receive notifications for certain activities on your bunq account, you have to create notification filters. These can be set for your UserPerson or UserCompany, MonetaryAccount or CashRegister.\n\nThe `notification_filters` object looks like this:\n\n```json \n{\n \"notification_filters\": [\n {\n \"notification_delivery_method\": \"URL\",\n \"notification_target\": \u201c{YOUR_CALLBACK_URL}\",\n \"category\": \"REQUEST\"\n },\n {\n \"notification_delivery_method\": \"URL\",\n \"notification_target\": \"{YOUR_CALLBACK_URL}\",\n \"category\": \"PAYMENT\"\n }\n ]\n}\n```\n\n### Notification Filter fields<\/span>\n\n- `notification_delivery_method`: choose between URL (sending an HTTP request to the provided URL) and PUSH (sending a push notification to user's phone). To receive callbacks, a notification has to be set for URL.\n- `notification_target`: provide the URL you want to receive the callbacks on. This URL must use HTTPS.\n- `category`: provides for which type of events you would like to receive a callback.\n\n### Callback categories<\/span>\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Category<\/th>\n Description<\/th>\n <\/tr>\n <\/thead>\n
BILLING<\/td>\n notifications for all bunq invoices<\/td>\n <\/tr>\n
CARD_TRANSACTION_SUCCESSFUL<\/td>\n notifications for successful card transactions<\/td>\n <\/tr>\n
CARD_TRANSACTION_FAILED<\/td>\n notifications for failed card transaction<\/td>\n <\/tr>\n
CHAT<\/td>\n notifications for received chat messages<\/td>\n <\/tr>\n
DRAFT_PAYMENT<\/td>\n notifications for creation and updates of draft payments<\/td>\n <\/tr>\n
IDEAL<\/td>\n notifications for iDEAL-deposits towards a bunq account<\/td>\n <\/tr>\n
SOFORT<\/td>\n notifications for SOFORT-deposits towards a bunq account<\/td>\n <\/tr>\n
MUTATION<\/td>\n notifications for any action that affects a monetary account\u2019s balance<\/td>\n <\/tr>\n
PAYMENT<\/td>\n notifications for payments created from, or received on a bunq account (doesn\u2019t include payments that result out of paying a Request, iDEAL, Sofort or Invoice). Outgoing payments have a negative value while incoming payments have a positive value<\/td>\n <\/tr>\n
REQUEST<\/td>\n notifications for incoming requests and updates on outgoing requests<\/td>\n <\/tr>\n
SCHEDULE_RESULT<\/td>\n notifications for when a scheduled payment is executed<\/td>\n <\/tr>\n
SCHEDULE_STATUS<\/td>\n notifications about the status of a scheduled payment, e.g. when the scheduled payment is updated or cancelled<\/td>\n <\/tr>\n
SHARE<\/td>\n notifications for any updates or creation of Connects (ShareInviteBankInquiry)<\/td>\n <\/tr>\n
TAB_RESULT<\/td>\n notifications for updates on Tab payments<\/td>\n <\/tr>\n
BUNQME_TAB<\/td>\n notifications for updates on bunq.me Tab (open request) payments<\/td>\n <\/tr>\n
SUPPORT<\/td>\n notifications for messages received from us through support chat<\/td>\n <\/tr>\n <\/tbody>\n<\/table>\n\n### Mutation category<\/span>\n\nA Mutation is a change in the balance of a monetary account. So, for each payment-like object, such as a request, iDEAL-payment or a regular payment, a Mutation is created. Therefore, the `MUTATION` category can be used to keep track of a monetary account's balance.\n\n### Receiving callbacks<\/span>\n\nCallbacks for the sandbox environment will be made from different IP's at AWS.\u00a0 \nCallbacks for the production environment will be made from `185.40.108.0\/22`.\n\n*The IP addresses might change*. We will notify you in a timely fashion if such a change would take place.\n\n### Retry mechanism<\/span>\n\nWhen the execution of a callback fails (e.g. if the callback server is down or the response contains an error) it is tried again for a maximum of 5 times, with an interval of one minute between each try. If your server is not reachable by the callback after the 6th total try, the callback is not sent anymore.\n\n## Certificate pinning<\/span>\n\nWe recommend you use certificate pinning as an extra security measure. With certificate pinning, we check the certificate of the server on which you want to receive callbacks against the pinned certificate that has been provided by you and cancel the callback if that check fails.\n\n### How to set up certificate pinning<\/span>\n\nRetrieve the SSL certificate of your server using the following command:\n\n1. `openssl s_client -servername www.example.com -connect www.example.com:443 < \/dev\/null | sed -n \"\/-----BEGIN\/,\/-----END\/p\" > www.example.com.pem`\n2. `POST` the certificate to the certificate-pinned endpoint.\n\nNow every callback that is made will be checked against the pinned certificate that you provided. Note that if the SSL certificate on your server expires or is changed, our callbacks will fail.\n\n# Pagination<\/span>\n\nIn order to control the size of the response of a `LIST` request, items can be paginated. A `LIST` request is a request for every one of a certain resources, for instance all payments of a certain monetary account `GET \/v1\/user\/1\/monetary-account\/1\/payment`). You can decide on the maximum amount of items of a response by adding a `count` query parameter with the number of items you want per page to the URL. For instance:\n\n`GET \/v1\/user\/1\/monetary-account\/1\/payment?count=25`\n\nWhen no `count` is given, the default count is set to 10. The maximum `count` you can set is 200.\n\nWith every listing, a `Pagination` object will be added to the response, containing the URLs to be used to get the next or previous set of items. The URLs in the Pagination object can be used to navigate through the listed resources. The Pagination object looks like this given a count of 25:\n\n```json\n{\n \"Pagination\": {\n \"future_url\": null,\n \"newer_url\": \"\/v1\/user\/1\/monetary-account\/1\/payment?count=25&newer_id=249\",\n \"older_url\": \"\/v1\/user\/1\/monetary-account\/1\/payment?count=25&older_id=224\"\n }\n}\n```\n\nThe `newer_url` value can be used to get the next page. The `newer_id` is always the ID of the last item in the current page. If `newer_url` is `null`, there are no more recent items before the current page.\n\nThe `older_url` value can be used to get the previous page. The `older_id` is always the ID of the first item in the current page. If `older_url` is `null`, there are no older items after the current page.\n\nThe `future_url` can be used to refresh and check for newer items that didn't exist when the listing was requested. The `newer_id` will always be the ID of the last item in the current page. `future_url` will be `null` if `newer_id` is not also the ID of the latest item.\n\n# Moving to Production<\/span>\n\nHave you tested your bunq integration to the fullest and are you now ready to introduce it to the world? Then the time has come to move it to a production environment!\n\nTo get started you'll need some fresh API keys for the production environment, which you can create via your bunq app. You can create these under \"Profile\" by tapping the \"Security\" menu. We do, however, highly recommend using a standard API Key instead of a Wildcard API Key. The former is significantly safer and it protects you from intrusions and possible attacks.\n\nThere's only a few things to do before your beautiful bunq creation can be moved to production. You're going to have to change your API Key and redo the sequence of calls to open a session.\n\nThe bunq Public API production environment is hosted at `https:\/\/api.bunq.com`.\n\nDo you have any questions or remarks about the process, or do you simply want to show off with your awesome creations? Don't hesitate to drop us a line on [together.bunq.com](https:\/\/together.bunq.com).\n\nPlease be aware that if you will gain access to account information of other bunq users or initiate a payment for them, you require a PSD2 permit.\n\n# Android Emulator<\/span>\n\nIn case you do not own an Android device on which you can run our Sandbox app for end-to-end testing, you can set up an emulator to run the bunq Sandbox app for Android.\n\nThings you will need\n\n- The [bunq Sandbox App APK](https:\/\/appstore.bunq.com\/api\/android\/builds\/bunq-android-sandbox-master.apk) that's optimised for emulating;\n- [Android Studio](https:\/\/developer.android.com\/studio\/index.html).\n\nStarting the Android Virtual Device (AVD) Manager\n\n1. Open Android Studio.\n2. From the top menu, select \u201cTools\u201d > \"Android\" > \"AVD Manager\".\n\nSetting up a new virtual device\n\n1. Start the wizard by clicking on \"+ Create Virtual Device\".\n2. Select a device (recommendation: \"Pixel 5.0\" or \"Nexus 6\") and press \"Next\".\n3. Select an x86 system image (recommendation: Nougat, API Level 25, Android 7.1.1 with Google APIs) and press \"Next\". The image needs to have Google Play Services 10.0.1 or higher.\n4. In the bottom left corner, select \"Show Advanced Settings\".\n5. Scroll to \"Memory and Storage\".\n6. Change \"Internal Storage\" to \"2048 MB\".\n7. Change \"SD card\" to \"200 MB\".\n8. Press \"Finish\".\n\nStarting the virtual device\n\n1. On the right side under \"Actions\", select the green \"Play\" button.\n2. Wait for the device to boot, this may take a few minutes.\n\nInstalling the bunq Sandbox App APK\n\n1. Open the command line.\n2. Navigate to your Android SDK platform tools directory (e.g. `cd ~\/Library\/Android\/sdk\/platform-tools` on macOS).\n3. Make sure that the virtual device is started and has fully booted.\n4. Run `.\/adb install ~\/Downloads\/bunq-android-sandboxEmulator-public-api.apk`, this may take a few minutes, and should finish with \"Success\".\n\nCreating an account or logging in\n\n- The first time you open the app you will be asked to verify your phone number. Sandbox however does not send actual SMS messages. Enter any valid phone number and use the default verification code `123456`. This will work for all numbers.\n- Get [tinker](https:\/\/bunq.com\/api\/) for the language of your choice.\n- Once installed, run `tinker\/user-overview`, this will create an account for you when necessary.\n- The output of the command above will show you the login credentials for your sandbox account.\n- It is **not** possible to create accounts using the regular signup in the app, bunq is not reviewing Sandbox applications.\n\nCreate a new API key\n\nTo create additional API keys for the sandbox environment, log in to the sandbox app for Android as either a UserPerson or UserCompany. Navigate to Profile > Security > API keys and click the '+' button. Please be aware that the API key can only be assigned to an IP within 4 hours after its creation. After the 4 hours, it will become invalid if not assigned. API keys that are created via the sandbox app are wiped with each sandbox reset.\n\n# Quickstart: Opening a Session<\/span>\n\n## Goal<\/span>\n\nSo, you want to start using the bunq API, awesome! To do this, you have to open a session in which you will be making those calls.\n\n## Getting an API key<\/span>\n\nTo connect to the API, you have to make sure you have received an API key. \n\nFor the production environment, you can generate your own keys in the bunq app (under 'Profile' -> 'Security'). \n\nFor the sandbox environment you can get an API key from tinker and android emulator as [described above](#android-emulator). \n\nAlternative you can do a curl request: `curl https:\/\/public-api.sandbox.bunq.com\/v1\/sandbox-user -X POST --header \"Content-Type: application\/json\" --header \"Cache-Control: none\" --header \"User-Agent: curl-request\" --header \"X-Bunq-Client-Request-Id: $(date)randomId\" --header \"X-Bunq-Language: nl_NL\" --header \"X-Bunq-Region: nl_NL\" --header \"X-Bunq-Geolocation: 0 0 0 0 000\"`. That'll create a sample user and return an associated API key for you.\n\nNote that production API key is only usable on production and sandbox key is only usable on sandbox. Sandbox key has a `sandbox_` prefix while production key does not have any noticeable prefixes.\n\n## Call sequence<\/span>\n\nThe calls you need to perform to set up a session from scratch are the following:\n\n### 1. POST installation<\/span>\n\nEach call needs to be signed with your own private key. An Installation is used to tell the server about the public key of your key pair. The server uses this key to verify your subsequent calls.\n\nStart by generating a 2048-bit RSA key pair. You can find examples by looking at the source code of the sdk's located at github.\n\n#### Headers\n\nOn the headers page you can find out about the mandatory headers. Take care that if you are in the sandbox environment, you set an `Authorization` header. Specific to the `POST \/installation` call, you shouldn't use the `X-Bunq-Client-Authentication` or the `X-Bunq-Client-Signature` headers.\n\n#### Body\n\nPost your public key to the Installation endpoint (use `\\n` for newlines in your public key).\n\n#### Response\n\nSave the Installation token and the bunq API's public key from the response. This token is used in the `Authentication` header to register a `DeviceServer` and to start a `SessionServer`. The bunq API's public key should be used to verify future responses received from the bunq API.\n\n### 2. POST device-server<\/span>\n\nFurther calls made to the server need to come from a registered device. `POST \/device-server` registers your current device and the IP address(es) it uses to connect to the bunq API.\n\n#### Headers\n\nUse the token you received from `POST \/installation` in the `X-Bunq-Client-Authentication` header. Make sure you sign your call, passing the call signature in `X-Bunq-Client-Signature` header.\n\n#### Body\n\nFor the secret, use the API key you received. If you want to create another API key, you can do so in the bunq sandbox app (or production app for the production environment). Login, go to Profile > Security and tap 'API keys'. The freshly created API key can be assigned to one or multiple IP addresses using `POST device-server` within 4 hours before becoming invalid. As soon as you start using your API key, it will remain valid until the next sandbox reset.\u2028\u2028 For the secret, use the API key you received.\n\n### 3. POST session-server<\/span>\n\nTo make any calls besides `installation` and `device-server`, you need to open a session.\n\n#### Headers\n\nUse the token you received from `POST \/installation` in the `X-Bunq-Client-Authentication` header. Make sure you sign your call, passing the call signature in `X-Bunq-Client-Signature` header.\n\n#### Body\n\nFor the secret, use the API key you received.\n\n#### Response\n\nThe token received in the response to `POST \/session-server` should be used to authenticate your calls in this session. Pass this session's token in the `X-Bunq-Client-Authentication` header on every call you make in this session.\n\n# Quickstart: Payment Request<\/span>\n\n## Goal<\/span>\n\nYou want to offer bunq payments on a website or in an application.\n\n## Scenario<\/span>\n\nIn this use case the consumer and the merchant both have a bunq account. The consumer wants to pay with bunq and enters their alias in the bunq payment field at checkout. The merchant sends the request for payment to the consumer when the consumer presses enter. The consumer agrees to the request in the bunq mobile app and the merchant has immediate confirmation of the payment. Please be aware that if you will gain access to account information of other bunq users or initiate a payment for them, you require a PSD2 permit.\n\n## Before you start<\/span>\n\nMake sure that you have opened a session and that for any call you make after that, you pass the session\u2019s token in the X-Bunq-Client-Authentication header.\n\n## Call Sequence<\/span>\n\nThe consumer is at checkout and selects the bunq payment method. This would be a logical time to open a session on the bunq server.\n\n### 1. LIST monetary-account<\/span>\n\nWhen a request for payment is accepted, the money will be deposited on the bank account the request for payment is connected to. Let\u2019s start by finding all your available bank accounts. Pick one of them to make the request for payment with and save its `id`.\n\n### 2. POST monetary-account attachment (optional)<\/span>\n\nOptionally, you can attach an image to the request for payment.\n\n#### Headers\nMake sure you set the `Content-Type` header to match the MIME type of the image. It\u2019s also required you pass a description of the image via the `X-Bunq-Attachment-Description` header.\n\n#### Body\nThe payload of this request is the binary representation of the image file. Do not use any JSON formatting.\n\n#### Response\nSave the `id` of the posted attachment. You\u2019ll need it to attach it to the request for payment.\n\n### 3. POST request-inquiry<\/span>\n\nNext, create a request inquiry. A request inquiry is the request for payment that your customer can respond to by accepting or rejecting it.\n\n#### Body\n\nPass the customer\u2019s email address, phone number or IBAN in the `counterparty_alias`. Make sure you set the correct `type` for the alias, depending on what you pass. When providing an IBAN, a name of the `counterparty_alias` is required. You can provide the `id` of the created attachment.\n\n#### Response\n\nYou will receive the `id` of the created request inquiry in the response. Save this `id`. You will need it to check if the customer has responded to the request yet.\n\n### 4. GET request-inquiry<\/span>\n\nAfter you\u2019ve sent the request for payment, its status can be checked.\n\n#### Response\n\nWhen the `status` is `ACCEPTED`, the customer has accepted and paid the request, and you will have received the money on the connected monetary account. If the `status` is `REJECTED`, the customer did not accept the request.\n\n# Quickstart: Create a Tab payment<\/span>\n\n## Goal<\/span>\n\nYou will create a tab that can be paid once by a single user, a so called TagUsageSingle, and explore three different ways to make the Tab visible to your customers:\n\n- QR code from the CashRegister\n- QR code from the Tab.\n\n## Before you start<\/span>\n\nMake sure that you have opened a session and that for any call you make after that, you pass the session\u2019s token in the `X-Bunq-Client-Authentication` header.\n\n## Call sequence<\/span>\n\n### 1. POST attachment-public<\/span>\n\nStart by creating an attachment that will be used for the avatar for the cash register.\n\n#### Header\n\nMake sure you set the `Content-Type` header to match the MIME type of the image. It is also required you pass a description of the image via the `X-Bunq-Attachment-Description` header.\n\n#### Body\n\nThe payload of this request is the binary representation of the image file. Do not use any JSON formatting.\n\n#### Response\n\nSave the `uuid` of the posted attachment. You'll need it to create the avatar in the next step.\n\n### 2. POST avatar<\/span>\n\nMake an avatar using the public attachment you've just created.\n\n#### Body\n\nThe payload of this request is the `uuid` of the attachment public.\n\n#### Response\n\nIn response, you\u2019ll receive the UUID of the avatar created using the attachment. Save this UUID. You\u2019ll use it as the avatar for the cash register you're about to create.\n\n### 3. LIST monetary-account<\/span>\n\nGet a listing of all available monetary accounts. Choose one, and save the id of the monetary account you want your cash register to be connected to. Each paid tab for the cash register will transfer the money to this account.\n\n### 4a. POST cash-register<\/span>\n\nCreate a cash register. Use the `id` of the monetary account you want to connect the cash register to in the URL of the request.\n\n#### Body\n\nIn the body provide the `uuid` of the avatar you created for this cash register. Also make sure to provide a unique name for your cash register. Set the status to `PENDING_APPROVAL`.\n\n#### Response\n\nThe response contains the `id` of the cash register you created. Save this `id`. You will need it to create subsequent tabs and tab items.\n\n### 4b. Wait for approval<\/span>\n\nOn the production environment, a bunq admin will review and approve your cash register. In the sandbox environment, your cash register will be automatically approved.\n\n### 5. POST tab-usage-single<\/span>\n\nCreate a new tab that is connected to your cash register. Use the id of the cash register you want to connect this tab to in the URL of your request.\n\n#### Body\n\nGive the tab a name in `merchant_reference`. Create the tab with status `OPEN`, and give the tab a starting amount. You can update this amount later.\n\n#### Response\n\nThe response contains the uuid of the tab you created.\n\n### 6. POST tab-item (optional)<\/span>\n\nYou can add items to a tab. For instance, if a customer will be paying for multiple products via this tab, you can decide to add an item for each of these. Adding items to a tab is optional, and adding them will not change the total amount of the tab itself. However, if you've added any tab items the sum of the amounts of these items must be equal to the `total_amount` of the tab when you change its status to `WAITING_FOR_PAYMENT`.\n\n### 7. PUT tab-usage-single<\/span>\n\nUpdate the status of the tab to `WAITING_FOR_PAYMENT` if you want the costumer to pay the tab, and you're done adding any tab items. You can use this request to make the tab visible for your costumers.\n\n#### Visibility\n\nTo decide how you are going to make your tab visible, pass a visibility object in the payload.\n\nSetting `cash_register_qr_code` to true will connect this tab to the QR code from the cash register. If this cash register does not have a QR code yet, one will be created. Only one Tab can be connected to the cash register\u2019s QR code at any given time.\n\nSetting `tab_qr_code` to true will create a QR code specifically for this tab. This QR code can not be linked to anything else.\n", "termsOfService": "http:\/\/bunq.com\/terms-api\/", "contact": { "name": "bunq Developer Support", "url": "http:\/\/bunq.com\/developer" }, "license": { "name": "Apache 2.0", "url": "https:\/\/www.apache.org\/licenses\/LICENSE-2.0.html" }, "version": "1.0" }, "servers": [ { "url": "https:\/\/public-api.sandbox.bunq.com\/{basePath}", "description": "Sandbox server", "variables": { "basePath": { "default": "v1" } } }, { "url": "https:\/\/api.bunq.com\/{basePath}", "description": "Production server", "variables": { "basePath": { "default": "v1" } } } ], "components": { "schemas": { "Address": { "type": "object", "properties": { "street": { "type": "string", "description": "The street.", "readOnly": false, "writeOnly": false }, "house_number": { "type": "string", "description": "The house number.", "readOnly": false, "writeOnly": false }, "po_box": { "type": "string", "description": "The PO box.", "readOnly": false, "writeOnly": false }, "postal_code": { "type": "string", "description": "The postal code.", "readOnly": false, "writeOnly": false }, "city": { "type": "string", "description": "The city.", "readOnly": false, "writeOnly": false }, "country": { "type": "string", "description": "The country as an ISO 3166-1 alpha-2 country code..", "readOnly": false, "writeOnly": false }, "extra": { "type": "string", "description": "The appartment, building or other extra information for addresses.", "readOnly": false, "writeOnly": false }, "mailbox_name": { "type": "string", "description": "The name on the mailbox (only used for Postal addresses).", "readOnly": false, "writeOnly": false }, "province": { "type": "string", "description": "The province according to local standard.", "readOnly": true, "writeOnly": false } } }, "Amount": { "type": "object", "properties": { "value": { "type": "string", "description": "The amount formatted to two decimal places.", "readOnly": false, "writeOnly": false }, "currency": { "type": "string", "description": "The currency of the amount. It is an ISO 4217 formatted currency code.", "readOnly": false, "writeOnly": false } } }, "Attachment": { "type": "object", "properties": { "description": { "type": "string", "description": "The description of the attachment.", "readOnly": true, "writeOnly": false }, "content_type": { "type": "string", "description": "The content type of the attachment's file.", "readOnly": true, "writeOnly": false } } }, "AttachmentConversationContentListing": { "type": "object" }, "AttachmentMonetaryAccount": { "type": "object" }, "AttachmentMonetaryAccountContentListing": { "type": "object" }, "AttachmentMonetaryAccountCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the attachment created.", "readOnly": true, "writeOnly": false } } }, "AttachmentMonetaryAccountPayment": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the attached Attachment.", "readOnly": false, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the MonetaryAccount this Attachment is attached from.", "readOnly": true, "writeOnly": false } } }, "AttachmentPublic": { "type": "object" }, "AttachmentPublicContentListing": { "type": "object" }, "AttachmentPublicCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "AttachmentPublicRead": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The UUID of the attachment.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the attachment's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the attachment's last update.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "object", "description": "The attachment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Attachment" } } }, "AttachmentTab": { "type": "object" }, "AttachmentTabContentListing": { "type": "object" }, "AttachmentTabCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "AttachmentTabRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the attachment.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the attachment's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the attachment's last update.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "object", "description": "The attachment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Attachment" } } }, "AttachmentUserContentListing": { "type": "object" }, "AttachmentUserRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the attachment.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the attachment's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the attachment's last update.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "object", "description": "The attachment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Attachment" } } }, "Avatar": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The public UUID of the avatar.", "readOnly": false, "writeOnly": false }, "anchor_uuid": { "type": "string", "description": "The public UUID of object this avatar is anchored to.", "readOnly": true, "writeOnly": false }, "image": { "type": "array", "description": "The actual image information of this avatar.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Image" } } } }, "AvatarCreate": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The UUID of the created avatar.", "readOnly": true, "writeOnly": false } } }, "AvatarRead": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The UUID of the created avatar.", "readOnly": true, "writeOnly": false }, "image": { "type": "array", "description": "The content type of the image.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Image" } } } }, "BankSwitchServiceNetherlandsIncoming": { "type": "object", "properties": { "alias": { "type": "object", "description": "The label of the monetary of this switch service.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The IBAN alias that's displayed for this switch service.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "status": { "type": "string", "description": "The status of the switch service.", "readOnly": false, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub status of the switch service.", "readOnly": false, "writeOnly": false }, "time_start_actual": { "type": "string", "description": "The timestamp when the switch service actually starts.", "readOnly": false, "writeOnly": false }, "user_alias": { "type": "object", "description": "The label of the user creator of this switch service.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "time_start_desired": { "type": "string", "description": "The timestamp when the switch service desired to be start.", "readOnly": true, "writeOnly": false }, "time_end": { "type": "string", "description": "The timestamp when the switch service ends.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "object", "description": "Reference to the bank transfer form for this switch-service.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Attachment" } } }, "BankSwitchServiceNetherlandsIncomingPayment": { "type": "object", "properties": { "bank_switch_service": { "type": "object", "description": "The bank switch service details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BankSwitchServiceNetherlandsIncoming" }, "payment": { "type": "object", "description": "The payment made using bank switch service.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" } } }, "BankSwitchServiceNetherlandsIncomingPaymentRead": { "type": "object", "properties": { "bank_switch_service": { "type": "object", "description": "The bank switch service details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BankSwitchServiceNetherlandsIncoming" }, "payment": { "type": "object", "description": "The payment made using bank switch service.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" } } }, "BillingContractSubscription": { "type": "object", "properties": { "subscription_type": { "type": "string", "description": "The subscription type of the user. Can be one of PERSON_SUPER_LIGHT_V1, PERSON_LIGHT_V1, PERSON_MORE_V1, PERSON_FREE_V1, PERSON_PREMIUM_V1, COMPANY_V1, or COMPANY_V2.", "readOnly": false, "writeOnly": false }, "id": { "type": "integer", "description": "The id of the billing contract.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp when the billing contract was made.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp when the billing contract was last updated.", "readOnly": true, "writeOnly": false }, "contract_date_start": { "type": "string", "description": "The date from when the billing contract is valid.", "readOnly": true, "writeOnly": false }, "contract_date_end": { "type": "string", "description": "The date until when the billing contract is valid.", "readOnly": true, "writeOnly": false }, "contract_version": { "type": "integer", "description": "The version of the billing contract.", "readOnly": true, "writeOnly": false }, "subscription_type_downgrade": { "type": "string", "description": "The subscription type the user will have after a subscription downgrade. Will be null if downgrading is not possible.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The subscription status.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The subscription substatus.", "readOnly": true, "writeOnly": false } } }, "BillingContractSubscriptionListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the billing contract.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp when the billing contract was made.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp when the billing contract was last updated.", "readOnly": true, "writeOnly": false }, "contract_date_start": { "type": "string", "description": "The date from when the billing contract is valid.", "readOnly": true, "writeOnly": false }, "contract_date_end": { "type": "string", "description": "The date until when the billing contract is valid.", "readOnly": true, "writeOnly": false }, "contract_version": { "type": "integer", "description": "The version of the billing contract.", "readOnly": true, "writeOnly": false }, "subscription_type": { "type": "string", "description": "The subscription type of the user. Can be one of PERSON_SUPER_LIGHT_V1, PERSON_LIGHT_V1, PERSON_MORE_V1, PERSON_FREE_V1, PERSON_PREMIUM_V1, COMPANY_V1, or COMPANY_V2.", "readOnly": true, "writeOnly": false }, "subscription_type_downgrade": { "type": "string", "description": "The subscription type the user will have after a subscription downgrade. Will be null if downgrading is not possible.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The subscription status.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The subscription substatus.", "readOnly": true, "writeOnly": false } } }, "BudgetRestriction": { "type": "object", "properties": { "amount": { "type": "object", "description": "The amount of the budget given to the invited user.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "frequency": { "type": "string", "description": "The duration for a budget restriction. Valid values are DAILY, WEEKLY, MONTHLY, YEARLY.", "readOnly": false, "writeOnly": false } } }, "BunqId": { "type": "object", "properties": { "id": { "type": "integer", "description": "An integer ID of an object. Unique per object type.", "readOnly": false, "writeOnly": false } } }, "BunqMeFundraiserProfile": { "type": "object", "properties": { "pointer": { "type": "object", "description": "The pointer (url) which will be used to access the bunq.me fundraiser profile.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Pointer" }, "color": { "type": "string", "description": "The color chosen for the bunq.me fundraiser profile in hexadecimal format.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the User and the MonetaryAccount that created the bunq.me fundraiser profile.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "description": { "type": "string", "description": "The description of the bunq.me fundraiser profile.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachments attached to the fundraiser profile.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentPublic" } }, "status": { "type": "string", "description": "The status of the bunq.me fundraiser profile, can be ACTIVE or DEACTIVATED.", "readOnly": true, "writeOnly": false }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to when a payment is completed.", "readOnly": true, "writeOnly": false }, "invite_profile_name": { "type": "string", "description": "Provided if the user has enabled their invite link.", "readOnly": true, "writeOnly": false } } }, "BunqMeFundraiserProfileUserListing": { "type": "object", "properties": { "monetary_account_id": { "type": "integer", "description": "Id of the monetary account on which you want to receive bunq.me payments.", "readOnly": true, "writeOnly": false }, "color": { "type": "string", "description": "The color chosen for the bunq.me fundraiser profile in hexadecimal format.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the User and the MonetaryAccount that created the bunq.me fundraiser profile.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "description": { "type": "string", "description": "The description of the bunq.me fundraiser profile.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "object", "description": "The attachment used for the background of the bunq.me fundraiser profile.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/AttachmentPublic" }, "pointer": { "type": "object", "description": "The pointer (url) which will be used to access the bunq.me fundraiser profile.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Pointer" }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to when a payment is completed.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the bunq.me fundraiser profile, can be ACTIVE or DEACTIVATED.", "readOnly": true, "writeOnly": false } } }, "BunqMeFundraiserProfileUserRead": { "type": "object", "properties": { "monetary_account_id": { "type": "integer", "description": "Id of the monetary account on which you want to receive bunq.me payments.", "readOnly": true, "writeOnly": false }, "color": { "type": "string", "description": "The color chosen for the bunq.me fundraiser profile in hexadecimal format.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the User and the MonetaryAccount that created the bunq.me fundraiser profile.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "description": { "type": "string", "description": "The description of the bunq.me fundraiser profile.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "object", "description": "The attachment used for the background of the bunq.me fundraiser profile.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/AttachmentPublic" }, "pointer": { "type": "object", "description": "The pointer (url) which will be used to access the bunq.me fundraiser profile.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Pointer" }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to when a payment is completed.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the bunq.me fundraiser profile, can be ACTIVE or DEACTIVATED.", "readOnly": true, "writeOnly": false } } }, "BunqMeFundraiserResult": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the bunq.me.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp when the bunq.me was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp when the bunq.me was last updated.", "readOnly": true, "writeOnly": false }, "bunqme_fundraiser_profile": { "type": "object", "description": "The bunq.me fundraiser profile.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqMeFundraiserProfile" }, "payments": { "type": "array", "description": "The list of payments, paid to the bunq.me fundraiser profile.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Payment" } } } }, "BunqMeFundraiserResultRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the bunq.me.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp when the bunq.me was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp when the bunq.me was last updated.", "readOnly": true, "writeOnly": false }, "bunqme_fundraiser_profile": { "type": "object", "description": "The bunq.me fundraiser profile.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqMeFundraiserProfile" }, "payments": { "type": "array", "description": "The list of payments, paid to the bunq.me fundraiser profile.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Payment" } } } }, "BunqMeMerchantAvailable": { "type": "object", "properties": { "merchant_type": { "type": "string", "description": "A merchant type supported by bunq.me.", "readOnly": true, "writeOnly": false }, "available": { "type": "boolean", "description": "Whether or not the merchant is available for the user.", "readOnly": true, "writeOnly": false } } }, "BunqMeTab": { "type": "object", "properties": { "bunqme_tab_entry": { "type": "object", "description": "The bunq.me entry containing the payment information.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqMeTabEntry" }, "status": { "type": "string", "description": "The status of the bunq.me. Ignored in POST requests but can be used for cancelling the bunq.me by setting status as CANCELLED with a PUT request.", "readOnly": false, "writeOnly": false } }, "required": [ "bunqme_tab_entry" ] }, "BunqMeTabCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created bunq.me.", "readOnly": true, "writeOnly": false } } }, "BunqMeTabEntry": { "type": "object", "properties": { "amount_inquired": { "type": "object", "description": "The requested Amount.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "description": { "type": "string", "description": "The description for the bunq.me. Maximum 9000 characters.", "readOnly": false, "writeOnly": false }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to when a payment is completed.", "readOnly": false, "writeOnly": false }, "uuid": { "type": "string", "description": "The uuid of the bunq.me.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the User and the MonetaryAccount that created the bunq.me link.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "status": { "type": "string", "description": "The status of the bunq.me. Can be WAITING_FOR_PAYMENT, CANCELLED or EXPIRED.", "readOnly": true, "writeOnly": false }, "merchant_available": { "type": "array", "description": "List of available merchants.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BunqMeMerchantAvailable" } } } }, "BunqMeTabListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created bunq.me.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp when the bunq.me was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp when the bunq.me was last updated.", "readOnly": true, "writeOnly": false }, "time_expiry": { "type": "string", "description": "The timestamp of when the bunq.me expired or will expire.", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the MonetaryAccount the bunq.me was sent from.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the bunq.me. Can be WAITING_FOR_PAYMENT, CANCELLED or EXPIRED.", "readOnly": true, "writeOnly": false }, "bunqme_tab_share_url": { "type": "string", "description": "The url that points to the bunq.me page.", "readOnly": true, "writeOnly": false }, "bunqme_tab_entry": { "type": "object", "description": "The bunq.me entry containing the payment information.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqMeTabEntry" }, "result_inquiries": { "type": "array", "description": "The list of bunq.me result Inquiries successfully made and paid.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BunqMeTabResultInquiry" } } } }, "BunqMeTabRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created bunq.me.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp when the bunq.me was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp when the bunq.me was last updated.", "readOnly": true, "writeOnly": false }, "time_expiry": { "type": "string", "description": "The timestamp of when the bunq.me expired or will expire.", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the MonetaryAccount the bunq.me was sent from.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the bunq.me. Can be WAITING_FOR_PAYMENT, CANCELLED or EXPIRED.", "readOnly": true, "writeOnly": false }, "bunqme_tab_share_url": { "type": "string", "description": "The url that points to the bunq.me page.", "readOnly": true, "writeOnly": false }, "bunqme_tab_entry": { "type": "object", "description": "The bunq.me entry containing the payment information.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqMeTabEntry" }, "result_inquiries": { "type": "array", "description": "The list of bunq.me result Inquiries successfully made and paid.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BunqMeTabResultInquiry" } } } }, "BunqMeTabResultInquiry": { "type": "object", "properties": { "payment": { "type": "object", "description": "The payment made for the Tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" }, "bunq_me_tab_id": { "type": "integer", "description": "The Id of the bunq.me tab that this BunqMeTabResultInquiry belongs to.", "readOnly": true, "writeOnly": false } } }, "BunqMeTabResultResponse": { "type": "object", "properties": { "payment": { "type": "object", "description": "The payment made for the bunq.me tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" } } }, "BunqMeTabResultResponseRead": { "type": "object", "properties": { "payment": { "type": "object", "description": "The payment made for the bunq.me tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" } } }, "BunqMeTabUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "Card": { "type": "object", "properties": { "pin_code": { "type": "string", "description": "The plaintext pin code. Requests require encryption to be enabled.", "readOnly": false, "writeOnly": true }, "activation_code": { "type": "string", "description": "DEPRECATED: Activate a card by setting status to ACTIVE when the order_status is ACCEPTED_FOR_PRODUCTION.", "readOnly": false, "writeOnly": true }, "status": { "type": "string", "description": "The status to set for the card. Can be ACTIVE, DEACTIVATED, LOST, STOLEN or CANCELLED, and can only be set to LOST\/STOLEN\/CANCELLED when order status is ACCEPTED_FOR_PRODUCTION\/DELIVERED_TO_CUSTOMER\/CARD_UPDATE_REQUESTED\/CARD_UPDATE_SENT\/CARD_UPDATE_ACCEPTED. Can only be set to DEACTIVATED after initial activation, i.e. order_status is DELIVERED_TO_CUSTOMER\/CARD_UPDATE_REQUESTED\/CARD_UPDATE_SENT\/CARD_UPDATE_ACCEPTED. Mind that all the possible choices (apart from ACTIVE and DEACTIVATED) are permanent and cannot be changed after.", "readOnly": false, "writeOnly": false }, "card_limit": { "type": "object", "description": "The spending limit for the card.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "card_limit_atm": { "type": "object", "description": "The ATM spending limit for the card.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "mag_stripe_permission": { "type": "object", "description": "DEPRECATED: Whether or not it is allowed to use the mag stripe for the card.", "readOnly": false, "writeOnly": true, "$ref": "#\/components\/schemas\/CardMagStripePermission" }, "country_permission": { "type": "array", "description": "The countries for which to grant (temporary) permissions to use the card.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CardCountryPermission" } }, "pin_code_assignment": { "type": "array", "description": "Array of Types, PINs, account IDs assigned to the card.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CardPinAssignment" } }, "primary_account_numbers_virtual": { "type": "array", "description": "Array of PANs, status, description and account id for online cards.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CardVirtualPrimaryAccountNumber" } }, "primary_account_numbers": { "type": "array", "description": "Array of PANs and their attributes.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CardPrimaryAccountNumber" } }, "monetary_account_id_fallback": { "type": "integer", "description": "ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied.", "readOnly": false, "writeOnly": false } } }, "CardBatch": { "type": "object", "properties": { "cards": { "type": "array", "description": "The cards that need to be updated.", "readOnly": false, "writeOnly": true, "items": { "$ref": "#\/components\/schemas\/CardBatchEntry" } } }, "required": [ "cards" ] }, "CardBatchCreate": { "type": "object", "properties": { "updated_card_ids": { "type": "array", "description": "The ids of the cards that have been updated.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BunqId" } } } }, "CardBatchEntry": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the card that needs to be updated.", "readOnly": false, "writeOnly": true }, "status": { "type": "string", "description": "The status to set for the card. Can be ACTIVE, DEACTIVATED, LOST, STOLEN or CANCELLED, and can only be set to LOST\/STOLEN\/CANCELLED when order status is ACCEPTED_FOR_PRODUCTION\/DELIVERED_TO_CUSTOMER\/CARD_UPDATE_REQUESTED\/CARD_UPDATE_SENT\/CARD_UPDATE_ACCEPTED. Can only be set to DEACTIVATED after initial activation, i.e. order_status is DELIVERED_TO_CUSTOMER\/CARD_UPDATE_REQUESTED\/CARD_UPDATE_SENT\/CARD_UPDATE_ACCEPTED. Mind that all the possible choices (apart from ACTIVE and DEACTIVATED) are permanent and cannot be changed after.", "readOnly": false, "writeOnly": true }, "card_limit": { "type": "object", "description": "The spending limit for the card.", "readOnly": false, "writeOnly": true, "$ref": "#\/components\/schemas\/Amount" }, "card_limit_atm": { "type": "object", "description": "The ATM spending limit for the card.", "readOnly": false, "writeOnly": true, "$ref": "#\/components\/schemas\/Amount" }, "country_permission": { "type": "array", "description": "The countries for which to grant (temporary) permissions to use the card.", "readOnly": false, "writeOnly": true, "items": { "$ref": "#\/components\/schemas\/CardCountryPermission" } }, "monetary_account_id_fallback": { "type": "integer", "description": "ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied.", "readOnly": false, "writeOnly": true } }, "required": [ "id" ] }, "CardCountryPermission": { "type": "object", "properties": { "country": { "type": "string", "description": "The country to allow transactions in (e.g. NL, DE).", "readOnly": false, "writeOnly": false }, "expiry_time": { "type": "string", "description": "Expiry time of this rule.", "readOnly": false, "writeOnly": false }, "id": { "type": "integer", "description": "The id of the card country permission entry.", "readOnly": true, "writeOnly": false } } }, "CardDebit": { "type": "object", "properties": { "second_line": { "type": "string", "description": "The second line of text on the card, used as name\/description for it. It can contain at most 17 characters and it can be empty.", "readOnly": false, "writeOnly": false }, "name_on_card": { "type": "string", "description": "The user's name as it will be on the card. Check 'card-name' for the available card names for a user.", "readOnly": false, "writeOnly": false }, "alias": { "type": "object", "description": "The pointer to the monetary account that will be connected at first with the card. Its IBAN code is also the one that will be printed on the card itself. The pointer must be of type IBAN.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Pointer" }, "type": { "type": "string", "description": "The type of card to order. Can be MAESTRO or MASTERCARD.", "readOnly": false, "writeOnly": false }, "pin_code_assignment": { "type": "array", "description": "Array of Types, PINs, account IDs assigned to the card.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CardPinAssignment" } }, "monetary_account_id_fallback": { "type": "integer", "description": "ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied.", "readOnly": false, "writeOnly": false } }, "required": [ "second_line", "name_on_card" ] }, "CardDebitCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "CardGeneratedCvc2": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of generated cvc2. Can be STATIC or GENERATED.", "readOnly": false, "writeOnly": false } } }, "CardGeneratedCvc2Create": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "CardGeneratedCvc2Listing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the cvc code.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the cvc code's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the cvc code's last update.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of generated cvc2. Can be STATIC or GENERATED.", "readOnly": true, "writeOnly": false }, "cvc2": { "type": "string", "description": "The cvc2 code.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the cvc2. Can be AVAILABLE, USED, EXPIRED, BLOCKED.", "readOnly": true, "writeOnly": false }, "expiry_time": { "type": "string", "description": "Expiry time of the cvc2.", "readOnly": true, "writeOnly": false } } }, "CardGeneratedCvc2Read": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the cvc code.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the cvc code's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the cvc code's last update.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of generated cvc2. Can be STATIC or GENERATED.", "readOnly": true, "writeOnly": false }, "cvc2": { "type": "string", "description": "The cvc2 code.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the cvc2. Can be AVAILABLE, USED, EXPIRED, BLOCKED.", "readOnly": true, "writeOnly": false }, "expiry_time": { "type": "string", "description": "Expiry time of the cvc2.", "readOnly": true, "writeOnly": false } } }, "CardGeneratedCvc2Update": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "CardListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the card.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the card's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the card's last update.", "readOnly": true, "writeOnly": false }, "public_uuid": { "type": "string", "description": "The public UUID of the card.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the card. Can be MAESTRO, MASTERCARD.", "readOnly": true, "writeOnly": false }, "sub_type": { "type": "string", "description": "The sub-type of the card.", "readOnly": true, "writeOnly": false }, "second_line": { "type": "string", "description": "The second line of text on the card", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status to set for the card. Can be ACTIVE, DEACTIVATED, LOST, STOLEN, CANCELLED, EXPIRED or PIN_TRIES_EXCEEDED.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the card. Can be NONE or REPLACED.", "readOnly": true, "writeOnly": false }, "order_status": { "type": "string", "description": "The order status of the card. Can be CARD_UPDATE_REQUESTED, CARD_UPDATE_SENT, CARD_UPDATE_ACCEPTED, ACCEPTED_FOR_PRODUCTION or DELIVERED_TO_CUSTOMER.", "readOnly": true, "writeOnly": false }, "expiry_date": { "type": "string", "description": "Expiry date of the card.", "readOnly": true, "writeOnly": false }, "name_on_card": { "type": "string", "description": "The user's name on the card.", "readOnly": true, "writeOnly": false }, "primary_account_number_four_digit": { "type": "string", "description": "The last 4 digits of the PAN of the card.", "readOnly": true, "writeOnly": false }, "primary_account_numbers_virtual": { "type": "array", "description": "Array of PANs, status, description and account id for online cards.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CardVirtualPrimaryAccountNumber" } }, "primary_account_numbers": { "type": "array", "description": "Array of PANs and their attributes.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CardPrimaryAccountNumber" } }, "card_limit": { "type": "object", "description": "The spending limit for the card.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "card_limit_atm": { "type": "object", "description": "The ATM spending limit for the card.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "country_permission": { "type": "array", "description": "The countries for which to grant (temporary) permissions to use the card.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CardCountryPermission" } }, "label_monetary_account_ordered": { "type": "object", "description": "The monetary account this card was ordered on and the label user that owns the card.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "label_monetary_account_current": { "type": "object", "description": "The monetary account that this card is currently linked to and the label user viewing it.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "pin_code_assignment": { "type": "array", "description": "Array of Types, PINs, account IDs assigned to the card.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CardPinAssignment" } }, "monetary_account_id_fallback": { "type": "integer", "description": "ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied.", "readOnly": true, "writeOnly": false }, "country": { "type": "string", "description": "The country that is domestic to the card. Defaults to country of residence of user.", "readOnly": true, "writeOnly": false } } }, "CardMagStripePermission": { "type": "object", "properties": { "expiry_time": { "type": "string", "description": "Expiry time of this rule.", "readOnly": false, "writeOnly": false } } }, "CardNameListing": { "type": "object", "properties": { "possible_card_name_array": { "type": "array", "description": "All possible variations (of suitable length) of user's legal name for the debit card.", "readOnly": true, "writeOnly": false, "items": { "type": "string" } } } }, "CardPinAssignment": { "type": "object", "properties": { "type": { "type": "string", "description": "PIN type. Can be PRIMARY, SECONDARY or TERTIARY", "readOnly": false, "writeOnly": false }, "pin_code": { "type": "string", "description": "The 4 digit PIN to be assigned to this account.", "readOnly": false, "writeOnly": true }, "monetary_account_id": { "type": "integer", "description": "The ID of the monetary account to assign to this pin for the card.", "readOnly": false, "writeOnly": false } } }, "CardPrimaryAccountNumber": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID for this Virtual PAN.", "readOnly": false, "writeOnly": false }, "description": { "type": "string", "description": "The description for this PAN.", "readOnly": false, "writeOnly": false }, "status": { "type": "string", "description": "The status for this PAN, only for Online Cards.", "readOnly": false, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The ID of the monetary account to assign to this PAN, only for Online Cards.", "readOnly": false, "writeOnly": false }, "uuid": { "type": "string", "description": "The UUID for this Virtual PAN.", "readOnly": true, "writeOnly": false }, "four_digit": { "type": "string", "description": "The last four digits of the PAN.", "readOnly": true, "writeOnly": false } } }, "CardRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the card.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the card's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the card's last update.", "readOnly": true, "writeOnly": false }, "public_uuid": { "type": "string", "description": "The public UUID of the card.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the card. Can be MAESTRO, MASTERCARD.", "readOnly": true, "writeOnly": false }, "sub_type": { "type": "string", "description": "The sub-type of the card.", "readOnly": true, "writeOnly": false }, "second_line": { "type": "string", "description": "The second line of text on the card", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status to set for the card. Can be ACTIVE, DEACTIVATED, LOST, STOLEN, CANCELLED, EXPIRED or PIN_TRIES_EXCEEDED.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the card. Can be NONE or REPLACED.", "readOnly": true, "writeOnly": false }, "order_status": { "type": "string", "description": "The order status of the card. Can be CARD_UPDATE_REQUESTED, CARD_UPDATE_SENT, CARD_UPDATE_ACCEPTED, ACCEPTED_FOR_PRODUCTION or DELIVERED_TO_CUSTOMER.", "readOnly": true, "writeOnly": false }, "expiry_date": { "type": "string", "description": "Expiry date of the card.", "readOnly": true, "writeOnly": false }, "name_on_card": { "type": "string", "description": "The user's name on the card.", "readOnly": true, "writeOnly": false }, "primary_account_number_four_digit": { "type": "string", "description": "The last 4 digits of the PAN of the card.", "readOnly": true, "writeOnly": false }, "primary_account_numbers_virtual": { "type": "array", "description": "Array of PANs, status, description and account id for online cards.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CardVirtualPrimaryAccountNumber" } }, "primary_account_numbers": { "type": "array", "description": "Array of PANs and their attributes.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CardPrimaryAccountNumber" } }, "card_limit": { "type": "object", "description": "The spending limit for the card.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "card_limit_atm": { "type": "object", "description": "The ATM spending limit for the card.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "country_permission": { "type": "array", "description": "The countries for which to grant (temporary) permissions to use the card.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CardCountryPermission" } }, "label_monetary_account_ordered": { "type": "object", "description": "The monetary account this card was ordered on and the label user that owns the card.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "label_monetary_account_current": { "type": "object", "description": "The monetary account that this card is currently linked to and the label user viewing it.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "pin_code_assignment": { "type": "array", "description": "Array of Types, PINs, account IDs assigned to the card.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CardPinAssignment" } }, "monetary_account_id_fallback": { "type": "integer", "description": "ID of the MA to be used as fallback for this card if insufficient balance. Fallback account is removed if not supplied.", "readOnly": true, "writeOnly": false }, "country": { "type": "string", "description": "The country that is domestic to the card. Defaults to country of residence of user.", "readOnly": true, "writeOnly": false } } }, "CardReplace": { "type": "object", "properties": { "name_on_card": { "type": "string", "description": "The user's name as it will be on the card. Check 'card-name' for the available card names for a user.", "readOnly": false, "writeOnly": true }, "pin_code": { "type": "string", "description": "The plaintext pin code. Requests require encryption to be enabled.", "readOnly": false, "writeOnly": true }, "second_line": { "type": "string", "description": "The second line on the card.", "readOnly": false, "writeOnly": true } } }, "CardReplaceCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "CardUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "CardVirtualPrimaryAccountNumber": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID for this Virtual PAN.", "readOnly": false, "writeOnly": false }, "description": { "type": "string", "description": "The description for this Virtual PAN.", "readOnly": false, "writeOnly": false }, "status": { "type": "string", "description": "The status for this Virtual PAN.", "readOnly": false, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The ID of the monetary account to assign to this Virtual PAN.", "readOnly": false, "writeOnly": false }, "uuid": { "type": "string", "description": "The UUID for this Virtual PAN.", "readOnly": true, "writeOnly": false }, "four_digit": { "type": "string", "description": "The last four digits of the Virtual PAN.", "readOnly": true, "writeOnly": false } } }, "CashRegister": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the CashRegister.", "readOnly": false, "writeOnly": false }, "status": { "type": "string", "description": "The status of the CashRegister. Can be PENDING_APPROVAL, ACTIVE, DENIED or CLOSED.", "readOnly": false, "writeOnly": false }, "avatar_uuid": { "type": "string", "description": "The UUID of the avatar of the CashRegister. Use the calls \/attachment-public and \/avatar to create a new Avatar and get its UUID.", "readOnly": false, "writeOnly": true }, "location": { "type": "object", "description": "The geolocation of the CashRegister. Can be null.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this CashRegister.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "tab_text_waiting_screen": { "type": "array", "description": "The tab text for waiting screen of CashRegister.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/TabTextWaitingScreen" } }, "id": { "type": "integer", "description": "The id of the created CashRegister.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the CashRegister's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the CashRegister's last update.", "readOnly": true, "writeOnly": false }, "avatar": { "type": "object", "description": "The Avatar of the CashRegister.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" } }, "required": [ "avatar_uuid" ] }, "CashRegisterCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created CashRegister.", "readOnly": true, "writeOnly": false } } }, "CashRegisterListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created CashRegister.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the CashRegister's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the CashRegister's last update.", "readOnly": true, "writeOnly": false }, "name": { "type": "string", "description": "The name of the CashRegister.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the CashRegister. Can be PENDING_APPROVAL, ACTIVE, DENIED or CLOSED.", "readOnly": true, "writeOnly": false }, "avatar": { "type": "object", "description": "The Avatar of the CashRegister.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "location": { "type": "object", "description": "The geolocation of the CashRegister. Can be null.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this CashRegister.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "tab_text_waiting_screen": { "type": "array", "description": "The tab text for waiting screen of CashRegister.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/TabTextWaitingScreen" } } } }, "CashRegisterQrCode": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the QR code. ACTIVE or INACTIVE. Only one QR code can be ACTIVE for a CashRegister at any time. Setting a QR code to ACTIVE will deactivate any other CashRegister QR codes.", "readOnly": false, "writeOnly": false } }, "required": [ "status" ] }, "CashRegisterQrCodeContentListing": { "type": "object" }, "CashRegisterQrCodeCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created QR code. Use this id to get the RAW content of the QR code with: ..\/qr-code\/{id}\/content", "readOnly": true, "writeOnly": false } } }, "CashRegisterQrCodeListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created QR code. Use this id to get the RAW content of the QR code with: ..\/qr-code\/{id}\/content", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the QR code's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the TokenQrCashRegister's last update.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of this QR code. If the status is \"ACTIVE\" the QR code can be scanned to see the linked CashRegister and tab. If the status is \"INACTIVE\" the QR code does not link to a anything.", "readOnly": true, "writeOnly": false }, "cash_register": { "type": "object", "description": "The CashRegister that is linked to the token.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/CashRegister" }, "tab_object": { "type": "object", "description": "Holds the Tab object. Can be TabUsageSingle, TabUsageMultiple or null", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Tab" } } }, "CashRegisterQrCodeRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created QR code. Use this id to get the RAW content of the QR code with: ..\/qr-code\/{id}\/content", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the QR code's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the TokenQrCashRegister's last update.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of this QR code. If the status is \"ACTIVE\" the QR code can be scanned to see the linked CashRegister and tab. If the status is \"INACTIVE\" the QR code does not link to a anything.", "readOnly": true, "writeOnly": false }, "cash_register": { "type": "object", "description": "The CashRegister that is linked to the token.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/CashRegister" }, "tab_object": { "type": "object", "description": "Holds the Tab object. Can be TabUsageSingle, TabUsageMultiple or null", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Tab" } } }, "CashRegisterQrCodeUpdate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the updated QR code. Use this id to get the RAW content of the QR code with: ..\/qr-code\/{id}\/content", "readOnly": true, "writeOnly": false } } }, "CashRegisterRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created CashRegister.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the CashRegister's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the CashRegister's last update.", "readOnly": true, "writeOnly": false }, "name": { "type": "string", "description": "The name of the CashRegister.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the CashRegister. Can be PENDING_APPROVAL, ACTIVE, DENIED or CLOSED.", "readOnly": true, "writeOnly": false }, "avatar": { "type": "object", "description": "The Avatar of the CashRegister.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "location": { "type": "object", "description": "The geolocation of the CashRegister. Can be null.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this CashRegister.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "tab_text_waiting_screen": { "type": "array", "description": "The tab text for waiting screen of CashRegister.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/TabTextWaitingScreen" } } } }, "CashRegisterUpdate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the updated CashRegister.", "readOnly": true, "writeOnly": false } } }, "Certificate": { "type": "object", "properties": { "certificate": { "type": "string", "description": "A single certificate in the chain in .PEM format.", "readOnly": false, "writeOnly": false } } }, "CertificatePinned": { "type": "object", "properties": { "certificate_chain": { "type": "array", "description": "The certificate chain in .PEM format.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Certificate" } } }, "required": [ "certificate_chain" ] }, "CertificatePinnedCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id generated for the pinned certificate chain.", "readOnly": true, "writeOnly": false } } }, "CertificatePinnedDelete": { "type": "object" }, "CertificatePinnedListing": { "type": "object", "properties": { "certificate_chain": { "type": "string", "description": "The certificate chain in .PEM format. Certificates are glued with newline characters.", "readOnly": true, "writeOnly": false }, "id": { "type": "integer", "description": "The id generated for the pinned certificate chain.", "readOnly": true, "writeOnly": false } } }, "CertificatePinnedRead": { "type": "object", "properties": { "certificate_chain": { "type": "string", "description": "The certificate chain in .PEM format. Certificates are glued with newline characters.", "readOnly": true, "writeOnly": false }, "id": { "type": "integer", "description": "The id generated for the pinned certificate chain.", "readOnly": true, "writeOnly": false } } }, "CoOwner": { "type": "object", "properties": { "alias": { "type": "object", "description": "The Alias of the co-owner.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "status": { "type": "string", "description": "Can be: ACCEPTED, REJECTED, PENDING or REVOKED", "readOnly": true, "writeOnly": false } } }, "ConfirmationOfFunds": { "type": "object", "properties": { "pointer_iban": { "type": "object", "description": "The pointer (IBAN) of the account we're querying.", "readOnly": false, "writeOnly": true, "$ref": "#\/components\/schemas\/Pointer" }, "amount": { "type": "object", "description": "The amount we want to check for.", "readOnly": false, "writeOnly": true, "$ref": "#\/components\/schemas\/Amount" } }, "required": [ "pointer_iban", "amount" ] }, "ConfirmationOfFundsCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "Customer": { "type": "object", "properties": { "billing_account_id": { "type": "string", "description": "The primary billing account account's id.", "readOnly": false, "writeOnly": false }, "invoice_notification_preference": { "type": "string", "description": "The preferred notification type for invoices.", "readOnly": false, "writeOnly": false }, "id": { "type": "integer", "description": "The id of the customer.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the customer object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the customer object's last update.", "readOnly": true, "writeOnly": false } } }, "CustomerLimit": { "type": "object", "properties": { "limit_monetary_account": { "type": "integer", "description": "The limit of monetary accounts.", "readOnly": true, "writeOnly": false }, "limit_monetary_account_remaining": { "type": "integer", "description": "The amount of additional monetary accounts you can create.", "readOnly": true, "writeOnly": false }, "limit_card_debit_maestro": { "type": "integer", "description": "The limit of Maestro cards.", "readOnly": true, "writeOnly": false }, "limit_card_debit_mastercard": { "type": "integer", "description": "The limit of MasterCard cards.", "readOnly": true, "writeOnly": false }, "limit_card_debit_wildcard": { "type": "integer", "description": "DEPRECTATED: The limit of wildcards, e.g. Maestro or MasterCard cards.", "readOnly": true, "writeOnly": false }, "limit_card_wildcard": { "type": "integer", "description": "The limit of wildcards, e.g. Maestro or MasterCard cards.", "readOnly": true, "writeOnly": false }, "limit_card_debit_replacement": { "type": "integer", "description": "DEPRECTATED: The limit of free replacement debit cards, replaced by: limit_card_replacement", "readOnly": true, "writeOnly": false }, "limit_card_replacement": { "type": "integer", "description": "The limit of free replacement cards.", "readOnly": true, "writeOnly": false }, "limit_amount_monthly": { "type": "object", "description": "The maximum amount a user is allowed to spend in a month.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "spent_amount_monthly": { "type": "object", "description": "The amount the user has spent in the last month.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "CustomerLimitListing": { "type": "object", "properties": { "limit_monetary_account": { "type": "integer", "description": "The limit of monetary accounts.", "readOnly": true, "writeOnly": false }, "limit_monetary_account_remaining": { "type": "integer", "description": "The amount of additional monetary accounts you can create.", "readOnly": true, "writeOnly": false }, "limit_card_debit_maestro": { "type": "integer", "description": "The limit of Maestro cards.", "readOnly": true, "writeOnly": false }, "limit_card_debit_mastercard": { "type": "integer", "description": "The limit of MasterCard cards.", "readOnly": true, "writeOnly": false }, "limit_card_debit_wildcard": { "type": "integer", "description": "DEPRECTATED: The limit of wildcards, e.g. Maestro or MasterCard cards.", "readOnly": true, "writeOnly": false }, "limit_card_wildcard": { "type": "integer", "description": "The limit of wildcards, e.g. Maestro or MasterCard cards.", "readOnly": true, "writeOnly": false }, "limit_card_debit_replacement": { "type": "integer", "description": "DEPRECTATED: The limit of free replacement debit cards, replaced by: limit_card_replacement", "readOnly": true, "writeOnly": false }, "limit_card_replacement": { "type": "integer", "description": "The limit of free replacement cards.", "readOnly": true, "writeOnly": false }, "limit_amount_monthly": { "type": "object", "description": "The maximum amount a user is allowed to spend in a month.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "spent_amount_monthly": { "type": "object", "description": "The amount the user has spent in the last month.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "CustomerStatementExport": { "type": "object", "properties": { "statement_format": { "type": "string", "description": "The format type of statement. Allowed values: MT940, CSV, PDF.", "readOnly": false, "writeOnly": false }, "date_start": { "type": "string", "description": "The start date for making statements.", "readOnly": false, "writeOnly": false }, "date_end": { "type": "string", "description": "The end date for making statements.", "readOnly": false, "writeOnly": false }, "regional_format": { "type": "string", "description": "Required for CSV exports. The regional format of the statement, can be UK_US (comma-separated) or EUROPEAN (semicolon-separated).", "readOnly": false, "writeOnly": false } }, "required": [ "statement_format", "date_start", "date_end" ] }, "CustomerStatementExportContentListing": { "type": "object" }, "CustomerStatementExportCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "CustomerStatementExportDelete": { "type": "object" }, "CustomerStatementExportListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the customer statement model.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the statement model's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the statement model's last update.", "readOnly": true, "writeOnly": false }, "date_start": { "type": "string", "description": "The date from when this statement shows transactions.", "readOnly": true, "writeOnly": false }, "date_end": { "type": "string", "description": "The date until which statement shows transactions.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the export.", "readOnly": true, "writeOnly": false }, "statement_number": { "type": "integer", "description": "MT940 Statement number. Unique per monetary account.", "readOnly": true, "writeOnly": false }, "statement_format": { "type": "string", "description": "The format of statement.", "readOnly": true, "writeOnly": false }, "regional_format": { "type": "string", "description": "The regional format of a CSV statement.", "readOnly": true, "writeOnly": false }, "alias_monetary_account": { "type": "object", "description": "The monetary account for which this statement was created.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" } } }, "CustomerStatementExportRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the customer statement model.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the statement model's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the statement model's last update.", "readOnly": true, "writeOnly": false }, "date_start": { "type": "string", "description": "The date from when this statement shows transactions.", "readOnly": true, "writeOnly": false }, "date_end": { "type": "string", "description": "The date until which statement shows transactions.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the export.", "readOnly": true, "writeOnly": false }, "statement_number": { "type": "integer", "description": "MT940 Statement number. Unique per monetary account.", "readOnly": true, "writeOnly": false }, "statement_format": { "type": "string", "description": "The format of statement.", "readOnly": true, "writeOnly": false }, "regional_format": { "type": "string", "description": "The regional format of a CSV statement.", "readOnly": true, "writeOnly": false }, "alias_monetary_account": { "type": "object", "description": "The monetary account for which this statement was created.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" } } }, "DeviceListing": { "type": "object", "properties": { "DeviceServer": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/DeviceServer" } } }, "DeviceRead": { "type": "object", "properties": { "DeviceServer": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/DeviceServer" } } }, "DeviceServer": { "type": "object", "properties": { "description": { "type": "string", "description": "The description of the DeviceServer. This is only for your own reference when reading the DeviceServer again.", "readOnly": false, "writeOnly": false }, "secret": { "type": "string", "description": "The API key. You can request an API key in the bunq app.", "readOnly": false, "writeOnly": true }, "permitted_ips": { "type": "array", "description": "An array of IPs (v4 or v6) this DeviceServer will be able to do calls from. These will be linked to the API key.", "readOnly": false, "writeOnly": true, "items": { "type": "string" } } }, "required": [ "description", "secret" ] }, "DeviceServerCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the DeviceServer as created on the server.", "readOnly": true, "writeOnly": false } } }, "DeviceServerListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the DeviceServer as created on the server.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the DeviceServer's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the DeviceServer's last update.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of the DeviceServer.", "readOnly": true, "writeOnly": false }, "ip": { "type": "string", "description": "The ip address which was used to create the DeviceServer.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the DeviceServer. Can be ACTIVE, BLOCKED, NEEDS_CONFIRMATION or OBSOLETE.", "readOnly": true, "writeOnly": false } } }, "DeviceServerRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the DeviceServer as created on the server.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the DeviceServer's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the DeviceServer's last update.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of the DeviceServer.", "readOnly": true, "writeOnly": false }, "ip": { "type": "string", "description": "The ip address which was used to create the DeviceServer.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the DeviceServer. Can be ACTIVE, BLOCKED, NEEDS_CONFIRMATION or OBSOLETE.", "readOnly": true, "writeOnly": false } } }, "DraftPayment": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the DraftPayment.", "readOnly": false, "writeOnly": false }, "entries": { "type": "array", "description": "The list of entries in the DraftPayment. Each entry will result in a payment when the DraftPayment is accepted.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/DraftPaymentEntry" } }, "previous_updated_timestamp": { "type": "string", "description": "The last updated_timestamp that you received for this DraftPayment. This needs to be provided to prevent race conditions.", "readOnly": false, "writeOnly": true }, "number_of_required_accepts": { "type": "integer", "description": "The number of accepts that are required for the draft payment to receive status ACCEPTED. Currently only 1 is valid.", "readOnly": false, "writeOnly": true }, "schedule": { "type": "object", "description": "The schedule details when creating or updating a scheduled payment.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Schedule" } }, "required": [ "entries", "number_of_required_accepts" ] }, "DraftPaymentAnchorObject": { "type": "object", "properties": { "Payment": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" }, "PaymentBatch": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/PaymentBatch" } } }, "DraftPaymentCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created DrafPayment.", "readOnly": true, "writeOnly": false } } }, "DraftPaymentEntry": { "type": "object", "properties": { "amount": { "type": "object", "description": "The amount of the payment.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of the other (counterparty) side of the DraftPayment.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "description": { "type": "string", "description": "The description for the DraftPayment. Maximum 140 characters for DraftPayments to external IBANs, 9000 characters for DraftPayments to only other bunq MonetaryAccounts.", "readOnly": false, "writeOnly": false }, "merchant_reference": { "type": "string", "description": "Optional data to be included with the Payment specific to the merchant.", "readOnly": false, "writeOnly": false }, "attachment": { "type": "array", "description": "The Attachments attached to the DraftPayment.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } }, "id": { "type": "integer", "description": "The id of the draft payment entry.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of 'this' (party) side of the DraftPayment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "type": { "type": "string", "description": "The type of the draft payment entry.", "readOnly": true, "writeOnly": false } } }, "DraftPaymentListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created DrafPayment.", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the MonetaryAccount the DraftPayment applies to.", "readOnly": true, "writeOnly": false }, "user_alias_created": { "type": "object", "description": "The label of the User who created the DraftPayment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "responses": { "type": "array", "description": "All responses to this draft payment.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/DraftPaymentResponse" } }, "status": { "type": "string", "description": "The status of the DraftPayment.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the DraftPayment.", "readOnly": true, "writeOnly": false }, "entries": { "type": "array", "description": "The entries in the DraftPayment.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/DraftPaymentEntry" } }, "object": { "type": "object", "description": "The Payment or PaymentBatch. This will only be present after the DraftPayment has been accepted.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/DraftPaymentAnchorObject" }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } }, "schedule": { "type": "object", "description": "The schedule details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Schedule" } } }, "DraftPaymentRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created DrafPayment.", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the MonetaryAccount the DraftPayment applies to.", "readOnly": true, "writeOnly": false }, "user_alias_created": { "type": "object", "description": "The label of the User who created the DraftPayment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "responses": { "type": "array", "description": "All responses to this draft payment.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/DraftPaymentResponse" } }, "status": { "type": "string", "description": "The status of the DraftPayment.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the DraftPayment.", "readOnly": true, "writeOnly": false }, "entries": { "type": "array", "description": "The entries in the DraftPayment.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/DraftPaymentEntry" } }, "object": { "type": "object", "description": "The Payment or PaymentBatch. This will only be present after the DraftPayment has been accepted.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/DraftPaymentAnchorObject" }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } }, "schedule": { "type": "object", "description": "The schedule details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Schedule" } } }, "DraftPaymentResponse": { "type": "object", "properties": { "status": { "type": "string", "description": "The status with which was responded.", "readOnly": true, "writeOnly": false }, "user_alias_created": { "type": "object", "description": "The user that responded to the DraftPayment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" } } }, "DraftPaymentUpdate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created DrafPayment.", "readOnly": true, "writeOnly": false } } }, "DraftShareInviteApiKey": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the draft share invite. Can be CANCELLED (the user cancels the draft share before it's used).", "readOnly": false, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the draft share invite. Can be NONE, ACCEPTED or REJECTED.", "readOnly": false, "writeOnly": false }, "expiration": { "type": "string", "description": "The moment when this draft share invite expires.", "readOnly": false, "writeOnly": false } }, "required": [ "expiration" ] }, "DraftShareInviteApiKeyCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the newly created draft share invite.", "readOnly": true, "writeOnly": false } } }, "DraftShareInviteApiKeyListing": { "type": "object", "properties": { "user_alias_created": { "type": "object", "description": "The user who created the draft share invite.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "status": { "type": "string", "description": "The status of the draft share invite. Can be USED, CANCELLED and PENDING.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the draft share invite. Can be NONE, ACCEPTED or REJECTED.", "readOnly": true, "writeOnly": false }, "expiration": { "type": "string", "description": "The moment when this draft share invite expires.", "readOnly": true, "writeOnly": false }, "draft_share_url": { "type": "string", "description": "The URL redirecting user to the draft share invite in the app. Only works on mobile devices.", "readOnly": true, "writeOnly": false }, "api_key": { "type": "string", "description": "The API key generated for this DraftShareInviteApiKey.", "readOnly": true, "writeOnly": false }, "id": { "type": "integer", "description": "The id of the newly created draft share invite.", "readOnly": true, "writeOnly": false } } }, "DraftShareInviteApiKeyQrCodeContentListing": { "type": "object" }, "DraftShareInviteApiKeyRead": { "type": "object", "properties": { "user_alias_created": { "type": "object", "description": "The user who created the draft share invite.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "status": { "type": "string", "description": "The status of the draft share invite. Can be USED, CANCELLED and PENDING.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the draft share invite. Can be NONE, ACCEPTED or REJECTED.", "readOnly": true, "writeOnly": false }, "expiration": { "type": "string", "description": "The moment when this draft share invite expires.", "readOnly": true, "writeOnly": false }, "draft_share_url": { "type": "string", "description": "The URL redirecting user to the draft share invite in the app. Only works on mobile devices.", "readOnly": true, "writeOnly": false }, "api_key": { "type": "string", "description": "The API key generated for this DraftShareInviteApiKey.", "readOnly": true, "writeOnly": false }, "id": { "type": "integer", "description": "The id of the newly created draft share invite.", "readOnly": true, "writeOnly": false } } }, "DraftShareInviteApiKeyUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "DraftShareInviteBank": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the draft share invite. Can be CANCELLED (the user cancels the draft share before it's used).", "readOnly": false, "writeOnly": false }, "expiration": { "type": "string", "description": "The moment when this draft share invite expires.", "readOnly": false, "writeOnly": false }, "draft_share_settings": { "type": "object", "description": "The draft share invite details.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/DraftShareInviteEntry" } }, "required": [ "expiration", "draft_share_settings" ] }, "DraftShareInviteBankCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the newly created draft share invite.", "readOnly": true, "writeOnly": false } } }, "DraftShareInviteBankListing": { "type": "object", "properties": { "user_alias_created": { "type": "object", "description": "The user who created the draft share invite.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "status": { "type": "string", "description": "The status of the draft share invite. Can be USED, CANCELLED and PENDING.", "readOnly": true, "writeOnly": false }, "expiration": { "type": "string", "description": "The moment when this draft share invite expires.", "readOnly": true, "writeOnly": false }, "share_invite_bank_response_id": { "type": "integer", "description": "The id of the share invite bank response this draft share belongs to.", "readOnly": true, "writeOnly": false }, "draft_share_url": { "type": "string", "description": "The URL redirecting user to the draft share invite in the app. Only works on mobile devices.", "readOnly": true, "writeOnly": false }, "draft_share_settings": { "type": "object", "description": "The draft share invite details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/DraftShareInviteEntry" }, "id": { "type": "integer", "description": "The id of the newly created draft share invite.", "readOnly": true, "writeOnly": false } } }, "DraftShareInviteBankQrCodeContentListing": { "type": "object" }, "DraftShareInviteBankRead": { "type": "object", "properties": { "user_alias_created": { "type": "object", "description": "The user who created the draft share invite.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "status": { "type": "string", "description": "The status of the draft share invite. Can be USED, CANCELLED and PENDING.", "readOnly": true, "writeOnly": false }, "expiration": { "type": "string", "description": "The moment when this draft share invite expires.", "readOnly": true, "writeOnly": false }, "share_invite_bank_response_id": { "type": "integer", "description": "The id of the share invite bank response this draft share belongs to.", "readOnly": true, "writeOnly": false }, "draft_share_url": { "type": "string", "description": "The URL redirecting user to the draft share invite in the app. Only works on mobile devices.", "readOnly": true, "writeOnly": false }, "draft_share_settings": { "type": "object", "description": "The draft share invite details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/DraftShareInviteEntry" }, "id": { "type": "integer", "description": "The id of the newly created draft share invite.", "readOnly": true, "writeOnly": false } } }, "DraftShareInviteBankUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "DraftShareInviteEntry": { "type": "object", "properties": { "share_detail": { "type": "object", "description": "The share details. Only one of these objects is returned.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetail" }, "start_date": { "type": "string", "description": "The start date of this share.", "readOnly": false, "writeOnly": false }, "end_date": { "type": "string", "description": "The expiration date of this share.", "readOnly": false, "writeOnly": false } } }, "Error": { "type": "array", "items": { "type": "object", "properties": { "error_description": { "type": "string", "description": "The error description in English." }, "error_description_translated": { "type": "string", "description": "The error description translated to the user's language." } } } }, "EventListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the event.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the event's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the event's last update.", "readOnly": true, "writeOnly": false }, "action": { "type": "string", "description": "The performed action. Can be: CREATE or UPDATE.", "readOnly": true, "writeOnly": false }, "user_id": { "type": "string", "description": "The id of the user the event applied to (if it was a user event).", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "string", "description": "The id of the monetary account the event applied to (if it was a monetary account event).", "readOnly": true, "writeOnly": false }, "object": { "type": "object", "description": "The details of the external object the event was created for.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/EventObject" }, "status": { "type": "string", "description": "The event status. Can be: FINALIZED or AWAITING_REPLY. An example of FINALIZED event is a payment received event, while an AWAITING_REPLY event is a request received event.", "readOnly": true, "writeOnly": false } } }, "EventObject": { "type": "object", "properties": { "BunqMeTab": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqMeTab" }, "BunqMeTabResultResponse": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqMeTabResultResponse" }, "BunqMeFundraiserResult": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqMeFundraiserResult" }, "Card": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Card" }, "CardDebit": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/CardDebit" }, "DraftPayment": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/DraftPayment" }, "FeatureAnnouncement": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/FeatureAnnouncement" }, "IdealMerchantTransaction": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/IdealMerchantTransaction" }, "Invoice": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Invoice" }, "ScheduledPayment": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/SchedulePayment" }, "ScheduledPaymentBatch": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/SchedulePaymentBatch" }, "ScheduledInstance": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ScheduleInstance" }, "MasterCardAction": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MasterCardAction" }, "BankSwitchServiceNetherlandsIncomingPayment": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BankSwitchServiceNetherlandsIncomingPayment" }, "Payment": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" }, "PaymentBatch": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/PaymentBatch" }, "RequestInquiryBatch": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/RequestInquiryBatch" }, "RequestInquiry": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/RequestInquiry" }, "RequestResponse": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/RequestResponse" }, "RewardRecipient": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/RewardRecipient" }, "RewardSender": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/RewardSender" }, "ShareInviteBankInquiryBatch": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareInviteBankInquiryBatch" }, "ShareInviteBankInquiry": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareInviteBankInquiry" }, "ShareInviteBankResponse": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareInviteBankResponse" }, "SofortMerchantTransaction": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/SofortMerchantTransaction" }, "TabResultInquiry": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TabResultInquiry" }, "TabResultResponse": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TabResultResponse" }, "TransferwiseTransfer": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TransferwiseTransfer" } } }, "EventRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the event.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the event's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the event's last update.", "readOnly": true, "writeOnly": false }, "action": { "type": "string", "description": "The performed action. Can be: CREATE or UPDATE.", "readOnly": true, "writeOnly": false }, "user_id": { "type": "string", "description": "The id of the user the event applied to (if it was a user event).", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "string", "description": "The id of the monetary account the event applied to (if it was a monetary account event).", "readOnly": true, "writeOnly": false }, "object": { "type": "object", "description": "The details of the external object the event was created for.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/EventObject" }, "status": { "type": "string", "description": "The event status. Can be: FINALIZED or AWAITING_REPLY. An example of FINALIZED event is a payment received event, while an AWAITING_REPLY event is a request received event.", "readOnly": true, "writeOnly": false } } }, "ExportAnnualOverview": { "type": "object", "properties": { "year": { "type": "integer", "description": "The year for which the overview is.", "readOnly": false, "writeOnly": false } }, "required": [ "year" ] }, "ExportAnnualOverviewContentListing": { "type": "object" }, "ExportAnnualOverviewCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the annual overview as created on the server.", "readOnly": true, "writeOnly": false } } }, "ExportAnnualOverviewDelete": { "type": "object" }, "ExportAnnualOverviewListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the annual overview as created on the server.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the annual overview 's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the annual overview 's last update.", "readOnly": true, "writeOnly": false }, "year": { "type": "integer", "description": "The year for which the overview is.", "readOnly": true, "writeOnly": false }, "alias_user": { "type": "object", "description": "The user to which this annual overview belongs.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" } } }, "ExportAnnualOverviewRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the annual overview as created on the server.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the annual overview 's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the annual overview 's last update.", "readOnly": true, "writeOnly": false }, "year": { "type": "integer", "description": "The year for which the overview is.", "readOnly": true, "writeOnly": false }, "alias_user": { "type": "object", "description": "The user to which this annual overview belongs.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" } } }, "ExportRib": { "type": "object" }, "ExportRibContentListing": { "type": "object" }, "ExportRibCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the rib as created on the server.", "readOnly": true, "writeOnly": false } } }, "ExportRibDelete": { "type": "object" }, "ExportRibListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the rib as created on the server.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the RIB's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the RIB's last update.", "readOnly": true, "writeOnly": false } } }, "ExportRibRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the rib as created on the server.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the RIB's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the RIB's last update.", "readOnly": true, "writeOnly": false } } }, "ExportStatementPayment": { "type": "object" }, "ExportStatementPaymentContentListing": { "type": "object" }, "ExportStatementPaymentCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "ExportStatementPaymentRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the single payment statement model.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the statement model's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the statement model's last update.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the export.", "readOnly": true, "writeOnly": false } } }, "FeatureAnnouncement": { "type": "object", "properties": { "avatar": { "type": "object", "description": "The Avatar of the event overview.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "title": { "type": "string", "description": "The event overview title of the feature display", "readOnly": true, "writeOnly": false }, "sub_title": { "type": "string", "description": "The event overview subtitle of the feature display", "readOnly": true, "writeOnly": false } } }, "FeatureAnnouncementRead": { "type": "object", "properties": { "avatar": { "type": "object", "description": "The Avatar of the event overview.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "title": { "type": "string", "description": "The event overview title of the feature display", "readOnly": true, "writeOnly": false }, "sub_title": { "type": "string", "description": "The event overview subtitle of the feature display", "readOnly": true, "writeOnly": false } } }, "Geolocation": { "type": "object", "properties": { "latitude": { "type": "integer", "description": "The latitude for a geolocation restriction.", "readOnly": false, "writeOnly": false }, "longitude": { "type": "integer", "description": "The longitude for a geolocation restriction.", "readOnly": false, "writeOnly": false }, "altitude": { "type": "integer", "description": "The altitude for a geolocation restriction.", "readOnly": false, "writeOnly": false }, "radius": { "type": "integer", "description": "The radius for a geolocation restriction.", "readOnly": false, "writeOnly": false } } }, "IdealMerchantTransaction": { "type": "object", "properties": { "amount_requested": { "type": "object", "description": "The requested amount of money to add.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "issuer": { "type": "string", "description": "The BIC of the issuer.", "readOnly": false, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account this ideal merchant transaction links to.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The alias of the monetary account to add money to.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The alias of the monetary account the money comes from.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "amount_guaranteed": { "type": "object", "description": "In case of a successful transaction, the amount of money that will be transferred.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "expiration": { "type": "string", "description": "When the transaction will expire.", "readOnly": true, "writeOnly": false }, "issuer_name": { "type": "string", "description": "The Name of the issuer.", "readOnly": true, "writeOnly": false }, "issuer_authentication_url": { "type": "string", "description": "The URL to visit to ", "readOnly": true, "writeOnly": false }, "purchase_identifier": { "type": "string", "description": "The 'purchase ID' of the iDEAL transaction.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the transaction.", "readOnly": true, "writeOnly": false }, "status_timestamp": { "type": "string", "description": "When the status was last updated.", "readOnly": true, "writeOnly": false }, "transaction_identifier": { "type": "string", "description": "The 'transaction ID' of the iDEAL transaction.", "readOnly": true, "writeOnly": false }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false } } }, "IdealMerchantTransactionCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "IdealMerchantTransactionListing": { "type": "object", "properties": { "monetary_account_id": { "type": "integer", "description": "The id of the monetary account this ideal merchant transaction links to.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The alias of the monetary account to add money to.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The alias of the monetary account the money comes from.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "amount_guaranteed": { "type": "object", "description": "In case of a successful transaction, the amount of money that will be transferred.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_requested": { "type": "object", "description": "The requested amount of money to add.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "expiration": { "type": "string", "description": "When the transaction will expire.", "readOnly": true, "writeOnly": false }, "issuer": { "type": "string", "description": "The BIC of the issuer.", "readOnly": true, "writeOnly": false }, "issuer_name": { "type": "string", "description": "The Name of the issuer.", "readOnly": true, "writeOnly": false }, "issuer_authentication_url": { "type": "string", "description": "The URL to visit to ", "readOnly": true, "writeOnly": false }, "purchase_identifier": { "type": "string", "description": "The 'purchase ID' of the iDEAL transaction.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the transaction.", "readOnly": true, "writeOnly": false }, "status_timestamp": { "type": "string", "description": "When the status was last updated.", "readOnly": true, "writeOnly": false }, "transaction_identifier": { "type": "string", "description": "The 'transaction ID' of the iDEAL transaction.", "readOnly": true, "writeOnly": false }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false } } }, "IdealMerchantTransactionRead": { "type": "object", "properties": { "monetary_account_id": { "type": "integer", "description": "The id of the monetary account this ideal merchant transaction links to.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The alias of the monetary account to add money to.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The alias of the monetary account the money comes from.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "amount_guaranteed": { "type": "object", "description": "In case of a successful transaction, the amount of money that will be transferred.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_requested": { "type": "object", "description": "The requested amount of money to add.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "expiration": { "type": "string", "description": "When the transaction will expire.", "readOnly": true, "writeOnly": false }, "issuer": { "type": "string", "description": "The BIC of the issuer.", "readOnly": true, "writeOnly": false }, "issuer_name": { "type": "string", "description": "The Name of the issuer.", "readOnly": true, "writeOnly": false }, "issuer_authentication_url": { "type": "string", "description": "The URL to visit to ", "readOnly": true, "writeOnly": false }, "purchase_identifier": { "type": "string", "description": "The 'purchase ID' of the iDEAL transaction.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the transaction.", "readOnly": true, "writeOnly": false }, "status_timestamp": { "type": "string", "description": "When the status was last updated.", "readOnly": true, "writeOnly": false }, "transaction_identifier": { "type": "string", "description": "The 'transaction ID' of the iDEAL transaction.", "readOnly": true, "writeOnly": false }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false } } }, "Image": { "type": "object", "properties": { "attachment_public_uuid": { "type": "string", "description": "The public UUID of the public attachment containing the image.", "readOnly": true, "writeOnly": false }, "content_type": { "type": "string", "description": "The content-type as a MIME filetype.", "readOnly": true, "writeOnly": false }, "height": { "type": "integer", "description": "The image height in pixels.", "readOnly": true, "writeOnly": false }, "width": { "type": "integer", "description": "The image width in pixels.", "readOnly": true, "writeOnly": false } } }, "Installation": { "type": "object", "properties": { "client_public_key": { "type": "string", "description": "Your public key. This is the public part of the key pair that you are going to use to create value of the \"X-Bunq-Client-Signature\" header for all future API calls.", "readOnly": false, "writeOnly": true } }, "required": [ "client_public_key" ] }, "InstallationCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The Id object of the created Installation", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" }, "Token": { "type": "object", "description": "The Token object of this Installation.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/InstallationToken" }, "ServerPublicKey": { "type": "object", "description": "The ServerPublicKey object of the created Installation", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/InstallationServerPublicKey" } } }, "InstallationListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the Installation as created on the server. You can use this id to request the server's public key again.", "readOnly": true, "writeOnly": false } } }, "InstallationRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the Installation as created on the server. You can use this id to request the server's public key again.", "readOnly": true, "writeOnly": false } } }, "InstallationServerPublicKey": { "type": "object", "properties": { "server_public_key": { "type": "string", "description": "The server's public key for this Installation. You should use this key to verify the \"X-Bunq-Server-Signature\" header for each response from the server.", "readOnly": true, "writeOnly": false } } }, "InstallationServerPublicKeyListing": { "type": "object", "properties": { "server_public_key": { "type": "string", "description": "The server's public key for this Installation.", "readOnly": true, "writeOnly": false } } }, "InstallationToken": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the Token.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the Token's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the Token's last update.", "readOnly": true, "writeOnly": false }, "token": { "type": "string", "description": "The installation token is the token the client has to provide in the \"X-Bunq-Client-Authentication\" header for the creation of a DeviceServer and SessionServer.", "readOnly": true, "writeOnly": false } } }, "Invoice": { "type": "object", "properties": { "status": { "type": "string", "description": "The invoice status.", "readOnly": false, "writeOnly": false }, "description": { "type": "string", "description": "The description provided by the admin.", "readOnly": false, "writeOnly": true }, "external_url": { "type": "string", "description": "The external url provided by the admin.", "readOnly": false, "writeOnly": true }, "id": { "type": "integer", "description": "The id of the invoice object.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the invoice object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the invoice object's last update.", "readOnly": true, "writeOnly": false }, "invoice_date": { "type": "string", "description": "The invoice date.", "readOnly": true, "writeOnly": false }, "invoice_number": { "type": "string", "description": "The invoice number.", "readOnly": true, "writeOnly": false }, "group": { "type": "array", "description": "The invoice item groups.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/InvoiceItemGroup" } }, "total_vat_inclusive": { "type": "object", "description": "The total discounted item price including VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "total_vat_exclusive": { "type": "object", "description": "The total discounted item price excluding VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "total_vat": { "type": "object", "description": "The VAT on the total discounted item price.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "object", "description": "The label that's displayed to the counterparty with the invoice. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "address": { "type": "object", "description": "The customer's address.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "counterparty_alias": { "type": "object", "description": "The label of the counterparty of the invoice. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_address": { "type": "object", "description": "The company's address.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "chamber_of_commerce_number": { "type": "string", "description": "The company's chamber of commerce number.", "readOnly": true, "writeOnly": false }, "vat_number": { "type": "string", "description": "The company's chamber of commerce number.", "readOnly": true, "writeOnly": false }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } }, "required": [ "description", "external_url" ] }, "InvoiceByUserListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the invoice object.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the invoice object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the invoice object's last update.", "readOnly": true, "writeOnly": false }, "invoice_date": { "type": "string", "description": "The invoice date.", "readOnly": true, "writeOnly": false }, "invoice_number": { "type": "string", "description": "The invoice number.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The invoice status.", "readOnly": true, "writeOnly": false }, "group": { "type": "array", "description": "The invoice item groups.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/InvoiceItemGroup" } }, "total_vat_inclusive": { "type": "object", "description": "The total discounted item price including VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "total_vat_exclusive": { "type": "object", "description": "The total discounted item price excluding VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "total_vat": { "type": "object", "description": "The VAT on the total discounted item price.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "object", "description": "The label that's displayed to the counterparty with the invoice. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "address": { "type": "object", "description": "The customer's address.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "counterparty_alias": { "type": "object", "description": "The label of the counterparty of the invoice. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_address": { "type": "object", "description": "The company's address.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "chamber_of_commerce_number": { "type": "string", "description": "The company's chamber of commerce number.", "readOnly": true, "writeOnly": false }, "vat_number": { "type": "string", "description": "The company's chamber of commerce number.", "readOnly": true, "writeOnly": false } } }, "InvoiceByUserRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the invoice object.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the invoice object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the invoice object's last update.", "readOnly": true, "writeOnly": false }, "invoice_date": { "type": "string", "description": "The invoice date.", "readOnly": true, "writeOnly": false }, "invoice_number": { "type": "string", "description": "The invoice number.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The invoice status.", "readOnly": true, "writeOnly": false }, "group": { "type": "array", "description": "The invoice item groups.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/InvoiceItemGroup" } }, "total_vat_inclusive": { "type": "object", "description": "The total discounted item price including VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "total_vat_exclusive": { "type": "object", "description": "The total discounted item price excluding VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "total_vat": { "type": "object", "description": "The VAT on the total discounted item price.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "object", "description": "The label that's displayed to the counterparty with the invoice. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "address": { "type": "object", "description": "The customer's address.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "counterparty_alias": { "type": "object", "description": "The label of the counterparty of the invoice. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_address": { "type": "object", "description": "The company's address.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "chamber_of_commerce_number": { "type": "string", "description": "The company's chamber of commerce number.", "readOnly": true, "writeOnly": false }, "vat_number": { "type": "string", "description": "The company's chamber of commerce number.", "readOnly": true, "writeOnly": false } } }, "InvoiceExportPdfContentListing": { "type": "object" }, "InvoiceItem": { "type": "object", "properties": { "billing_date": { "type": "string", "description": "The billing date of the item.", "readOnly": true, "writeOnly": false }, "type_description": { "type": "string", "description": "The price description.", "readOnly": true, "writeOnly": false }, "type_description_translated": { "type": "string", "description": "The translated price description.", "readOnly": true, "writeOnly": false }, "unit_vat_exclusive": { "type": "object", "description": "The unit item price excluding VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "unit_vat_inclusive": { "type": "object", "description": "The unit item price including VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "vat": { "type": "integer", "description": "The VAT tax fraction.", "readOnly": true, "writeOnly": false }, "quantity": { "type": "integer", "description": "The number of items priced.", "readOnly": true, "writeOnly": false }, "total_vat_exclusive": { "type": "object", "description": "The item price excluding VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "total_vat_inclusive": { "type": "object", "description": "The item price including VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "InvoiceItemGroup": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the invoice item group.", "readOnly": true, "writeOnly": false }, "type_description": { "type": "string", "description": "The description of the type of the invoice item group.", "readOnly": true, "writeOnly": false }, "type_description_translated": { "type": "string", "description": "The translated description of the type of the invoice item group.", "readOnly": true, "writeOnly": false }, "instance_description": { "type": "string", "description": "The identifier of the invoice item group.", "readOnly": true, "writeOnly": false }, "product_vat_exclusive": { "type": "object", "description": "The unit item price excluding VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "product_vat_inclusive": { "type": "object", "description": "The unit item price including VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "item": { "type": "object", "description": "The invoice items in the group.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/InvoiceItem" } } }, "InvoiceListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the invoice object.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the invoice object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the invoice object's last update.", "readOnly": true, "writeOnly": false }, "invoice_date": { "type": "string", "description": "The invoice date.", "readOnly": true, "writeOnly": false }, "invoice_number": { "type": "string", "description": "The invoice number.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The invoice status.", "readOnly": true, "writeOnly": false }, "group": { "type": "array", "description": "The invoice item groups.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/InvoiceItemGroup" } }, "total_vat_inclusive": { "type": "object", "description": "The total discounted item price including VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "total_vat_exclusive": { "type": "object", "description": "The total discounted item price excluding VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "total_vat": { "type": "object", "description": "The VAT on the total discounted item price.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "object", "description": "The label that's displayed to the counterparty with the invoice. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "address": { "type": "object", "description": "The customer's address.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "counterparty_alias": { "type": "object", "description": "The label of the counterparty of the invoice. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_address": { "type": "object", "description": "The company's address.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "chamber_of_commerce_number": { "type": "string", "description": "The company's chamber of commerce number.", "readOnly": true, "writeOnly": false }, "vat_number": { "type": "string", "description": "The company's chamber of commerce number.", "readOnly": true, "writeOnly": false }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "InvoiceRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the invoice object.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the invoice object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the invoice object's last update.", "readOnly": true, "writeOnly": false }, "invoice_date": { "type": "string", "description": "The invoice date.", "readOnly": true, "writeOnly": false }, "invoice_number": { "type": "string", "description": "The invoice number.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The invoice status.", "readOnly": true, "writeOnly": false }, "group": { "type": "array", "description": "The invoice item groups.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/InvoiceItemGroup" } }, "total_vat_inclusive": { "type": "object", "description": "The total discounted item price including VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "total_vat_exclusive": { "type": "object", "description": "The total discounted item price excluding VAT.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "total_vat": { "type": "object", "description": "The VAT on the total discounted item price.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "object", "description": "The label that's displayed to the counterparty with the invoice. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "address": { "type": "object", "description": "The customer's address.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "counterparty_alias": { "type": "object", "description": "The label of the counterparty of the invoice. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_address": { "type": "object", "description": "The company's address.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "chamber_of_commerce_number": { "type": "string", "description": "The company's chamber of commerce number.", "readOnly": true, "writeOnly": false }, "vat_number": { "type": "string", "description": "The company's chamber of commerce number.", "readOnly": true, "writeOnly": false }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "Issuer": { "type": "object", "properties": { "bic": { "type": "string", "description": "The BIC code.", "readOnly": false, "writeOnly": false }, "name": { "type": "string", "description": "The name of the bank.", "readOnly": false, "writeOnly": false } } }, "LabelCard": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The public UUID.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the card.", "readOnly": true, "writeOnly": false }, "second_line": { "type": "string", "description": "The second line on the card.", "readOnly": true, "writeOnly": false }, "expiry_date": { "type": "string", "description": "The date this card will expire.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the card.", "readOnly": true, "writeOnly": false }, "label_user": { "type": "object", "description": "The owner of this card.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" } } }, "LabelMonetaryAccount": { "type": "object", "properties": { "iban": { "type": "string", "description": "The IBAN of the monetary account.", "readOnly": true, "writeOnly": false }, "display_name": { "type": "string", "description": "The name to display with this monetary account.", "readOnly": true, "writeOnly": false }, "avatar": { "type": "object", "description": "The avatar of the monetary account.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "label_user": { "type": "object", "description": "The user this monetary account belongs to.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "country": { "type": "string", "description": "The country of the user. Formatted as a ISO 3166-1 alpha-2 country code.", "readOnly": true, "writeOnly": false }, "bunq_me": { "type": "object", "description": "Bunq.me pointer with type and value.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Pointer" }, "is_light": { "type": "boolean", "description": "Whether or not the monetary account is light.", "readOnly": true, "writeOnly": false }, "swift_bic": { "type": "string", "description": "The BIC used for a SWIFT payment.", "readOnly": true, "writeOnly": false }, "swift_account_number": { "type": "string", "description": "The account number used for a SWIFT payment. May or may not be an IBAN.", "readOnly": true, "writeOnly": false }, "transferwise_account_number": { "type": "string", "description": "The account number used for a Transferwise payment. May or may not be an IBAN.", "readOnly": true, "writeOnly": false }, "transferwise_bank_code": { "type": "string", "description": "The bank code used for a Transferwise payment. May or may not be a BIC.", "readOnly": true, "writeOnly": false } } }, "LabelUser": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The public UUID of the label-user.", "readOnly": false, "writeOnly": false }, "display_name": { "type": "string", "description": "The name to be displayed for this user, as it was given on the request.", "readOnly": false, "writeOnly": false }, "country": { "type": "string", "description": "The country of the user. 000 stands for \"unknown\"", "readOnly": false, "writeOnly": false }, "avatar": { "type": "object", "description": "The current avatar of the user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "public_nick_name": { "type": "string", "description": "The current nickname of the user.", "readOnly": true, "writeOnly": false } } }, "MasterCardAction": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the MastercardAction.", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account this action links to.", "readOnly": true, "writeOnly": false }, "card_id": { "type": "integer", "description": "The id of the card this action links to.", "readOnly": true, "writeOnly": false }, "amount_local": { "type": "object", "description": "The amount of the transaction in local currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_converted": { "type": "object", "description": "The amount of the transaction in local currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_billing": { "type": "object", "description": "The amount of the transaction in the monetary account's currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_original_local": { "type": "object", "description": "The original amount in local currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_original_billing": { "type": "object", "description": "The original amount in the monetary account's currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_fee": { "type": "object", "description": "The fee amount as charged by the merchant, if applicable.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "card_authorisation_id_response": { "type": "string", "description": "The response code by which authorised transaction can be identified as authorised by bunq.", "readOnly": true, "writeOnly": false }, "decision": { "type": "string", "description": "Why the transaction was denied, if it was denied, or just ALLOWED.", "readOnly": true, "writeOnly": false }, "decision_description": { "type": "string", "description": "Empty if allowed, otherwise a textual explanation of why it was denied.", "readOnly": true, "writeOnly": false }, "decision_description_translated": { "type": "string", "description": "Empty if allowed, otherwise a textual explanation of why it was denied in user's language.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description for this transaction to display.", "readOnly": true, "writeOnly": false }, "authorisation_status": { "type": "string", "description": "The status in the authorisation process.", "readOnly": true, "writeOnly": false }, "authorisation_type": { "type": "string", "description": "The type of transaction that was delivered using the card.", "readOnly": true, "writeOnly": false }, "pan_entry_mode_user": { "type": "string", "description": "The type of entry mode the user used. Can be 'ATM', 'ICC', 'MAGNETIC_STRIPE' or 'E_COMMERCE'.", "readOnly": true, "writeOnly": false }, "settlement_status": { "type": "string", "description": "The setlement status in the authorisation process.", "readOnly": true, "writeOnly": false }, "maturity_date": { "type": "string", "description": "The maturity date.", "readOnly": true, "writeOnly": false }, "city": { "type": "string", "description": "The city where the message originates from as announced by the terminal.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The monetary account label of the account that this action is created for.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The monetary account label of the counterparty.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "label_card": { "type": "object", "description": "The label of the card.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelCard" }, "token_status": { "type": "string", "description": "If this is a tokenisation action, this shows the status of the token.", "readOnly": true, "writeOnly": false }, "reservation_expiry_time": { "type": "string", "description": "If this is a reservation, the moment the reservation will expire.", "readOnly": true, "writeOnly": false }, "applied_limit": { "type": "string", "description": "The type of the limit applied to validate if this MasterCardAction was within the spending limits. The returned string matches the limit types as defined in the card endpoint.", "readOnly": true, "writeOnly": false }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false }, "secure_code_id": { "type": "integer", "description": "The secure code id for this mastercard action or null.", "readOnly": true, "writeOnly": false }, "wallet_provider_id": { "type": "string", "description": "The ID of the wallet provider as defined by MasterCard. 420 = bunq Android app with Tap&Pay; 103 = Apple Pay.", "readOnly": true, "writeOnly": false }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "MasterCardActionListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the MastercardAction.", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account this action links to.", "readOnly": true, "writeOnly": false }, "card_id": { "type": "integer", "description": "The id of the card this action links to.", "readOnly": true, "writeOnly": false }, "amount_local": { "type": "object", "description": "The amount of the transaction in local currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_converted": { "type": "object", "description": "The amount of the transaction in local currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_billing": { "type": "object", "description": "The amount of the transaction in the monetary account's currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_original_local": { "type": "object", "description": "The original amount in local currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_original_billing": { "type": "object", "description": "The original amount in the monetary account's currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_fee": { "type": "object", "description": "The fee amount as charged by the merchant, if applicable.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "card_authorisation_id_response": { "type": "string", "description": "The response code by which authorised transaction can be identified as authorised by bunq.", "readOnly": true, "writeOnly": false }, "decision": { "type": "string", "description": "Why the transaction was denied, if it was denied, or just ALLOWED.", "readOnly": true, "writeOnly": false }, "decision_description": { "type": "string", "description": "Empty if allowed, otherwise a textual explanation of why it was denied.", "readOnly": true, "writeOnly": false }, "decision_description_translated": { "type": "string", "description": "Empty if allowed, otherwise a textual explanation of why it was denied in user's language.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description for this transaction to display.", "readOnly": true, "writeOnly": false }, "authorisation_status": { "type": "string", "description": "The status in the authorisation process.", "readOnly": true, "writeOnly": false }, "authorisation_type": { "type": "string", "description": "The type of transaction that was delivered using the card.", "readOnly": true, "writeOnly": false }, "pan_entry_mode_user": { "type": "string", "description": "The type of entry mode the user used. Can be 'ATM', 'ICC', 'MAGNETIC_STRIPE' or 'E_COMMERCE'.", "readOnly": true, "writeOnly": false }, "settlement_status": { "type": "string", "description": "The setlement status in the authorisation process.", "readOnly": true, "writeOnly": false }, "maturity_date": { "type": "string", "description": "The maturity date.", "readOnly": true, "writeOnly": false }, "city": { "type": "string", "description": "The city where the message originates from as announced by the terminal.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The monetary account label of the account that this action is created for.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The monetary account label of the counterparty.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "label_card": { "type": "object", "description": "The label of the card.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelCard" }, "token_status": { "type": "string", "description": "If this is a tokenisation action, this shows the status of the token.", "readOnly": true, "writeOnly": false }, "reservation_expiry_time": { "type": "string", "description": "If this is a reservation, the moment the reservation will expire.", "readOnly": true, "writeOnly": false }, "applied_limit": { "type": "string", "description": "The type of the limit applied to validate if this MasterCardAction was within the spending limits. The returned string matches the limit types as defined in the card endpoint.", "readOnly": true, "writeOnly": false }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false }, "secure_code_id": { "type": "integer", "description": "The secure code id for this mastercard action or null.", "readOnly": true, "writeOnly": false }, "wallet_provider_id": { "type": "string", "description": "The ID of the wallet provider as defined by MasterCard. 420 = bunq Android app with Tap&Pay; 103 = Apple Pay.", "readOnly": true, "writeOnly": false }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "MasterCardActionRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the MastercardAction.", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account this action links to.", "readOnly": true, "writeOnly": false }, "card_id": { "type": "integer", "description": "The id of the card this action links to.", "readOnly": true, "writeOnly": false }, "amount_local": { "type": "object", "description": "The amount of the transaction in local currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_converted": { "type": "object", "description": "The amount of the transaction in local currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_billing": { "type": "object", "description": "The amount of the transaction in the monetary account's currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_original_local": { "type": "object", "description": "The original amount in local currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_original_billing": { "type": "object", "description": "The original amount in the monetary account's currency.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_fee": { "type": "object", "description": "The fee amount as charged by the merchant, if applicable.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "card_authorisation_id_response": { "type": "string", "description": "The response code by which authorised transaction can be identified as authorised by bunq.", "readOnly": true, "writeOnly": false }, "decision": { "type": "string", "description": "Why the transaction was denied, if it was denied, or just ALLOWED.", "readOnly": true, "writeOnly": false }, "decision_description": { "type": "string", "description": "Empty if allowed, otherwise a textual explanation of why it was denied.", "readOnly": true, "writeOnly": false }, "decision_description_translated": { "type": "string", "description": "Empty if allowed, otherwise a textual explanation of why it was denied in user's language.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description for this transaction to display.", "readOnly": true, "writeOnly": false }, "authorisation_status": { "type": "string", "description": "The status in the authorisation process.", "readOnly": true, "writeOnly": false }, "authorisation_type": { "type": "string", "description": "The type of transaction that was delivered using the card.", "readOnly": true, "writeOnly": false }, "pan_entry_mode_user": { "type": "string", "description": "The type of entry mode the user used. Can be 'ATM', 'ICC', 'MAGNETIC_STRIPE' or 'E_COMMERCE'.", "readOnly": true, "writeOnly": false }, "settlement_status": { "type": "string", "description": "The setlement status in the authorisation process.", "readOnly": true, "writeOnly": false }, "maturity_date": { "type": "string", "description": "The maturity date.", "readOnly": true, "writeOnly": false }, "city": { "type": "string", "description": "The city where the message originates from as announced by the terminal.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The monetary account label of the account that this action is created for.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The monetary account label of the counterparty.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "label_card": { "type": "object", "description": "The label of the card.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelCard" }, "token_status": { "type": "string", "description": "If this is a tokenisation action, this shows the status of the token.", "readOnly": true, "writeOnly": false }, "reservation_expiry_time": { "type": "string", "description": "If this is a reservation, the moment the reservation will expire.", "readOnly": true, "writeOnly": false }, "applied_limit": { "type": "string", "description": "The type of the limit applied to validate if this MasterCardAction was within the spending limits. The returned string matches the limit types as defined in the card endpoint.", "readOnly": true, "writeOnly": false }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false }, "secure_code_id": { "type": "integer", "description": "The secure code id for this mastercard action or null.", "readOnly": true, "writeOnly": false }, "wallet_provider_id": { "type": "string", "description": "The ID of the wallet provider as defined by MasterCard. 420 = bunq Android app with Tap&Pay; 103 = Apple Pay.", "readOnly": true, "writeOnly": false }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "MonetaryAccountBank": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the MonetaryAccountBank as an ISO 4217 formatted currency code.", "readOnly": false, "writeOnly": false }, "description": { "type": "string", "description": "The description of the MonetaryAccountBank. Defaults to 'bunq account'.", "readOnly": false, "writeOnly": false }, "daily_limit": { "type": "object", "description": "The daily spending limit Amount of the MonetaryAccountBank. Defaults to 1000 EUR. Currency must match the MonetaryAccountBank's currency. Limited to 10000 EUR.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "avatar_uuid": { "type": "string", "description": "The UUID of the Avatar of the MonetaryAccountBank.", "readOnly": false, "writeOnly": true }, "status": { "type": "string", "description": "The status of the MonetaryAccountBank. Ignored in POST requests (always set to ACTIVE) can be CANCELLED or PENDING_REOPEN in PUT requests to cancel (close) or reopen the MonetaryAccountBank. When updating the status and\/or sub_status no other fields can be updated in the same request (and vice versa).", "readOnly": false, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the MonetaryAccountBank providing extra information regarding the status. Should be ignored for POST requests. In case of PUT requests with status CANCELLED it can only be REDEMPTION_VOLUNTARY, while with status PENDING_REOPEN it can only be NONE. When updating the status and\/or sub_status no other fields can be updated in the same request (and vice versa).", "readOnly": false, "writeOnly": false }, "reason": { "type": "string", "description": "The reason for voluntarily cancelling (closing) the MonetaryAccountBank, can only be OTHER. Should only be specified if updating the status to CANCELLED.", "readOnly": false, "writeOnly": false }, "reason_description": { "type": "string", "description": "The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountBank. Can be any user provided message. Should only be specified if updating the status to CANCELLED.", "readOnly": false, "writeOnly": false }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this MonetaryAccountBank.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "setting": { "type": "object", "description": "The settings of the MonetaryAccountBank.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountSetting" } }, "required": [ "currency" ] }, "MonetaryAccountBankCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "MonetaryAccountBankListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the MonetaryAccountBank.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the MonetaryAccountBank's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the MonetaryAccountBank's last update.", "readOnly": true, "writeOnly": false }, "avatar": { "type": "object", "description": "The Avatar of the MonetaryAccountBank.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "currency": { "type": "string", "description": "The currency of the MonetaryAccountBank as an ISO 4217 formatted currency code.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of the MonetaryAccountBank. Defaults to 'bunq account'.", "readOnly": true, "writeOnly": false }, "daily_limit": { "type": "object", "description": "The daily spending limit Amount of the MonetaryAccountBank. Defaults to 1000 EUR. Currency must match the MonetaryAccountBank's currency. Limited to 10000 EUR.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "daily_spent": { "type": "object", "description": "Total Amount of money spent today. Timezone aware.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "overdraft_limit": { "type": "object", "description": "The maximum Amount the MonetaryAccountBank can be 'in the red'.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "balance": { "type": "object", "description": "The current available balance Amount of the MonetaryAccountBank.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "array", "description": "The Aliases for the MonetaryAccountBank.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "public_uuid": { "type": "string", "description": "The MonetaryAccountBank's public UUID.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the MonetaryAccountBank. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the MonetaryAccountBank 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.", "readOnly": true, "writeOnly": false }, "reason": { "type": "string", "description": "The reason for voluntarily cancelling (closing) the MonetaryAccountBank, can only be OTHER.", "readOnly": true, "writeOnly": false }, "reason_description": { "type": "string", "description": "The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountBank. Can be any user provided message.", "readOnly": true, "writeOnly": false }, "user_id": { "type": "integer", "description": "The id of the User who owns the MonetaryAccountBank.", "readOnly": true, "writeOnly": false }, "monetary_account_profile": { "type": "object", "description": "The profile of the account.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountProfile" }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this MonetaryAccountBank.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "setting": { "type": "object", "description": "The settings of the MonetaryAccountBank.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountSetting" } } }, "MonetaryAccountBankRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the MonetaryAccountBank.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the MonetaryAccountBank's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the MonetaryAccountBank's last update.", "readOnly": true, "writeOnly": false }, "avatar": { "type": "object", "description": "The Avatar of the MonetaryAccountBank.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "currency": { "type": "string", "description": "The currency of the MonetaryAccountBank as an ISO 4217 formatted currency code.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of the MonetaryAccountBank. Defaults to 'bunq account'.", "readOnly": true, "writeOnly": false }, "daily_limit": { "type": "object", "description": "The daily spending limit Amount of the MonetaryAccountBank. Defaults to 1000 EUR. Currency must match the MonetaryAccountBank's currency. Limited to 10000 EUR.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "daily_spent": { "type": "object", "description": "Total Amount of money spent today. Timezone aware.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "overdraft_limit": { "type": "object", "description": "The maximum Amount the MonetaryAccountBank can be 'in the red'.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "balance": { "type": "object", "description": "The current available balance Amount of the MonetaryAccountBank.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "array", "description": "The Aliases for the MonetaryAccountBank.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "public_uuid": { "type": "string", "description": "The MonetaryAccountBank's public UUID.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the MonetaryAccountBank. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the MonetaryAccountBank 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.", "readOnly": true, "writeOnly": false }, "reason": { "type": "string", "description": "The reason for voluntarily cancelling (closing) the MonetaryAccountBank, can only be OTHER.", "readOnly": true, "writeOnly": false }, "reason_description": { "type": "string", "description": "The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountBank. Can be any user provided message.", "readOnly": true, "writeOnly": false }, "user_id": { "type": "integer", "description": "The id of the User who owns the MonetaryAccountBank.", "readOnly": true, "writeOnly": false }, "monetary_account_profile": { "type": "object", "description": "The profile of the account.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountProfile" }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this MonetaryAccountBank.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "setting": { "type": "object", "description": "The settings of the MonetaryAccountBank.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountSetting" } } }, "MonetaryAccountBankUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "MonetaryAccountJoint": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the MonetaryAccountJoint as an ISO 4217 formatted currency code.", "readOnly": false, "writeOnly": false }, "description": { "type": "string", "description": "The description of the MonetaryAccountJoint. Defaults to 'bunq account'.", "readOnly": false, "writeOnly": false }, "daily_limit": { "type": "object", "description": "The daily spending limit Amount of the MonetaryAccountJoint. Defaults to 1000 EUR. Currency must match the MonetaryAccountJoint's currency. Limited to 10000 EUR.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "overdraft_limit": { "type": "object", "description": "The maximum Amount the MonetaryAccountJoint can be 'in the red'. Must be 0 EUR or omitted.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "array", "description": "The Aliases to add to MonetaryAccountJoint. Must all be confirmed first. Can mostly be ignored.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "avatar_uuid": { "type": "string", "description": "The UUID of the Avatar of the MonetaryAccountJoint.", "readOnly": false, "writeOnly": true }, "status": { "type": "string", "description": "The status of the MonetaryAccountJoint. Ignored in POST requests (always set to ACTIVE) can be CANCELLED or PENDING_REOPEN in PUT requests to cancel (close) or reopen the MonetaryAccountJoint. When updating the status and\/or sub_status no other fields can be updated in the same request (and vice versa).", "readOnly": false, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the MonetaryAccountJoint providing extra information regarding the status. Should be ignored for POST requests. In case of PUT requests with status CANCELLED it can only be REDEMPTION_VOLUNTARY, while with status PENDING_REOPEN it can only be NONE. When updating the status and\/or sub_status no other fields can be updated in the same request (and vice versa).", "readOnly": false, "writeOnly": false }, "reason": { "type": "string", "description": "The reason for voluntarily cancelling (closing) the MonetaryAccountJoint, can only be OTHER. Should only be specified if updating the status to CANCELLED.", "readOnly": false, "writeOnly": false }, "reason_description": { "type": "string", "description": "The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountJoint. Can be any user provided message. Should only be specified if updating the status to CANCELLED.", "readOnly": false, "writeOnly": false }, "all_co_owner": { "type": "array", "description": "The users the account will be joint with.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CoOwner" } }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this MonetaryAccountJoint.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "setting": { "type": "object", "description": "The settings of the MonetaryAccountJoint.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountSetting" } }, "required": [ "currency", "all_co_owner" ] }, "MonetaryAccountJointCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "MonetaryAccountJointListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the MonetaryAccountJoint.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the MonetaryAccountJoint's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the MonetaryAccountJoint's last update.", "readOnly": true, "writeOnly": false }, "avatar": { "type": "object", "description": "The Avatar of the MonetaryAccountJoint.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "currency": { "type": "string", "description": "The currency of the MonetaryAccountJoint as an ISO 4217 formatted currency code.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of the MonetaryAccountJoint. Defaults to 'bunq account'.", "readOnly": true, "writeOnly": false }, "daily_limit": { "type": "object", "description": "The daily spending limit Amount of the MonetaryAccountJoint. Defaults to 1000 EUR. Currency must match the MonetaryAccountJoint's currency. Limited to 10000 EUR.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "daily_spent": { "type": "object", "description": "Total Amount of money spent today. Timezone aware.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "overdraft_limit": { "type": "object", "description": "The maximum Amount the MonetaryAccountJoint can be 'in the red'.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "balance": { "type": "object", "description": "The current available balance Amount of the MonetaryAccountJoint.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "array", "description": "The Aliases for the MonetaryAccountJoint.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "public_uuid": { "type": "string", "description": "The MonetaryAccountJoint's public UUID.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the MonetaryAccountJoint. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the MonetaryAccountJoint 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.", "readOnly": true, "writeOnly": false }, "reason": { "type": "string", "description": "The reason for voluntarily cancelling (closing) the MonetaryAccountJoint, can only be OTHER.", "readOnly": true, "writeOnly": false }, "reason_description": { "type": "string", "description": "The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountJoint. Can be any user provided message.", "readOnly": true, "writeOnly": false }, "all_co_owner": { "type": "array", "description": "The users the account will be joint with.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CoOwner" } }, "user_id": { "type": "integer", "description": "The id of the User who owns the MonetaryAccountJoint.", "readOnly": true, "writeOnly": false }, "monetary_account_profile": { "type": "object", "description": "The profile of the account.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountProfile" }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this MonetaryAccountJoint.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "setting": { "type": "object", "description": "The settings of the MonetaryAccountJoint.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountSetting" } } }, "MonetaryAccountJointRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the MonetaryAccountJoint.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the MonetaryAccountJoint's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the MonetaryAccountJoint's last update.", "readOnly": true, "writeOnly": false }, "avatar": { "type": "object", "description": "The Avatar of the MonetaryAccountJoint.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "currency": { "type": "string", "description": "The currency of the MonetaryAccountJoint as an ISO 4217 formatted currency code.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of the MonetaryAccountJoint. Defaults to 'bunq account'.", "readOnly": true, "writeOnly": false }, "daily_limit": { "type": "object", "description": "The daily spending limit Amount of the MonetaryAccountJoint. Defaults to 1000 EUR. Currency must match the MonetaryAccountJoint's currency. Limited to 10000 EUR.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "daily_spent": { "type": "object", "description": "Total Amount of money spent today. Timezone aware.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "overdraft_limit": { "type": "object", "description": "The maximum Amount the MonetaryAccountJoint can be 'in the red'.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "balance": { "type": "object", "description": "The current available balance Amount of the MonetaryAccountJoint.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "array", "description": "The Aliases for the MonetaryAccountJoint.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "public_uuid": { "type": "string", "description": "The MonetaryAccountJoint's public UUID.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the MonetaryAccountJoint. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the MonetaryAccountJoint 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.", "readOnly": true, "writeOnly": false }, "reason": { "type": "string", "description": "The reason for voluntarily cancelling (closing) the MonetaryAccountJoint, can only be OTHER.", "readOnly": true, "writeOnly": false }, "reason_description": { "type": "string", "description": "The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountJoint. Can be any user provided message.", "readOnly": true, "writeOnly": false }, "all_co_owner": { "type": "array", "description": "The users the account will be joint with.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CoOwner" } }, "user_id": { "type": "integer", "description": "The id of the User who owns the MonetaryAccountJoint.", "readOnly": true, "writeOnly": false }, "monetary_account_profile": { "type": "object", "description": "The profile of the account.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountProfile" }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this MonetaryAccountJoint.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "setting": { "type": "object", "description": "The settings of the MonetaryAccountJoint.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountSetting" } } }, "MonetaryAccountJointUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "MonetaryAccountLight": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the MonetaryAccountLight as an ISO 4217 formatted currency code.", "readOnly": false, "writeOnly": false }, "description": { "type": "string", "description": "The description of the MonetaryAccountLight. Defaults to 'bunq account'.", "readOnly": false, "writeOnly": false }, "daily_limit": { "type": "object", "description": "The daily spending limit Amount of the MonetaryAccountLight. Defaults to 1000 EUR. Currency must match the MonetaryAccountLight's currency. Limited to 10000 EUR.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "avatar_uuid": { "type": "string", "description": "The UUID of the Avatar of the MonetaryAccountLight.", "readOnly": false, "writeOnly": true }, "status": { "type": "string", "description": "The status of the MonetaryAccountLight. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN", "readOnly": false, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the MonetaryAccountLight 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.", "readOnly": false, "writeOnly": false }, "reason": { "type": "string", "description": "The reason for voluntarily cancelling (closing) the MonetaryAccountBank, can only be OTHER.", "readOnly": false, "writeOnly": false }, "reason_description": { "type": "string", "description": "The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountBank. Can be any user provided message.", "readOnly": false, "writeOnly": false }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this MonetaryAccountLight.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "setting": { "type": "object", "description": "The settings of the MonetaryAccountLight.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountSetting" }, "id": { "type": "integer", "description": "The id of the MonetaryAccountLight.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the MonetaryAccountLight's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the MonetaryAccountLight's last update.", "readOnly": true, "writeOnly": false }, "avatar": { "type": "object", "description": "The Avatar of the MonetaryAccountLight.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "daily_spent": { "type": "object", "description": "Total Amount of money spent today. Timezone aware.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "balance": { "type": "object", "description": "The current available balance Amount of the MonetaryAccountLight.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "balance_real": { "type": "object", "description": "The current real balance Amount of the MonetaryAccountLight.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "array", "description": "The Aliases for the MonetaryAccountLight.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "public_uuid": { "type": "string", "description": "The MonetaryAccountLight's public UUID.", "readOnly": true, "writeOnly": false }, "user_id": { "type": "integer", "description": "The id of the User who owns the MonetaryAccountLight.", "readOnly": true, "writeOnly": false }, "balance_maximum": { "type": "object", "description": "The maximum balance Amount of the MonetaryAccountLight.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "budget_month_used": { "type": "object", "description": "The amount of the monthly budget used.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "budget_month_maximum": { "type": "object", "description": "The total amount of the monthly budget.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "budget_year_used": { "type": "object", "description": "The amount of the yearly budget used.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "budget_year_maximum": { "type": "object", "description": "The total amount of the yearly budget.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "budget_withdrawal_year_used": { "type": "object", "description": "The amount of the yearly withdrawal budget used.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "budget_withdrawal_year_maximum": { "type": "object", "description": "The total amount of the yearly withdrawal budget.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "MonetaryAccountListing": { "type": "object", "properties": { "MonetaryAccountBank": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountBank" }, "MonetaryAccountJoint": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountJoint" }, "MonetaryAccountLight": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountLight" }, "MonetaryAccountSavings": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountSavings" } } }, "MonetaryAccountProfile": { "type": "object", "properties": { "profile_fill": { "type": "object", "description": "The profile settings for triggering the fill of a monetary account.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountProfileFill" }, "profile_drain": { "type": "object", "description": "The profile settings for moving excesses to a savings account", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountProfileDrain" } } }, "MonetaryAccountProfileDrain": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the profile.", "readOnly": false, "writeOnly": false }, "balance_preferred": { "type": "object", "description": "The goal balance.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "balance_threshold_high": { "type": "object", "description": "The high threshold balance.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "savings_account_alias": { "type": "object", "description": "The savings monetary account.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" } } }, "MonetaryAccountProfileFill": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the profile.", "readOnly": false, "writeOnly": false }, "balance_preferred": { "type": "object", "description": "The goal balance.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "balance_threshold_low": { "type": "object", "description": "The low threshold balance.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "method_fill": { "type": "string", "description": "The method used to fill the monetary account. Currently only iDEAL is supported, and it is the default one.", "readOnly": false, "writeOnly": false }, "issuer": { "type": "object", "description": "The bank the fill is supposed to happen from, with BIC and bank name.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Issuer" } } }, "MonetaryAccountRead": { "type": "object", "properties": { "MonetaryAccountBank": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountBank" }, "MonetaryAccountJoint": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountJoint" }, "MonetaryAccountLight": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountLight" }, "MonetaryAccountSavings": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountSavings" } } }, "MonetaryAccountSavings": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the MonetaryAccountSavings as an ISO 4217 formatted currency code.", "readOnly": false, "writeOnly": false }, "description": { "type": "string", "description": "The description of the MonetaryAccountSavings. Defaults to 'bunq account'.", "readOnly": false, "writeOnly": false }, "daily_limit": { "type": "object", "description": "The daily spending limit Amount of the MonetaryAccountSavings. Defaults to 1000 EUR. Currency must match the MonetaryAccountSavings's currency. Limited to 10000 EUR.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "avatar_uuid": { "type": "string", "description": "The UUID of the Avatar of the MonetaryAccountSavings.", "readOnly": false, "writeOnly": true }, "status": { "type": "string", "description": "The status of the MonetaryAccountSavings. Ignored in POST requests (always set to ACTIVE) can be CANCELLED or PENDING_REOPEN in PUT requests to cancel (close) or reopen the MonetaryAccountSavings. When updating the status and\/or sub_status no other fields can be updated in the same request (and vice versa).", "readOnly": false, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the MonetaryAccountSavings providing extra information regarding the status. Should be ignored for POST requests. In case of PUT requests with status CANCELLED it can only be REDEMPTION_VOLUNTARY, while with status PENDING_REOPEN it can only be NONE. When updating the status and\/or sub_status no other fields can be updated in the same request (and vice versa).", "readOnly": false, "writeOnly": false }, "reason": { "type": "string", "description": "The reason for voluntarily cancelling (closing) the MonetaryAccountSavings, can only be OTHER. Should only be specified if updating the status to CANCELLED.", "readOnly": false, "writeOnly": false }, "reason_description": { "type": "string", "description": "The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountSavings. Can be any user provided message. Should only be specified if updating the status to CANCELLED.", "readOnly": false, "writeOnly": false }, "all_co_owner": { "type": "array", "description": "The users the account will be joint with.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CoOwner" } }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this MonetaryAccountSavings.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "setting": { "type": "object", "description": "The settings of the MonetaryAccountSavings.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountSetting" }, "savings_goal": { "type": "object", "description": "The Savings Goal set for this MonetaryAccountSavings.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } }, "required": [ "currency", "savings_goal" ] }, "MonetaryAccountSavingsCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "MonetaryAccountSavingsListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the MonetaryAccountSavings.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the MonetaryAccountSavings's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the MonetaryAccountSavings's last update.", "readOnly": true, "writeOnly": false }, "avatar": { "type": "object", "description": "The Avatar of the MonetaryAccountSavings.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "currency": { "type": "string", "description": "The currency of the MonetaryAccountSavings as an ISO 4217 formatted currency code.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of the MonetaryAccountSavings. Defaults to 'bunq account'.", "readOnly": true, "writeOnly": false }, "daily_limit": { "type": "object", "description": "The daily spending limit Amount of the MonetaryAccountSavings. Defaults to 1000 EUR. Currency must match the MonetaryAccountSavings's currency. Limited to 10000 EUR.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "daily_spent": { "type": "object", "description": "Total Amount of money spent today. Timezone aware.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "overdraft_limit": { "type": "object", "description": "The maximum Amount the MonetaryAccountSavings can be 'in the red'. Must be 0 EUR or omitted.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "balance": { "type": "object", "description": "The current available balance Amount of the MonetaryAccountSavings.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "array", "description": "The Aliases for the MonetaryAccountSavings.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "public_uuid": { "type": "string", "description": "The MonetaryAccountSavings's public UUID.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the MonetaryAccountSavings. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the MonetaryAccountSavings 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.", "readOnly": true, "writeOnly": false }, "reason": { "type": "string", "description": "The reason for voluntarily cancelling (closing) the MonetaryAccountSavings, can only be OTHER.", "readOnly": true, "writeOnly": false }, "reason_description": { "type": "string", "description": "The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountSavings. Can be any user provided message.", "readOnly": true, "writeOnly": false }, "all_co_owner": { "type": "array", "description": "The users the account will be joint with.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CoOwner" } }, "user_id": { "type": "integer", "description": "The id of the User who owns the MonetaryAccountSavings.", "readOnly": true, "writeOnly": false }, "monetary_account_profile": { "type": "object", "description": "The profile of the account.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountProfile" }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this MonetaryAccountSavings.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "setting": { "type": "object", "description": "The settings of the MonetaryAccountSavings.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountSetting" }, "savings_goal": { "type": "object", "description": "The Savings Goal set for this MonetaryAccountSavings.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "savings_goal_progress": { "type": "integer", "description": "The progress in percentages for the Savings Goal set for this MonetaryAccountSavings.", "readOnly": true, "writeOnly": false } } }, "MonetaryAccountSavingsRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the MonetaryAccountSavings.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the MonetaryAccountSavings's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the MonetaryAccountSavings's last update.", "readOnly": true, "writeOnly": false }, "avatar": { "type": "object", "description": "The Avatar of the MonetaryAccountSavings.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "currency": { "type": "string", "description": "The currency of the MonetaryAccountSavings as an ISO 4217 formatted currency code.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of the MonetaryAccountSavings. Defaults to 'bunq account'.", "readOnly": true, "writeOnly": false }, "daily_limit": { "type": "object", "description": "The daily spending limit Amount of the MonetaryAccountSavings. Defaults to 1000 EUR. Currency must match the MonetaryAccountSavings's currency. Limited to 10000 EUR.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "daily_spent": { "type": "object", "description": "Total Amount of money spent today. Timezone aware.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "overdraft_limit": { "type": "object", "description": "The maximum Amount the MonetaryAccountSavings can be 'in the red'. Must be 0 EUR or omitted.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "balance": { "type": "object", "description": "The current available balance Amount of the MonetaryAccountSavings.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "array", "description": "The Aliases for the MonetaryAccountSavings.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "public_uuid": { "type": "string", "description": "The MonetaryAccountSavings's public UUID.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the MonetaryAccountSavings. Can be: ACTIVE, BLOCKED, CANCELLED or PENDING_REOPEN", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The sub-status of the MonetaryAccountSavings 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.", "readOnly": true, "writeOnly": false }, "reason": { "type": "string", "description": "The reason for voluntarily cancelling (closing) the MonetaryAccountSavings, can only be OTHER.", "readOnly": true, "writeOnly": false }, "reason_description": { "type": "string", "description": "The optional free-form reason for voluntarily cancelling (closing) the MonetaryAccountSavings. Can be any user provided message.", "readOnly": true, "writeOnly": false }, "all_co_owner": { "type": "array", "description": "The users the account will be joint with.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/CoOwner" } }, "user_id": { "type": "integer", "description": "The id of the User who owns the MonetaryAccountSavings.", "readOnly": true, "writeOnly": false }, "monetary_account_profile": { "type": "object", "description": "The profile of the account.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountProfile" }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this MonetaryAccountSavings.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "setting": { "type": "object", "description": "The settings of the MonetaryAccountSavings.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MonetaryAccountSetting" }, "savings_goal": { "type": "object", "description": "The Savings Goal set for this MonetaryAccountSavings.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "savings_goal_progress": { "type": "integer", "description": "The progress in percentages for the Savings Goal set for this MonetaryAccountSavings.", "readOnly": true, "writeOnly": false } } }, "MonetaryAccountSavingsUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "MonetaryAccountSetting": { "type": "object", "properties": { "color": { "type": "string", "description": "The color chosen for the MonetaryAccount.", "readOnly": false, "writeOnly": false }, "icon": { "type": "string", "description": "The icon chosen for the MonetaryAccount.", "readOnly": false, "writeOnly": false }, "default_avatar_status": { "type": "string", "description": "The status of the avatar. Can be either AVATAR_DEFAULT, AVATAR_CUSTOM or AVATAR_UNDETERMINED.", "readOnly": false, "writeOnly": false }, "restriction_chat": { "type": "string", "description": "The chat restriction. Possible values are ALLOW_INCOMING or BLOCK_INCOMING", "readOnly": false, "writeOnly": false } } }, "NoteAttachmentBankSwitchServiceNetherlandsIncomingPayment": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentDelete": { "type": "object" }, "NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentBunqMeFundraiserResult": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentBunqMeFundraiserResultCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentBunqMeFundraiserResultDelete": { "type": "object" }, "NoteAttachmentBunqMeFundraiserResultListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentBunqMeFundraiserResultRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentBunqMeFundraiserResultUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentDraftPayment": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentDraftPaymentCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentDraftPaymentDelete": { "type": "object" }, "NoteAttachmentDraftPaymentListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentDraftPaymentRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentDraftPaymentUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentIdealMerchantTransaction": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentIdealMerchantTransactionCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentIdealMerchantTransactionDelete": { "type": "object" }, "NoteAttachmentIdealMerchantTransactionListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentIdealMerchantTransactionRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentIdealMerchantTransactionUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentMasterCardAction": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentMasterCardActionCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentMasterCardActionDelete": { "type": "object" }, "NoteAttachmentMasterCardActionListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentMasterCardActionRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentMasterCardActionUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentPayment": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentPaymentBatch": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentPaymentBatchCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentPaymentBatchDelete": { "type": "object" }, "NoteAttachmentPaymentBatchListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentPaymentBatchRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentPaymentBatchUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentPaymentCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentPaymentDelete": { "type": "object" }, "NoteAttachmentPaymentListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentPaymentRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentPaymentUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentRequestInquiry": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentRequestInquiryBatch": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentRequestInquiryBatchCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentRequestInquiryBatchDelete": { "type": "object" }, "NoteAttachmentRequestInquiryBatchListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentRequestInquiryBatchRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentRequestInquiryBatchUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentRequestInquiryCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentRequestInquiryDelete": { "type": "object" }, "NoteAttachmentRequestInquiryListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentRequestInquiryRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentRequestInquiryUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentRequestResponse": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentRequestResponseCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentRequestResponseDelete": { "type": "object" }, "NoteAttachmentRequestResponseListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentRequestResponseRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentRequestResponseUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentScheduleInstance": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentScheduleInstanceCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentScheduleInstanceDelete": { "type": "object" }, "NoteAttachmentScheduleInstanceListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentScheduleInstanceRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentScheduleInstanceUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentSchedulePayment": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentSchedulePaymentBatch": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentSchedulePaymentBatchCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentSchedulePaymentBatchDelete": { "type": "object" }, "NoteAttachmentSchedulePaymentBatchListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentSchedulePaymentBatchRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentSchedulePaymentBatchUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentSchedulePaymentCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentSchedulePaymentDelete": { "type": "object" }, "NoteAttachmentSchedulePaymentListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentSchedulePaymentRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentSchedulePaymentUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentSofortMerchantTransaction": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentSofortMerchantTransactionCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentSofortMerchantTransactionDelete": { "type": "object" }, "NoteAttachmentSofortMerchantTransactionListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentSofortMerchantTransactionRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentSofortMerchantTransactionUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentWhitelistResult": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": false, "writeOnly": false }, "attachment_id": { "type": "integer", "description": "The reference to the uploaded file to attach to this note.", "readOnly": false, "writeOnly": true } }, "required": [ "attachment_id" ] }, "NoteAttachmentWhitelistResultCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteAttachmentWhitelistResultDelete": { "type": "object" }, "NoteAttachmentWhitelistResultListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentWhitelistResultRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "description": { "type": "string", "description": "Optional description of the attachment.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachment attached to the note.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } } } }, "NoteAttachmentWhitelistResultUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextBankSwitchServiceNetherlandsIncomingPayment": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextBankSwitchServiceNetherlandsIncomingPaymentCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextBankSwitchServiceNetherlandsIncomingPaymentDelete": { "type": "object" }, "NoteTextBankSwitchServiceNetherlandsIncomingPaymentListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextBankSwitchServiceNetherlandsIncomingPaymentRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextBankSwitchServiceNetherlandsIncomingPaymentUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextBunqMeFundraiserResult": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextBunqMeFundraiserResultCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextBunqMeFundraiserResultDelete": { "type": "object" }, "NoteTextBunqMeFundraiserResultListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextBunqMeFundraiserResultRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextBunqMeFundraiserResultUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextDraftPayment": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextDraftPaymentCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextDraftPaymentDelete": { "type": "object" }, "NoteTextDraftPaymentListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextDraftPaymentRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextDraftPaymentUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextIdealMerchantTransaction": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextIdealMerchantTransactionCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextIdealMerchantTransactionDelete": { "type": "object" }, "NoteTextIdealMerchantTransactionListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextIdealMerchantTransactionRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextIdealMerchantTransactionUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextMasterCardAction": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextMasterCardActionCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextMasterCardActionDelete": { "type": "object" }, "NoteTextMasterCardActionListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextMasterCardActionRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextMasterCardActionUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextPayment": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextPaymentBatch": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextPaymentBatchCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextPaymentBatchDelete": { "type": "object" }, "NoteTextPaymentBatchListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextPaymentBatchRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextPaymentBatchUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextPaymentCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextPaymentDelete": { "type": "object" }, "NoteTextPaymentListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextPaymentRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextPaymentUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextRequestInquiry": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextRequestInquiryBatch": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextRequestInquiryBatchCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextRequestInquiryBatchDelete": { "type": "object" }, "NoteTextRequestInquiryBatchListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextRequestInquiryBatchRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextRequestInquiryBatchUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextRequestInquiryCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextRequestInquiryDelete": { "type": "object" }, "NoteTextRequestInquiryListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextRequestInquiryRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextRequestInquiryUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextRequestResponse": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextRequestResponseCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextRequestResponseDelete": { "type": "object" }, "NoteTextRequestResponseListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextRequestResponseRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextRequestResponseUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextScheduleInstance": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextScheduleInstanceCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextScheduleInstanceDelete": { "type": "object" }, "NoteTextScheduleInstanceListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextScheduleInstanceRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextScheduleInstanceUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextSchedulePayment": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextSchedulePaymentBatch": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextSchedulePaymentBatchCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextSchedulePaymentBatchDelete": { "type": "object" }, "NoteTextSchedulePaymentBatchListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextSchedulePaymentBatchRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextSchedulePaymentBatchUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextSchedulePaymentCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextSchedulePaymentDelete": { "type": "object" }, "NoteTextSchedulePaymentListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextSchedulePaymentRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextSchedulePaymentUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextSofortMerchantTransaction": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextSofortMerchantTransactionCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextSofortMerchantTransactionDelete": { "type": "object" }, "NoteTextSofortMerchantTransactionListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextSofortMerchantTransactionRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextSofortMerchantTransactionUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextWhitelistResult": { "type": "object", "properties": { "content": { "type": "string", "description": "The content of the note.", "readOnly": false, "writeOnly": false } } }, "NoteTextWhitelistResultCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NoteTextWhitelistResultDelete": { "type": "object" }, "NoteTextWhitelistResultListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextWhitelistResultRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the note.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the note's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the note's last update.", "readOnly": true, "writeOnly": false }, "label_user_creator": { "type": "object", "description": "The label of the user who created this note.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "content": { "type": "string", "description": "The content of the note.", "readOnly": true, "writeOnly": false } } }, "NoteTextWhitelistResultUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NotificationFilter": { "type": "object", "properties": { "notification_delivery_method": { "type": "string", "description": "The delivery method via which notifications that match this notification filter will be delivered. Possible choices are PUSH for delivery via push notification and URL for delivery via URL callback.", "readOnly": false, "writeOnly": false }, "notification_target": { "type": "string", "description": "The target of notifications that match this notification filter. For URL notification filters this is the URL to which the callback will be made. For PUSH notifications filters this should always be null.", "readOnly": false, "writeOnly": false }, "category": { "type": "string", "description": "The notification category that will match this notification filter. Possible choices are BILLING, CARD_TRANSACTION_FAILED, CARD_TRANSACTION_SUCCESSFUL, CHAT, DRAFT_PAYMENT, IDEAL, SOFORT, MONETARY_ACCOUNT_PROFILE, MUTATION, PAYMENT, PROMOTION, REQUEST, SCHEDULE_RESULT, SCHEDULE_STATUS, SHARE, SUPPORT, TAB_RESULT, USER_APPROVAL.", "readOnly": false, "writeOnly": false } } }, "NotificationFilterPush": { "type": "object", "properties": { "category": { "type": "string", "description": "The notification category that will match this notification filter.", "readOnly": false, "writeOnly": false } } }, "NotificationFilterPushUser": { "type": "object", "properties": { "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification for this user.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilterPush" } } } }, "NotificationFilterPushUserCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NotificationFilterPushUserListing": { "type": "object", "properties": { "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification for this user.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilterPush" } } } }, "NotificationFilterUrl": { "type": "object", "properties": { "category": { "type": "string", "description": "The notification category that will match this notification filter.", "readOnly": false, "writeOnly": false }, "notification_target": { "type": "string", "description": "The URL to which the callback should be made.", "readOnly": false, "writeOnly": false } } }, "NotificationFilterUrlMonetaryAccount": { "type": "object", "properties": { "notification_filters": { "type": "array", "description": "The types of notifications that will result in a url notification for this monetary account.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilterUrl" } } } }, "NotificationFilterUrlMonetaryAccountCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NotificationFilterUrlMonetaryAccountListing": { "type": "object", "properties": { "notification_filters": { "type": "array", "description": "The types of notifications that will result in a url notification for this monetary account.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilterUrl" } } } }, "NotificationFilterUrlUser": { "type": "object", "properties": { "notification_filters": { "type": "array", "description": "The types of notifications that will result in a url notification for this user.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilterUrl" } } } }, "NotificationFilterUrlUserCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "NotificationFilterUrlUserListing": { "type": "object", "properties": { "notification_filters": { "type": "array", "description": "The types of notifications that will result in a url notification for this user.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilterUrl" } } } }, "OauthCallbackUrl": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL for this callback.", "readOnly": false, "writeOnly": false } }, "required": [ "url" ] }, "OauthCallbackUrlCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "OauthCallbackUrlDelete": { "type": "object" }, "OauthCallbackUrlListing": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL for this callback.", "readOnly": true, "writeOnly": false } } }, "OauthCallbackUrlRead": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL for this callback.", "readOnly": true, "writeOnly": false } } }, "OauthCallbackUrlUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "OauthClient": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the Oauth Client, can be ACTIVE or CANCELLED.", "readOnly": false, "writeOnly": false } } }, "OauthClientCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "OauthClientListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "Id of the client.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the pack group, can be ACTIVE, CANCELLED or CANCELLED_PENDING.", "readOnly": true, "writeOnly": false }, "client_id": { "type": "string", "description": "The Client ID associated with this Oauth Client", "readOnly": true, "writeOnly": false }, "secret": { "type": "string", "description": "Secret associated with this Oauth Client", "readOnly": true, "writeOnly": false }, "callback_url": { "type": "array", "description": "The callback URLs which are bound to this Oauth Client", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/OauthCallbackUrl" } } } }, "OauthClientRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "Id of the client.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the pack group, can be ACTIVE, CANCELLED or CANCELLED_PENDING.", "readOnly": true, "writeOnly": false }, "client_id": { "type": "string", "description": "The Client ID associated with this Oauth Client", "readOnly": true, "writeOnly": false }, "secret": { "type": "string", "description": "Secret associated with this Oauth Client", "readOnly": true, "writeOnly": false }, "callback_url": { "type": "array", "description": "The callback URLs which are bound to this Oauth Client", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/OauthCallbackUrl" } } } }, "OauthClientUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "Payment": { "type": "object", "properties": { "amount": { "type": "object", "description": "The Amount transferred by the Payment. Will be negative for outgoing Payments and positive for incoming Payments (relative to the MonetaryAccount indicated by monetary_account_id).", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of the other (counterparty) side of the Payment.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "description": { "type": "string", "description": "The description for the Payment. Maximum 140 characters for Payments to external IBANs, 9000 characters for Payments to only other bunq MonetaryAccounts.", "readOnly": false, "writeOnly": false }, "attachment": { "type": "array", "description": "The Attachments attached to the Payment.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } }, "merchant_reference": { "type": "string", "description": "Optional data included with the Payment specific to the merchant.", "readOnly": false, "writeOnly": false }, "allow_bunqto": { "type": "boolean", "description": "Whether or not sending a bunq.to payment is allowed.", "readOnly": false, "writeOnly": true }, "id": { "type": "integer", "description": "The id of the created Payment.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp when the Payment was done.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp when the Payment was last updated (will be updated when chat messages are received).", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the MonetaryAccount the Payment was made to or from (depending on whether this is an incoming or outgoing Payment).", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of 'this' (party) side of the Payment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "type": { "type": "string", "description": "The type of Payment, can be BUNQ, EBA_SCT, EBA_SDD, IDEAL, SWIFT or FIS (card).", "readOnly": true, "writeOnly": false }, "sub_type": { "type": "string", "description": "The sub-type of the Payment, can be PAYMENT, WITHDRAWAL, REVERSAL, REQUEST, BILLING, SCT, SDD or NLO.", "readOnly": true, "writeOnly": false }, "bunqto_status": { "type": "string", "description": "The status of the bunq.to payment.", "readOnly": true, "writeOnly": false }, "bunqto_sub_status": { "type": "string", "description": "The sub status of the bunq.to payment.", "readOnly": true, "writeOnly": false }, "bunqto_share_url": { "type": "string", "description": "The status of the bunq.to payment.", "readOnly": true, "writeOnly": false }, "bunqto_expiry": { "type": "string", "description": "When bunq.to payment is about to expire.", "readOnly": true, "writeOnly": false }, "bunqto_time_responded": { "type": "string", "description": "The timestamp of when the bunq.to payment was responded to.", "readOnly": true, "writeOnly": false }, "batch_id": { "type": "integer", "description": "The id of the PaymentBatch if this Payment was part of one.", "readOnly": true, "writeOnly": false }, "scheduled_id": { "type": "integer", "description": "The id of the JobScheduled if the Payment was scheduled.", "readOnly": true, "writeOnly": false }, "address_shipping": { "type": "object", "description": "A shipping Address provided with the Payment, currently unused.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_billing": { "type": "object", "description": "A billing Address provided with the Payment, currently unused.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "geolocation": { "type": "object", "description": "The Geolocation where the Payment was done from.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } }, "balance_after_mutation": { "type": "object", "description": "The new balance of the monetary account after the mutation.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "PaymentBatch": { "type": "object", "properties": { "payments": { "type": "array", "description": "The list of mutations that were made.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Payment" } } } }, "PaymentBatchCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "PaymentBatchListing": { "type": "object", "properties": { "payments": { "type": "array", "description": "The list of mutations that were made.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Payment" } } } }, "PaymentBatchRead": { "type": "object", "properties": { "payments": { "type": "array", "description": "The list of mutations that were made.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Payment" } } } }, "PaymentBatchUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "PaymentCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created Payment.", "readOnly": true, "writeOnly": false } } }, "PaymentListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created Payment.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp when the Payment was done.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp when the Payment was last updated (will be updated when chat messages are received).", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the MonetaryAccount the Payment was made to or from (depending on whether this is an incoming or outgoing Payment).", "readOnly": true, "writeOnly": false }, "amount": { "type": "object", "description": "The Amount transferred by the Payment. Will be negative for outgoing Payments and positive for incoming Payments (relative to the MonetaryAccount indicated by monetary_account_id).", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of 'this' (party) side of the Payment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of the other (counterparty) side of the Payment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "description": { "type": "string", "description": "The description for the Payment. Maximum 140 characters for Payments to external IBANs, 9000 characters for Payments to only other bunq MonetaryAccounts.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of Payment, can be BUNQ, EBA_SCT, EBA_SDD, IDEAL, SWIFT or FIS (card).", "readOnly": true, "writeOnly": false }, "sub_type": { "type": "string", "description": "The sub-type of the Payment, can be PAYMENT, WITHDRAWAL, REVERSAL, REQUEST, BILLING, SCT, SDD or NLO.", "readOnly": true, "writeOnly": false }, "bunqto_status": { "type": "string", "description": "The status of the bunq.to payment.", "readOnly": true, "writeOnly": false }, "bunqto_sub_status": { "type": "string", "description": "The sub status of the bunq.to payment.", "readOnly": true, "writeOnly": false }, "bunqto_share_url": { "type": "string", "description": "The status of the bunq.to payment.", "readOnly": true, "writeOnly": false }, "bunqto_expiry": { "type": "string", "description": "When bunq.to payment is about to expire.", "readOnly": true, "writeOnly": false }, "bunqto_time_responded": { "type": "string", "description": "The timestamp of when the bunq.to payment was responded to.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The Attachments attached to the Payment.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } }, "merchant_reference": { "type": "string", "description": "Optional data included with the Payment specific to the merchant.", "readOnly": true, "writeOnly": false }, "batch_id": { "type": "integer", "description": "The id of the PaymentBatch if this Payment was part of one.", "readOnly": true, "writeOnly": false }, "scheduled_id": { "type": "integer", "description": "The id of the JobScheduled if the Payment was scheduled.", "readOnly": true, "writeOnly": false }, "address_shipping": { "type": "object", "description": "A shipping Address provided with the Payment, currently unused.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_billing": { "type": "object", "description": "A billing Address provided with the Payment, currently unused.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "geolocation": { "type": "object", "description": "The Geolocation where the Payment was done from.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } }, "balance_after_mutation": { "type": "object", "description": "The new balance of the monetary account after the mutation.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "PaymentRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created Payment.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp when the Payment was done.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp when the Payment was last updated (will be updated when chat messages are received).", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the MonetaryAccount the Payment was made to or from (depending on whether this is an incoming or outgoing Payment).", "readOnly": true, "writeOnly": false }, "amount": { "type": "object", "description": "The Amount transferred by the Payment. Will be negative for outgoing Payments and positive for incoming Payments (relative to the MonetaryAccount indicated by monetary_account_id).", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of 'this' (party) side of the Payment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of the other (counterparty) side of the Payment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "description": { "type": "string", "description": "The description for the Payment. Maximum 140 characters for Payments to external IBANs, 9000 characters for Payments to only other bunq MonetaryAccounts.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of Payment, can be BUNQ, EBA_SCT, EBA_SDD, IDEAL, SWIFT or FIS (card).", "readOnly": true, "writeOnly": false }, "sub_type": { "type": "string", "description": "The sub-type of the Payment, can be PAYMENT, WITHDRAWAL, REVERSAL, REQUEST, BILLING, SCT, SDD or NLO.", "readOnly": true, "writeOnly": false }, "bunqto_status": { "type": "string", "description": "The status of the bunq.to payment.", "readOnly": true, "writeOnly": false }, "bunqto_sub_status": { "type": "string", "description": "The sub status of the bunq.to payment.", "readOnly": true, "writeOnly": false }, "bunqto_share_url": { "type": "string", "description": "The status of the bunq.to payment.", "readOnly": true, "writeOnly": false }, "bunqto_expiry": { "type": "string", "description": "When bunq.to payment is about to expire.", "readOnly": true, "writeOnly": false }, "bunqto_time_responded": { "type": "string", "description": "The timestamp of when the bunq.to payment was responded to.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The Attachments attached to the Payment.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } }, "merchant_reference": { "type": "string", "description": "Optional data included with the Payment specific to the merchant.", "readOnly": true, "writeOnly": false }, "batch_id": { "type": "integer", "description": "The id of the PaymentBatch if this Payment was part of one.", "readOnly": true, "writeOnly": false }, "scheduled_id": { "type": "integer", "description": "The id of the JobScheduled if the Payment was scheduled.", "readOnly": true, "writeOnly": false }, "address_shipping": { "type": "object", "description": "A shipping Address provided with the Payment, currently unused.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_billing": { "type": "object", "description": "A billing Address provided with the Payment, currently unused.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "geolocation": { "type": "object", "description": "The Geolocation where the Payment was done from.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } }, "balance_after_mutation": { "type": "object", "description": "The new balance of the monetary account after the mutation.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "PaymentServiceProviderCredential": { "type": "object", "properties": { "client_payment_service_provider_certificate": { "type": "string", "description": "Payment Services Directive 2 compatible QSEAL certificate", "readOnly": false, "writeOnly": true }, "client_payment_service_provider_certificate_chain": { "type": "string", "description": "Intermediate and root certificate belonging to the provided certificate.", "readOnly": false, "writeOnly": true }, "client_public_key_signature": { "type": "string", "description": "The Base64 encoded signature of the public key provided during installation and with the installation token appended as a nonce. Signed with the private key belonging to the QSEAL certificate.", "readOnly": false, "writeOnly": true } }, "required": [ "client_payment_service_provider_certificate", "client_payment_service_provider_certificate_chain", "client_public_key_signature" ] }, "PaymentServiceProviderCredentialCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "PaymentServiceProviderCredentialRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the credential.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the credential object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the credential object's last update.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the credential.", "readOnly": true, "writeOnly": false }, "expiry_time": { "type": "string", "description": "When the status is PENDING_FIRST_USE: when the credential expires.", "readOnly": true, "writeOnly": false }, "token_value": { "type": "string", "description": "When the status is PENDING_FIRST_USE: the value of the token.", "readOnly": true, "writeOnly": false }, "permitted_device": { "type": "object", "description": "When the status is ACTIVE: the details of the device that may use the credential.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/PermittedDevice" } } }, "PermittedDevice": { "type": "object", "properties": { "description": { "type": "string", "description": "The description of the device that may use the credential.", "readOnly": true, "writeOnly": false }, "ip": { "type": "string", "description": "The IP address of the device that may use the credential.", "readOnly": true, "writeOnly": false } } }, "PermittedIp": { "type": "object", "properties": { "ip": { "type": "string", "description": "The IP address.", "readOnly": false, "writeOnly": false }, "status": { "type": "string", "description": "The status of the IP. May be \"ACTIVE\" or \"INACTIVE\". It is only possible to make requests from \"ACTIVE\" IP addresses. Only \"ACTIVE\" IPs will be billed.", "readOnly": false, "writeOnly": false } }, "required": [ "ip" ] }, "PermittedIpCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "PermittedIpListing": { "type": "object", "properties": { "ip": { "type": "string", "description": "The IP address.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the IP. May be \"ACTIVE\" or \"INACTIVE\". It is only possible to make requests from \"ACTIVE\" IP addresses. Only \"ACTIVE\" IPs will be billed.", "readOnly": true, "writeOnly": false } } }, "PermittedIpRead": { "type": "object", "properties": { "ip": { "type": "string", "description": "The IP address.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the IP. May be \"ACTIVE\" or \"INACTIVE\". It is only possible to make requests from \"ACTIVE\" IP addresses. Only \"ACTIVE\" IPs will be billed.", "readOnly": true, "writeOnly": false } } }, "PermittedIpUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "Pointer": { "type": "object", "properties": { "type": { "type": "string", "description": "The alias type, can be: EMAIL|PHONE_NUMBER|IBAN.", "readOnly": false, "writeOnly": false }, "value": { "type": "string", "description": "The alias value.", "readOnly": false, "writeOnly": false }, "name": { "type": "string", "description": "The alias name.", "readOnly": false, "writeOnly": false } } }, "RequestInquiry": { "type": "object", "properties": { "amount_inquired": { "type": "object", "description": "The requested amount.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount the money was requested from.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "description": { "type": "string", "description": "The description of the inquiry.", "readOnly": false, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachments attached to the payment.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BunqId" } }, "merchant_reference": { "type": "string", "description": "The client's custom reference that was attached to the request and the mutation.", "readOnly": false, "writeOnly": false }, "status": { "type": "string", "description": "The status of the request.", "readOnly": false, "writeOnly": false }, "minimum_age": { "type": "integer", "description": "The minimum age the user accepting the RequestInquiry must have.", "readOnly": false, "writeOnly": false }, "require_address": { "type": "string", "description": "Whether or not an address must be provided on accept.", "readOnly": false, "writeOnly": false }, "want_tip": { "type": "boolean", "description": "[DEPRECATED] Whether or not the accepting user can give an extra tip on top of the requested Amount. Defaults to false.", "readOnly": false, "writeOnly": true }, "allow_amount_lower": { "type": "boolean", "description": "[DEPRECATED] Whether or not the accepting user can choose to accept with a lower amount than requested. Defaults to false.", "readOnly": false, "writeOnly": true }, "allow_amount_higher": { "type": "boolean", "description": "[DEPRECATED] Whether or not the accepting user can choose to accept with a higher amount than requested. Defaults to false.", "readOnly": false, "writeOnly": true }, "allow_bunqme": { "type": "boolean", "description": "Whether or not sending a bunq.me request is allowed.", "readOnly": false, "writeOnly": true }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to after accepting or rejecting the Request.", "readOnly": false, "writeOnly": false }, "event_id": { "type": "integer", "description": "The ID of the associated event if the request was made using 'split the bill'.", "readOnly": false, "writeOnly": true }, "id": { "type": "integer", "description": "The id of the created RequestInquiry.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the payment request's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the payment request's last update.", "readOnly": true, "writeOnly": false }, "time_responded": { "type": "string", "description": "The timestamp of when the payment request was responded to.", "readOnly": true, "writeOnly": false }, "time_expiry": { "type": "string", "description": "The timestamp of when the payment request expired.", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account the request response applies to.", "readOnly": true, "writeOnly": false }, "amount_responded": { "type": "object", "description": "The responded amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "user_alias_created": { "type": "object", "description": "The label that's displayed to the counterparty with the mutation. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "user_alias_revoked": { "type": "object", "description": "The label that's displayed to the counterparty with the mutation. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "batch_id": { "type": "integer", "description": "The id of the batch if the request was part of a batch.", "readOnly": true, "writeOnly": false }, "scheduled_id": { "type": "integer", "description": "The id of the scheduled job if the request was scheduled.", "readOnly": true, "writeOnly": false }, "bunqme_share_url": { "type": "string", "description": "The url that points to the bunq.me request.", "readOnly": true, "writeOnly": false }, "address_shipping": { "type": "object", "description": "The shipping address provided by the accepting user if an address was requested.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_billing": { "type": "object", "description": "The billing address provided by the accepting user if an address was requested.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "geolocation": { "type": "object", "description": "The geolocation where the payment was done.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false }, "reference_split_the_bill": { "type": "object", "description": "The reference to the object used for split the bill. Can be Payment, PaymentBatch, ScheduleInstance, RequestResponse and MasterCardAction", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/RequestReferenceSplitTheBillAnchorObject" } }, "required": [ "allow_bunqme" ] }, "RequestInquiryBatch": { "type": "object", "properties": { "request_inquiries": { "type": "array", "description": "The list of requests that were made.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiry" } }, "status": { "type": "string", "description": "The status of the request.", "readOnly": false, "writeOnly": true }, "total_amount_inquired": { "type": "object", "description": "The total amount originally inquired for this batch.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "event_id": { "type": "integer", "description": "The ID of the associated event if the request batch was made using 'split the bill'.", "readOnly": false, "writeOnly": true }, "reference_split_the_bill": { "type": "object", "description": "The reference to the object used for split the bill. Can be Payment, PaymentBatch, ScheduleInstance, RequestResponse and MasterCardAction", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/RequestReferenceSplitTheBillAnchorObject" } } }, "RequestInquiryBatchCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "RequestInquiryBatchListing": { "type": "object", "properties": { "request_inquiries": { "type": "array", "description": "The list of requests that were made.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiry" } }, "total_amount_inquired": { "type": "object", "description": "The total amount originally inquired for this batch.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "reference_split_the_bill": { "type": "object", "description": "The reference to the object used for split the bill. Can be Payment, PaymentBatch, ScheduleInstance, RequestResponse and MasterCardAction", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/RequestReferenceSplitTheBillAnchorObject" } } }, "RequestInquiryBatchRead": { "type": "object", "properties": { "request_inquiries": { "type": "array", "description": "The list of requests that were made.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiry" } }, "total_amount_inquired": { "type": "object", "description": "The total amount originally inquired for this batch.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "reference_split_the_bill": { "type": "object", "description": "The reference to the object used for split the bill. Can be Payment, PaymentBatch, ScheduleInstance, RequestResponse and MasterCardAction", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/RequestReferenceSplitTheBillAnchorObject" } } }, "RequestInquiryBatchUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "RequestInquiryCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created RequestInquiry.", "readOnly": true, "writeOnly": false } } }, "RequestInquiryListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created RequestInquiry.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the payment request's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the payment request's last update.", "readOnly": true, "writeOnly": false }, "time_responded": { "type": "string", "description": "The timestamp of when the payment request was responded to.", "readOnly": true, "writeOnly": false }, "time_expiry": { "type": "string", "description": "The timestamp of when the payment request expired.", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account the request response applies to.", "readOnly": true, "writeOnly": false }, "amount_inquired": { "type": "object", "description": "The requested amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_responded": { "type": "object", "description": "The responded amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "user_alias_created": { "type": "object", "description": "The label that's displayed to the counterparty with the mutation. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "user_alias_revoked": { "type": "object", "description": "The label that's displayed to the counterparty with the mutation. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount the money was requested from.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "description": { "type": "string", "description": "The description of the inquiry.", "readOnly": true, "writeOnly": false }, "merchant_reference": { "type": "string", "description": "The client's custom reference that was attached to the request and the mutation.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachments attached to the payment.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BunqId" } }, "status": { "type": "string", "description": "The status of the request.", "readOnly": true, "writeOnly": false }, "batch_id": { "type": "integer", "description": "The id of the batch if the request was part of a batch.", "readOnly": true, "writeOnly": false }, "scheduled_id": { "type": "integer", "description": "The id of the scheduled job if the request was scheduled.", "readOnly": true, "writeOnly": false }, "minimum_age": { "type": "integer", "description": "The minimum age the user accepting the RequestInquiry must have.", "readOnly": true, "writeOnly": false }, "require_address": { "type": "string", "description": "Whether or not an address must be provided on accept.", "readOnly": true, "writeOnly": false }, "bunqme_share_url": { "type": "string", "description": "The url that points to the bunq.me request.", "readOnly": true, "writeOnly": false }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to after accepting or rejecting the Request.", "readOnly": true, "writeOnly": false }, "address_shipping": { "type": "object", "description": "The shipping address provided by the accepting user if an address was requested.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_billing": { "type": "object", "description": "The billing address provided by the accepting user if an address was requested.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "geolocation": { "type": "object", "description": "The geolocation where the payment was done.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false }, "reference_split_the_bill": { "type": "object", "description": "The reference to the object used for split the bill. Can be Payment, PaymentBatch, ScheduleInstance, RequestResponse and MasterCardAction", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/RequestReferenceSplitTheBillAnchorObject" } } }, "RequestInquiryRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created RequestInquiry.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the payment request's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the payment request's last update.", "readOnly": true, "writeOnly": false }, "time_responded": { "type": "string", "description": "The timestamp of when the payment request was responded to.", "readOnly": true, "writeOnly": false }, "time_expiry": { "type": "string", "description": "The timestamp of when the payment request expired.", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account the request response applies to.", "readOnly": true, "writeOnly": false }, "amount_inquired": { "type": "object", "description": "The requested amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_responded": { "type": "object", "description": "The responded amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "user_alias_created": { "type": "object", "description": "The label that's displayed to the counterparty with the mutation. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "user_alias_revoked": { "type": "object", "description": "The label that's displayed to the counterparty with the mutation. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount the money was requested from.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "description": { "type": "string", "description": "The description of the inquiry.", "readOnly": true, "writeOnly": false }, "merchant_reference": { "type": "string", "description": "The client's custom reference that was attached to the request and the mutation.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachments attached to the payment.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BunqId" } }, "status": { "type": "string", "description": "The status of the request.", "readOnly": true, "writeOnly": false }, "batch_id": { "type": "integer", "description": "The id of the batch if the request was part of a batch.", "readOnly": true, "writeOnly": false }, "scheduled_id": { "type": "integer", "description": "The id of the scheduled job if the request was scheduled.", "readOnly": true, "writeOnly": false }, "minimum_age": { "type": "integer", "description": "The minimum age the user accepting the RequestInquiry must have.", "readOnly": true, "writeOnly": false }, "require_address": { "type": "string", "description": "Whether or not an address must be provided on accept.", "readOnly": true, "writeOnly": false }, "bunqme_share_url": { "type": "string", "description": "The url that points to the bunq.me request.", "readOnly": true, "writeOnly": false }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to after accepting or rejecting the Request.", "readOnly": true, "writeOnly": false }, "address_shipping": { "type": "object", "description": "The shipping address provided by the accepting user if an address was requested.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_billing": { "type": "object", "description": "The billing address provided by the accepting user if an address was requested.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "geolocation": { "type": "object", "description": "The geolocation where the payment was done.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false }, "reference_split_the_bill": { "type": "object", "description": "The reference to the object used for split the bill. Can be Payment, PaymentBatch, ScheduleInstance, RequestResponse and MasterCardAction", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/RequestReferenceSplitTheBillAnchorObject" } } }, "RequestInquiryReference": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of request inquiry. Can be RequestInquiry or RequestInquiryBatch.", "readOnly": true, "writeOnly": false }, "id": { "type": "integer", "description": "The id of the request inquiry (batch).", "readOnly": true, "writeOnly": false } } }, "RequestInquiryUpdate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the payment request.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the payment request's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the payment request's last update.", "readOnly": true, "writeOnly": false }, "time_responded": { "type": "string", "description": "The timestamp of when the payment request was responded to.", "readOnly": true, "writeOnly": false }, "time_expiry": { "type": "string", "description": "The timestamp of when the payment request expired.", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account the request response applies to.", "readOnly": true, "writeOnly": false }, "amount_inquired": { "type": "object", "description": "The requested amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_responded": { "type": "object", "description": "The responded amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "user_alias_created": { "type": "object", "description": "The label that's displayed to the counterparty with the mutation. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "user_alias_revoked": { "type": "object", "description": "The label that's displayed to the counterparty with the mutation. Includes user.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount the money was requested from.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "description": { "type": "string", "description": "The description of the inquiry.", "readOnly": true, "writeOnly": false }, "merchant_reference": { "type": "string", "description": "The client's custom reference that was attached to the request and the mutation.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The attachments attached to the payment.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BunqId" } }, "status": { "type": "string", "description": "The status of the request.", "readOnly": true, "writeOnly": false }, "batch_id": { "type": "integer", "description": "The id of the batch if the request was part of a batch.", "readOnly": true, "writeOnly": false }, "scheduled_id": { "type": "integer", "description": "The id of the scheduled job if the request was scheduled.", "readOnly": true, "writeOnly": false }, "minimum_age": { "type": "integer", "description": "The minimum age the user accepting the RequestInquiry must have.", "readOnly": true, "writeOnly": false }, "require_address": { "type": "string", "description": "Whether or not an address must be provided on accept.", "readOnly": true, "writeOnly": false }, "address_shipping": { "type": "object", "description": "The shipping address provided by the accepting user if an address was requested.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_billing": { "type": "object", "description": "The billing address provided by the accepting user if an address was requested.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "geolocation": { "type": "object", "description": "The geolocation where the payment was done.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "reference_split_the_bill": { "type": "object", "description": "The reference to the object used for split the bill. Can be Payment, PaymentBatch, ScheduleInstance, RequestResponse and MasterCardAction", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/RequestReferenceSplitTheBillAnchorObject" } } }, "RequestReferenceSplitTheBillAnchorObject": { "type": "object", "properties": { "BillingInvoice": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Invoice" }, "DraftPayment": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/DraftPayment" }, "MasterCardAction": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/MasterCardAction" }, "Payment": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" }, "PaymentBatch": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/PaymentBatch" }, "RequestResponse": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/RequestResponse" }, "ScheduleInstance": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ScheduleInstance" }, "TabResultResponse": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TabResultResponse" }, "WhitelistResult": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/WhitelistResult" } } }, "RequestResponse": { "type": "object", "properties": { "amount_responded": { "type": "object", "description": "The Amount the RequestResponse was accepted with.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "status": { "type": "string", "description": "The status of the RequestResponse. Can be ACCEPTED, PENDING, REJECTED, REFUND_REQUESTED, REFUNDED or REVOKED.", "readOnly": false, "writeOnly": false }, "address_shipping": { "type": "object", "description": "The shipping address provided by the accepting user if an address was requested.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_billing": { "type": "object", "description": "The billing address provided by the accepting user if an address was requested.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "id": { "type": "integer", "description": "The id of the Request Response.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp when the Request Response was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp when the Request Response was last updated (will be updated when chat messages are received).", "readOnly": true, "writeOnly": false }, "time_responded": { "type": "string", "description": "The timestamp of when the RequestResponse was responded to.", "readOnly": true, "writeOnly": false }, "time_expiry": { "type": "string", "description": "The timestamp of when the RequestResponse expired or will expire.", "readOnly": true, "writeOnly": false }, "time_refund_requested": { "type": "string", "description": "The timestamp of when a refund request for the RequestResponse was claimed.", "readOnly": true, "writeOnly": false }, "time_refunded": { "type": "string", "description": "The timestamp of when the RequestResponse was refunded.", "readOnly": true, "writeOnly": false }, "user_refund_requested": { "type": "object", "description": "The label of the user that requested the refund.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "monetary_account_id": { "type": "integer", "description": "The id of the MonetaryAccount the RequestResponse was received on.", "readOnly": true, "writeOnly": false }, "amount_inquired": { "type": "object", "description": "The requested Amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "description": { "type": "string", "description": "The description for the RequestResponse provided by the requesting party. Maximum 9000 characters.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount this RequestResponse was received on.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount that is requesting money with this RequestResponse.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "attachment": { "type": "array", "description": "The Attachments attached to the RequestResponse.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Attachment" } }, "minimum_age": { "type": "integer", "description": "The minimum age the user accepting the RequestResponse must have.", "readOnly": true, "writeOnly": false }, "require_address": { "type": "string", "description": "Whether or not an address must be provided on accept.", "readOnly": true, "writeOnly": false }, "geolocation": { "type": "object", "description": "The Geolocation where the RequestResponse was created.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "type": { "type": "string", "description": "The type of the RequestInquiry. Can be DIRECT_DEBIT, DIRECT_DEBIT_B2B, IDEAL, SOFORT or INTERNAL.", "readOnly": true, "writeOnly": false }, "sub_type": { "type": "string", "description": "The subtype of the RequestInquiry. Can be ONCE or RECURRING for DIRECT_DEBIT RequestInquiries and NONE for all other.", "readOnly": true, "writeOnly": false }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to after accepting or rejecting the Request.", "readOnly": true, "writeOnly": false }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false }, "credit_scheme_identifier": { "type": "string", "description": "The credit scheme id provided by the counterparty for DIRECT_DEBIT inquiries.", "readOnly": true, "writeOnly": false }, "mandate_identifier": { "type": "string", "description": "The mandate id provided by the counterparty for DIRECT_DEBIT inquiries.", "readOnly": true, "writeOnly": false }, "eligible_whitelist_id": { "type": "integer", "description": "The whitelist id for this action or null.", "readOnly": true, "writeOnly": false }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "RequestResponseListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the Request Response.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp when the Request Response was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp when the Request Response was last updated (will be updated when chat messages are received).", "readOnly": true, "writeOnly": false }, "time_responded": { "type": "string", "description": "The timestamp of when the RequestResponse was responded to.", "readOnly": true, "writeOnly": false }, "time_expiry": { "type": "string", "description": "The timestamp of when the RequestResponse expired or will expire.", "readOnly": true, "writeOnly": false }, "time_refund_requested": { "type": "string", "description": "The timestamp of when a refund request for the RequestResponse was claimed.", "readOnly": true, "writeOnly": false }, "time_refunded": { "type": "string", "description": "The timestamp of when the RequestResponse was refunded.", "readOnly": true, "writeOnly": false }, "user_refund_requested": { "type": "object", "description": "The label of the user that requested the refund.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "monetary_account_id": { "type": "integer", "description": "The id of the MonetaryAccount the RequestResponse was received on.", "readOnly": true, "writeOnly": false }, "amount_inquired": { "type": "object", "description": "The requested Amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_responded": { "type": "object", "description": "The Amount the RequestResponse was accepted with.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "status": { "type": "string", "description": "The status of the RequestResponse. Can be ACCEPTED, PENDING, REJECTED, REFUND_REQUESTED, REFUNDED or REVOKED.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description for the RequestResponse provided by the requesting party. Maximum 9000 characters.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount this RequestResponse was received on.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount that is requesting money with this RequestResponse.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "attachment": { "type": "array", "description": "The Attachments attached to the RequestResponse.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Attachment" } }, "minimum_age": { "type": "integer", "description": "The minimum age the user accepting the RequestResponse must have.", "readOnly": true, "writeOnly": false }, "require_address": { "type": "string", "description": "Whether or not an address must be provided on accept.", "readOnly": true, "writeOnly": false }, "geolocation": { "type": "object", "description": "The Geolocation where the RequestResponse was created.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "type": { "type": "string", "description": "The type of the RequestInquiry. Can be DIRECT_DEBIT, DIRECT_DEBIT_B2B, IDEAL, SOFORT or INTERNAL.", "readOnly": true, "writeOnly": false }, "sub_type": { "type": "string", "description": "The subtype of the RequestInquiry. Can be ONCE or RECURRING for DIRECT_DEBIT RequestInquiries and NONE for all other.", "readOnly": true, "writeOnly": false }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to after accepting or rejecting the Request.", "readOnly": true, "writeOnly": false }, "address_billing": { "type": "object", "description": "The billing address provided by the accepting user if an address was requested.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_shipping": { "type": "object", "description": "The shipping address provided by the accepting user if an address was requested.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false }, "credit_scheme_identifier": { "type": "string", "description": "The credit scheme id provided by the counterparty for DIRECT_DEBIT inquiries.", "readOnly": true, "writeOnly": false }, "mandate_identifier": { "type": "string", "description": "The mandate id provided by the counterparty for DIRECT_DEBIT inquiries.", "readOnly": true, "writeOnly": false }, "eligible_whitelist_id": { "type": "integer", "description": "The whitelist id for this action or null.", "readOnly": true, "writeOnly": false }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "RequestResponseRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the Request Response.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp when the Request Response was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp when the Request Response was last updated (will be updated when chat messages are received).", "readOnly": true, "writeOnly": false }, "time_responded": { "type": "string", "description": "The timestamp of when the RequestResponse was responded to.", "readOnly": true, "writeOnly": false }, "time_expiry": { "type": "string", "description": "The timestamp of when the RequestResponse expired or will expire.", "readOnly": true, "writeOnly": false }, "time_refund_requested": { "type": "string", "description": "The timestamp of when a refund request for the RequestResponse was claimed.", "readOnly": true, "writeOnly": false }, "time_refunded": { "type": "string", "description": "The timestamp of when the RequestResponse was refunded.", "readOnly": true, "writeOnly": false }, "user_refund_requested": { "type": "object", "description": "The label of the user that requested the refund.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "monetary_account_id": { "type": "integer", "description": "The id of the MonetaryAccount the RequestResponse was received on.", "readOnly": true, "writeOnly": false }, "amount_inquired": { "type": "object", "description": "The requested Amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_responded": { "type": "object", "description": "The Amount the RequestResponse was accepted with.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "status": { "type": "string", "description": "The status of the RequestResponse. Can be ACCEPTED, PENDING, REJECTED, REFUND_REQUESTED, REFUNDED or REVOKED.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description for the RequestResponse provided by the requesting party. Maximum 9000 characters.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount this RequestResponse was received on.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount that is requesting money with this RequestResponse.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "attachment": { "type": "array", "description": "The Attachments attached to the RequestResponse.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Attachment" } }, "minimum_age": { "type": "integer", "description": "The minimum age the user accepting the RequestResponse must have.", "readOnly": true, "writeOnly": false }, "require_address": { "type": "string", "description": "Whether or not an address must be provided on accept.", "readOnly": true, "writeOnly": false }, "geolocation": { "type": "object", "description": "The Geolocation where the RequestResponse was created.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "type": { "type": "string", "description": "The type of the RequestInquiry. Can be DIRECT_DEBIT, DIRECT_DEBIT_B2B, IDEAL, SOFORT or INTERNAL.", "readOnly": true, "writeOnly": false }, "sub_type": { "type": "string", "description": "The subtype of the RequestInquiry. Can be ONCE or RECURRING for DIRECT_DEBIT RequestInquiries and NONE for all other.", "readOnly": true, "writeOnly": false }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to after accepting or rejecting the Request.", "readOnly": true, "writeOnly": false }, "address_billing": { "type": "object", "description": "The billing address provided by the accepting user if an address was requested.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_shipping": { "type": "object", "description": "The shipping address provided by the accepting user if an address was requested.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false }, "credit_scheme_identifier": { "type": "string", "description": "The credit scheme id provided by the counterparty for DIRECT_DEBIT inquiries.", "readOnly": true, "writeOnly": false }, "mandate_identifier": { "type": "string", "description": "The mandate id provided by the counterparty for DIRECT_DEBIT inquiries.", "readOnly": true, "writeOnly": false }, "eligible_whitelist_id": { "type": "integer", "description": "The whitelist id for this action or null.", "readOnly": true, "writeOnly": false }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "RequestResponseUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "RewardListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the reward.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The time the reward was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The time the reward was last updated.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the reward.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The subStatus of the reward.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the reward.", "readOnly": true, "writeOnly": false }, "counterparty_alias": { "type": "object", "description": "The alias of the other user eligible for the reward award.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "amount_reward": { "type": "object", "description": "The amount that will be\/was awarded as reward for the reward.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "RewardRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the reward.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The time the reward was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The time the reward was last updated.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the reward.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The subStatus of the reward.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the reward.", "readOnly": true, "writeOnly": false }, "counterparty_alias": { "type": "object", "description": "The alias of the other user eligible for the reward award.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "amount_reward": { "type": "object", "description": "The amount that will be\/was awarded as reward for the reward.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "RewardRecipient": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the reward.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The time the reward was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The time the reward was last updated.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the reward.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The subStatus of the reward.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the reward.", "readOnly": true, "writeOnly": false }, "counterparty_alias": { "type": "object", "description": "The alias of the other user eligible for the reward award.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "amount_reward": { "type": "object", "description": "The amount that will be\/was awarded as reward for the reward.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "RewardRecipientListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the reward.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The time the reward was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The time the reward was last updated.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the reward.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The subStatus of the reward.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the reward.", "readOnly": true, "writeOnly": false }, "counterparty_alias": { "type": "object", "description": "The alias of the other user eligible for the reward award.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "amount_reward": { "type": "object", "description": "The amount that will be\/was awarded as reward for the reward.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "RewardRecipientRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the reward.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The time the reward was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The time the reward was last updated.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the reward.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The subStatus of the reward.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the reward.", "readOnly": true, "writeOnly": false }, "counterparty_alias": { "type": "object", "description": "The alias of the other user eligible for the reward award.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "amount_reward": { "type": "object", "description": "The amount that will be\/was awarded as reward for the reward.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "RewardSender": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the reward.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The time the reward was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The time the reward was last updated.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the reward.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The subStatus of the reward.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the reward.", "readOnly": true, "writeOnly": false }, "counterparty_alias": { "type": "object", "description": "The alias of the other user eligible for the reward award.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "amount_reward": { "type": "object", "description": "The amount that will be\/was awarded as reward for the reward.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "RewardSenderListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the reward.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The time the reward was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The time the reward was last updated.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the reward.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The subStatus of the reward.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the reward.", "readOnly": true, "writeOnly": false }, "counterparty_alias": { "type": "object", "description": "The alias of the other user eligible for the reward award.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "amount_reward": { "type": "object", "description": "The amount that will be\/was awarded as reward for the reward.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "RewardSenderRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the reward.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The time the reward was created.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The time the reward was last updated.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the reward.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The subStatus of the reward.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the reward.", "readOnly": true, "writeOnly": false }, "counterparty_alias": { "type": "object", "description": "The alias of the other user eligible for the reward award.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "amount_reward": { "type": "object", "description": "The amount that will be\/was awarded as reward for the reward.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "SandboxUser": { "type": "object" }, "SandboxUserCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "Schedule": { "type": "object", "properties": { "time_start": { "type": "string", "description": "The schedule start time (UTC).", "readOnly": false, "writeOnly": false }, "time_end": { "type": "string", "description": "The schedule end time (UTC).", "readOnly": false, "writeOnly": false }, "recurrence_unit": { "type": "string", "description": "The schedule recurrence unit, options: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY", "readOnly": false, "writeOnly": false }, "recurrence_size": { "type": "integer", "description": "The schedule recurrence size. For example size 4 and unit WEEKLY means the recurrence is every 4 weeks.", "readOnly": false, "writeOnly": false }, "status": { "type": "string", "description": "The schedule status, options: ACTIVE, FINISHED, CANCELLED.", "readOnly": true, "writeOnly": false }, "object": { "type": "object", "description": "The scheduled object. (Payment, PaymentBatch)", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ScheduleAnchorObject" } } }, "ScheduleAnchorObject": { "type": "object", "properties": { "Payment": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" }, "PaymentBatch": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/PaymentBatch" } } }, "ScheduleInstance": { "type": "object", "properties": { "state": { "type": "string", "description": "The state of the scheduleInstance. (FINISHED_SUCCESSFULLY, RETRY, FAILED_USER_ERROR)", "readOnly": false, "writeOnly": false }, "time_start": { "type": "string", "description": "The schedule start time (UTC).", "readOnly": true, "writeOnly": false }, "time_end": { "type": "string", "description": "The schedule end time (UTC).", "readOnly": true, "writeOnly": false }, "error_message": { "type": "array", "description": "The message when the scheduled instance has run and failed due to user error.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Error" } }, "scheduled_object": { "type": "object", "description": "The scheduled object. (Payment, PaymentBatch)", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ScheduleAnchorObject" }, "result_object": { "type": "object", "description": "The result object of this schedule instance. (Payment, PaymentBatch)", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ScheduleInstanceAnchorObject" }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "ScheduleInstanceAnchorObject": { "type": "object", "properties": { "Payment": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" }, "PaymentBatch": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/PaymentBatch" } } }, "ScheduleInstanceListing": { "type": "object", "properties": { "state": { "type": "string", "description": "The state of the scheduleInstance. (FINISHED_SUCCESSFULLY, RETRY, FAILED_USER_ERROR)", "readOnly": true, "writeOnly": false }, "time_start": { "type": "string", "description": "The schedule start time (UTC).", "readOnly": true, "writeOnly": false }, "time_end": { "type": "string", "description": "The schedule end time (UTC).", "readOnly": true, "writeOnly": false }, "error_message": { "type": "array", "description": "The message when the scheduled instance has run and failed due to user error.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Error" } }, "scheduled_object": { "type": "object", "description": "The scheduled object. (Payment, PaymentBatch)", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ScheduleAnchorObject" }, "result_object": { "type": "object", "description": "The result object of this schedule instance. (Payment, PaymentBatch)", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ScheduleInstanceAnchorObject" }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "ScheduleInstanceRead": { "type": "object", "properties": { "state": { "type": "string", "description": "The state of the scheduleInstance. (FINISHED_SUCCESSFULLY, RETRY, FAILED_USER_ERROR)", "readOnly": true, "writeOnly": false }, "time_start": { "type": "string", "description": "The schedule start time (UTC).", "readOnly": true, "writeOnly": false }, "time_end": { "type": "string", "description": "The schedule end time (UTC).", "readOnly": true, "writeOnly": false }, "error_message": { "type": "array", "description": "The message when the scheduled instance has run and failed due to user error.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Error" } }, "scheduled_object": { "type": "object", "description": "The scheduled object. (Payment, PaymentBatch)", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ScheduleAnchorObject" }, "result_object": { "type": "object", "description": "The result object of this schedule instance. (Payment, PaymentBatch)", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ScheduleInstanceAnchorObject" }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "ScheduleInstanceUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "ScheduleListing": { "type": "object", "properties": { "time_start": { "type": "string", "description": "The schedule start time (UTC).", "readOnly": true, "writeOnly": false }, "time_end": { "type": "string", "description": "The schedule end time (UTC).", "readOnly": true, "writeOnly": false }, "recurrence_unit": { "type": "string", "description": "The schedule recurrence unit, options: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY", "readOnly": true, "writeOnly": false }, "recurrence_size": { "type": "integer", "description": "The schedule recurrence size. For example size 4 and unit WEEKLY means the recurrence is every 4 weeks.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The schedule status, options: ACTIVE, FINISHED, CANCELLED.", "readOnly": true, "writeOnly": false }, "object": { "type": "object", "description": "The scheduled object. (Payment, PaymentBatch)", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ScheduleAnchorObject" } } }, "SchedulePayment": { "type": "object", "properties": { "payment": { "type": "object", "description": "The payment details.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/SchedulePaymentEntry" }, "schedule": { "type": "object", "description": "The schedule details.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Schedule" } } }, "SchedulePaymentBatch": { "type": "object", "properties": { "payments": { "type": "array", "description": "The payment details.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/SchedulePaymentEntry" } }, "schedule": { "type": "object", "description": "The schedule details.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Schedule" } } }, "SchedulePaymentBatchCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "SchedulePaymentBatchDelete": { "type": "object" }, "SchedulePaymentBatchUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "SchedulePaymentCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "SchedulePaymentDelete": { "type": "object" }, "SchedulePaymentEntry": { "type": "object", "properties": { "amount": { "type": "object", "description": "The Amount transferred by the Payment. Will be negative for outgoing Payments and positive for incoming Payments (relative to the MonetaryAccount indicated by monetary_account_id).", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of the other (counterparty) side of the Payment.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "description": { "type": "string", "description": "The description for the Payment. Maximum 140 characters for Payments to external IBANs, 9000 characters for Payments to only other bunq MonetaryAccounts.", "readOnly": false, "writeOnly": false }, "attachment": { "type": "array", "description": "The Attachments attached to the Payment.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountPayment" } }, "merchant_reference": { "type": "string", "description": "Optional data included with the Payment specific to the merchant.", "readOnly": false, "writeOnly": false }, "allow_bunqto": { "type": "boolean", "description": "Whether or not sending a bunq.to payment is allowed.", "readOnly": false, "writeOnly": true }, "alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of 'this' (party) side of the Payment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" } } }, "SchedulePaymentListing": { "type": "object", "properties": { "payment": { "type": "object", "description": "The payment details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/SchedulePaymentEntry" }, "schedule": { "type": "object", "description": "The schedule details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Schedule" } } }, "SchedulePaymentRead": { "type": "object", "properties": { "payment": { "type": "object", "description": "The payment details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/SchedulePaymentEntry" }, "schedule": { "type": "object", "description": "The schedule details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Schedule" } } }, "SchedulePaymentUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "ScheduleRead": { "type": "object", "properties": { "time_start": { "type": "string", "description": "The schedule start time (UTC).", "readOnly": true, "writeOnly": false }, "time_end": { "type": "string", "description": "The schedule end time (UTC).", "readOnly": true, "writeOnly": false }, "recurrence_unit": { "type": "string", "description": "The schedule recurrence unit, options: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY", "readOnly": true, "writeOnly": false }, "recurrence_size": { "type": "integer", "description": "The schedule recurrence size. For example size 4 and unit WEEKLY means the recurrence is every 4 weeks.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The schedule status, options: ACTIVE, FINISHED, CANCELLED.", "readOnly": true, "writeOnly": false }, "object": { "type": "object", "description": "The scheduled object. (Payment, PaymentBatch)", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ScheduleAnchorObject" } } }, "ScheduleUserListing": { "type": "object" }, "SessionDelete": { "type": "object" }, "SessionServer": { "type": "object", "properties": { "secret": { "type": "string", "description": "The API key of the user you want to login. If your API key has not been used before, it will be bound to the ip address of this DeviceServer.", "readOnly": false, "writeOnly": true } }, "required": [ "secret" ] }, "SessionServerCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The Id object of the created Session.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" }, "Token": { "type": "object", "description": "The token object of this Session.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/SessionServerToken" }, "UserCompany": { "type": "object", "description": "The UserCompany object that is logged in with this Session.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserCompany" }, "UserPerson": { "type": "object", "description": "The UserPerson object that is logged in with this Session.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserPerson" }, "UserApiKey": { "type": "object", "description": "The UserApiKey object that is logged in with this Session.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserApiKey" }, "UserPaymentServiceProvider": { "type": "object", "description": "The UserPaymentServiceProvider object that is logged in with this Session.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserPaymentServiceProvider" } } }, "SessionServerToken": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the Token.", "readOnly": true, "writeOnly": false }, "token": { "type": "string", "description": "The Session token is the token the client has to provide in the \"X-Bunq-Client-Authentication\" header for each API call that requires a Session (only the creation of a Installation and DeviceServer don't require a Session).", "readOnly": true, "writeOnly": false } } }, "ShareDetail": { "type": "object", "properties": { "payment": { "type": "object", "description": "The share details for a payment share. In the response 'payment' is replaced by 'ShareDetailPayment'.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetailPayment" }, "read_only": { "type": "object", "description": "The share details for viewing a share. In the response 'read_only' is replaced by 'ShareDetailReadOnly'.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetailReadOnly" }, "draft_payment": { "type": "object", "description": "The share details for a draft payment share. In the response 'draft_payment' is replaced by 'ShareDetailDraftPayment'.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetailDraftPayment" } } }, "ShareDetailDraftPayment": { "type": "object", "properties": { "make_draft_payments": { "type": "boolean", "description": "If set to true, the invited user will be able to make draft payments from the shared account.", "readOnly": false, "writeOnly": false }, "view_balance": { "type": "boolean", "description": "If set to true, the invited user will be able to view the account balance.", "readOnly": false, "writeOnly": false }, "view_old_events": { "type": "boolean", "description": "If set to true, the invited user will be able to view events from before the share was active.", "readOnly": false, "writeOnly": false }, "view_new_events": { "type": "boolean", "description": "If set to true, the invited user will be able to view events starting from the time the share became active.", "readOnly": false, "writeOnly": false } } }, "ShareDetailPayment": { "type": "object", "properties": { "make_payments": { "type": "boolean", "description": "If set to true, the invited user will be able to make payments from the shared account.", "readOnly": false, "writeOnly": false }, "make_draft_payments": { "type": "boolean", "description": "If set to true, the invited user will be able to make draft payments from the shared account.", "readOnly": false, "writeOnly": false }, "view_balance": { "type": "boolean", "description": "If set to true, the invited user will be able to view the account balance.", "readOnly": false, "writeOnly": false }, "view_old_events": { "type": "boolean", "description": "If set to true, the invited user will be able to view events from before the share was active.", "readOnly": false, "writeOnly": false }, "view_new_events": { "type": "boolean", "description": "If set to true, the invited user will be able to view events starting from the time the share became active.", "readOnly": false, "writeOnly": false }, "budget": { "type": "object", "description": "The budget restriction.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/BudgetRestriction" } } }, "ShareDetailReadOnly": { "type": "object", "properties": { "view_balance": { "type": "boolean", "description": "If set to true, the invited user will be able to view the account balance.", "readOnly": false, "writeOnly": false }, "view_old_events": { "type": "boolean", "description": "If set to true, the invited user will be able to view events from before the share was active.", "readOnly": false, "writeOnly": false }, "view_new_events": { "type": "boolean", "description": "If set to true, the invited user will be able to view events starting from the time the share became active.", "readOnly": false, "writeOnly": false } } }, "ShareInviteBankAmountUsedDelete": { "type": "object" }, "ShareInviteBankInquiry": { "type": "object", "properties": { "counter_user_alias": { "type": "object", "description": "The label of the user to share with.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "draft_share_invite_bank_id": { "type": "integer", "description": "The id of the draft share invite bank.", "readOnly": false, "writeOnly": false }, "share_detail": { "type": "object", "description": "The share details. Only one of these objects is returned.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetail" }, "status": { "type": "string", "description": "The status of the share. Can be PENDING, REVOKED (the user deletes the share inquiry before it's accepted), ACCEPTED, CANCELLED (the user deletes an active share) or CANCELLATION_PENDING, CANCELLATION_ACCEPTED, CANCELLATION_REJECTED (for canceling mutual connects)", "readOnly": false, "writeOnly": false }, "share_type": { "type": "string", "description": "The share type, either STANDARD or MUTUAL.", "readOnly": false, "writeOnly": false }, "start_date": { "type": "string", "description": "The start date of this share.", "readOnly": false, "writeOnly": false }, "end_date": { "type": "string", "description": "The expiration date of this share.", "readOnly": false, "writeOnly": false }, "alias": { "type": "object", "description": "The label of the monetary account that's being shared.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "user_alias_created": { "type": "object", "description": "The user who created the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "user_alias_revoked": { "type": "object", "description": "The user who revoked the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account the share applies to.", "readOnly": true, "writeOnly": false }, "id": { "type": "integer", "description": "The id of the newly created share invite.", "readOnly": true, "writeOnly": false } } }, "ShareInviteBankInquiryBatch": { "type": "object", "properties": { "share_invite_bank_inquiries": { "type": "array", "description": "The list of share invite bank inquiries that were made.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/ShareInviteBankInquiry" } }, "alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of this share invite inquiry batch.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" } } }, "ShareInviteBankInquiryCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the newly created share invite.", "readOnly": true, "writeOnly": false } } }, "ShareInviteBankInquiryListing": { "type": "object", "properties": { "alias": { "type": "object", "description": "The label of the monetary account that's being shared.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "user_alias_created": { "type": "object", "description": "The user who created the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "user_alias_revoked": { "type": "object", "description": "The user who revoked the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "counter_user_alias": { "type": "object", "description": "The label of the user to share with.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account the share applies to.", "readOnly": true, "writeOnly": false }, "draft_share_invite_bank_id": { "type": "integer", "description": "The id of the draft share invite bank.", "readOnly": true, "writeOnly": false }, "share_detail": { "type": "object", "description": "The share details. Only one of these objects is returned.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetail" }, "status": { "type": "string", "description": "The status of the share. Can be PENDING, REVOKED (the user deletes the share inquiry before it's accepted), ACCEPTED, CANCELLED (the user deletes an active share) or CANCELLATION_PENDING, CANCELLATION_ACCEPTED, CANCELLATION_REJECTED (for canceling mutual connects)", "readOnly": true, "writeOnly": false }, "share_type": { "type": "string", "description": "The share type, either STANDARD or MUTUAL.", "readOnly": true, "writeOnly": false }, "start_date": { "type": "string", "description": "The start date of this share.", "readOnly": true, "writeOnly": false }, "end_date": { "type": "string", "description": "The expiration date of this share.", "readOnly": true, "writeOnly": false }, "id": { "type": "integer", "description": "The id of the newly created share invite.", "readOnly": true, "writeOnly": false } } }, "ShareInviteBankInquiryRead": { "type": "object", "properties": { "alias": { "type": "object", "description": "The label of the monetary account that's being shared.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "user_alias_created": { "type": "object", "description": "The user who created the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "user_alias_revoked": { "type": "object", "description": "The user who revoked the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "counter_user_alias": { "type": "object", "description": "The label of the user to share with.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account the share applies to.", "readOnly": true, "writeOnly": false }, "draft_share_invite_bank_id": { "type": "integer", "description": "The id of the draft share invite bank.", "readOnly": true, "writeOnly": false }, "share_detail": { "type": "object", "description": "The share details. Only one of these objects is returned.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetail" }, "status": { "type": "string", "description": "The status of the share. Can be PENDING, REVOKED (the user deletes the share inquiry before it's accepted), ACCEPTED, CANCELLED (the user deletes an active share) or CANCELLATION_PENDING, CANCELLATION_ACCEPTED, CANCELLATION_REJECTED (for canceling mutual connects)", "readOnly": true, "writeOnly": false }, "share_type": { "type": "string", "description": "The share type, either STANDARD or MUTUAL.", "readOnly": true, "writeOnly": false }, "start_date": { "type": "string", "description": "The start date of this share.", "readOnly": true, "writeOnly": false }, "end_date": { "type": "string", "description": "The expiration date of this share.", "readOnly": true, "writeOnly": false }, "id": { "type": "integer", "description": "The id of the newly created share invite.", "readOnly": true, "writeOnly": false } } }, "ShareInviteBankInquiryUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "ShareInviteBankResponse": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the share. Can be PENDING, REVOKED (the user deletes the share inquiry before it's accepted), ACCEPTED, CANCELLED (the user deletes an active share) or CANCELLATION_PENDING, CANCELLATION_ACCEPTED, CANCELLATION_REJECTED (for canceling mutual connects)", "readOnly": false, "writeOnly": false }, "id": { "type": "integer", "description": "The id of the ShareInviteBankResponse.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the ShareInviteBankResponse creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the ShareInviteBankResponse last update.", "readOnly": true, "writeOnly": false }, "counter_alias": { "type": "object", "description": "The monetary account and user who created the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "user_alias_cancelled": { "type": "object", "description": "The user who cancelled the share if it has been revoked or rejected.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account the ACCEPTED share applies to. null otherwise.", "readOnly": true, "writeOnly": false }, "draft_share_invite_bank_id": { "type": "integer", "description": "The id of the draft share invite bank.", "readOnly": true, "writeOnly": false }, "share_detail": { "type": "object", "description": "The share details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetail" }, "share_type": { "type": "string", "description": "The share type, either STANDARD or MUTUAL.", "readOnly": true, "writeOnly": false }, "start_date": { "type": "string", "description": "The start date of this share.", "readOnly": true, "writeOnly": false }, "end_date": { "type": "string", "description": "The expiration date of this share.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of this share. It is basically the monetary account description.", "readOnly": true, "writeOnly": false } } }, "ShareInviteBankResponseListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the ShareInviteBankResponse.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the ShareInviteBankResponse creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the ShareInviteBankResponse last update.", "readOnly": true, "writeOnly": false }, "counter_alias": { "type": "object", "description": "The monetary account and user who created the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "user_alias_cancelled": { "type": "object", "description": "The user who cancelled the share if it has been revoked or rejected.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account the ACCEPTED share applies to. null otherwise.", "readOnly": true, "writeOnly": false }, "draft_share_invite_bank_id": { "type": "integer", "description": "The id of the draft share invite bank.", "readOnly": true, "writeOnly": false }, "share_detail": { "type": "object", "description": "The share details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetail" }, "status": { "type": "string", "description": "The status of the share. Can be PENDING, REVOKED (the user deletes the share inquiry before it's accepted), ACCEPTED, CANCELLED (the user deletes an active share) or CANCELLATION_PENDING, CANCELLATION_ACCEPTED, CANCELLATION_REJECTED (for canceling mutual connects)", "readOnly": true, "writeOnly": false }, "share_type": { "type": "string", "description": "The share type, either STANDARD or MUTUAL.", "readOnly": true, "writeOnly": false }, "start_date": { "type": "string", "description": "The start date of this share.", "readOnly": true, "writeOnly": false }, "end_date": { "type": "string", "description": "The expiration date of this share.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of this share. It is basically the monetary account description.", "readOnly": true, "writeOnly": false } } }, "ShareInviteBankResponseRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the ShareInviteBankResponse.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the ShareInviteBankResponse creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the ShareInviteBankResponse last update.", "readOnly": true, "writeOnly": false }, "counter_alias": { "type": "object", "description": "The monetary account and user who created the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "user_alias_cancelled": { "type": "object", "description": "The user who cancelled the share if it has been revoked or rejected.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account the ACCEPTED share applies to. null otherwise.", "readOnly": true, "writeOnly": false }, "draft_share_invite_bank_id": { "type": "integer", "description": "The id of the draft share invite bank.", "readOnly": true, "writeOnly": false }, "share_detail": { "type": "object", "description": "The share details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetail" }, "status": { "type": "string", "description": "The status of the share. Can be PENDING, REVOKED (the user deletes the share inquiry before it's accepted), ACCEPTED, CANCELLED (the user deletes an active share) or CANCELLATION_PENDING, CANCELLATION_ACCEPTED, CANCELLATION_REJECTED (for canceling mutual connects)", "readOnly": true, "writeOnly": false }, "share_type": { "type": "string", "description": "The share type, either STANDARD or MUTUAL.", "readOnly": true, "writeOnly": false }, "start_date": { "type": "string", "description": "The start date of this share.", "readOnly": true, "writeOnly": false }, "end_date": { "type": "string", "description": "The expiration date of this share.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of this share. It is basically the monetary account description.", "readOnly": true, "writeOnly": false } } }, "ShareInviteBankResponseUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "ShareInviteMonetaryAccountAmountUsedDelete": { "type": "object" }, "ShareInviteMonetaryAccountInquiry": { "type": "object", "properties": { "counter_user_alias": { "type": "object", "description": "The pointer of the user to share with.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Pointer" }, "draft_share_invite_bank_id": { "type": "integer", "description": "The id of the draft share invite bank.", "readOnly": false, "writeOnly": false }, "share_detail": { "type": "object", "description": "The share details. Only one of these objects may be passed.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetail" }, "status": { "type": "string", "description": "The status of the share. Can be PENDING, REVOKED (the user deletes the share inquiry before it's accepted), ACCEPTED, CANCELLED (the user deletes an active share) or CANCELLATION_PENDING, CANCELLATION_ACCEPTED, CANCELLATION_REJECTED (for canceling mutual connects).", "readOnly": false, "writeOnly": false }, "share_type": { "type": "string", "description": "The share type, either STANDARD or MUTUAL.", "readOnly": false, "writeOnly": false }, "start_date": { "type": "string", "description": "The start date of this share.", "readOnly": false, "writeOnly": false }, "end_date": { "type": "string", "description": "The expiration date of this share.", "readOnly": false, "writeOnly": false } }, "required": [ "counter_user_alias", "share_detail", "status" ] }, "ShareInviteMonetaryAccountInquiryCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the newly created share invite.", "readOnly": true, "writeOnly": false } } }, "ShareInviteMonetaryAccountInquiryListing": { "type": "object", "properties": { "alias": { "type": "object", "description": "The label of the monetary account that's being shared.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "user_alias_created": { "type": "object", "description": "The user who created the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "user_alias_revoked": { "type": "object", "description": "The user who revoked the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "counter_user_alias": { "type": "object", "description": "The label of the user to share with.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account the share applies to.", "readOnly": true, "writeOnly": false }, "draft_share_invite_bank_id": { "type": "integer", "description": "The id of the draft share invite bank.", "readOnly": true, "writeOnly": false }, "share_detail": { "type": "object", "description": "The share details. Only one of these objects is returned.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetail" }, "status": { "type": "string", "description": "The status of the share. Can be PENDING, REVOKED (the user deletes the share inquiry before it's accepted), ACCEPTED, CANCELLED (the user deletes an active share) or CANCELLATION_PENDING, CANCELLATION_ACCEPTED, CANCELLATION_REJECTED (for canceling mutual connects)", "readOnly": true, "writeOnly": false }, "share_type": { "type": "string", "description": "The share type, either STANDARD or MUTUAL.", "readOnly": true, "writeOnly": false }, "start_date": { "type": "string", "description": "The start date of this share.", "readOnly": true, "writeOnly": false }, "end_date": { "type": "string", "description": "The expiration date of this share.", "readOnly": true, "writeOnly": false }, "id": { "type": "integer", "description": "The id of the newly created share invite.", "readOnly": true, "writeOnly": false } } }, "ShareInviteMonetaryAccountInquiryRead": { "type": "object", "properties": { "alias": { "type": "object", "description": "The label of the monetary account that's being shared.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "user_alias_created": { "type": "object", "description": "The user who created the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "user_alias_revoked": { "type": "object", "description": "The user who revoked the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "counter_user_alias": { "type": "object", "description": "The label of the user to share with.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account the share applies to.", "readOnly": true, "writeOnly": false }, "draft_share_invite_bank_id": { "type": "integer", "description": "The id of the draft share invite bank.", "readOnly": true, "writeOnly": false }, "share_detail": { "type": "object", "description": "The share details. Only one of these objects is returned.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetail" }, "status": { "type": "string", "description": "The status of the share. Can be PENDING, REVOKED (the user deletes the share inquiry before it's accepted), ACCEPTED, CANCELLED (the user deletes an active share) or CANCELLATION_PENDING, CANCELLATION_ACCEPTED, CANCELLATION_REJECTED (for canceling mutual connects)", "readOnly": true, "writeOnly": false }, "share_type": { "type": "string", "description": "The share type, either STANDARD or MUTUAL.", "readOnly": true, "writeOnly": false }, "start_date": { "type": "string", "description": "The start date of this share.", "readOnly": true, "writeOnly": false }, "end_date": { "type": "string", "description": "The expiration date of this share.", "readOnly": true, "writeOnly": false }, "id": { "type": "integer", "description": "The id of the newly created share invite.", "readOnly": true, "writeOnly": false } } }, "ShareInviteMonetaryAccountInquiryUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "ShareInviteMonetaryAccountResponse": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the share. Can be PENDING, REVOKED (the user deletes the share inquiry before it's accepted), ACCEPTED, CANCELLED (the user deletes an active share) or CANCELLATION_PENDING, CANCELLATION_ACCEPTED, CANCELLATION_REJECTED (for canceling mutual connects)", "readOnly": false, "writeOnly": false }, "card_id": { "type": "integer", "description": "The card to link to the shared monetary account. Used only if share_detail is ShareDetailCardPayment.", "readOnly": false, "writeOnly": true } } }, "ShareInviteMonetaryAccountResponseListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the ShareInviteBankResponse.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the ShareInviteBankResponse creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the ShareInviteBankResponse last update.", "readOnly": true, "writeOnly": false }, "counter_alias": { "type": "object", "description": "The monetary account and user who created the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "user_alias_cancelled": { "type": "object", "description": "The user who cancelled the share if it has been revoked or rejected.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account the ACCEPTED share applies to. null otherwise.", "readOnly": true, "writeOnly": false }, "draft_share_invite_bank_id": { "type": "integer", "description": "The id of the draft share invite bank.", "readOnly": true, "writeOnly": false }, "share_detail": { "type": "object", "description": "The share details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetail" }, "status": { "type": "string", "description": "The status of the share. Can be PENDING, REVOKED (the user deletes the share inquiry before it's accepted), ACCEPTED, CANCELLED (the user deletes an active share) or CANCELLATION_PENDING, CANCELLATION_ACCEPTED, CANCELLATION_REJECTED (for canceling mutual connects)", "readOnly": true, "writeOnly": false }, "share_type": { "type": "string", "description": "The share type, either STANDARD or MUTUAL.", "readOnly": true, "writeOnly": false }, "start_date": { "type": "string", "description": "The start date of this share.", "readOnly": true, "writeOnly": false }, "end_date": { "type": "string", "description": "The expiration date of this share.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of this share. It is basically the monetary account description.", "readOnly": true, "writeOnly": false } } }, "ShareInviteMonetaryAccountResponseRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the ShareInviteBankResponse.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the ShareInviteBankResponse creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the ShareInviteBankResponse last update.", "readOnly": true, "writeOnly": false }, "counter_alias": { "type": "object", "description": "The monetary account and user who created the share.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "user_alias_cancelled": { "type": "object", "description": "The user who cancelled the share if it has been revoked or rejected.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account the ACCEPTED share applies to. null otherwise.", "readOnly": true, "writeOnly": false }, "draft_share_invite_bank_id": { "type": "integer", "description": "The id of the draft share invite bank.", "readOnly": true, "writeOnly": false }, "share_detail": { "type": "object", "description": "The share details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/ShareDetail" }, "status": { "type": "string", "description": "The status of the share. Can be PENDING, REVOKED (the user deletes the share inquiry before it's accepted), ACCEPTED, CANCELLED (the user deletes an active share) or CANCELLATION_PENDING, CANCELLATION_ACCEPTED, CANCELLATION_REJECTED (for canceling mutual connects)", "readOnly": true, "writeOnly": false }, "share_type": { "type": "string", "description": "The share type, either STANDARD or MUTUAL.", "readOnly": true, "writeOnly": false }, "start_date": { "type": "string", "description": "The start date of this share.", "readOnly": true, "writeOnly": false }, "end_date": { "type": "string", "description": "The expiration date of this share.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of this share. It is basically the monetary account description.", "readOnly": true, "writeOnly": false } } }, "ShareInviteMonetaryAccountResponseUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "SofortMerchantTransaction": { "type": "object", "properties": { "amount_requested": { "type": "object", "description": "The requested amount of money to add.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "issuer": { "type": "string", "description": "The BIC of the issuer.", "readOnly": false, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the monetary account this sofort merchant transaction links to.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The alias of the monetary account to add money to.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The alias of the monetary account the money comes from.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "amount_guaranteed": { "type": "object", "description": "In case of a successful transaction, the amount of money that will be transferred.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "issuer_authentication_url": { "type": "string", "description": "The URL to visit to ", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the transaction.", "readOnly": true, "writeOnly": false }, "error_message": { "type": "array", "description": "The error message of the transaction.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Error" } }, "transaction_identifier": { "type": "string", "description": "The 'transaction ID' of the Sofort transaction.", "readOnly": true, "writeOnly": false } } }, "SofortMerchantTransactionListing": { "type": "object", "properties": { "monetary_account_id": { "type": "integer", "description": "The id of the monetary account this sofort merchant transaction links to.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The alias of the monetary account to add money to.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The alias of the monetary account the money comes from.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "amount_guaranteed": { "type": "object", "description": "In case of a successful transaction, the amount of money that will be transferred.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_requested": { "type": "object", "description": "The requested amount of money to add.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "issuer": { "type": "string", "description": "The BIC of the issuer.", "readOnly": true, "writeOnly": false }, "issuer_authentication_url": { "type": "string", "description": "The URL to visit to ", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the transaction.", "readOnly": true, "writeOnly": false }, "error_message": { "type": "array", "description": "The error message of the transaction.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Error" } }, "transaction_identifier": { "type": "string", "description": "The 'transaction ID' of the Sofort transaction.", "readOnly": true, "writeOnly": false } } }, "SofortMerchantTransactionRead": { "type": "object", "properties": { "monetary_account_id": { "type": "integer", "description": "The id of the monetary account this sofort merchant transaction links to.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The alias of the monetary account to add money to.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The alias of the monetary account the money comes from.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "amount_guaranteed": { "type": "object", "description": "In case of a successful transaction, the amount of money that will be transferred.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_requested": { "type": "object", "description": "The requested amount of money to add.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "issuer": { "type": "string", "description": "The BIC of the issuer.", "readOnly": true, "writeOnly": false }, "issuer_authentication_url": { "type": "string", "description": "The URL to visit to ", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the transaction.", "readOnly": true, "writeOnly": false }, "error_message": { "type": "array", "description": "The error message of the transaction.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Error" } }, "transaction_identifier": { "type": "string", "description": "The 'transaction ID' of the Sofort transaction.", "readOnly": true, "writeOnly": false } } }, "Tab": { "type": "object", "properties": { "TabUsageSingle": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TabUsageSingle" }, "TabUsageMultiple": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TabUsageMultiple" } } }, "TabAttachmentTabContentListing": { "type": "object" }, "TabAttachmentTabRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the attachment.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the attachment's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the attachment's last update.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "object", "description": "The attachment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Attachment" } } }, "TabItem": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the tab item.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The item's brief description.", "readOnly": true, "writeOnly": false }, "ean_code": { "type": "string", "description": "The item's EAN code.", "readOnly": true, "writeOnly": false }, "avatar_attachment": { "type": "object", "description": "A struct with an AttachmentPublic UUID that used as an avatar for the TabItem.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/AttachmentPublic" }, "tab_attachment": { "type": "array", "description": "A list of AttachmentTab attached to the TabItem.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentTab" } }, "quantity": { "type": "string", "description": "The quantity of the item. Formatted as a number containing up to 15 digits, up to 15 decimals and using a dot.", "readOnly": true, "writeOnly": false }, "amount": { "type": "object", "description": "The money amount of the item.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "TabItemShop": { "type": "object", "properties": { "description": { "type": "string", "description": "The TabItem's brief description.", "readOnly": false, "writeOnly": false }, "ean_code": { "type": "string", "description": "The TabItem's EAN code.", "readOnly": false, "writeOnly": false }, "avatar_attachment_uuid": { "type": "string", "description": "An AttachmentPublic UUID that used as an avatar for the TabItem.", "readOnly": false, "writeOnly": true }, "tab_attachment": { "type": "array", "description": "A list of AttachmentTab attached to the TabItem.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentTab" } }, "quantity": { "type": "integer", "description": "The quantity of the TabItem.", "readOnly": false, "writeOnly": false }, "amount": { "type": "object", "description": "The money amount of the TabItem.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "id": { "type": "integer", "description": "The id of the created TabItem.", "readOnly": true, "writeOnly": false }, "avatar_attachment": { "type": "object", "description": "A struct with an AttachmentPublic UUID that used as an avatar for the TabItem.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/AttachmentPublic" } } }, "TabItemShopBatch": { "type": "object", "properties": { "tab_items": { "type": "array", "description": "The list of tab items we want to create in a single batch. Limited to 50 items per batch.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/TabItemShop" } } }, "required": [ "tab_items" ] }, "TabItemShopBatchCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "TabItemShopCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created TabItem.", "readOnly": true, "writeOnly": false } } }, "TabItemShopDelete": { "type": "object" }, "TabItemShopListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created TabItem.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The TabItem's brief description.", "readOnly": true, "writeOnly": false }, "ean_code": { "type": "string", "description": "The TabItem's EAN code.", "readOnly": true, "writeOnly": false }, "avatar_attachment": { "type": "object", "description": "A struct with an AttachmentPublic UUID that used as an avatar for the TabItem.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/AttachmentPublic" }, "tab_attachment": { "type": "array", "description": "A list of AttachmentTab attached to the TabItem.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentTab" } }, "quantity": { "type": "integer", "description": "The quantity of the TabItem.", "readOnly": true, "writeOnly": false }, "amount": { "type": "object", "description": "The money amount of the TabItem.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "TabItemShopRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the created TabItem.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The TabItem's brief description.", "readOnly": true, "writeOnly": false }, "ean_code": { "type": "string", "description": "The TabItem's EAN code.", "readOnly": true, "writeOnly": false }, "avatar_attachment": { "type": "object", "description": "A struct with an AttachmentPublic UUID that used as an avatar for the TabItem.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/AttachmentPublic" }, "tab_attachment": { "type": "array", "description": "A list of AttachmentTab attached to the TabItem.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/AttachmentTab" } }, "quantity": { "type": "integer", "description": "The quantity of the TabItem.", "readOnly": true, "writeOnly": false }, "amount": { "type": "object", "description": "The money amount of the TabItem.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } } }, "TabItemShopUpdate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the modified TabItem.", "readOnly": true, "writeOnly": false } } }, "TabListing": { "type": "object", "properties": { "TabUsageSingle": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TabUsageSingle" }, "TabUsageMultiple": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TabUsageMultiple" } } }, "TabQrCodeContentListing": { "type": "object" }, "TabRead": { "type": "object", "properties": { "TabUsageSingle": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TabUsageSingle" }, "TabUsageMultiple": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TabUsageMultiple" } } }, "TabResultInquiry": { "type": "object", "properties": { "tab": { "type": "object", "description": "The Tab details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Tab" }, "payment": { "type": "object", "description": "The payment made for the Tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" } } }, "TabResultInquiryListing": { "type": "object", "properties": { "tab": { "type": "object", "description": "The Tab details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Tab" }, "payment": { "type": "object", "description": "The payment made for the Tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" } } }, "TabResultInquiryRead": { "type": "object", "properties": { "tab": { "type": "object", "description": "The Tab details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Tab" }, "payment": { "type": "object", "description": "The payment made for the Tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" } } }, "TabResultResponse": { "type": "object", "properties": { "tab": { "type": "object", "description": "The Tab details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Tab" }, "payment": { "type": "object", "description": "The payment made for the Tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "TabResultResponseListing": { "type": "object", "properties": { "tab": { "type": "object", "description": "The Tab details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Tab" }, "payment": { "type": "object", "description": "The payment made for the Tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "TabResultResponseRead": { "type": "object", "properties": { "tab": { "type": "object", "description": "The Tab details.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Tab" }, "payment": { "type": "object", "description": "The payment made for the Tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Payment" }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "TabTextWaitingScreen": { "type": "object", "properties": { "language": { "type": "string", "description": "Language of tab text", "readOnly": false, "writeOnly": false }, "description": { "type": "string", "description": "Tab text", "readOnly": false, "writeOnly": false } } }, "TabUsageMultiple": { "type": "object", "properties": { "description": { "type": "string", "description": "The description of the TabUsageMultiple. Maximum 9000 characters.", "readOnly": false, "writeOnly": false }, "status": { "type": "string", "description": "The status of the Tab. Can be OPEN, PAYABLE or CLOSED.", "readOnly": false, "writeOnly": false }, "amount_total": { "type": "object", "description": "The total amount of the Tab.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "allow_amount_higher": { "type": "boolean", "description": "[DEPRECATED] Whether or not a higher amount can be paid.", "readOnly": false, "writeOnly": true }, "allow_amount_lower": { "type": "boolean", "description": "[DEPRECATED] Whether or not a lower amount can be paid.", "readOnly": false, "writeOnly": true }, "want_tip": { "type": "boolean", "description": "[DEPRECATED] Whether or not the user paying the Tab should be asked if he wants to give a tip. When want_tip is set to true, allow_amount_higher must also be set to true and allow_amount_lower must be false.", "readOnly": false, "writeOnly": true }, "minimum_age": { "type": "boolean", "description": "The minimum age of the user paying the Tab.", "readOnly": false, "writeOnly": false }, "require_address": { "type": "string", "description": "Whether or not an billing and shipping address must be provided when paying the Tab.", "readOnly": false, "writeOnly": false }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to after paying the Tab.", "readOnly": false, "writeOnly": false }, "visibility": { "type": "object", "description": "The visibility of a Tab. A Tab can be visible trough NearPay, the QR code of the CashRegister and its own QR code.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/TabVisibility" }, "expiration": { "type": "string", "description": "The moment when this Tab expires.", "readOnly": false, "writeOnly": false }, "tab_attachment": { "type": "array", "description": "An array of attachments that describe the tab. Viewable through the GET \/tab\/{tabid}\/attachment\/{attachmentid}\/content endpoint.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BunqId" } }, "uuid": { "type": "string", "description": "The uuid of the created TabUsageMultiple.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the Tab's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the Tab's last update.", "readOnly": true, "writeOnly": false }, "qr_code_token": { "type": "string", "description": "The token used to redirect mobile devices directly to the bunq app. Because they can't scan a QR code.", "readOnly": true, "writeOnly": false }, "tab_url": { "type": "string", "description": "The URL redirecting user to the tab payment in the bunq app. Only works on mobile devices.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The alias of the party that owns this tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "cash_register_location": { "type": "object", "description": "The location of the cash register that created this tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "tab_item": { "type": "array", "description": "The tab items of this tab.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/TabItem" } } } }, "TabUsageMultipleCreate": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The uuid of the created TabUsageMultiple.", "readOnly": true, "writeOnly": false } } }, "TabUsageMultipleDelete": { "type": "object" }, "TabUsageMultipleListing": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The uuid of the created TabUsageMultiple.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the Tab's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the Tab's last update.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of the TabUsageMultiple. Maximum 9000 characters.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the Tab. Can be OPEN, PAYABLE or CLOSED.", "readOnly": true, "writeOnly": false }, "amount_total": { "type": "object", "description": "The total amount of the Tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "qr_code_token": { "type": "string", "description": "The token used to redirect mobile devices directly to the bunq app. Because they can't scan a QR code.", "readOnly": true, "writeOnly": false }, "tab_url": { "type": "string", "description": "The URL redirecting user to the tab payment in the bunq app. Only works on mobile devices.", "readOnly": true, "writeOnly": false }, "visibility": { "type": "object", "description": "The visibility of a Tab. A Tab can be visible trough NearPay, the QR code of the CashRegister and its own QR code.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TabVisibility" }, "minimum_age": { "type": "boolean", "description": "The minimum age of the user paying the Tab.", "readOnly": true, "writeOnly": false }, "require_address": { "type": "string", "description": "Whether or not an billing and shipping address must be provided when paying the Tab.", "readOnly": true, "writeOnly": false }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to after paying the Tab.", "readOnly": true, "writeOnly": false }, "expiration": { "type": "string", "description": "The moment when this Tab expires.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The alias of the party that owns this tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "cash_register_location": { "type": "object", "description": "The location of the cash register that created this tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "tab_item": { "type": "array", "description": "The tab items of this tab.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/TabItem" } }, "tab_attachment": { "type": "array", "description": "An array of attachments that describe the tab. Viewable through the GET \/tab\/{tabid}\/attachment\/{attachmentid}\/content endpoint.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BunqId" } } } }, "TabUsageMultipleRead": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The uuid of the created TabUsageMultiple.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the Tab's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the Tab's last update.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of the TabUsageMultiple. Maximum 9000 characters.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the Tab. Can be OPEN, PAYABLE or CLOSED.", "readOnly": true, "writeOnly": false }, "amount_total": { "type": "object", "description": "The total amount of the Tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "qr_code_token": { "type": "string", "description": "The token used to redirect mobile devices directly to the bunq app. Because they can't scan a QR code.", "readOnly": true, "writeOnly": false }, "tab_url": { "type": "string", "description": "The URL redirecting user to the tab payment in the bunq app. Only works on mobile devices.", "readOnly": true, "writeOnly": false }, "visibility": { "type": "object", "description": "The visibility of a Tab. A Tab can be visible trough NearPay, the QR code of the CashRegister and its own QR code.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TabVisibility" }, "minimum_age": { "type": "boolean", "description": "The minimum age of the user paying the Tab.", "readOnly": true, "writeOnly": false }, "require_address": { "type": "string", "description": "Whether or not an billing and shipping address must be provided when paying the Tab.", "readOnly": true, "writeOnly": false }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to after paying the Tab.", "readOnly": true, "writeOnly": false }, "expiration": { "type": "string", "description": "The moment when this Tab expires.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The alias of the party that owns this tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "cash_register_location": { "type": "object", "description": "The location of the cash register that created this tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "tab_item": { "type": "array", "description": "The tab items of this tab.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/TabItem" } }, "tab_attachment": { "type": "array", "description": "An array of attachments that describe the tab. Viewable through the GET \/tab\/{tabid}\/attachment\/{attachmentid}\/content endpoint.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BunqId" } } } }, "TabUsageMultipleUpdate": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The uuid of the modified TabUsageMultiple.", "readOnly": true, "writeOnly": false } } }, "TabUsageSingle": { "type": "object", "properties": { "merchant_reference": { "type": "string", "description": "The merchant reference of the Tab, as defined by the owner.", "readOnly": false, "writeOnly": false }, "description": { "type": "string", "description": "The description of the TabUsageMultiple. Maximum 9000 characters.", "readOnly": false, "writeOnly": false }, "status": { "type": "string", "description": "The status of the Tab. Can be OPEN, WAITING_FOR_PAYMENT, PAID or CANCELED.", "readOnly": false, "writeOnly": false }, "amount_total": { "type": "object", "description": "The total amount of the Tab.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "allow_amount_higher": { "type": "boolean", "description": "[DEPRECATED] Whether or not a higher amount can be paid.", "readOnly": false, "writeOnly": true }, "allow_amount_lower": { "type": "boolean", "description": "[DEPRECATED] Whether or not a lower amount can be paid.", "readOnly": false, "writeOnly": true }, "want_tip": { "type": "boolean", "description": "[DEPRECATED] Whether or not the user paying the Tab should be asked if he wants to give a tip. When want_tip is set to true, allow_amount_higher must also be set to true and allow_amount_lower must be false.", "readOnly": false, "writeOnly": true }, "minimum_age": { "type": "boolean", "description": "The minimum age of the user paying the Tab.", "readOnly": false, "writeOnly": false }, "require_address": { "type": "string", "description": "Whether or not an billing and shipping address must be provided when paying the Tab.", "readOnly": false, "writeOnly": false }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to after paying the Tab.", "readOnly": false, "writeOnly": false }, "visibility": { "type": "object", "description": "The visibility of a Tab. A Tab can be visible trough NearPay, the QR code of the CashRegister and its own QR code.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/TabVisibility" }, "expiration": { "type": "string", "description": "The moment when this Tab expires.", "readOnly": false, "writeOnly": false }, "tab_attachment": { "type": "array", "description": "An array of attachments that describe the tab. Uploaded through the POST \/user\/{userid}\/attachment-tab endpoint.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BunqId" } }, "uuid": { "type": "string", "description": "The uuid of the created TabUsageSingle.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the Tab's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the Tab's last update.", "readOnly": true, "writeOnly": false }, "amount_paid": { "type": "object", "description": "The amount that has been paid for this Tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "qr_code_token": { "type": "string", "description": "The token used to redirect mobile devices directly to the bunq app. Because they can't scan a QR code.", "readOnly": true, "writeOnly": false }, "tab_url": { "type": "string", "description": "The URL redirecting user to the tab payment in the bunq app. Only works on mobile devices.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The alias of the party that owns this tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "cash_register_location": { "type": "object", "description": "The location of the cash register that created this tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "tab_item": { "type": "array", "description": "The tab items of this tab.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/TabItem" } } } }, "TabUsageSingleCreate": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The uuid of the created TabUsageSingle.", "readOnly": true, "writeOnly": false } } }, "TabUsageSingleDelete": { "type": "object" }, "TabUsageSingleListing": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The uuid of the created TabUsageSingle.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the Tab's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the Tab's last update.", "readOnly": true, "writeOnly": false }, "merchant_reference": { "type": "string", "description": "The merchant reference of the Tab, as defined by the owner.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of the TabUsageMultiple. Maximum 9000 characters.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the Tab. Can be OPEN, WAITING_FOR_PAYMENT, PAID or CANCELED.", "readOnly": true, "writeOnly": false }, "amount_total": { "type": "object", "description": "The total amount of the Tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_paid": { "type": "object", "description": "The amount that has been paid for this Tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "qr_code_token": { "type": "string", "description": "The token used to redirect mobile devices directly to the bunq app. Because they can't scan a QR code.", "readOnly": true, "writeOnly": false }, "tab_url": { "type": "string", "description": "The URL redirecting user to the tab payment in the bunq app. Only works on mobile devices.", "readOnly": true, "writeOnly": false }, "visibility": { "type": "object", "description": "The visibility of a Tab. A Tab can be visible trough NearPay, the QR code of the CashRegister and its own QR code.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TabVisibility" }, "minimum_age": { "type": "boolean", "description": "The minimum age of the user paying the Tab.", "readOnly": true, "writeOnly": false }, "require_address": { "type": "string", "description": "Whether or not an billing and shipping address must be provided when paying the Tab.", "readOnly": true, "writeOnly": false }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to after paying the Tab.", "readOnly": true, "writeOnly": false }, "expiration": { "type": "string", "description": "The moment when this Tab expires.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The alias of the party that owns this tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "cash_register_location": { "type": "object", "description": "The location of the cash register that created this tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "tab_item": { "type": "array", "description": "The tab items of this tab.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/TabItem" } }, "tab_attachment": { "type": "array", "description": "An array of attachments that describe the tab. Uploaded through the POST \/user\/{userid}\/attachment-tab endpoint.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BunqId" } } } }, "TabUsageSingleRead": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The uuid of the created TabUsageSingle.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the Tab's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the Tab's last update.", "readOnly": true, "writeOnly": false }, "merchant_reference": { "type": "string", "description": "The merchant reference of the Tab, as defined by the owner.", "readOnly": true, "writeOnly": false }, "description": { "type": "string", "description": "The description of the TabUsageMultiple. Maximum 9000 characters.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the Tab. Can be OPEN, WAITING_FOR_PAYMENT, PAID or CANCELED.", "readOnly": true, "writeOnly": false }, "amount_total": { "type": "object", "description": "The total amount of the Tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_paid": { "type": "object", "description": "The amount that has been paid for this Tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "qr_code_token": { "type": "string", "description": "The token used to redirect mobile devices directly to the bunq app. Because they can't scan a QR code.", "readOnly": true, "writeOnly": false }, "tab_url": { "type": "string", "description": "The URL redirecting user to the tab payment in the bunq app. Only works on mobile devices.", "readOnly": true, "writeOnly": false }, "visibility": { "type": "object", "description": "The visibility of a Tab. A Tab can be visible trough NearPay, the QR code of the CashRegister and its own QR code.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TabVisibility" }, "minimum_age": { "type": "boolean", "description": "The minimum age of the user paying the Tab.", "readOnly": true, "writeOnly": false }, "require_address": { "type": "string", "description": "Whether or not an billing and shipping address must be provided when paying the Tab.", "readOnly": true, "writeOnly": false }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to after paying the Tab.", "readOnly": true, "writeOnly": false }, "expiration": { "type": "string", "description": "The moment when this Tab expires.", "readOnly": true, "writeOnly": false }, "alias": { "type": "object", "description": "The alias of the party that owns this tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "cash_register_location": { "type": "object", "description": "The location of the cash register that created this tab.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "tab_item": { "type": "array", "description": "The tab items of this tab.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/TabItem" } }, "tab_attachment": { "type": "array", "description": "An array of attachments that describe the tab. Uploaded through the POST \/user\/{userid}\/attachment-tab endpoint.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BunqId" } } } }, "TabUsageSingleUpdate": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The uuid of the modified TabUsageSingle.", "readOnly": true, "writeOnly": false } } }, "TabVisibility": { "type": "object", "properties": { "cash_register_qr_code": { "type": "boolean", "description": "When true the tab will be linked to the ACTIVE cash registers QR code.", "readOnly": false, "writeOnly": false }, "tab_qr_code": { "type": "boolean", "description": "When true the tab will be visible through its own QR code. Use ..\/tab\/{tab-id}\/qr-code-content to get the raw content of this QR code", "readOnly": false, "writeOnly": false }, "location": { "type": "object", "description": "The location of the Tab in NearPay.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" } } }, "TaxResident": { "type": "object", "properties": { "country": { "type": "string", "description": "The country of the tax number.", "readOnly": false, "writeOnly": false }, "tax_number": { "type": "string", "description": "The tax number.", "readOnly": false, "writeOnly": false }, "status": { "type": "string", "description": "The status of the tax number. Either CONFIRMED or UNCONFIRMED.", "readOnly": false, "writeOnly": false } } }, "TokenQrRequestIdeal": { "type": "object", "properties": { "token": { "type": "string", "description": "The token passed from a site or read from a QR code.", "readOnly": false, "writeOnly": true } }, "required": [ "token" ] }, "TokenQrRequestIdealCreate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the RequestResponse.", "readOnly": true, "writeOnly": false }, "time_responded": { "type": "string", "description": "The timestamp of when the RequestResponse was responded to.", "readOnly": true, "writeOnly": false }, "time_expiry": { "type": "string", "description": "The timestamp of when the RequestResponse expired or will expire.", "readOnly": true, "writeOnly": false }, "monetary_account_id": { "type": "integer", "description": "The id of the MonetaryAccount the RequestResponse was received on.", "readOnly": true, "writeOnly": false }, "amount_inquired": { "type": "object", "description": "The requested Amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_responded": { "type": "object", "description": "The Amount the RequestResponse was accepted with.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount this RequestResponse was received on.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount with the public information of the MonetaryAccount that is requesting money with this RequestResponse.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "description": { "type": "string", "description": "The description for the RequestResponse provided by the requesting party. Maximum 9000 characters.", "readOnly": true, "writeOnly": false }, "attachment": { "type": "array", "description": "The Attachments attached to the RequestResponse.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Attachment" } }, "status": { "type": "string", "description": "The status of the created RequestResponse. Can only be PENDING.", "readOnly": true, "writeOnly": false }, "minimum_age": { "type": "integer", "description": "The minimum age the user accepting the RequestResponse must have.", "readOnly": true, "writeOnly": false }, "require_address": { "type": "string", "description": "Whether or not an address must be provided on accept.", "readOnly": true, "writeOnly": false }, "address_shipping": { "type": "object", "description": "The shipping address provided by the accepting user if an address was requested.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_billing": { "type": "object", "description": "The billing address provided by the accepting user if an address was requested.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "geolocation": { "type": "object", "description": "The Geolocation where the RequestResponse was created.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Geolocation" }, "redirect_url": { "type": "string", "description": "The URL which the user is sent to after accepting or rejecting the Request.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the RequestResponse. Can be only be IDEAL.", "readOnly": true, "writeOnly": false }, "sub_type": { "type": "string", "description": "The subtype of the RequestResponse. Can be only be NONE.", "readOnly": true, "writeOnly": false }, "allow_chat": { "type": "boolean", "description": "Whether or not chat messages are allowed.", "readOnly": true, "writeOnly": false }, "eligible_whitelist_id": { "type": "integer", "description": "The whitelist id for this action or null.", "readOnly": true, "writeOnly": false } } }, "TokenQrRequestSofort": { "type": "object", "properties": { "token": { "type": "string", "description": "The token passed from a site or read from a QR code.", "readOnly": false, "writeOnly": true } }, "required": [ "token" ] }, "TokenQrRequestSofortCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "TransferwiseQuote": { "type": "object", "properties": { "currency_source": { "type": "string", "description": "The source currency.", "readOnly": false, "writeOnly": true }, "currency_target": { "type": "string", "description": "The target currency.", "readOnly": false, "writeOnly": true }, "amount_source": { "type": "object", "description": "The source amount.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_target": { "type": "object", "description": "The target amount.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "id": { "type": "integer", "description": "The id of the quote.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the quote's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the quote's last update.", "readOnly": true, "writeOnly": false }, "time_expiry": { "type": "string", "description": "The expiration timestamp of the quote.", "readOnly": true, "writeOnly": false }, "quote_id": { "type": "string", "description": "The quote id Transferwise needs.", "readOnly": true, "writeOnly": false }, "amount_fee": { "type": "object", "description": "The fee amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "rate": { "type": "string", "description": "The rate.", "readOnly": true, "writeOnly": false }, "time_delivery_estimate": { "type": "string", "description": "The estimated delivery time.", "readOnly": true, "writeOnly": false } }, "required": [ "currency_source", "currency_target" ] }, "TransferwiseTransfer": { "type": "object", "properties": { "monetary_account_id": { "type": "string", "description": "The id of the monetary account the payment should be made from.", "readOnly": false, "writeOnly": true }, "recipient_id": { "type": "string", "description": "The id of the target account.", "readOnly": false, "writeOnly": true }, "alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of 'this' (party) side of the Payment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of the other (counterparty) side of the Payment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "status": { "type": "string", "description": "The status.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The subStatus.", "readOnly": true, "writeOnly": false }, "status_transferwise": { "type": "string", "description": "The status as Transferwise reports it.", "readOnly": true, "writeOnly": false }, "status_transferwise_issue": { "type": "string", "description": "A status to indicatie if Transferwise has an issue with this payment and requires more information.", "readOnly": true, "writeOnly": false }, "amount_source": { "type": "object", "description": "The source amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_target": { "type": "object", "description": "The target amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "rate": { "type": "string", "description": "The rate of the payment.", "readOnly": true, "writeOnly": false }, "reference": { "type": "string", "description": "The reference of the payment.", "readOnly": true, "writeOnly": false }, "pay_in_reference": { "type": "string", "description": "The Pay-In reference of the payment.", "readOnly": true, "writeOnly": false }, "time_delivery_estimate": { "type": "string", "description": "The estimated delivery time.", "readOnly": true, "writeOnly": false }, "quote": { "type": "object", "description": "The quote details used to created the payment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TransferwiseQuote" } }, "required": [ "monetary_account_id", "recipient_id" ] }, "TransferwiseTransferRead": { "type": "object", "properties": { "alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of 'this' (party) side of the Payment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "counterparty_alias": { "type": "object", "description": "The LabelMonetaryAccount containing the public information of the other (counterparty) side of the Payment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "status": { "type": "string", "description": "The status.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The subStatus.", "readOnly": true, "writeOnly": false }, "status_transferwise": { "type": "string", "description": "The status as Transferwise reports it.", "readOnly": true, "writeOnly": false }, "status_transferwise_issue": { "type": "string", "description": "A status to indicatie if Transferwise has an issue with this payment and requires more information.", "readOnly": true, "writeOnly": false }, "amount_source": { "type": "object", "description": "The source amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "amount_target": { "type": "object", "description": "The target amount.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "rate": { "type": "string", "description": "The rate of the payment.", "readOnly": true, "writeOnly": false }, "reference": { "type": "string", "description": "The reference of the payment.", "readOnly": true, "writeOnly": false }, "pay_in_reference": { "type": "string", "description": "The Pay-In reference of the payment.", "readOnly": true, "writeOnly": false }, "time_delivery_estimate": { "type": "string", "description": "The estimated delivery time.", "readOnly": true, "writeOnly": false }, "quote": { "type": "object", "description": "The quote details used to created the payment.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/TransferwiseQuote" } } }, "Ubo": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the ultimate beneficiary owner.", "readOnly": false, "writeOnly": false }, "date_of_birth": { "type": "string", "description": "The date of birth of the ultimate beneficiary owner.", "readOnly": false, "writeOnly": false }, "nationality": { "type": "string", "description": "The nationality of the ultimate beneficiary owner.", "readOnly": false, "writeOnly": false } } }, "UserApiKey": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the user.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the user object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the user object's last update.", "readOnly": true, "writeOnly": false }, "requested_by_user": { "type": "object", "description": "The user who requested access.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserApiKeyAnchoredUser" }, "granted_by_user": { "type": "object", "description": "The user who granted access.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserApiKeyAnchoredUser" } } }, "UserApiKeyAnchoredUser": { "type": "object", "properties": { "UserPerson": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserPerson" }, "UserCompany": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserCompany" }, "UserPaymentServiceProvider": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserPaymentServiceProvider" } } }, "UserCompany": { "type": "object", "properties": { "name": { "type": "string", "description": "The company name.", "readOnly": false, "writeOnly": false }, "public_nick_name": { "type": "string", "description": "The company's public nick name.", "readOnly": false, "writeOnly": false }, "avatar_uuid": { "type": "string", "description": "The public UUID of the company's avatar.", "readOnly": false, "writeOnly": true }, "address_main": { "type": "object", "description": "The company's main address.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_postal": { "type": "object", "description": "The company's postal address.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "language": { "type": "string", "description": "The person's preferred language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.", "readOnly": false, "writeOnly": false }, "region": { "type": "string", "description": "The person's preferred region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.", "readOnly": false, "writeOnly": false }, "country": { "type": "string", "description": "The country as an ISO 3166-1 alpha-2 country code..", "readOnly": false, "writeOnly": false }, "ubo": { "type": "array", "description": "The names of the company's ultimate beneficiary owners. Minimum zero, maximum four.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Ubo" } }, "chamber_of_commerce_number": { "type": "string", "description": "The company's chamber of commerce number.", "readOnly": false, "writeOnly": false }, "legal_form": { "type": "string", "description": "The company's legal form.", "readOnly": false, "writeOnly": false }, "status": { "type": "string", "description": "The user status. Can be: ACTIVE, SIGNUP, RECOVERY.", "readOnly": false, "writeOnly": false }, "sub_status": { "type": "string", "description": "The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT.", "readOnly": false, "writeOnly": false }, "session_timeout": { "type": "integer", "description": "The setting for the session timeout of the company in seconds.", "readOnly": false, "writeOnly": false }, "daily_limit_without_confirmation_login": { "type": "object", "description": "The amount the company can pay in the session without asking for credentials.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this UserCompany.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "id": { "type": "integer", "description": "The id of the modified company.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the company object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the company object's last update.", "readOnly": true, "writeOnly": false }, "public_uuid": { "type": "string", "description": "The company's public UUID.", "readOnly": true, "writeOnly": false }, "display_name": { "type": "string", "description": "The company's display name.", "readOnly": true, "writeOnly": false }, "alias": { "type": "array", "description": "The aliases of the account.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "type_of_business_entity": { "type": "string", "description": "The type of business entity.", "readOnly": true, "writeOnly": false }, "sector_of_industry": { "type": "string", "description": "The sector of industry.", "readOnly": true, "writeOnly": false }, "counter_bank_iban": { "type": "string", "description": "The company's other bank account IBAN, through which we verify it.", "readOnly": true, "writeOnly": false }, "avatar": { "type": "object", "description": "The company's avatar.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "version_terms_of_service": { "type": "string", "description": "The version of the terms of service accepted by the user.", "readOnly": true, "writeOnly": false }, "director_alias": { "type": "object", "description": "The existing bunq user alias for the company's director.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "customer": { "type": "object", "description": "The customer profile of the company.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Customer" }, "customer_limit": { "type": "object", "description": "The customer limits of the company.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/CustomerLimit" }, "billing_contract": { "type": "array", "description": "The subscription of the company.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BillingContractSubscription" } } } }, "UserCompanyNameListing": { "type": "object", "properties": { "name_array": { "type": "array", "description": "All known (trade) names for a user company.", "readOnly": true, "writeOnly": false, "items": { "type": "string" } } } }, "UserCompanyRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the modified company.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the company object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the company object's last update.", "readOnly": true, "writeOnly": false }, "public_uuid": { "type": "string", "description": "The company's public UUID.", "readOnly": true, "writeOnly": false }, "name": { "type": "string", "description": "The company name.", "readOnly": true, "writeOnly": false }, "display_name": { "type": "string", "description": "The company's display name.", "readOnly": true, "writeOnly": false }, "public_nick_name": { "type": "string", "description": "The company's public nick name.", "readOnly": true, "writeOnly": false }, "alias": { "type": "array", "description": "The aliases of the account.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "chamber_of_commerce_number": { "type": "string", "description": "The company's chamber of commerce number.", "readOnly": true, "writeOnly": false }, "legal_form": { "type": "string", "description": "The company's legal form.", "readOnly": true, "writeOnly": false }, "type_of_business_entity": { "type": "string", "description": "The type of business entity.", "readOnly": true, "writeOnly": false }, "sector_of_industry": { "type": "string", "description": "The sector of industry.", "readOnly": true, "writeOnly": false }, "counter_bank_iban": { "type": "string", "description": "The company's other bank account IBAN, through which we verify it.", "readOnly": true, "writeOnly": false }, "avatar": { "type": "object", "description": "The company's avatar.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "address_main": { "type": "object", "description": "The company's main address.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_postal": { "type": "object", "description": "The company's postal address.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "version_terms_of_service": { "type": "string", "description": "The version of the terms of service accepted by the user.", "readOnly": true, "writeOnly": false }, "director_alias": { "type": "object", "description": "The existing bunq user alias for the company's director.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" }, "language": { "type": "string", "description": "The person's preferred language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.", "readOnly": true, "writeOnly": false }, "country": { "type": "string", "description": "The country as an ISO 3166-1 alpha-2 country code..", "readOnly": true, "writeOnly": false }, "region": { "type": "string", "description": "The person's preferred region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.", "readOnly": true, "writeOnly": false }, "ubo": { "type": "array", "description": "The names of the company's ultimate beneficiary owners. Minimum zero, maximum four.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Ubo" } }, "status": { "type": "string", "description": "The user status. Can be: ACTIVE, SIGNUP, RECOVERY.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT.", "readOnly": true, "writeOnly": false }, "session_timeout": { "type": "integer", "description": "The setting for the session timeout of the company in seconds.", "readOnly": true, "writeOnly": false }, "daily_limit_without_confirmation_login": { "type": "object", "description": "The amount the company can pay in the session without asking for credentials.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this UserCompany.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "customer": { "type": "object", "description": "The customer profile of the company.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Customer" }, "customer_limit": { "type": "object", "description": "The customer limits of the company.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/CustomerLimit" }, "billing_contract": { "type": "array", "description": "The subscription of the company.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/BillingContractSubscription" } } } }, "UserCompanyUpdate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the modified company.", "readOnly": true, "writeOnly": false } } }, "UserCredentialPasswordIpListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the credential.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the credential object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the credential object's last update.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the credential.", "readOnly": true, "writeOnly": false }, "expiry_time": { "type": "string", "description": "When the status is PENDING_FIRST_USE: when the credential expires.", "readOnly": true, "writeOnly": false }, "token_value": { "type": "string", "description": "When the status is PENDING_FIRST_USE: the value of the token.", "readOnly": true, "writeOnly": false }, "permitted_device": { "type": "object", "description": "When the status is ACTIVE: the details of the device that may use the credential.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/PermittedDevice" } } }, "UserCredentialPasswordIpRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the credential.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the credential object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the credential object's last update.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the credential.", "readOnly": true, "writeOnly": false }, "expiry_time": { "type": "string", "description": "When the status is PENDING_FIRST_USE: when the credential expires.", "readOnly": true, "writeOnly": false }, "token_value": { "type": "string", "description": "When the status is PENDING_FIRST_USE: the value of the token.", "readOnly": true, "writeOnly": false }, "permitted_device": { "type": "object", "description": "When the status is ACTIVE: the details of the device that may use the credential.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/PermittedDevice" } } }, "UserLegalNameListing": { "type": "object", "properties": { "legal_names": { "type": "array", "description": "All legal names that can be used by the user", "readOnly": true, "writeOnly": false, "items": { "type": "string" } } } }, "UserLight": { "type": "object", "properties": { "first_name": { "type": "string", "description": "The user's first name.", "readOnly": false, "writeOnly": false }, "middle_name": { "type": "string", "description": "The user's middle name.", "readOnly": false, "writeOnly": false }, "last_name": { "type": "string", "description": "The user's last name.", "readOnly": false, "writeOnly": false }, "public_nick_name": { "type": "string", "description": "The public nick name for the user.", "readOnly": false, "writeOnly": false }, "address_main": { "type": "object", "description": "The user's main address.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_postal": { "type": "object", "description": "The user's postal address.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "avatar_uuid": { "type": "string", "description": "The public UUID of the user's avatar.", "readOnly": false, "writeOnly": true }, "social_security_number": { "type": "string", "description": "The user's social security number.", "readOnly": false, "writeOnly": false }, "tax_resident": { "type": "array", "description": "The user's tax residence numbers for different countries.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/TaxResident" } }, "document_type": { "type": "string", "description": "The type of identification document the user registered with.", "readOnly": false, "writeOnly": false }, "document_number": { "type": "string", "description": "The identification document number the user registered with.", "readOnly": false, "writeOnly": false }, "document_country_of_issuance": { "type": "string", "description": "The country which issued the identification document the user registered with.", "readOnly": false, "writeOnly": false }, "document_front_attachment_id": { "type": "integer", "description": "The reference to the uploaded picture\/scan of the front side of the identification document.", "readOnly": false, "writeOnly": true }, "document_back_attachment_id": { "type": "integer", "description": "The reference to the uploaded picture\/scan of the back side of the identification document.", "readOnly": false, "writeOnly": true }, "date_of_birth": { "type": "string", "description": "The user's date of birth. Accepts ISO8601 date formats.", "readOnly": false, "writeOnly": false }, "place_of_birth": { "type": "string", "description": "The user's place of birth.", "readOnly": false, "writeOnly": false }, "country_of_birth": { "type": "string", "description": "The user's country of birth. Formatted as a SO 3166-1 alpha-2 country code.", "readOnly": false, "writeOnly": false }, "nationality": { "type": "string", "description": "The user's nationality. Formatted as a SO 3166-1 alpha-2 country code.", "readOnly": false, "writeOnly": false }, "language": { "type": "string", "description": "The user's preferred language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.", "readOnly": false, "writeOnly": false }, "region": { "type": "string", "description": "The user's preferred region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.", "readOnly": false, "writeOnly": false }, "gender": { "type": "string", "description": "The user's gender. Can be MALE, FEMALE or UNKNOWN.", "readOnly": false, "writeOnly": false }, "status": { "type": "string", "description": "The user status. The user status. Can be: ACTIVE, BLOCKED, SIGNUP, DENIED or ABORTED.", "readOnly": false, "writeOnly": false }, "sub_status": { "type": "string", "description": "The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_PARENT, AWAITING_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT.", "readOnly": false, "writeOnly": false }, "legal_guardian_alias": { "type": "object", "description": "The legal guardian of the user. Required for minors.", "readOnly": false, "writeOnly": true, "$ref": "#\/components\/schemas\/Pointer" }, "session_timeout": { "type": "integer", "description": "The setting for the session timeout of the user in seconds.", "readOnly": false, "writeOnly": false }, "daily_limit_without_confirmation_login": { "type": "object", "description": "The amount the user can pay in the session without asking for credentials.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this UserLight.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "id": { "type": "integer", "description": "The id of the user.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the user object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the user object's last update.", "readOnly": true, "writeOnly": false }, "public_uuid": { "type": "string", "description": "The user's public UUID.", "readOnly": true, "writeOnly": false }, "legal_name": { "type": "string", "description": "The user's legal name.", "readOnly": true, "writeOnly": false }, "display_name": { "type": "string", "description": "The display name for the user.", "readOnly": true, "writeOnly": false }, "alias": { "type": "array", "description": "The aliases of the user.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "avatar": { "type": "object", "description": "The user's avatar.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "version_terms_of_service": { "type": "string", "description": "The version of the terms of service accepted by the user.", "readOnly": true, "writeOnly": false } }, "required": [ "avatar_uuid" ] }, "UserListing": { "type": "object", "properties": { "UserLight": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserLight" }, "UserPerson": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserPerson" }, "UserCompany": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserCompany" }, "UserApiKey": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserApiKey" }, "UserPaymentServiceProvider": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserPaymentServiceProvider" } } }, "UserPaymentServiceProvider": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the user.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the user object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the user object's last update.", "readOnly": true, "writeOnly": false }, "certificate_distinguished_name": { "type": "string", "description": "The distinguished name from the certificate used to identify this user.", "readOnly": true, "writeOnly": false }, "alias": { "type": "array", "description": "The aliases of the user.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "avatar": { "type": "object", "description": "The user's avatar.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "status": { "type": "string", "description": "The user status. The user status. Can be: ACTIVE, BLOCKED or DENIED.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The user sub-status. Can be: NONE", "readOnly": true, "writeOnly": false }, "public_uuid": { "type": "string", "description": "The providers's public UUID.", "readOnly": true, "writeOnly": false }, "display_name": { "type": "string", "description": "The display name for the provider.", "readOnly": true, "writeOnly": false }, "public_nick_name": { "type": "string", "description": "The public nick name for the provider.", "readOnly": true, "writeOnly": false }, "language": { "type": "string", "description": "The provider's language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore.", "readOnly": true, "writeOnly": false }, "region": { "type": "string", "description": "The provider's region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore.", "readOnly": true, "writeOnly": false }, "session_timeout": { "type": "integer", "description": "The setting for the session timeout of the user in seconds.", "readOnly": true, "writeOnly": false } } }, "UserPaymentServiceProviderRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the user.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the user object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the user object's last update.", "readOnly": true, "writeOnly": false }, "certificate_distinguished_name": { "type": "string", "description": "The distinguished name from the certificate used to identify this user.", "readOnly": true, "writeOnly": false }, "alias": { "type": "array", "description": "The aliases of the user.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "avatar": { "type": "object", "description": "The user's avatar.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "status": { "type": "string", "description": "The user status. The user status. Can be: ACTIVE, BLOCKED or DENIED.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The user sub-status. Can be: NONE", "readOnly": true, "writeOnly": false }, "public_uuid": { "type": "string", "description": "The providers's public UUID.", "readOnly": true, "writeOnly": false }, "display_name": { "type": "string", "description": "The display name for the provider.", "readOnly": true, "writeOnly": false }, "public_nick_name": { "type": "string", "description": "The public nick name for the provider.", "readOnly": true, "writeOnly": false }, "language": { "type": "string", "description": "The provider's language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore.", "readOnly": true, "writeOnly": false }, "region": { "type": "string", "description": "The provider's region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore.", "readOnly": true, "writeOnly": false }, "session_timeout": { "type": "integer", "description": "The setting for the session timeout of the user in seconds.", "readOnly": true, "writeOnly": false } } }, "UserPerson": { "type": "object", "properties": { "first_name": { "type": "string", "description": "The person's first name.", "readOnly": false, "writeOnly": false }, "middle_name": { "type": "string", "description": "The person's middle name.", "readOnly": false, "writeOnly": false }, "last_name": { "type": "string", "description": "The person's last name.", "readOnly": false, "writeOnly": false }, "public_nick_name": { "type": "string", "description": "The public nick name for the person.", "readOnly": false, "writeOnly": false }, "address_main": { "type": "object", "description": "The person's main address.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_postal": { "type": "object", "description": "The person's postal address.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "avatar_uuid": { "type": "string", "description": "The public UUID of the user's avatar.", "readOnly": false, "writeOnly": true }, "tax_resident": { "type": "array", "description": "The user's tax residence numbers for different countries.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/TaxResident" } }, "document_type": { "type": "string", "description": "The type of identification document the person registered with.", "readOnly": false, "writeOnly": false }, "document_number": { "type": "string", "description": "The identification document number the person registered with.", "readOnly": false, "writeOnly": false }, "document_country_of_issuance": { "type": "string", "description": "The country which issued the identification document the person registered with.", "readOnly": false, "writeOnly": false }, "document_front_attachment_id": { "type": "integer", "description": "The reference to the uploaded picture\/scan of the front side of the identification document.", "readOnly": false, "writeOnly": true }, "document_back_attachment_id": { "type": "integer", "description": "The reference to the uploaded picture\/scan of the back side of the identification document.", "readOnly": false, "writeOnly": true }, "date_of_birth": { "type": "string", "description": "The person's date of birth. Accepts ISO8601 date formats.", "readOnly": false, "writeOnly": false }, "place_of_birth": { "type": "string", "description": "The person's place of birth.", "readOnly": false, "writeOnly": false }, "country_of_birth": { "type": "string", "description": "The person's country of birth. Formatted as a SO 3166-1 alpha-2 country code.", "readOnly": false, "writeOnly": false }, "nationality": { "type": "string", "description": "The person's nationality. Formatted as a SO 3166-1 alpha-2 country code.", "readOnly": false, "writeOnly": false }, "language": { "type": "string", "description": "The person's preferred language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.", "readOnly": false, "writeOnly": false }, "region": { "type": "string", "description": "The person's preferred region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.", "readOnly": false, "writeOnly": false }, "gender": { "type": "string", "description": "The person's gender. Can be MALE, FEMALE or UNKNOWN.", "readOnly": false, "writeOnly": false }, "status": { "type": "string", "description": "The user status. The user status. Can be: ACTIVE, BLOCKED, SIGNUP, RECOVERY, DENIED or ABORTED.", "readOnly": false, "writeOnly": false }, "sub_status": { "type": "string", "description": "The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT.", "readOnly": false, "writeOnly": false }, "legal_guardian_alias": { "type": "object", "description": "The legal guardian of the user. Required for minors.", "readOnly": false, "writeOnly": true, "$ref": "#\/components\/schemas\/Pointer" }, "session_timeout": { "type": "integer", "description": "The setting for the session timeout of the user in seconds.", "readOnly": false, "writeOnly": false }, "daily_limit_without_confirmation_login": { "type": "object", "description": "The amount the user can pay in the session without asking for credentials.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this UserPerson.", "readOnly": false, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } }, "display_name": { "type": "string", "description": "The display name for the person.", "readOnly": false, "writeOnly": false }, "id": { "type": "integer", "description": "The id of the modified person object.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the person object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the person object's last update.", "readOnly": true, "writeOnly": false }, "public_uuid": { "type": "string", "description": "The person's public UUID.", "readOnly": true, "writeOnly": false }, "legal_name": { "type": "string", "description": "The person's legal name.", "readOnly": true, "writeOnly": false }, "alias": { "type": "array", "description": "The aliases of the user.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "avatar": { "type": "object", "description": "The user's avatar.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "version_terms_of_service": { "type": "string", "description": "The version of the terms of service accepted by the user.", "readOnly": true, "writeOnly": false } }, "required": [ "avatar_uuid", "document_front_attachment_id", "legal_guardian_alias" ] }, "UserPersonRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the modified person object.", "readOnly": true, "writeOnly": false }, "created": { "type": "string", "description": "The timestamp of the person object's creation.", "readOnly": true, "writeOnly": false }, "updated": { "type": "string", "description": "The timestamp of the person object's last update.", "readOnly": true, "writeOnly": false }, "public_uuid": { "type": "string", "description": "The person's public UUID.", "readOnly": true, "writeOnly": false }, "first_name": { "type": "string", "description": "The person's first name.", "readOnly": true, "writeOnly": false }, "middle_name": { "type": "string", "description": "The person's middle name.", "readOnly": true, "writeOnly": false }, "last_name": { "type": "string", "description": "The person's last name.", "readOnly": true, "writeOnly": false }, "legal_name": { "type": "string", "description": "The person's legal name.", "readOnly": true, "writeOnly": false }, "display_name": { "type": "string", "description": "The display name for the person.", "readOnly": true, "writeOnly": false }, "public_nick_name": { "type": "string", "description": "The public nick name for the person.", "readOnly": true, "writeOnly": false }, "alias": { "type": "array", "description": "The aliases of the user.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Pointer" } }, "tax_resident": { "type": "array", "description": "The user's tax residence numbers for different countries.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/TaxResident" } }, "document_type": { "type": "string", "description": "The type of identification document the person registered with.", "readOnly": true, "writeOnly": false }, "document_number": { "type": "string", "description": "The identification document number the person registered with.", "readOnly": true, "writeOnly": false }, "document_country_of_issuance": { "type": "string", "description": "The country which issued the identification document the person registered with.", "readOnly": true, "writeOnly": false }, "address_main": { "type": "object", "description": "The person's main address.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "address_postal": { "type": "object", "description": "The person's postal address.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Address" }, "date_of_birth": { "type": "string", "description": "The person's date of birth. Accepts ISO8601 date formats.", "readOnly": true, "writeOnly": false }, "place_of_birth": { "type": "string", "description": "The person's place of birth.", "readOnly": true, "writeOnly": false }, "country_of_birth": { "type": "string", "description": "The person's country of birth. Formatted as a SO 3166-1 alpha-2 country code.", "readOnly": true, "writeOnly": false }, "nationality": { "type": "string", "description": "The person's nationality. Formatted as a SO 3166-1 alpha-2 country code.", "readOnly": true, "writeOnly": false }, "language": { "type": "string", "description": "The person's preferred language. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.", "readOnly": true, "writeOnly": false }, "region": { "type": "string", "description": "The person's preferred region. Formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, seperated by an underscore.", "readOnly": true, "writeOnly": false }, "gender": { "type": "string", "description": "The person's gender. Can be MALE, FEMALE or UNKNOWN.", "readOnly": true, "writeOnly": false }, "avatar": { "type": "object", "description": "The user's avatar.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Avatar" }, "version_terms_of_service": { "type": "string", "description": "The version of the terms of service accepted by the user.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The user status. The user status. Can be: ACTIVE, BLOCKED, SIGNUP, RECOVERY, DENIED or ABORTED.", "readOnly": true, "writeOnly": false }, "sub_status": { "type": "string", "description": "The user sub-status. Can be: NONE, FACE_RESET, APPROVAL, APPROVAL_DIRECTOR, APPROVAL_PARENT, APPROVAL_SUPPORT, COUNTER_IBAN, IDEAL or SUBMIT.", "readOnly": true, "writeOnly": false }, "session_timeout": { "type": "integer", "description": "The setting for the session timeout of the user in seconds.", "readOnly": true, "writeOnly": false }, "daily_limit_without_confirmation_login": { "type": "object", "description": "The amount the user can pay in the session without asking for credentials.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "notification_filters": { "type": "array", "description": "The types of notifications that will result in a push notification or URL callback for this UserPerson.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/NotificationFilter" } } } }, "UserPersonUpdate": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the modified person object.", "readOnly": true, "writeOnly": false } } }, "UserRead": { "type": "object", "properties": { "UserLight": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserLight" }, "UserPerson": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserPerson" }, "UserCompany": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserCompany" }, "UserApiKey": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserApiKey" }, "UserPaymentServiceProvider": { "type": "object", "description": "", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/UserPaymentServiceProvider" } } }, "Whitelist": { "type": "object" }, "WhitelistResult": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the whitelist entry.", "readOnly": true, "writeOnly": false }, "monetary_account_paying_id": { "type": "integer", "description": "The account from which payments will be deducted when a transaction is matched with this whitelist.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the WhitelistResult.", "readOnly": true, "writeOnly": false }, "error_message": { "type": "array", "description": "The message when the whitelist result has failed due to user error.", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/Error" } }, "whitelist": { "type": "object", "description": "The corresponding whitelist.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Whitelist" }, "object": { "type": "object", "description": "The details of the external object the event was created for.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/WhitelistResultViewAnchoredObject" }, "request_reference_split_the_bill": { "type": "array", "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch", "readOnly": true, "writeOnly": false, "items": { "$ref": "#\/components\/schemas\/RequestInquiryReference" } } } }, "WhitelistResultViewAnchoredObject": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the whitelist entry.", "readOnly": true, "writeOnly": false }, "requestResponse": { "type": "object", "description": "The RequestResponse object", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/RequestResponse" }, "draftPayment": { "type": "object", "description": "The DraftPayment object", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/DraftPayment" } } }, "WhitelistSdd": { "type": "object", "properties": { "monetary_account_paying_id": { "type": "integer", "description": "ID of the monetary account of which you want to pay from.", "readOnly": false, "writeOnly": false }, "request_id": { "type": "integer", "description": "ID of the request for which you want to whitelist the originating SDD.", "readOnly": false, "writeOnly": true }, "maximum_amount_per_month": { "type": "object", "description": "The maximum amount of money that is allowed to be deducted based on the whitelist.", "readOnly": false, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" } }, "required": [ "monetary_account_paying_id", "request_id", "maximum_amount_per_month" ] }, "WhitelistSddCreate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } }, "WhitelistSddDelete": { "type": "object" }, "WhitelistSddListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the whitelist entry.", "readOnly": true, "writeOnly": false }, "monetary_account_incoming_id": { "type": "integer", "description": "The account to which payments will come in before possibly being 'redirected' by the whitelist.", "readOnly": true, "writeOnly": false }, "monetary_account_paying_id": { "type": "integer", "description": "The account from which payments will be deducted when a transaction is matched with this whitelist.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the SDD whitelist, can be CORE or B2B.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the whitelist.", "readOnly": true, "writeOnly": false }, "credit_scheme_identifier": { "type": "string", "description": "The credit scheme ID provided by the counterparty.", "readOnly": true, "writeOnly": false }, "mandate_identifier": { "type": "string", "description": "The mandate ID provided by the counterparty.", "readOnly": true, "writeOnly": false }, "counterparty_alias": { "type": "object", "description": "The account to which payments will be paid.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "maximum_amount_per_month": { "type": "object", "description": "The monthly maximum amount that can be deducted from the target account.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "user_alias_created": { "type": "object", "description": "The user who created the whitelist entry.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" } } }, "WhitelistSddRead": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the whitelist entry.", "readOnly": true, "writeOnly": false }, "monetary_account_incoming_id": { "type": "integer", "description": "The account to which payments will come in before possibly being 'redirected' by the whitelist.", "readOnly": true, "writeOnly": false }, "monetary_account_paying_id": { "type": "integer", "description": "The account from which payments will be deducted when a transaction is matched with this whitelist.", "readOnly": true, "writeOnly": false }, "type": { "type": "string", "description": "The type of the SDD whitelist, can be CORE or B2B.", "readOnly": true, "writeOnly": false }, "status": { "type": "string", "description": "The status of the whitelist.", "readOnly": true, "writeOnly": false }, "credit_scheme_identifier": { "type": "string", "description": "The credit scheme ID provided by the counterparty.", "readOnly": true, "writeOnly": false }, "mandate_identifier": { "type": "string", "description": "The mandate ID provided by the counterparty.", "readOnly": true, "writeOnly": false }, "counterparty_alias": { "type": "object", "description": "The account to which payments will be paid.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelMonetaryAccount" }, "maximum_amount_per_month": { "type": "object", "description": "The monthly maximum amount that can be deducted from the target account.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/Amount" }, "user_alias_created": { "type": "object", "description": "The user who created the whitelist entry.", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/LabelUser" } } }, "WhitelistSddUpdate": { "type": "object", "properties": { "Id": { "type": "object", "description": "The id of the created item", "readOnly": true, "writeOnly": false, "$ref": "#\/components\/schemas\/BunqId" } } } }, "parameters": { "Cache-Control": { "description": "The standard HTTP Cache-Control header is required for all requests.", "schema": { "type": "string" }, "required": true, "in": "header", "name": "Cache-Control" }, "User-Agent": { "description": "The User-Agent header field should contain information about the user agent originating the request. There are no restrictions on the value of this header.", "schema": { "type": "string" }, "required": true, "in": "header", "name": "User-Agent" }, "X-Bunq-Language": { "description": "The X-Bunq-Language header must contain a preferred language indication. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore. Currently only the languages en_US and nl_NL are supported. Anything else will default to en_US.", "schema": { "type": "string" }, "required": true, "in": "header", "name": "X-Bunq-Language" }, "X-Bunq-Region": { "description": "The X-Bunq-Region header must contain the region (country) of the client device. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore.", "schema": { "type": "string" }, "required": true, "in": "header", "name": "X-Bunq-Region" }, "X-Bunq-Client-Request-Id": { "description": "This header must specify an ID with each request that is unique for the logged in user. There are no restrictions for the format of this ID. However, the server will respond with an error when the same ID is used again on the same DeviceServer.", "schema": { "type": "string" }, "required": true, "in": "header", "name": "X-Bunq-Client-Request-Id" }, "X-Bunq-Geolocation": { "description": "This header must specify the geolocation of the device. The format of this value is longitude latitude altitude radius country. The country is expected to be formatted of an ISO 3166-1 alpha-2 country code. When no geolocation is available or known the header must still be included but can be zero valued.", "schema": { "type": "string" }, "required": true, "in": "header", "name": "X-Bunq-Geolocation" }, "X-Bunq-Client-Signature": { "description": "The signature header is included for all API calls except for POST \/v1\/installation. See the signing page for details on how to create this signature.", "schema": { "type": "string" }, "required": true, "in": "header", "name": "X-Bunq-Client-Signature" }, "X-Bunq-Client-Authentication": { "description": "The authentication token is used to authenticate the source of the API call. It is required by all API calls except for POST \/v1\/installation. It is important to note that the device and session calls are using the token from the response of the installation call, while all the other calls use the token from the response of the session-server call", "schema": { "type": "string" }, "required": true, "in": "header", "name": "X-Bunq-Client-Authentication" }, "X-Bunq-Attachment-Description": { "description": "This header should be used when uploading an Attachment's content to give it a description.", "schema": { "type": "string" }, "in": "header", "name": "X-Bunq-Attachment-Description" } }, "responses": { "GenericError": { "description": "This is how the error response looks like for 4XX response codes", "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } }, "content": { "application\/json": { "schema": { "type": "object", "properties": { "Error": { "$ref": "#\/components\/schemas\/Error" } } } } } } }, "headers": { "X-Bunq-Client-Request-Id": { "description": "This header must specify an ID with each request that is unique for the logged in user. There are no restrictions for the format of this ID. However, the server will respond with an error when the same ID is used again on the same DeviceServer.", "schema": { "type": "string" }, "required": true }, "X-Bunq-Client-Response-Id": { "description": "A unique ID for the response formatted as a UUID. Clients can use it to add extra protection against replay attacks.", "schema": { "type": "string" } }, "X-Bunq-Server-Signature": { "description": "The server's signature for this response. See the signing page for details on how to verify this signature.", "schema": { "type": "string" } } } }, "paths": { "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/share-invite-bank-inquiry\/{share-invite-bank-inquiryID}\/amount-used\/{itemId}": { "delete": { "tags": [ "amount-used" ], "summary": "", "operationId": "Delete_AmountUsed_for_User_MonetaryAccount_ShareInviteBankInquiry", "description": "[DEPRECATED - use \/share-invite-monetary-account-inquiry\/ID\/amount-used] Reset the available budget for a bank account share. To be called without any ID at the end of the path.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "share-invite-bank-inquiryID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "[DEPRECATED - use \/share-invite-monetary-account-inquiry\/ID\/amount-used] When you have connected your monetary account bank to a user, and given this user a (for example) daily budget of 10 EUR. If this users has used his entire budget or part of it, this call can be used to reset the amount he used to 0. The user can then spend the daily budget of 10 EUR again.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteBankAmountUsedDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/share-invite-monetary-account-inquiry\/{share-invite-monetary-account-inquiryID}\/amount-used\/{itemId}": { "delete": { "tags": [ "amount-used" ], "summary": "", "operationId": "Delete_AmountUsed_for_User_MonetaryAccount_ShareInviteMonetaryAccountInquiry", "description": "Reset the available budget for an account share. To be called without any ID at the end of the path.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "share-invite-monetary-account-inquiryID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "When you have connected your monetary account to a user, and given this user a (for example) daily budget of 10 EUR. If this users has used his entire budget or part of it, this call can be used to reset the amount he used to 0. The user can then spend the daily budget of 10 EUR again.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteMonetaryAccountAmountUsedDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/tab\/{tabUUID}\/attachment\/{itemId}": { "get": { "tags": [ "attachment" ], "summary": "", "operationId": "Read_Attachment_for_Tab", "description": "Get a specific attachment. The header of the response contains the content-type of the attachment.", "parameters": [ { "in": "path", "name": "tabUUID", "description": "", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "This call is used to view an attachment that is linked to a tab.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabAttachmentTabRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/attachment": { "post": { "tags": [ "attachment" ], "summary": "", "operationId": "Create_Attachment_for_User_MonetaryAccount", "description": "Create a new monetary account attachment. Create a POST request with a payload that contains the binary representation of the file, without any JSON wrapping. Make sure you define the MIME type (i.e. image\/jpeg) in the Content-Type header. You are required to provide a description of the attachment using the X-Bunq-Attachment-Description header.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccount" } } } }, "responses": { "200": { "description": "This call is used to upload an attachment that can be referenced to in payment requests and payments sent from a specific monetary account. Attachments supported are png, jpg and gif.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/attachment\/{itemId}": { "get": { "tags": [ "attachment" ], "summary": "", "operationId": "Read_Attachment_for_User", "description": "Get a specific attachment. The header of the response contains the content-type of the attachment.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "This call is used to upload an attachment that is accessible only by a specific user. This can be used for example to upload passport scans or other documents. Attachments supported are png, jpg and gif.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttachmentUserRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/attachment-public\/{itemId}": { "get": { "tags": [ "attachment-public" ], "summary": "", "operationId": "Read_AttachmentPublic", "description": "Get a specific attachment's metadata through its UUID. The Content-Type header of the response will describe the MIME type of the attachment file.", "parameters": [ { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "This call is used to upload an attachment that can be referenced to as an avatar (through the Avatar endpoint) or in a tab sent. Attachments supported are png, jpg and gif.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttachmentPublicRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/attachment-public": { "post": { "tags": [ "attachment-public" ], "summary": "", "operationId": "Create_AttachmentPublic", "description": "Create 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 you define the MIME type (i.e. image\/jpeg, or image\/png) in the Content-Type header. You are required to provide a description of the attachment using the X-Bunq-Attachment-Description header.", "parameters": [ { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttachmentPublic" } } } }, "responses": { "200": { "description": "This call is used to upload an attachment that can be referenced to as an avatar (through the Avatar endpoint) or in a tab sent. Attachments supported are png, jpg and gif.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttachmentPublicCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/attachment-tab\/{itemId}": { "get": { "tags": [ "attachment-tab" ], "summary": "", "operationId": "Read_AttachmentTab_for_User_MonetaryAccount", "description": "Get a specific attachment. The header of the response contains the content-type of the attachment.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "This call is used to upload an attachment that will be accessible only through tabs. This can be used for example to upload special promotions or other attachments. Attachments supported are png, jpg and gif.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttachmentTabRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/attachment-tab": { "post": { "tags": [ "attachment-tab" ], "summary": "", "operationId": "Create_AttachmentTab_for_User_MonetaryAccount", "description": "Upload a new attachment to use with a tab, and to read its metadata. Create a POST request with a payload that contains the binary representation of the file, without any JSON wrapping. Make sure you define the MIME type (i.e. image\/jpeg) in the Content-Type header. You are required to provide a description of the attachment using the X-Bunq-Attachment-Description header.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttachmentTab" } } } }, "responses": { "200": { "description": "This call is used to upload an attachment that will be accessible only through tabs. This can be used for example to upload special promotions or other attachments. Attachments supported are png, jpg and gif.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttachmentTabCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/avatar\/{itemId}": { "get": { "tags": [ "avatar" ], "summary": "", "operationId": "Read_Avatar", "description": "Avatars are public images used to represent you or your company. Avatars are used to represent users, monetary accounts and cash registers. Avatars cannot be deleted, only replaced. Avatars can be updated after uploading the image you would like to use through AttachmentPublic. Using the attachment_public_uuid which is returned you can update your Avatar. Avatars used for cash registers and company accounts will be reviewed by bunq.", "parameters": [ { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Avatars are public images used to represent you or your company. Avatars are used to represent users, monetary accounts and cash registers. Avatars cannot be deleted, only replaced. Avatars can be updated after uploading the image you would like to use through AttachmentPublic. Using the attachment_public_uuid which is returned you can update your Avatar. Avatars used for cash registers and company accounts will be reviewed by bunq.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AvatarRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/avatar": { "post": { "tags": [ "avatar" ], "summary": "", "operationId": "Create_Avatar", "description": "Avatars are public images used to represent you or your company. Avatars are used to represent users, monetary accounts and cash registers. Avatars cannot be deleted, only replaced. Avatars can be updated after uploading the image you would like to use through AttachmentPublic. Using the attachment_public_uuid which is returned you can update your Avatar. Avatars used for cash registers and company accounts will be reviewed by bunq.", "parameters": [ { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Avatar" } } } }, "responses": { "200": { "description": "Avatars are public images used to represent you or your company. Avatars are used to represent users, monetary accounts and cash registers. Avatars cannot be deleted, only replaced. Avatars can be updated after uploading the image you would like to use through AttachmentPublic. Using the attachment_public_uuid which is returned you can update your Avatar. Avatars used for cash registers and company accounts will be reviewed by bunq.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AvatarCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/billing-contract-subscription": { "get": { "tags": [ "billing-contract-subscription" ], "summary": "", "operationId": "List_all_BillingContractSubscription_for_User", "description": "Get all subscription billing contract for the authenticated user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Show the subscription billing contract for the authenticated user.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BillingContractSubscriptionListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/bunqme-fundraiser-profile": { "get": { "tags": [ "bunqme-fundraiser-profile" ], "summary": "", "operationId": "List_all_BunqmeFundraiserProfile_for_User", "description": "bunq.me public profile of the user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "bunq.me public profile of the user.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BunqMeFundraiserProfileUserListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/bunqme-fundraiser-profile\/{itemId}": { "get": { "tags": [ "bunqme-fundraiser-profile" ], "summary": "", "operationId": "Read_BunqmeFundraiserProfile_for_User", "description": "bunq.me public profile of the user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "bunq.me public profile of the user.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BunqMeFundraiserProfileUserRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/bunqme-fundraiser-result\/{itemId}": { "get": { "tags": [ "bunqme-fundraiser-result" ], "summary": "", "operationId": "Read_BunqmeFundraiserResult_for_User_MonetaryAccount", "description": "bunq.me fundraiser result containing all payments.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "bunq.me fundraiser result containing all payments.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BunqMeFundraiserResultRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/bunqme-tab": { "post": { "tags": [ "bunqme-tab" ], "summary": "", "operationId": "Create_BunqmeTab_for_User_MonetaryAccount", "description": "bunq.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 and pay through bunq, iDeal or SOFORT.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BunqMeTab" } } } }, "responses": { "200": { "description": "bunq.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 and pay through bunq, iDeal or SOFORT.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BunqMeTabCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "bunqme-tab" ], "summary": "", "operationId": "List_all_BunqmeTab_for_User_MonetaryAccount", "description": "bunq.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 and pay through bunq, iDeal or SOFORT.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "bunq.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 and pay through bunq, iDeal or SOFORT.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BunqMeTabListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/bunqme-tab\/{itemId}": { "put": { "tags": [ "bunqme-tab" ], "summary": "", "operationId": "Update_BunqmeTab_for_User_MonetaryAccount", "description": "bunq.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 and pay through bunq, iDeal or SOFORT.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BunqMeTab" } } } }, "responses": { "200": { "description": "bunq.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 and pay through bunq, iDeal or SOFORT.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BunqMeTabUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "bunqme-tab" ], "summary": "", "operationId": "Read_BunqmeTab_for_User_MonetaryAccount", "description": "bunq.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 and pay through bunq, iDeal or SOFORT.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "bunq.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 and pay through bunq, iDeal or SOFORT.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BunqMeTabRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/bunqme-tab-result-response\/{itemId}": { "get": { "tags": [ "bunqme-tab-result-response" ], "summary": "", "operationId": "Read_BunqmeTabResultResponse_for_User_MonetaryAccount", "description": "Used 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 provided monetary account.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used 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 provided monetary account.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BunqMeTabResultResponseRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/oauth-client\/{oauth-clientID}\/callback-url": { "post": { "tags": [ "callback-url" ], "summary": "", "operationId": "Create_CallbackUrl_for_User_OauthClient", "description": "Used for managing OAuth Client Callback URLs.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "oauth-clientID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthCallbackUrl" } } } }, "responses": { "200": { "description": "Used for managing OAuth Client Callback URLs.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthCallbackUrlCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "callback-url" ], "summary": "", "operationId": "List_all_CallbackUrl_for_User_OauthClient", "description": "Used for managing OAuth Client Callback URLs.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "oauth-clientID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used for managing OAuth Client Callback URLs.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OauthCallbackUrlListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/oauth-client\/{oauth-clientID}\/callback-url\/{itemId}": { "get": { "tags": [ "callback-url" ], "summary": "", "operationId": "Read_CallbackUrl_for_User_OauthClient", "description": "Used for managing OAuth Client Callback URLs.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "oauth-clientID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used for managing OAuth Client Callback URLs.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthCallbackUrlRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "callback-url" ], "summary": "", "operationId": "Update_CallbackUrl_for_User_OauthClient", "description": "Used for managing OAuth Client Callback URLs.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "oauth-clientID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthCallbackUrl" } } } }, "responses": { "200": { "description": "Used for managing OAuth Client Callback URLs.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthCallbackUrlUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "callback-url" ], "summary": "", "operationId": "Delete_CallbackUrl_for_User_OauthClient", "description": "Used for managing OAuth Client Callback URLs.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "oauth-clientID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used for managing OAuth Client Callback URLs.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthCallbackUrlDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/card": { "get": { "tags": [ "card" ], "summary": "", "operationId": "List_all_Card_for_User", "description": "Return all the cards available to the user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Endpoint for retrieving details for the cards the user has access to.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CardListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/card\/{itemId}": { "put": { "tags": [ "card" ], "summary": "", "operationId": "Update_Card_for_User", "description": "Update 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 received, it can be also activated through this endpoint.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Card" } } } }, "responses": { "200": { "description": "Endpoint for retrieving details for the cards the user has access to.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CardUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "card" ], "summary": "", "operationId": "Read_Card_for_User", "description": "Return the details of a specific card.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Endpoint for retrieving details for the cards the user has access to.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CardRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/card-batch": { "post": { "tags": [ "card-batch" ], "summary": "", "operationId": "Create_CardBatch_for_User", "description": "Used to update multiple cards in a batch.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CardBatch" } } } }, "responses": { "200": { "description": "Used to update multiple cards in a batch.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CardBatchCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/card-debit": { "post": { "tags": [ "card-debit" ], "summary": "", "operationId": "Create_CardDebit_for_User", "description": "Create a new debit card request.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CardDebit" } } } }, "responses": { "200": { "description": "With bunq it is possible to order debit cards that can then be connected with each one of the monetary accounts the user has access to (including connected accounts).", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CardDebitCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/card-name": { "get": { "tags": [ "card-name" ], "summary": "", "operationId": "List_all_CardName_for_User", "description": "Return all the accepted card names for a specific user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Endpoint for getting all the accepted card names for a user. As bunq do not allow total freedom in choosing the name that is going to be printed on the card, the following formats are accepted: Name Surname, N. Surname, N Surname or Surname.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CardNameListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{itemId}": { "get": { "tags": [ "cash-register" ], "summary": "", "operationId": "Read_CashRegister_for_User_MonetaryAccount", "description": "Get a specific CashRegister.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "CashRegisters are virtual points of sale. They have a specific name and avatar, and optionally, a location.With a CashRegister you can create a Tab and then use a QR code to receive payments.Check out our Quickstart example to learn how you can easily create Tab payments<\/a>.Notification filters can be set on a CashRegister to receive callbacks. For more information check the dedicated callbacks page<\/a>.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CashRegisterRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "cash-register" ], "summary": "", "operationId": "Update_CashRegister_for_User_MonetaryAccount", "description": "Modify or close an existing CashRegister. You must set the status back to PENDING_APPROVAL if you modify the name, avatar or location of a CashRegister. To close a cash register put its status to CLOSED.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CashRegister" } } } }, "responses": { "200": { "description": "CashRegisters are virtual points of sale. They have a specific name and avatar, and optionally, a location.With a CashRegister you can create a Tab and then use a QR code to receive payments.Check out our Quickstart example to learn how you can easily create Tab payments<\/a>.Notification filters can be set on a CashRegister to receive callbacks. For more information check the dedicated callbacks page<\/a>.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CashRegisterUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register": { "post": { "tags": [ "cash-register" ], "summary": "", "operationId": "Create_CashRegister_for_User_MonetaryAccount", "description": "Create a new CashRegister. Only an UserCompany can create a CashRegisters. They need to be created with status PENDING_APPROVAL, an bunq admin has to approve your CashRegister before you can use it. In the sandbox testing environment an CashRegister will be automatically approved immediately after creation.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CashRegister" } } } }, "responses": { "200": { "description": "CashRegisters are virtual points of sale. They have a specific name and avatar, and optionally, a location.With a CashRegister you can create a Tab and then use a QR code to receive payments.Check out our Quickstart example to learn how you can easily create Tab payments<\/a>.Notification filters can be set on a CashRegister to receive callbacks. For more information check the dedicated callbacks page<\/a>.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CashRegisterCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "cash-register" ], "summary": "", "operationId": "List_all_CashRegister_for_User_MonetaryAccount", "description": "Get a collection of CashRegister for a given user and monetary account.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "CashRegisters are virtual points of sale. They have a specific name and avatar, and optionally, a location.With a CashRegister you can create a Tab and then use a QR code to receive payments.Check out our Quickstart example to learn how you can easily create Tab payments<\/a>.Notification filters can be set on a CashRegister to receive callbacks. For more information check the dedicated callbacks page<\/a>.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CashRegisterListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/certificate-pinned": { "post": { "tags": [ "certificate-pinned" ], "summary": "", "operationId": "Create_CertificatePinned_for_User", "description": "Pin the certificate chain.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CertificatePinned" } } } }, "responses": { "200": { "description": "This endpoint allow you to pin the certificate chains to your account. These certificate chains are used for SSL validation whenever a callback is initiated to one of your https callback urls.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CertificatePinnedCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "certificate-pinned" ], "summary": "", "operationId": "List_all_CertificatePinned_for_User", "description": "List all the pinned certificate chain for the given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "This endpoint allow you to pin the certificate chains to your account. These certificate chains are used for SSL validation whenever a callback is initiated to one of your https callback urls.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CertificatePinnedListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/certificate-pinned\/{itemId}": { "delete": { "tags": [ "certificate-pinned" ], "summary": "", "operationId": "Delete_CertificatePinned_for_User", "description": "Remove the pinned certificate chain with the specific ID.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "This endpoint allow you to pin the certificate chains to your account. These certificate chains are used for SSL validation whenever a callback is initiated to one of your https callback urls.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CertificatePinnedDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "certificate-pinned" ], "summary": "", "operationId": "Read_CertificatePinned_for_User", "description": "Get the pinned certificate chain with the specified ID.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "This endpoint allow you to pin the certificate chains to your account. These certificate chains are used for SSL validation whenever a callback is initiated to one of your https callback urls.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CertificatePinnedRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/confirmation-of-funds": { "post": { "tags": [ "confirmation-of-funds" ], "summary": "", "operationId": "Create_ConfirmationOfFunds_for_User", "description": "Used to confirm availability of funds on an account.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ConfirmationOfFunds" } } } }, "responses": { "200": { "description": "Used to confirm availability of funds on an account.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ConfirmationOfFundsCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/export-rib\/{export-ribID}\/content": { "get": { "tags": [ "content" ], "summary": "", "operationId": "List_all_Content_for_User_MonetaryAccount_ExportRib", "description": "Used to retrieve the raw content of an RIB.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "export-ribID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Fetch the raw content of an RIB. The RIB is always in PDF format.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ExportRibContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/customer-statement\/{customer-statementID}\/content": { "get": { "tags": [ "content" ], "summary": "", "operationId": "List_all_Content_for_User_MonetaryAccount_CustomerStatement", "description": "Fetch 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 statement creation. The doc won't display the response of a request to get the content of a statement export.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "customer-statementID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Fetch 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 statement creation. The doc won't display the response of a request to get the content of a statement export.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CustomerStatementExportContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/chat-conversation\/{chat-conversationID}\/attachment\/{attachmentID}\/content": { "get": { "tags": [ "content" ], "summary": "", "operationId": "List_all_Content_for_User_ChatConversation_Attachment", "description": "Get the raw content of a specific attachment.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "chat-conversationID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "attachmentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Fetch the raw content of an attachment with given ID. The raw content is the base64 of a file, without any JSON wrapping.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AttachmentConversationContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/attachment\/{attachmentID}\/content": { "get": { "tags": [ "content" ], "summary": "", "operationId": "List_all_Content_for_User_MonetaryAccount_Attachment", "description": "Get the raw content of a specific attachment.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "attachmentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Fetch the raw content of a monetary account attachment with given ID. The raw content is the binary representation of a file, without any JSON wrapping.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AttachmentMonetaryAccountContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/export-annual-overview\/{export-annual-overviewID}\/content": { "get": { "tags": [ "content" ], "summary": "", "operationId": "List_all_Content_for_User_ExportAnnualOverview", "description": "Used to retrieve the raw content of an annual overview.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "export-annual-overviewID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Fetch the raw content of an annual overview. The annual overview is always in PDF format. Doc won't display the response of a request to get the content of an annual overview.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ExportAnnualOverviewContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/attachment\/{attachmentID}\/content": { "get": { "tags": [ "content" ], "summary": "", "operationId": "List_all_Content_for_User_Attachment", "description": "Get the raw content of a specific attachment.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "attachmentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Fetch the raw content of a user attachment with given ID. The raw content is the binary representation of a file, without any JSON wrapping.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AttachmentUserContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/attachment-public\/{attachment-publicUUID}\/content": { "get": { "tags": [ "content" ], "summary": "", "operationId": "List_all_Content_for_AttachmentPublic", "description": "Get the raw content of a specific attachment.", "parameters": [ { "in": "path", "name": "attachment-publicUUID", "description": "", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Fetch the raw content of a public attachment with given ID. The raw content is the binary representation of a file, without any JSON wrapping.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AttachmentPublicContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/attachment-tab\/{attachment-tabID}\/content": { "get": { "tags": [ "content" ], "summary": "", "operationId": "List_all_Content_for_User_MonetaryAccount_AttachmentTab", "description": "Get the raw content of a specific attachment.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "attachment-tabID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Fetch the raw content of a tab attachment with given ID. The raw content is the binary representation of a file, without any JSON wrapping.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AttachmentTabContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/event\/{eventID}\/statement\/{statementID}\/content": { "get": { "tags": [ "content" ], "summary": "", "operationId": "List_all_Content_for_User_MonetaryAccount_Event_Statement", "description": "Fetch the raw content of a payment statement export.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "eventID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "statementID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Fetch the raw content of a payment statement export.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ExportStatementPaymentContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/qr-code\/{qr-codeID}\/content": { "get": { "tags": [ "content" ], "summary": "", "operationId": "List_all_Content_for_User_MonetaryAccount_CashRegister_QrCode", "description": "Show the raw contents of a QR code", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "qr-codeID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Show the raw contents of a QR code. First you need to created a QR code using ..\/cash-register\/{id}\/qr-code.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CashRegisterQrCodeContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/tab\/{tabUUID}\/attachment\/{attachmentID}\/content": { "get": { "tags": [ "content" ], "summary": "", "operationId": "List_all_Content_for_Tab_Attachment", "description": "Get the raw content of a specific attachment.", "parameters": [ { "in": "path", "name": "tabUUID", "description": "", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "attachmentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Fetch the raw content of a tab attachment with given ID. The raw content is the binary representation of a file, without any JSON wrapping.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TabAttachmentTabContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/credential-password-ip\/{itemId}": { "get": { "tags": [ "credential-password-ip" ], "summary": "", "operationId": "Read_CredentialPasswordIp_for_User", "description": "Create a credential of a user for server authentication, or delete the credential of a user for server authentication.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Create a credential of a user for server authentication, or delete the credential of a user for server authentication.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserCredentialPasswordIpRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/credential-password-ip": { "get": { "tags": [ "credential-password-ip" ], "summary": "", "operationId": "List_all_CredentialPasswordIp_for_User", "description": "Create a credential of a user for server authentication, or delete the credential of a user for server authentication.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Create a credential of a user for server authentication, or delete the credential of a user for server authentication.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UserCredentialPasswordIpListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/customer-statement": { "post": { "tags": [ "customer-statement" ], "summary": "", "operationId": "Create_CustomerStatement_for_User_MonetaryAccount", "description": "Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerStatementExport" } } } }, "responses": { "200": { "description": "Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerStatementExportCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "customer-statement" ], "summary": "", "operationId": "List_all_CustomerStatement_for_User_MonetaryAccount", "description": "Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CustomerStatementExportListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/customer-statement\/{itemId}": { "get": { "tags": [ "customer-statement" ], "summary": "", "operationId": "Read_CustomerStatement_for_User_MonetaryAccount", "description": "Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerStatementExportRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "customer-statement" ], "summary": "", "operationId": "Delete_CustomerStatement_for_User_MonetaryAccount", "description": "Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to create new and read existing statement exports. Statement exports can be created in either CSV, MT940 or PDF file format.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerStatementExportDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/device": { "get": { "tags": [ "device" ], "summary": "", "operationId": "List_all_Device", "description": "Get a collection of Devices. A Device is either a DevicePhone or a DeviceServer.", "parameters": [ { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to get a Device or a listing of Devices. Creating a DeviceServer should happen via \/device-server", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DeviceListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/device\/{itemId}": { "get": { "tags": [ "device" ], "summary": "", "operationId": "Read_Device", "description": "Get a single Device. A Device is either a DevicePhone or a DeviceServer.", "parameters": [ { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to get a Device or a listing of Devices. Creating a DeviceServer should happen via \/device-server", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeviceRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/device-server": { "post": { "tags": [ "device-server" ], "summary": "", "operationId": "Create_DeviceServer", "description": "Create 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 installation. The API Key that you are using will be bound to the IP address of the DeviceServer which you have created.Using a Wildcard API Key gives you the freedom to make API calls even if the IP address has changed after the POST device-server.Find out more at this link https:\/bunq.com\/en\/apikey-dynamic-ip<\/a>.", "parameters": [ { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeviceServer" } } } }, "responses": { "200": { "description": "After having created an Installation you can now create a DeviceServer. A DeviceServer is needed to do a login call with session-server.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeviceServerCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "device-server" ], "summary": "", "operationId": "List_all_DeviceServer", "description": "Get a collection of all the DeviceServers you have created.", "parameters": [ { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "After having created an Installation you can now create a DeviceServer. A DeviceServer is needed to do a login call with session-server.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DeviceServerListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/device-server\/{itemId}": { "get": { "tags": [ "device-server" ], "summary": "", "operationId": "Read_DeviceServer", "description": "Get one of your DeviceServers.", "parameters": [ { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "After having created an Installation you can now create a DeviceServer. A DeviceServer is needed to do a login call with session-server.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DeviceServerRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/draft-payment": { "post": { "tags": [ "draft-payment" ], "summary": "", "operationId": "Create_DraftPayment_for_User_MonetaryAccount", "description": "Create a new DraftPayment.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftPayment" } } } }, "responses": { "200": { "description": "A DraftPayment is like a regular Payment, but it needs to be accepted by the sending party before the actual Payment is done.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftPaymentCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "draft-payment" ], "summary": "", "operationId": "List_all_DraftPayment_for_User_MonetaryAccount", "description": "Get a listing of all DraftPayments from a given MonetaryAccount.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "A DraftPayment is like a regular Payment, but it needs to be accepted by the sending party before the actual Payment is done.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DraftPaymentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/draft-payment\/{itemId}": { "put": { "tags": [ "draft-payment" ], "summary": "", "operationId": "Update_DraftPayment_for_User_MonetaryAccount", "description": "Update a DraftPayment.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftPayment" } } } }, "responses": { "200": { "description": "A DraftPayment is like a regular Payment, but it needs to be accepted by the sending party before the actual Payment is done.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftPaymentUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "draft-payment" ], "summary": "", "operationId": "Read_DraftPayment_for_User_MonetaryAccount", "description": "Get a specific DraftPayment.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "A DraftPayment is like a regular Payment, but it needs to be accepted by the sending party before the actual Payment is done.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftPaymentRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/draft-share-invite-api-key\/{itemId}": { "get": { "tags": [ "draft-share-invite-api-key" ], "summary": "", "operationId": "Read_DraftShareInviteApiKey_for_User", "description": "Get the details of a specific draft of a share invite.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to create a draft share invite for a user with another bunq user. The user that accepts the invite can share his MAs with the user that created the invite.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftShareInviteApiKeyRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "draft-share-invite-api-key" ], "summary": "", "operationId": "Update_DraftShareInviteApiKey_for_User", "description": "Update a draft share invite. When sending status CANCELLED it is possible to cancel the draft share invite.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftShareInviteApiKey" } } } }, "responses": { "200": { "description": "Used to create a draft share invite for a user with another bunq user. The user that accepts the invite can share his MAs with the user that created the invite.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftShareInviteApiKeyUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/draft-share-invite-api-key": { "post": { "tags": [ "draft-share-invite-api-key" ], "summary": "", "operationId": "Create_DraftShareInviteApiKey_for_User", "description": "Used to create a draft share invite for a user with another bunq user. The user that accepts the invite can share his MAs with the user that created the invite.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftShareInviteApiKey" } } } }, "responses": { "200": { "description": "Used to create a draft share invite for a user with another bunq user. The user that accepts the invite can share his MAs with the user that created the invite.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftShareInviteApiKeyCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "draft-share-invite-api-key" ], "summary": "", "operationId": "List_all_DraftShareInviteApiKey_for_User", "description": "Used to create a draft share invite for a user with another bunq user. The user that accepts the invite can share his MAs with the user that created the invite.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to create a draft share invite for a user with another bunq user. The user that accepts the invite can share his MAs with the user that created the invite.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DraftShareInviteApiKeyListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/draft-share-invite-bank": { "post": { "tags": [ "draft-share-invite-bank" ], "summary": "", "operationId": "Create_DraftShareInviteBank_for_User", "description": "Used to create a draft share invite for a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. The user that accepts the invite can share one of their MonetaryAccounts with the user that created the invite.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftShareInviteBank" } } } }, "responses": { "200": { "description": "Used to create a draft share invite for a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. The user that accepts the invite can share one of their MonetaryAccounts with the user that created the invite.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftShareInviteBankCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "draft-share-invite-bank" ], "summary": "", "operationId": "List_all_DraftShareInviteBank_for_User", "description": "Used to create a draft share invite for a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. The user that accepts the invite can share one of their MonetaryAccounts with the user that created the invite.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to create a draft share invite for a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. The user that accepts the invite can share one of their MonetaryAccounts with the user that created the invite.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DraftShareInviteBankListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/draft-share-invite-bank\/{itemId}": { "get": { "tags": [ "draft-share-invite-bank" ], "summary": "", "operationId": "Read_DraftShareInviteBank_for_User", "description": "Get the details of a specific draft of a share invite.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to create a draft share invite for a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. The user that accepts the invite can share one of their MonetaryAccounts with the user that created the invite.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftShareInviteBankRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "draft-share-invite-bank" ], "summary": "", "operationId": "Update_DraftShareInviteBank_for_User", "description": "Update a draft share invite. When sending status CANCELLED it is possible to cancel the draft share invite.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftShareInviteBank" } } } }, "responses": { "200": { "description": "Used to create a draft share invite for a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. The user that accepts the invite can share one of their MonetaryAccounts with the user that created the invite.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DraftShareInviteBankUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/event\/{itemId}": { "get": { "tags": [ "event" ], "summary": "", "operationId": "Read_Event_for_User", "description": "Get a specific event for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view events. Events are automatically created and contain information about everything that happens to your bunq account. In the bunq app events are shown in your 'overview'. Examples of when events are created or modified: payment sent, payment received, request for payment received or connect invite received.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/event": { "get": { "tags": [ "event" ], "summary": "", "operationId": "List_all_Event_for_User", "description": "Get 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. When monetary_account_id={id,id} is provided only events that relate to these monetary account ids are returned. When status={AWAITING_REPLY\/FINALIZED} is provided the response only contains events with the status AWAITING_REPLY or FINALIZED. When display_user_event={true\/false} is set to false user events are excluded from the response, when not provided user events are displayed. User events are events that are not related to a monetary account (for example: connect invites).", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view events. Events are automatically created and contain information about everything that happens to your bunq account. In the bunq app events are shown in your 'overview'. Examples of when events are created or modified: payment sent, payment received, request for payment received or connect invite received.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EventListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/export-annual-overview": { "post": { "tags": [ "export-annual-overview" ], "summary": "", "operationId": "Create_ExportAnnualOverview_for_User", "description": "Create a new annual overview for a specific year. An overview can be generated only for a past year.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExportAnnualOverview" } } } }, "responses": { "200": { "description": "Used 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 the 'export-annual-overview\/{id}\/content' endpoint.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExportAnnualOverviewCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "export-annual-overview" ], "summary": "", "operationId": "List_all_ExportAnnualOverview_for_User", "description": "List all the annual overviews for a user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used 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 the 'export-annual-overview\/{id}\/content' endpoint.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ExportAnnualOverviewListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/export-annual-overview\/{itemId}": { "get": { "tags": [ "export-annual-overview" ], "summary": "", "operationId": "Read_ExportAnnualOverview_for_User", "description": "Get an annual overview for a user by its id.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used 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 the 'export-annual-overview\/{id}\/content' endpoint.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExportAnnualOverviewRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "export-annual-overview" ], "summary": "", "operationId": "Delete_ExportAnnualOverview_for_User", "description": "Used 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 the 'export-annual-overview\/{id}\/content' endpoint.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used 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 the 'export-annual-overview\/{id}\/content' endpoint.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExportAnnualOverviewDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/export-rib": { "post": { "tags": [ "export-rib" ], "summary": "", "operationId": "Create_ExportRib_for_User_MonetaryAccount", "description": "Create a new RIB.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExportRib" } } } }, "responses": { "200": { "description": "Used to create new and read existing RIBs of a monetary account", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExportRibCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "export-rib" ], "summary": "", "operationId": "List_all_ExportRib_for_User_MonetaryAccount", "description": "List all the RIBs for a monetary account.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to create new and read existing RIBs of a monetary account", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ExportRibListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/export-rib\/{itemId}": { "get": { "tags": [ "export-rib" ], "summary": "", "operationId": "Read_ExportRib_for_User_MonetaryAccount", "description": "Get a RIB for a monetary account by its id.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to create new and read existing RIBs of a monetary account", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExportRibRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "export-rib" ], "summary": "", "operationId": "Delete_ExportRib_for_User_MonetaryAccount", "description": "Used to create new and read existing RIBs of a monetary account", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to create new and read existing RIBs of a monetary account", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExportRibDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/feature-announcement\/{itemId}": { "get": { "tags": [ "feature-announcement" ], "summary": "", "operationId": "Read_FeatureAnnouncement_for_User", "description": "view for updating the feature display.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "view for updating the feature display.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/FeatureAnnouncementRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/card\/{cardID}\/generated-cvc2": { "post": { "tags": [ "generated-cvc2" ], "summary": "", "operationId": "Create_GeneratedCvc2_for_User_Card", "description": "Generate a new CVC2 code for a card.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cardID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CardGeneratedCvc2" } } } }, "responses": { "200": { "description": "Endpoint for generating and retrieving a new CVC2 code.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CardGeneratedCvc2Create" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "generated-cvc2" ], "summary": "", "operationId": "List_all_GeneratedCvc2_for_User_Card", "description": "Get all generated CVC2 codes for a card.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cardID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Endpoint for generating and retrieving a new CVC2 code.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CardGeneratedCvc2Listing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/card\/{cardID}\/generated-cvc2\/{itemId}": { "get": { "tags": [ "generated-cvc2" ], "summary": "", "operationId": "Read_GeneratedCvc2_for_User_Card", "description": "Get the details for a specific generated CVC2 code.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cardID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Endpoint for generating and retrieving a new CVC2 code.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CardGeneratedCvc2Read" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "generated-cvc2" ], "summary": "", "operationId": "Update_GeneratedCvc2_for_User_Card", "description": "Endpoint for generating and retrieving a new CVC2 code.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cardID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CardGeneratedCvc2" } } } }, "responses": { "200": { "description": "Endpoint for generating and retrieving a new CVC2 code.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CardGeneratedCvc2Update" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/ideal-merchant-transaction": { "post": { "tags": [ "ideal-merchant-transaction" ], "summary": "", "operationId": "Create_IdealMerchantTransaction_for_User_MonetaryAccount", "description": "View for requesting iDEAL transactions and polling their status.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/IdealMerchantTransaction" } } } }, "responses": { "200": { "description": "View for requesting iDEAL transactions and polling their status.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/IdealMerchantTransactionCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "ideal-merchant-transaction" ], "summary": "", "operationId": "List_all_IdealMerchantTransaction_for_User_MonetaryAccount", "description": "View for requesting iDEAL transactions and polling their status.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "View for requesting iDEAL transactions and polling their status.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/IdealMerchantTransactionListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/ideal-merchant-transaction\/{itemId}": { "get": { "tags": [ "ideal-merchant-transaction" ], "summary": "", "operationId": "Read_IdealMerchantTransaction_for_User_MonetaryAccount", "description": "View for requesting iDEAL transactions and polling their status.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "View for requesting iDEAL transactions and polling their status.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/IdealMerchantTransactionRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/installation": { "post": { "tags": [ "installation" ], "summary": "", "operationId": "Create_Installation", "description": "This is the only API call that does not require you to use the \"X-Bunq-Client-Authentication\" and \"X-Bunq-Client-Signature\" headers.\n You provide the server with the public part of the key pair that you are going to use to create the value of the signature header for all future API calls. The server creates an installation for you. Store the Installation Token and ServerPublicKey from the response. This token is used in the \"X-Bunq-Client-Authentication\" header for the creation of a DeviceServer and SessionServer.", "parameters": [ { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Installation" } } } }, "responses": { "200": { "description": "Installation is used to tell the server about the public key of your key pair. The server uses this key to verify your subsequent calls, which need to be signed with your own private key. Additionally, you can use the token you get from an Installation to authenticate the registration of a new device.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InstallationCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "installation" ], "summary": "", "operationId": "List_all_Installation", "description": "You must have an active session to make this call. This call returns the Id of the the Installation you are using in your session.", "parameters": [ { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Installation is used to tell the server about the public key of your key pair. The server uses this key to verify your subsequent calls, which need to be signed with your own private key. Additionally, you can use the token you get from an Installation to authenticate the registration of a new device.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InstallationListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/installation\/{itemId}": { "get": { "tags": [ "installation" ], "summary": "", "operationId": "Read_Installation", "description": "You 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.", "parameters": [ { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Installation is used to tell the server about the public key of your key pair. The server uses this key to verify your subsequent calls, which need to be signed with your own private key. Additionally, you can use the token you get from an Installation to authenticate the registration of a new device.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InstallationRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/invoice\/{itemId}": { "get": { "tags": [ "invoice" ], "summary": "", "operationId": "Read_Invoice_for_User", "description": "Used to list bunq invoices by user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to list bunq invoices by user.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InvoiceByUserRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/invoice": { "get": { "tags": [ "invoice" ], "summary": "", "operationId": "List_all_Invoice_for_User", "description": "Used to list bunq invoices by user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to list bunq invoices by user.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InvoiceByUserListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/invoice": { "get": { "tags": [ "invoice" ], "summary": "", "operationId": "List_all_Invoice_for_User_MonetaryAccount", "description": "Used to view a bunq invoice.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view a bunq invoice.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InvoiceListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/invoice\/{itemId}": { "get": { "tags": [ "invoice" ], "summary": "", "operationId": "Read_Invoice_for_User_MonetaryAccount", "description": "Used to view a bunq invoice.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view a bunq invoice.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InvoiceRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/credential-password-ip\/{credential-password-ipID}\/ip\/{itemId}": { "get": { "tags": [ "ip" ], "summary": "", "operationId": "Read_Ip_for_User_CredentialPasswordIp", "description": "Manage the IPs which may be used for a credential of a user for server authentication.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "credential-password-ipID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Manage the IPs which may be used for a credential of a user for server authentication.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PermittedIpRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "ip" ], "summary": "", "operationId": "Update_Ip_for_User_CredentialPasswordIp", "description": "Manage the IPs which may be used for a credential of a user for server authentication.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "credential-password-ipID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PermittedIp" } } } }, "responses": { "200": { "description": "Manage the IPs which may be used for a credential of a user for server authentication.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PermittedIpUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/credential-password-ip\/{credential-password-ipID}\/ip": { "post": { "tags": [ "ip" ], "summary": "", "operationId": "Create_Ip_for_User_CredentialPasswordIp", "description": "Manage the IPs which may be used for a credential of a user for server authentication.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "credential-password-ipID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PermittedIp" } } } }, "responses": { "200": { "description": "Manage the IPs which may be used for a credential of a user for server authentication.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PermittedIpCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "ip" ], "summary": "", "operationId": "List_all_Ip_for_User_CredentialPasswordIp", "description": "Manage the IPs which may be used for a credential of a user for server authentication.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "credential-password-ipID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Manage the IPs which may be used for a credential of a user for server authentication.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PermittedIpListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/legal-name": { "get": { "tags": [ "legal-name" ], "summary": "", "operationId": "List_all_LegalName_for_User", "description": "Endpoint for getting available legal names that can be used by the user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Endpoint for getting available legal names that can be used by the user.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UserLegalNameListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/limit": { "get": { "tags": [ "limit" ], "summary": "", "operationId": "List_all_Limit_for_User", "description": "Get all limits for the authenticated user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Show the limits for the authenticated user.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CustomerLimitListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/mastercard-action\/{itemId}": { "get": { "tags": [ "mastercard-action" ], "summary": "", "operationId": "Read_MastercardAction_for_User_MonetaryAccount", "description": "MasterCard transaction view.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "MasterCard transaction view.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MasterCardActionRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/mastercard-action": { "get": { "tags": [ "mastercard-action" ], "summary": "", "operationId": "List_all_MastercardAction_for_User_MonetaryAccount", "description": "MasterCard transaction view.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "MasterCard transaction view.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MasterCardActionListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account": { "get": { "tags": [ "monetary-account" ], "summary": "", "operationId": "List_all_MonetaryAccount_for_User", "description": "Get a collection of all your MonetaryAccounts.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to show the MonetaryAccounts that you can access. Currently the only MonetaryAccount type is MonetaryAccountBank. See also: monetary-account-bank.Notification filters can be set on a monetary account level to receive callbacks. For more information check the dedicated callbacks page<\/a>.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MonetaryAccountListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{itemId}": { "get": { "tags": [ "monetary-account" ], "summary": "", "operationId": "Read_MonetaryAccount_for_User", "description": "Get a specific MonetaryAccount.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to show the MonetaryAccounts that you can access. Currently the only MonetaryAccount type is MonetaryAccountBank. See also: monetary-account-bank.Notification filters can be set on a monetary account level to receive callbacks. For more information check the dedicated callbacks page<\/a>.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account-bank\/{itemId}": { "get": { "tags": [ "monetary-account-bank" ], "summary": "", "operationId": "Read_MonetaryAccountBank_for_User", "description": "Get a specific MonetaryAccountBank.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "With MonetaryAccountBank you can create a new bank account, retrieve information regarding your existing MonetaryAccountBanks and update specific fields of an existing MonetaryAccountBank. Examples of fields that can be updated are the description, the daily limit and the avatar of the account.Notification filters can be set on a monetary account level to receive callbacks. For more information check the dedicated callbacks page<\/a>.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountBankRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "monetary-account-bank" ], "summary": "", "operationId": "Update_MonetaryAccountBank_for_User", "description": "Update a specific existing MonetaryAccountBank.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountBank" } } } }, "responses": { "200": { "description": "With MonetaryAccountBank you can create a new bank account, retrieve information regarding your existing MonetaryAccountBanks and update specific fields of an existing MonetaryAccountBank. Examples of fields that can be updated are the description, the daily limit and the avatar of the account.Notification filters can be set on a monetary account level to receive callbacks. For more information check the dedicated callbacks page<\/a>.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountBankUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account-bank": { "post": { "tags": [ "monetary-account-bank" ], "summary": "", "operationId": "Create_MonetaryAccountBank_for_User", "description": "Create new MonetaryAccountBank.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountBank" } } } }, "responses": { "200": { "description": "With MonetaryAccountBank you can create a new bank account, retrieve information regarding your existing MonetaryAccountBanks and update specific fields of an existing MonetaryAccountBank. Examples of fields that can be updated are the description, the daily limit and the avatar of the account.Notification filters can be set on a monetary account level to receive callbacks. For more information check the dedicated callbacks page<\/a>.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountBankCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "monetary-account-bank" ], "summary": "", "operationId": "List_all_MonetaryAccountBank_for_User", "description": "Gets a listing of all MonetaryAccountBanks of a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "With MonetaryAccountBank you can create a new bank account, retrieve information regarding your existing MonetaryAccountBanks and update specific fields of an existing MonetaryAccountBank. Examples of fields that can be updated are the description, the daily limit and the avatar of the account.Notification filters can be set on a monetary account level to receive callbacks. For more information check the dedicated callbacks page<\/a>.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MonetaryAccountBankListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account-joint\/{itemId}": { "get": { "tags": [ "monetary-account-joint" ], "summary": "", "operationId": "Read_MonetaryAccountJoint_for_User", "description": "The endpoint for joint monetary accounts.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "The endpoint for joint monetary accounts.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountJointRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "monetary-account-joint" ], "summary": "", "operationId": "Update_MonetaryAccountJoint_for_User", "description": "The endpoint for joint monetary accounts.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountJoint" } } } }, "responses": { "200": { "description": "The endpoint for joint monetary accounts.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountJointUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account-joint": { "post": { "tags": [ "monetary-account-joint" ], "summary": "", "operationId": "Create_MonetaryAccountJoint_for_User", "description": "The endpoint for joint monetary accounts.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountJoint" } } } }, "responses": { "200": { "description": "The endpoint for joint monetary accounts.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountJointCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "monetary-account-joint" ], "summary": "", "operationId": "List_all_MonetaryAccountJoint_for_User", "description": "The endpoint for joint monetary accounts.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "The endpoint for joint monetary accounts.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MonetaryAccountJointListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account-savings": { "post": { "tags": [ "monetary-account-savings" ], "summary": "", "operationId": "Create_MonetaryAccountSavings_for_User", "description": "Create new MonetaryAccountSavings.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountSavings" } } } }, "responses": { "200": { "description": "With MonetaryAccountSavings you can create a new savings account.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountSavingsCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "monetary-account-savings" ], "summary": "", "operationId": "List_all_MonetaryAccountSavings_for_User", "description": "Gets a listing of all MonetaryAccountSavingss of a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "With MonetaryAccountSavings you can create a new savings account.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MonetaryAccountSavingsListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account-savings\/{itemId}": { "get": { "tags": [ "monetary-account-savings" ], "summary": "", "operationId": "Read_MonetaryAccountSavings_for_User", "description": "Get a specific MonetaryAccountSavings.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "With MonetaryAccountSavings you can create a new savings account.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountSavingsRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "monetary-account-savings" ], "summary": "", "operationId": "Update_MonetaryAccountSavings_for_User", "description": "Update a specific existing MonetaryAccountSavings.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountSavings" } } } }, "responses": { "200": { "description": "With MonetaryAccountSavings you can create a new savings account.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MonetaryAccountSavingsUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user-company\/{user-companyID}\/name": { "get": { "tags": [ "name" ], "summary": "", "operationId": "List_all_Name_for_UserCompany", "description": "Return all the known (trade) names for a specific user company.", "parameters": [ { "in": "path", "name": "user-companyID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Endpoint for getting all the known (trade) names for a user company. This is needed for updating the user name, as we only accept legal or trade names.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UserCompanyNameListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule\/{scheduleID}\/schedule-instance\/{schedule-instanceID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "scheduleID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-instanceID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentScheduleInstance" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentScheduleInstanceCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "scheduleID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-instanceID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentScheduleInstanceListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/payment\/{paymentID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_Payment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentPayment" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentPaymentUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_Payment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentPaymentDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_Payment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentPaymentRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-inquiry-batch\/{request-inquiry-batchID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiry-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestInquiryBatch" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestInquiryBatchUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiry-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestInquiryBatchDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiry-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestInquiryBatchRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-inquiry\/{request-inquiryID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_RequestInquiry", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiryID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestInquiry" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestInquiryCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_RequestInquiry", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiryID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestInquiryListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-inquiry\/{request-inquiryID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_RequestInquiry", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiryID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestInquiry" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestInquiryUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_RequestInquiry", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiryID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestInquiryDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_RequestInquiry", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiryID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestInquiryRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-response\/{request-responseID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_RequestResponse", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-responseID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestResponse" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestResponseCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_RequestResponse", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-responseID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestResponseListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-response\/{request-responseID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_RequestResponse", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-responseID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestResponse" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestResponseUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_RequestResponse", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-responseID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestResponseDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_RequestResponse", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-responseID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestResponseRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule-payment\/{schedule-paymentID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_SchedulePayment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSchedulePayment" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSchedulePaymentUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_SchedulePayment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSchedulePaymentDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_SchedulePayment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSchedulePaymentRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule\/{scheduleID}\/schedule-instance\/{schedule-instanceID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "scheduleID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-instanceID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentScheduleInstance" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentScheduleInstanceUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "scheduleID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-instanceID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentScheduleInstanceDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_Schedule_ScheduleInstance", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "scheduleID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-instanceID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentScheduleInstanceRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule-payment-batch\/{schedule-payment-batchID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSchedulePaymentBatch" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSchedulePaymentBatchCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentSchedulePaymentBatchListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule-payment-batch\/{schedule-payment-batchID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSchedulePaymentBatch" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSchedulePaymentBatchUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSchedulePaymentBatchDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_SchedulePaymentBatch", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSchedulePaymentBatchRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule-payment\/{schedule-paymentID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_SchedulePayment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSchedulePayment" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSchedulePaymentCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_SchedulePayment", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentSchedulePaymentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/payment-batch\/{payment-batchID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_PaymentBatch", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentPaymentBatch" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentPaymentBatchUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_PaymentBatch", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentPaymentBatchDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_PaymentBatch", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentPaymentBatchRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/sofort-merchant-transaction\/{sofort-merchant-transactionID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "sofort-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSofortMerchantTransaction" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSofortMerchantTransactionCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "sofort-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentSofortMerchantTransactionListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/sofort-merchant-transaction\/{sofort-merchant-transactionID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "sofort-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSofortMerchantTransaction" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSofortMerchantTransactionUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "sofort-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSofortMerchantTransactionDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_SofortMerchantTransaction", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "sofort-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentSofortMerchantTransactionRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/whitelist\/{whitelistID}\/whitelist-result\/{whitelist-resultID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelistID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelist-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentWhitelistResult" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentWhitelistResultCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelistID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelist-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentWhitelistResultListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/whitelist\/{whitelistID}\/whitelist-result\/{whitelist-resultID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelistID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelist-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentWhitelistResult" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentWhitelistResultUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelistID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelist-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentWhitelistResultDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_Whitelist_WhitelistResult", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelistID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelist-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentWhitelistResultRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/payment\/{paymentID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_Payment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentPayment" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentPaymentCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_Payment", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentPaymentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-inquiry-batch\/{request-inquiry-batchID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiry-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestInquiryBatch" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestInquiryBatchCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_RequestInquiryBatch", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiry-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentRequestInquiryBatchListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/payment-batch\/{payment-batchID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_PaymentBatch", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentPaymentBatch" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentPaymentBatchCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_PaymentBatch", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentPaymentBatchListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/ideal-merchant-transaction\/{ideal-merchant-transactionID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "ideal-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentIdealMerchantTransaction" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentIdealMerchantTransactionUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "ideal-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentIdealMerchantTransactionDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "ideal-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentIdealMerchantTransactionRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/switch-service-payment\/{switch-service-paymentID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "switch-service-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentBankSwitchServiceNetherlandsIncomingPayment" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "switch-service-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "switch-service-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/switch-service-payment\/{switch-service-paymentID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "switch-service-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentBankSwitchServiceNetherlandsIncomingPayment" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_SwitchServicePayment", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "switch-service-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentBankSwitchServiceNetherlandsIncomingPaymentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/bunqme-fundraiser-result\/{bunqme-fundraiser-resultID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "bunqme-fundraiser-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentBunqMeFundraiserResult" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentBunqMeFundraiserResultCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "bunqme-fundraiser-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentBunqMeFundraiserResultListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/bunqme-fundraiser-result\/{bunqme-fundraiser-resultID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "bunqme-fundraiser-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentBunqMeFundraiserResult" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentBunqMeFundraiserResultUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "bunqme-fundraiser-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentBunqMeFundraiserResultDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_BunqmeFundraiserResult", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "bunqme-fundraiser-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentBunqMeFundraiserResultRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/draft-payment\/{draft-paymentID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_DraftPayment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "draft-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentDraftPayment" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentDraftPaymentUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_DraftPayment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "draft-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentDraftPaymentDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_DraftPayment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "draft-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentDraftPaymentRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/ideal-merchant-transaction\/{ideal-merchant-transactionID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "ideal-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentIdealMerchantTransaction" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentIdealMerchantTransactionCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_IdealMerchantTransaction", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "ideal-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentIdealMerchantTransactionListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/draft-payment\/{draft-paymentID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_DraftPayment", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "draft-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentDraftPayment" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentDraftPaymentCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_DraftPayment", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "draft-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentDraftPaymentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/mastercard-action\/{mastercard-actionID}\/note-attachment": { "post": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Create_NoteAttachment_for_User_MonetaryAccount_MastercardAction", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "mastercard-actionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentMasterCardAction" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentMasterCardActionCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "List_all_NoteAttachment_for_User_MonetaryAccount_MastercardAction", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "mastercard-actionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteAttachmentMasterCardActionListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/mastercard-action\/{mastercard-actionID}\/note-attachment\/{itemId}": { "put": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Update_NoteAttachment_for_User_MonetaryAccount_MastercardAction", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "mastercard-actionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentMasterCardAction" } } } }, "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentMasterCardActionUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Delete_NoteAttachment_for_User_MonetaryAccount_MastercardAction", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "mastercard-actionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentMasterCardActionDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-attachment" ], "summary": "", "operationId": "Read_NoteAttachment_for_User_MonetaryAccount_MastercardAction", "description": "Used to manage attachment notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "mastercard-actionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage attachment notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteAttachmentMasterCardActionRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-inquiry-batch\/{request-inquiry-batchID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_RequestInquiryBatch", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiry-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestInquiryBatch" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestInquiryBatchCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_RequestInquiryBatch", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiry-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextRequestInquiryBatchListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/switch-service-payment\/{switch-service-paymentID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_SwitchServicePayment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "switch-service-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextBankSwitchServiceNetherlandsIncomingPayment" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextBankSwitchServiceNetherlandsIncomingPaymentUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_SwitchServicePayment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "switch-service-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextBankSwitchServiceNetherlandsIncomingPaymentDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_SwitchServicePayment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "switch-service-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextBankSwitchServiceNetherlandsIncomingPaymentRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule-payment\/{schedule-paymentID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_SchedulePayment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSchedulePayment" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSchedulePaymentUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_SchedulePayment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSchedulePaymentDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_SchedulePayment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSchedulePaymentRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/payment\/{paymentID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_Payment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextPayment" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextPaymentCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_Payment", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextPaymentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/mastercard-action\/{mastercard-actionID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_MastercardAction", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "mastercard-actionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextMasterCardAction" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextMasterCardActionCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_MastercardAction", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "mastercard-actionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextMasterCardActionListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/sofort-merchant-transaction\/{sofort-merchant-transactionID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "sofort-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSofortMerchantTransaction" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSofortMerchantTransactionCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "sofort-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextSofortMerchantTransactionListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/sofort-merchant-transaction\/{sofort-merchant-transactionID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "sofort-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSofortMerchantTransaction" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSofortMerchantTransactionUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "sofort-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSofortMerchantTransactionDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_SofortMerchantTransaction", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "sofort-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSofortMerchantTransactionRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/whitelist\/{whitelistID}\/whitelist-result\/{whitelist-resultID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelistID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelist-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextWhitelistResult" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextWhitelistResultCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelistID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelist-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextWhitelistResultListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/switch-service-payment\/{switch-service-paymentID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_SwitchServicePayment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "switch-service-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextBankSwitchServiceNetherlandsIncomingPayment" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextBankSwitchServiceNetherlandsIncomingPaymentCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_SwitchServicePayment", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "switch-service-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextBankSwitchServiceNetherlandsIncomingPaymentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-inquiry-batch\/{request-inquiry-batchID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_RequestInquiryBatch", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiry-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestInquiryBatch" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestInquiryBatchUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_RequestInquiryBatch", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiry-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestInquiryBatchDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_RequestInquiryBatch", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiry-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestInquiryBatchRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/whitelist\/{whitelistID}\/whitelist-result\/{whitelist-resultID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelistID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelist-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextWhitelistResult" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextWhitelistResultUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelistID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelist-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextWhitelistResultDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_Whitelist_WhitelistResult", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelistID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "whitelist-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextWhitelistResultRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/mastercard-action\/{mastercard-actionID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_MastercardAction", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "mastercard-actionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextMasterCardAction" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextMasterCardActionUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_MastercardAction", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "mastercard-actionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextMasterCardActionDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_MastercardAction", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "mastercard-actionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextMasterCardActionRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/payment-batch\/{payment-batchID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_PaymentBatch", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextPaymentBatch" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextPaymentBatchCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_PaymentBatch", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextPaymentBatchListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/payment-batch\/{payment-batchID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_PaymentBatch", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextPaymentBatch" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextPaymentBatchUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_PaymentBatch", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextPaymentBatchDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_PaymentBatch", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextPaymentBatchRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule-payment\/{schedule-paymentID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_SchedulePayment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSchedulePayment" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSchedulePaymentCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_SchedulePayment", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextSchedulePaymentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/bunqme-fundraiser-result\/{bunqme-fundraiser-resultID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "bunqme-fundraiser-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextBunqMeFundraiserResult" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextBunqMeFundraiserResultCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "bunqme-fundraiser-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextBunqMeFundraiserResultListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/bunqme-fundraiser-result\/{bunqme-fundraiser-resultID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "bunqme-fundraiser-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextBunqMeFundraiserResult" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextBunqMeFundraiserResultUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "bunqme-fundraiser-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextBunqMeFundraiserResultDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_BunqmeFundraiserResult", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "bunqme-fundraiser-resultID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextBunqMeFundraiserResultRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-response\/{request-responseID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_RequestResponse", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-responseID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestResponse" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestResponseUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_RequestResponse", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-responseID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestResponseDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_RequestResponse", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-responseID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestResponseRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/ideal-merchant-transaction\/{ideal-merchant-transactionID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "ideal-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextIdealMerchantTransaction" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextIdealMerchantTransactionUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "ideal-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextIdealMerchantTransactionDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "ideal-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextIdealMerchantTransactionRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/ideal-merchant-transaction\/{ideal-merchant-transactionID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "ideal-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextIdealMerchantTransaction" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextIdealMerchantTransactionCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_IdealMerchantTransaction", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "ideal-merchant-transactionID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextIdealMerchantTransactionListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-inquiry\/{request-inquiryID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_RequestInquiry", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiryID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestInquiry" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestInquiryCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_RequestInquiry", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiryID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextRequestInquiryListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-inquiry\/{request-inquiryID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_RequestInquiry", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiryID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestInquiry" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestInquiryUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_RequestInquiry", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiryID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestInquiryDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_RequestInquiry", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-inquiryID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestInquiryRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule-payment-batch\/{schedule-payment-batchID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSchedulePaymentBatch" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSchedulePaymentBatchUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSchedulePaymentBatchDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSchedulePaymentBatchRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-response\/{request-responseID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_RequestResponse", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-responseID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestResponse" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextRequestResponseCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_RequestResponse", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "request-responseID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextRequestResponseListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/draft-payment\/{draft-paymentID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_DraftPayment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "draft-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextDraftPayment" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextDraftPaymentUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_DraftPayment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "draft-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextDraftPaymentDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_DraftPayment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "draft-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextDraftPaymentRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/draft-payment\/{draft-paymentID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_DraftPayment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "draft-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextDraftPayment" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextDraftPaymentCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_DraftPayment", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "draft-paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextDraftPaymentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule\/{scheduleID}\/schedule-instance\/{schedule-instanceID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "scheduleID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-instanceID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextScheduleInstance" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextScheduleInstanceCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "scheduleID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-instanceID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextScheduleInstanceListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule\/{scheduleID}\/schedule-instance\/{schedule-instanceID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "scheduleID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-instanceID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextScheduleInstance" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextScheduleInstanceUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "scheduleID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-instanceID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextScheduleInstanceDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_Schedule_ScheduleInstance", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "scheduleID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-instanceID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextScheduleInstanceRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/payment\/{paymentID}\/note-text\/{itemId}": { "put": { "tags": [ "note-text" ], "summary": "", "operationId": "Update_NoteText_for_User_MonetaryAccount_Payment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextPayment" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextPaymentUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "note-text" ], "summary": "", "operationId": "Delete_NoteText_for_User_MonetaryAccount_Payment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextPaymentDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "Read_NoteText_for_User_MonetaryAccount_Payment", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "paymentID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextPaymentRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule-payment-batch\/{schedule-payment-batchID}\/note-text": { "post": { "tags": [ "note-text" ], "summary": "", "operationId": "Create_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch", "description": "Used to manage text notes.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSchedulePaymentBatch" } } } }, "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NoteTextSchedulePaymentBatchCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "note-text" ], "summary": "", "operationId": "List_all_NoteText_for_User_MonetaryAccount_SchedulePaymentBatch", "description": "Manage the notes for a given user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "schedule-payment-batchID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to manage text notes.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NoteTextSchedulePaymentBatchListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/notification-filter-push": { "post": { "tags": [ "notification-filter-push" ], "summary": "", "operationId": "Create_NotificationFilterPush_for_User", "description": "Manage the push notification filters for a user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NotificationFilterPushUser" } } } }, "responses": { "200": { "description": "Manage the push notification filters for a user.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NotificationFilterPushUserCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "notification-filter-push" ], "summary": "", "operationId": "List_all_NotificationFilterPush_for_User", "description": "Manage the push notification filters for a user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Manage the push notification filters for a user.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NotificationFilterPushUserListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/notification-filter-url": { "post": { "tags": [ "notification-filter-url" ], "summary": "", "operationId": "Create_NotificationFilterUrl_for_User_MonetaryAccount", "description": "Manage the url notification filters for a user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NotificationFilterUrlMonetaryAccount" } } } }, "responses": { "200": { "description": "Manage the url notification filters for a user.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NotificationFilterUrlMonetaryAccountCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "notification-filter-url" ], "summary": "", "operationId": "List_all_NotificationFilterUrl_for_User_MonetaryAccount", "description": "Manage the url notification filters for a user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Manage the url notification filters for a user.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NotificationFilterUrlMonetaryAccountListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/notification-filter-url": { "post": { "tags": [ "notification-filter-url" ], "summary": "", "operationId": "Create_NotificationFilterUrl_for_User", "description": "Manage the url notification filters for a user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NotificationFilterUrlUser" } } } }, "responses": { "200": { "description": "Manage the url notification filters for a user.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NotificationFilterUrlUserCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "notification-filter-url" ], "summary": "", "operationId": "List_all_NotificationFilterUrl_for_User", "description": "Manage the url notification filters for a user.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Manage the url notification filters for a user.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NotificationFilterUrlUserListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/oauth-client\/{itemId}": { "get": { "tags": [ "oauth-client" ], "summary": "", "operationId": "Read_OauthClient_for_User", "description": "Used for managing OAuth Clients.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used for managing OAuth Clients.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthClientRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "oauth-client" ], "summary": "", "operationId": "Update_OauthClient_for_User", "description": "Used for managing OAuth Clients.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthClient" } } } }, "responses": { "200": { "description": "Used for managing OAuth Clients.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthClientUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/oauth-client": { "post": { "tags": [ "oauth-client" ], "summary": "", "operationId": "Create_OauthClient_for_User", "description": "Used for managing OAuth Clients.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthClient" } } } }, "responses": { "200": { "description": "Used for managing OAuth Clients.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthClientCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "oauth-client" ], "summary": "", "operationId": "List_all_OauthClient_for_User", "description": "Used for managing OAuth Clients.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used for managing OAuth Clients.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OauthClientListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/payment": { "post": { "tags": [ "payment" ], "summary": "", "operationId": "Create_Payment_for_User_MonetaryAccount", "description": "Create a new Payment.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Payment" } } } }, "responses": { "200": { "description": "Using Payment, you can send payments to bunq and non-bunq users from your bunq MonetaryAccounts. This can be done using bunq Aliases or IBAN Aliases. When transferring money to other bunq MonetaryAccounts you can also refer to Attachments. These will be received by the counter-party as part of the Payment. You can also retrieve a single Payment or all executed Payments of a specific monetary account.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "payment" ], "summary": "", "operationId": "List_all_Payment_for_User_MonetaryAccount", "description": "Get a listing of all Payments performed on a given MonetaryAccount (incoming and outgoing).", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Using Payment, you can send payments to bunq and non-bunq users from your bunq MonetaryAccounts. This can be done using bunq Aliases or IBAN Aliases. When transferring money to other bunq MonetaryAccounts you can also refer to Attachments. These will be received by the counter-party as part of the Payment. You can also retrieve a single Payment or all executed Payments of a specific monetary account.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PaymentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/payment\/{itemId}": { "get": { "tags": [ "payment" ], "summary": "", "operationId": "Read_Payment_for_User_MonetaryAccount", "description": "Get a specific previous Payment.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Using Payment, you can send payments to bunq and non-bunq users from your bunq MonetaryAccounts. This can be done using bunq Aliases or IBAN Aliases. When transferring money to other bunq MonetaryAccounts you can also refer to Attachments. These will be received by the counter-party as part of the Payment. You can also retrieve a single Payment or all executed Payments of a specific monetary account.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/payment-batch": { "post": { "tags": [ "payment-batch" ], "summary": "", "operationId": "Create_PaymentBatch_for_User_MonetaryAccount", "description": "Create a payment batch by sending an array of single payment objects, that will become part of the batch.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentBatch" } } } }, "responses": { "200": { "description": "Create a payment batch, or show the payment batches of a monetary account.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentBatchCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "payment-batch" ], "summary": "", "operationId": "List_all_PaymentBatch_for_User_MonetaryAccount", "description": "Return all the payment batches for a monetary account.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Create a payment batch, or show the payment batches of a monetary account.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PaymentBatchListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/payment-batch\/{itemId}": { "put": { "tags": [ "payment-batch" ], "summary": "", "operationId": "Update_PaymentBatch_for_User_MonetaryAccount", "description": "Revoke a bunq.to payment batch. The status of all the payments will be set to REVOKED.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentBatch" } } } }, "responses": { "200": { "description": "Create a payment batch, or show the payment batches of a monetary account.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentBatchUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "payment-batch" ], "summary": "", "operationId": "Read_PaymentBatch_for_User_MonetaryAccount", "description": "Return the details of a specific payment batch.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Create a payment batch, or show the payment batches of a monetary account.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentBatchRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/payment-service-provider-credential": { "post": { "tags": [ "payment-service-provider-credential" ], "summary": "", "operationId": "Create_PaymentServiceProviderCredential", "description": "Register a Payment Service Provider and provide credentials", "parameters": [ { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentServiceProviderCredential" } } } }, "responses": { "200": { "description": "Register a Payment Service Provider and provide credentials", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentServiceProviderCredentialCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/payment-service-provider-credential\/{itemId}": { "get": { "tags": [ "payment-service-provider-credential" ], "summary": "", "operationId": "Read_PaymentServiceProviderCredential", "description": "Register a Payment Service Provider and provide credentials", "parameters": [ { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Register a Payment Service Provider and provide credentials", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentServiceProviderCredentialRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/invoice\/{invoiceID}\/pdf-content": { "get": { "tags": [ "pdf-content" ], "summary": "", "operationId": "List_all_PdfContent_for_User_Invoice", "description": "Get a PDF export of an invoice.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "invoiceID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Get a PDF export of an invoice.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InvoiceExportPdfContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/qr-code": { "post": { "tags": [ "qr-code" ], "summary": "", "operationId": "Create_QrCode_for_User_MonetaryAccount_CashRegister", "description": "Create a new QR code for this CashRegister. You can only have one ACTIVE CashRegister QR code at the time.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CashRegisterQrCode" } } } }, "responses": { "200": { "description": "Once your CashRegister has been activated you can create a QR code for it. The visibility of a tab can be modified to be linked to this QR code. If a user of the bunq app scans this QR code, the linked tab will be shown on his device.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CashRegisterQrCodeCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "qr-code" ], "summary": "", "operationId": "List_all_QrCode_for_User_MonetaryAccount_CashRegister", "description": "Get a collection of QR code information from a given CashRegister", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Once your CashRegister has been activated you can create a QR code for it. The visibility of a tab can be modified to be linked to this QR code. If a user of the bunq app scans this QR code, the linked tab will be shown on his device.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CashRegisterQrCodeListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/qr-code\/{itemId}": { "put": { "tags": [ "qr-code" ], "summary": "", "operationId": "Update_QrCode_for_User_MonetaryAccount_CashRegister", "description": "Modify a QR code in a given CashRegister. You can only have one ACTIVE CashRegister QR code at the time.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CashRegisterQrCode" } } } }, "responses": { "200": { "description": "Once your CashRegister has been activated you can create a QR code for it. The visibility of a tab can be modified to be linked to this QR code. If a user of the bunq app scans this QR code, the linked tab will be shown on his device.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CashRegisterQrCodeUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "qr-code" ], "summary": "", "operationId": "Read_QrCode_for_User_MonetaryAccount_CashRegister", "description": "Get the information of a specific QR code. To get the RAW content of the QR code use ..\/qr-code\/{id}\/content", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Once your CashRegister has been activated you can create a QR code for it. The visibility of a tab can be modified to be linked to this QR code. If a user of the bunq app scans this QR code, the linked tab will be shown on his device.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CashRegisterQrCodeRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/draft-share-invite-api-key\/{draft-share-invite-api-keyID}\/qr-code-content": { "get": { "tags": [ "qr-code-content" ], "summary": "", "operationId": "List_all_QrCodeContent_for_User_DraftShareInviteApiKey", "description": "Returns the raw content of the QR code that links to this draft share invite. The raw content is the binary representation of a file, without any JSON wrapping.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "draft-share-invite-api-keyID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "This call returns the raw content of the QR code that links to this draft share invite. When a bunq user scans this QR code with the bunq app the draft share invite will be shown on his\/her device.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DraftShareInviteApiKeyQrCodeContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/draft-share-invite-bank\/{draft-share-invite-bankID}\/qr-code-content": { "get": { "tags": [ "qr-code-content" ], "summary": "", "operationId": "List_all_QrCodeContent_for_User_DraftShareInviteBank", "description": "Returns the raw content of the QR code that links to this draft share invite. The raw content is the binary representation of a file, without any JSON wrapping.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "draft-share-invite-bankID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "This call returns the raw content of the QR code that links to this draft share invite. When a bunq user scans this QR code with the bunq app the draft share invite will be shown on his\/her device.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DraftShareInviteBankQrCodeContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/tab\/{tabUUID}\/qr-code-content": { "get": { "tags": [ "qr-code-content" ], "summary": "", "operationId": "List_all_QrCodeContent_for_User_MonetaryAccount_CashRegister_Tab", "description": "Returns the raw content of the QR code that links to this Tab. The raw content is the binary representation of a file, without any JSON wrapping.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "tabUUID", "description": "", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "This call returns the raw content of the QR code that links to this Tab. When a bunq user scans this QR code with the bunq app the Tab will be shown on his\/her device.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TabQrCodeContentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/card\/{cardID}\/replace": { "post": { "tags": [ "replace" ], "summary": "", "operationId": "Create_Replace_for_User_Card", "description": "Request a card replacement.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cardID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CardReplace" } } } }, "responses": { "200": { "description": "It is possible to order a card replacement with the bunq API.You can order up to one free card replacement per year. Additional replacement requests will be billed.The card replacement will have the same expiry date and the same pricing as the old card, but it will have a new card number. You can change the description and optional the PIN through the card replacement endpoint.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CardReplaceCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-inquiry": { "post": { "tags": [ "request-inquiry" ], "summary": "", "operationId": "Create_RequestInquiry_for_User_MonetaryAccount", "description": "Create a new payment request.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RequestInquiry" } } } }, "responses": { "200": { "description": "RequestInquiry, aka 'RFP' (Request for Payment), is one of the innovative features that bunq offers. To request payment from another bunq account a new Request Inquiry is created. As with payments you can add attachments to a RFP. Requests for Payment are the foundation for a number of consumer features like 'Split the bill' and 'Request forwarding'. We invite you to invent your own based on the bunq api!", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RequestInquiryCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "request-inquiry" ], "summary": "", "operationId": "List_all_RequestInquiry_for_User_MonetaryAccount", "description": "Get all payment requests for a user's monetary account.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "RequestInquiry, aka 'RFP' (Request for Payment), is one of the innovative features that bunq offers. To request payment from another bunq account a new Request Inquiry is created. As with payments you can add attachments to a RFP. Requests for Payment are the foundation for a number of consumer features like 'Split the bill' and 'Request forwarding'. We invite you to invent your own based on the bunq api!", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/RequestInquiryListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-inquiry\/{itemId}": { "put": { "tags": [ "request-inquiry" ], "summary": "", "operationId": "Update_RequestInquiry_for_User_MonetaryAccount", "description": "Revoke a request for payment, by updating the status to REVOKED.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RequestInquiry" } } } }, "responses": { "200": { "description": "RequestInquiry, aka 'RFP' (Request for Payment), is one of the innovative features that bunq offers. To request payment from another bunq account a new Request Inquiry is created. As with payments you can add attachments to a RFP. Requests for Payment are the foundation for a number of consumer features like 'Split the bill' and 'Request forwarding'. We invite you to invent your own based on the bunq api!", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RequestInquiryUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "request-inquiry" ], "summary": "", "operationId": "Read_RequestInquiry_for_User_MonetaryAccount", "description": "Get the details of a specific payment request, including its status.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "RequestInquiry, aka 'RFP' (Request for Payment), is one of the innovative features that bunq offers. To request payment from another bunq account a new Request Inquiry is created. As with payments you can add attachments to a RFP. Requests for Payment are the foundation for a number of consumer features like 'Split the bill' and 'Request forwarding'. We invite you to invent your own based on the bunq api!", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RequestInquiryRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-inquiry-batch": { "post": { "tags": [ "request-inquiry-batch" ], "summary": "", "operationId": "Create_RequestInquiryBatch_for_User_MonetaryAccount", "description": "Create a request batch by sending an array of single request objects, that will become part of the batch.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RequestInquiryBatch" } } } }, "responses": { "200": { "description": "Create a batch of requests for payment, or show the request batches of a monetary account.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RequestInquiryBatchCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "request-inquiry-batch" ], "summary": "", "operationId": "List_all_RequestInquiryBatch_for_User_MonetaryAccount", "description": "Return all the request batches for a monetary account.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Create a batch of requests for payment, or show the request batches of a monetary account.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/RequestInquiryBatchListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-inquiry-batch\/{itemId}": { "put": { "tags": [ "request-inquiry-batch" ], "summary": "", "operationId": "Update_RequestInquiryBatch_for_User_MonetaryAccount", "description": "Revoke a request batch. The status of all the requests will be set to REVOKED.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RequestInquiryBatch" } } } }, "responses": { "200": { "description": "Create a batch of requests for payment, or show the request batches of a monetary account.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RequestInquiryBatchUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "request-inquiry-batch" ], "summary": "", "operationId": "Read_RequestInquiryBatch_for_User_MonetaryAccount", "description": "Return the details of a specific request batch.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Create a batch of requests for payment, or show the request batches of a monetary account.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RequestInquiryBatchRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-response\/{itemId}": { "put": { "tags": [ "request-response" ], "summary": "", "operationId": "Update_RequestResponse_for_User_MonetaryAccount", "description": "Update the status to accept or reject the RequestResponse.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RequestResponse" } } } }, "responses": { "200": { "description": "A RequestResponse is what a user on the other side of a RequestInquiry gets when he is sent one. So a RequestInquiry is the initiator and visible for the user that sent it and that wants to receive the money. A RequestResponse is what the other side sees, i.e. the user that pays the money to accept the request. The content is almost identical.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RequestResponseUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "request-response" ], "summary": "", "operationId": "Read_RequestResponse_for_User_MonetaryAccount", "description": "Get the details for a specific existing RequestResponse.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "A RequestResponse is what a user on the other side of a RequestInquiry gets when he is sent one. So a RequestInquiry is the initiator and visible for the user that sent it and that wants to receive the money. A RequestResponse is what the other side sees, i.e. the user that pays the money to accept the request. The content is almost identical.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RequestResponseRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/request-response": { "get": { "tags": [ "request-response" ], "summary": "", "operationId": "List_all_RequestResponse_for_User_MonetaryAccount", "description": "Get all RequestResponses for a MonetaryAccount.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "A RequestResponse is what a user on the other side of a RequestInquiry gets when he is sent one. So a RequestInquiry is the initiator and visible for the user that sent it and that wants to receive the money. A RequestResponse is what the other side sees, i.e. the user that pays the money to accept the request. The content is almost identical.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/RequestResponseListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/reward\/{itemId}": { "get": { "tags": [ "reward" ], "summary": "", "operationId": "Read_Reward_for_User", "description": "Used to view Rewards.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view Rewards.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RewardRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/reward": { "get": { "tags": [ "reward" ], "summary": "", "operationId": "List_all_Reward_for_User", "description": "Used to view Rewards.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view Rewards.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/RewardListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/reward-recipient": { "get": { "tags": [ "reward-recipient" ], "summary": "", "operationId": "List_all_RewardRecipient_for_User", "description": "Used to view Rewards.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view Rewards.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/RewardRecipientListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/reward-recipient\/{itemId}": { "get": { "tags": [ "reward-recipient" ], "summary": "", "operationId": "Read_RewardRecipient_for_User", "description": "Used to view Rewards.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view Rewards.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RewardRecipientRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/reward-sender": { "get": { "tags": [ "reward-sender" ], "summary": "", "operationId": "List_all_RewardSender_for_User", "description": "Used to view Rewards.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view Rewards.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/RewardSenderListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/reward-sender\/{itemId}": { "get": { "tags": [ "reward-sender" ], "summary": "", "operationId": "Read_RewardSender_for_User", "description": "Used to view Rewards.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view Rewards.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RewardSenderRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/sandbox-user": { "post": { "tags": [ "sandbox-user" ], "summary": "", "operationId": "Create_SandboxUser", "description": "Used to create a sandbox user.", "parameters": [ { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SandboxUser" } } } }, "responses": { "200": { "description": "Used to create a sandbox user.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SandboxUserCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule\/{itemId}": { "get": { "tags": [ "schedule" ], "summary": "", "operationId": "Read_Schedule_for_User_MonetaryAccount", "description": "Get a specific schedule definition for a given monetary account.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "view for reading the scheduled definitions.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ScheduleRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule": { "get": { "tags": [ "schedule" ], "summary": "", "operationId": "List_all_Schedule_for_User_MonetaryAccount", "description": "Get a collection of scheduled definition for a given monetary account. You can add the parameter type to filter the response. When type={SCHEDULE_DEFINITION_PAYMENT,SCHEDULE_DEFINITION_PAYMENT_BATCH} is provided only schedule definition object that relate to these definitions are returned.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "view for reading the scheduled definitions.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ScheduleListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/schedule": { "get": { "tags": [ "schedule" ], "summary": "", "operationId": "List_all_Schedule_for_User", "description": "Get a collection of scheduled definition for all accessible monetary accounts of the user. You can add the parameter type to filter the response. When type={SCHEDULE_DEFINITION_PAYMENT,SCHEDULE_DEFINITION_PAYMENT_BATCH} is provided only schedule definition object that relate to these definitions are returned.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "view for reading the scheduled definitions.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ScheduleUserListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule\/{scheduleID}\/schedule-instance\/{itemId}": { "get": { "tags": [ "schedule-instance" ], "summary": "", "operationId": "Read_ScheduleInstance_for_User_MonetaryAccount_Schedule", "description": "view for reading, updating and listing the scheduled instance.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "scheduleID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "view for reading, updating and listing the scheduled instance.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ScheduleInstanceRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "schedule-instance" ], "summary": "", "operationId": "Update_ScheduleInstance_for_User_MonetaryAccount_Schedule", "description": "view for reading, updating and listing the scheduled instance.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "scheduleID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ScheduleInstance" } } } }, "responses": { "200": { "description": "view for reading, updating and listing the scheduled instance.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ScheduleInstanceUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule\/{scheduleID}\/schedule-instance": { "get": { "tags": [ "schedule-instance" ], "summary": "", "operationId": "List_all_ScheduleInstance_for_User_MonetaryAccount_Schedule", "description": "view for reading, updating and listing the scheduled instance.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "scheduleID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "view for reading, updating and listing the scheduled instance.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ScheduleInstanceListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule-payment\/{itemId}": { "delete": { "tags": [ "schedule-payment" ], "summary": "", "operationId": "Delete_SchedulePayment_for_User_MonetaryAccount", "description": "Endpoint for schedule payments.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Endpoint for schedule payments.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchedulePaymentDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "schedule-payment" ], "summary": "", "operationId": "Read_SchedulePayment_for_User_MonetaryAccount", "description": "Endpoint for schedule payments.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Endpoint for schedule payments.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchedulePaymentRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "schedule-payment" ], "summary": "", "operationId": "Update_SchedulePayment_for_User_MonetaryAccount", "description": "Endpoint for schedule payments.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchedulePayment" } } } }, "responses": { "200": { "description": "Endpoint for schedule payments.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchedulePaymentUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule-payment": { "post": { "tags": [ "schedule-payment" ], "summary": "", "operationId": "Create_SchedulePayment_for_User_MonetaryAccount", "description": "Endpoint for schedule payments.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchedulePayment" } } } }, "responses": { "200": { "description": "Endpoint for schedule payments.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchedulePaymentCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "schedule-payment" ], "summary": "", "operationId": "List_all_SchedulePayment_for_User_MonetaryAccount", "description": "Endpoint for schedule payments.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Endpoint for schedule payments.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SchedulePaymentListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule-payment-batch\/{itemId}": { "put": { "tags": [ "schedule-payment-batch" ], "summary": "", "operationId": "Update_SchedulePaymentBatch_for_User_MonetaryAccount", "description": "Endpoint for schedule payment batches.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchedulePaymentBatch" } } } }, "responses": { "200": { "description": "Endpoint for schedule payment batches.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchedulePaymentBatchUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "schedule-payment-batch" ], "summary": "", "operationId": "Delete_SchedulePaymentBatch_for_User_MonetaryAccount", "description": "Endpoint for schedule payment batches.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Endpoint for schedule payment batches.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchedulePaymentBatchDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/schedule-payment-batch": { "post": { "tags": [ "schedule-payment-batch" ], "summary": "", "operationId": "Create_SchedulePaymentBatch_for_User_MonetaryAccount", "description": "Endpoint for schedule payment batches.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchedulePaymentBatch" } } } }, "responses": { "200": { "description": "Endpoint for schedule payment batches.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchedulePaymentBatchCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/installation\/{installationID}\/server-public-key": { "get": { "tags": [ "server-public-key" ], "summary": "", "operationId": "List_all_ServerPublicKey_for_Installation", "description": "Show the ServerPublicKey for this Installation.", "parameters": [ { "in": "path", "name": "installationID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Using \/installation\/_\/server-public-key you can request the ServerPublicKey again. This is done by referring to the id of the Installation.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InstallationServerPublicKeyListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/session\/{itemId}": { "delete": { "tags": [ "session" ], "summary": "", "operationId": "Delete_Session", "description": "Deletes the current session.", "parameters": [ { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Endpoint for operations over the current session.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SessionDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/session-server": { "post": { "tags": [ "session-server" ], "summary": "", "operationId": "Create_SessionServer", "description": "Create a new session for a DeviceServer. Provide the Installation token in the \"X-Bunq-Client-Authentication\" header. And don't forget to create the \"X-Bunq-Client-Signature\" header. The response contains a Session token that should be used for as the \"X-Bunq-Client-Authentication\" header for all future API calls. The ip address making this call needs to match the ip address bound to your API key.", "parameters": [ { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SessionServer" } } } }, "responses": { "200": { "description": "Once you have created an Installation and a DeviceServer with that Installation, then you are ready to start a session! A session expires after the same amount of time you have set for Auto Logout in your user account. By default this is 1 week. If a request is made 30 seconds before a session expires, it will be extended from that moment by your auto logout time, but never by more than 5 minutes.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SessionServerCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/share-invite-bank-inquiry": { "post": { "tags": [ "share-invite-bank-inquiry" ], "summary": "", "operationId": "Create_ShareInviteBankInquiry_for_User_MonetaryAccount", "description": "[DEPRECATED - use \/share-invite-monetary-account-inquiry] Create a new share inquiry for a monetary account, specifying the permission the other bunq user will have on it.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteBankInquiry" } } } }, "responses": { "200": { "description": "[DEPRECATED - use \/share-invite-monetary-account-inquiry] Used to share a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. Allow the creation of share inquiries that, in the same way as request inquiries, can be revoked by the user creating them or accepted\/rejected by the other party.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteBankInquiryCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "share-invite-bank-inquiry" ], "summary": "", "operationId": "List_all_ShareInviteBankInquiry_for_User_MonetaryAccount", "description": "[DEPRECATED - use \/share-invite-monetary-account-inquiry] Get a list with all the share inquiries for a monetary account, only if the requesting user has permission to change the details of the various ones.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "[DEPRECATED - use \/share-invite-monetary-account-inquiry] Used to share a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. Allow the creation of share inquiries that, in the same way as request inquiries, can be revoked by the user creating them or accepted\/rejected by the other party.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ShareInviteBankInquiryListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/share-invite-bank-inquiry\/{itemId}": { "get": { "tags": [ "share-invite-bank-inquiry" ], "summary": "", "operationId": "Read_ShareInviteBankInquiry_for_User_MonetaryAccount", "description": "[DEPRECATED - use \/share-invite-monetary-account-inquiry] Get the details of a specific share inquiry.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "[DEPRECATED - use \/share-invite-monetary-account-inquiry] Used to share a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. Allow the creation of share inquiries that, in the same way as request inquiries, can be revoked by the user creating them or accepted\/rejected by the other party.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteBankInquiryRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "share-invite-bank-inquiry" ], "summary": "", "operationId": "Update_ShareInviteBankInquiry_for_User_MonetaryAccount", "description": "[DEPRECATED - use \/share-invite-monetary-account-inquiry] Update the details of a share. This includes updating status (revoking or cancelling it), granted permission and validity period of this share.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteBankInquiry" } } } }, "responses": { "200": { "description": "[DEPRECATED - use \/share-invite-monetary-account-inquiry] Used to share a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. Allow the creation of share inquiries that, in the same way as request inquiries, can be revoked by the user creating them or accepted\/rejected by the other party.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteBankInquiryUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/share-invite-bank-response": { "get": { "tags": [ "share-invite-bank-response" ], "summary": "", "operationId": "List_all_ShareInviteBankResponse_for_User", "description": "Return all the shares a user was invited to.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view or respond to shares a user was invited to. See 'share-invite-bank-inquiry' for more information about the inquiring endpoint.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ShareInviteBankResponseListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/share-invite-bank-response\/{itemId}": { "get": { "tags": [ "share-invite-bank-response" ], "summary": "", "operationId": "Read_ShareInviteBankResponse_for_User", "description": "Return the details of a specific share a user was invited to.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view or respond to shares a user was invited to. See 'share-invite-bank-inquiry' for more information about the inquiring endpoint.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteBankResponseRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "share-invite-bank-response" ], "summary": "", "operationId": "Update_ShareInviteBankResponse_for_User", "description": "Accept or reject a share a user was invited to.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteBankResponse" } } } }, "responses": { "200": { "description": "Used to view or respond to shares a user was invited to. See 'share-invite-bank-inquiry' for more information about the inquiring endpoint.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteBankResponseUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/share-invite-monetary-account-inquiry": { "post": { "tags": [ "share-invite-monetary-account-inquiry" ], "summary": "", "operationId": "Create_ShareInviteMonetaryAccountInquiry_for_User_MonetaryAccount", "description": "[DEPRECATED - use \/share-invite-monetary-account-response] Create a new share inquiry for a monetary account, specifying the permission the other bunq user will have on it.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteMonetaryAccountInquiry" } } } }, "responses": { "200": { "description": "[DEPRECATED - use \/share-invite-monetary-account-response] Used to share a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. Allow the creation of share inquiries that, in the same way as request inquiries, can be revoked by the user creating them or accepted\/rejected by the other party.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteMonetaryAccountInquiryCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "share-invite-monetary-account-inquiry" ], "summary": "", "operationId": "List_all_ShareInviteMonetaryAccountInquiry_for_User_MonetaryAccount", "description": "[DEPRECATED - use \/share-invite-monetary-account-response] Get a list with all the share inquiries for a monetary account, only if the requesting user has permission to change the details of the various ones.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "[DEPRECATED - use \/share-invite-monetary-account-response] Used to share a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. Allow the creation of share inquiries that, in the same way as request inquiries, can be revoked by the user creating them or accepted\/rejected by the other party.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ShareInviteMonetaryAccountInquiryListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/share-invite-monetary-account-inquiry\/{itemId}": { "get": { "tags": [ "share-invite-monetary-account-inquiry" ], "summary": "", "operationId": "Read_ShareInviteMonetaryAccountInquiry_for_User_MonetaryAccount", "description": "[DEPRECATED - use \/share-invite-monetary-account-response] Get the details of a specific share inquiry.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "[DEPRECATED - use \/share-invite-monetary-account-response] Used to share a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. Allow the creation of share inquiries that, in the same way as request inquiries, can be revoked by the user creating them or accepted\/rejected by the other party.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteMonetaryAccountInquiryRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "share-invite-monetary-account-inquiry" ], "summary": "", "operationId": "Update_ShareInviteMonetaryAccountInquiry_for_User_MonetaryAccount", "description": "[DEPRECATED - use \/share-invite-monetary-account-response] Update the details of a share. This includes updating status (revoking or cancelling it), granted permission and validity period of this share.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteMonetaryAccountInquiry" } } } }, "responses": { "200": { "description": "[DEPRECATED - use \/share-invite-monetary-account-response] Used to share a monetary account with another bunq user, as in the 'Connect' feature in the bunq app. Allow the creation of share inquiries that, in the same way as request inquiries, can be revoked by the user creating them or accepted\/rejected by the other party.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteMonetaryAccountInquiryUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/share-invite-monetary-account-response": { "get": { "tags": [ "share-invite-monetary-account-response" ], "summary": "", "operationId": "List_all_ShareInviteMonetaryAccountResponse_for_User", "description": "Return all the shares a user was invited to.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view or respond to shares a user was invited to. See 'share-invite-bank-inquiry' for more information about the inquiring endpoint.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ShareInviteMonetaryAccountResponseListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/share-invite-monetary-account-response\/{itemId}": { "get": { "tags": [ "share-invite-monetary-account-response" ], "summary": "", "operationId": "Read_ShareInviteMonetaryAccountResponse_for_User", "description": "Return the details of a specific share a user was invited to.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view or respond to shares a user was invited to. See 'share-invite-bank-inquiry' for more information about the inquiring endpoint.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteMonetaryAccountResponseRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "share-invite-monetary-account-response" ], "summary": "", "operationId": "Update_ShareInviteMonetaryAccountResponse_for_User", "description": "Accept or reject a share a user was invited to.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteMonetaryAccountResponse" } } } }, "responses": { "200": { "description": "Used to view or respond to shares a user was invited to. See 'share-invite-bank-inquiry' for more information about the inquiring endpoint.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShareInviteMonetaryAccountResponseUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/sofort-merchant-transaction": { "get": { "tags": [ "sofort-merchant-transaction" ], "summary": "", "operationId": "List_all_SofortMerchantTransaction_for_User_MonetaryAccount", "description": "View for requesting Sofort transactions and polling their status.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "View for requesting Sofort transactions and polling their status.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SofortMerchantTransactionListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/sofort-merchant-transaction\/{itemId}": { "get": { "tags": [ "sofort-merchant-transaction" ], "summary": "", "operationId": "Read_SofortMerchantTransaction_for_User_MonetaryAccount", "description": "View for requesting Sofort transactions and polling their status.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "View for requesting Sofort transactions and polling their status.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SofortMerchantTransactionRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/event\/{eventID}\/statement": { "post": { "tags": [ "statement" ], "summary": "", "operationId": "Create_Statement_for_User_MonetaryAccount_Event", "description": "Used to create a statement export of a single payment.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "eventID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExportStatementPayment" } } } }, "responses": { "200": { "description": "Used to create a statement export of a single payment.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExportStatementPaymentCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/event\/{eventID}\/statement\/{itemId}": { "get": { "tags": [ "statement" ], "summary": "", "operationId": "Read_Statement_for_User_MonetaryAccount_Event", "description": "Used to create a statement export of a single payment.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "eventID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to create a statement export of a single payment.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExportStatementPaymentRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/switch-service-payment\/{itemId}": { "get": { "tags": [ "switch-service-payment" ], "summary": "", "operationId": "Read_SwitchServicePayment_for_User_MonetaryAccount", "description": "An incoming payment made towards an account of an external bank and redirected to a bunq account via switch service.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "An incoming payment made towards an account of an external bank and redirected to a bunq account via switch service.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BankSwitchServiceNetherlandsIncomingPaymentRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/tab\/{itemId}": { "get": { "tags": [ "tab" ], "summary": "", "operationId": "Read_Tab", "description": "Get a publicly visible tab.", "parameters": [ { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to read a single publicly visible tab.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/tab\/{itemId}": { "get": { "tags": [ "tab" ], "summary": "", "operationId": "Read_Tab_for_User_MonetaryAccount_CashRegister", "description": "Get a specific tab. This returns a TabUsageSingle or TabUsageMultiple.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Once your CashRegister has been activated you can use it to create Tabs. A Tab is a template for a payment. In contrast to requests a Tab is not pointed towards a specific user. Any user can pay the Tab as long as it is made visible by you. The creation of a Tab happens with \/tab-usage-single or \/tab-usage-multiple. A TabUsageSingle is a Tab that can be paid once. A TabUsageMultiple is a Tab that can be paid multiple times by different users.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/tab": { "get": { "tags": [ "tab" ], "summary": "", "operationId": "List_all_Tab_for_User_MonetaryAccount_CashRegister", "description": "Get a collection of tabs.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Once your CashRegister has been activated you can use it to create Tabs. A Tab is a template for a payment. In contrast to requests a Tab is not pointed towards a specific user. Any user can pay the Tab as long as it is made visible by you. The creation of a Tab happens with \/tab-usage-single or \/tab-usage-multiple. A TabUsageSingle is a Tab that can be paid once. A TabUsageMultiple is a Tab that can be paid multiple times by different users.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TabListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/tab\/{tabUUID}\/tab-item": { "post": { "tags": [ "tab-item" ], "summary": "", "operationId": "Create_TabItem_for_User_MonetaryAccount_CashRegister_Tab", "description": "Create a new TabItem for a given Tab.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "tabUUID", "description": "", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabItemShop" } } } }, "responses": { "200": { "description": "After you\u2019ve created a Tab using \/tab-usage-single or \/tab-usage-multiple you can add items and attachments using tab-item. You can only add or modify TabItems of a Tab which status is OPEN. The amount of the TabItems will not influence the total_amount of the corresponding Tab. However, if you've created any TabItems for a Tab the sum of the amounts of these items must be equal to the total_amount of the Tab when you change its status to PAYABLE\/WAITING_FOR_PAYMENT.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabItemShopCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "tab-item" ], "summary": "", "operationId": "List_all_TabItem_for_User_MonetaryAccount_CashRegister_Tab", "description": "Get a collection of TabItems from a given Tab.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "tabUUID", "description": "", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "After you\u2019ve created a Tab using \/tab-usage-single or \/tab-usage-multiple you can add items and attachments using tab-item. You can only add or modify TabItems of a Tab which status is OPEN. The amount of the TabItems will not influence the total_amount of the corresponding Tab. However, if you've created any TabItems for a Tab the sum of the amounts of these items must be equal to the total_amount of the Tab when you change its status to PAYABLE\/WAITING_FOR_PAYMENT.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TabItemShopListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/tab\/{tabUUID}\/tab-item\/{itemId}": { "put": { "tags": [ "tab-item" ], "summary": "", "operationId": "Update_TabItem_for_User_MonetaryAccount_CashRegister_Tab", "description": "Modify a TabItem from a given Tab.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "tabUUID", "description": "", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabItemShop" } } } }, "responses": { "200": { "description": "After you\u2019ve created a Tab using \/tab-usage-single or \/tab-usage-multiple you can add items and attachments using tab-item. You can only add or modify TabItems of a Tab which status is OPEN. The amount of the TabItems will not influence the total_amount of the corresponding Tab. However, if you've created any TabItems for a Tab the sum of the amounts of these items must be equal to the total_amount of the Tab when you change its status to PAYABLE\/WAITING_FOR_PAYMENT.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabItemShopUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "tab-item" ], "summary": "", "operationId": "Delete_TabItem_for_User_MonetaryAccount_CashRegister_Tab", "description": "Delete a specific TabItem from a Tab.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "tabUUID", "description": "", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "After you\u2019ve created a Tab using \/tab-usage-single or \/tab-usage-multiple you can add items and attachments using tab-item. You can only add or modify TabItems of a Tab which status is OPEN. The amount of the TabItems will not influence the total_amount of the corresponding Tab. However, if you've created any TabItems for a Tab the sum of the amounts of these items must be equal to the total_amount of the Tab when you change its status to PAYABLE\/WAITING_FOR_PAYMENT.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabItemShopDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "tab-item" ], "summary": "", "operationId": "Read_TabItem_for_User_MonetaryAccount_CashRegister_Tab", "description": "Get a specific TabItem from a given Tab.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "tabUUID", "description": "", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "After you\u2019ve created a Tab using \/tab-usage-single or \/tab-usage-multiple you can add items and attachments using tab-item. You can only add or modify TabItems of a Tab which status is OPEN. The amount of the TabItems will not influence the total_amount of the corresponding Tab. However, if you've created any TabItems for a Tab the sum of the amounts of these items must be equal to the total_amount of the Tab when you change its status to PAYABLE\/WAITING_FOR_PAYMENT.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabItemShopRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/tab\/{tabUUID}\/tab-item-batch": { "post": { "tags": [ "tab-item-batch" ], "summary": "", "operationId": "Create_TabItemBatch_for_User_MonetaryAccount_CashRegister_Tab", "description": "Create tab items as a batch.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "tabUUID", "description": "", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabItemShopBatch" } } } }, "responses": { "200": { "description": "Create a batch of tab items.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabItemShopBatchCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/tab\/{tabUUID}\/tab-result-inquiry\/{itemId}": { "get": { "tags": [ "tab-result-inquiry" ], "summary": "", "operationId": "Read_TabResultInquiry_for_User_MonetaryAccount_CashRegister_Tab", "description": "Used to view a single TabResultInquiry belonging to a tab.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "tabUUID", "description": "", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view TabResultInquiry objects belonging to a tab. A TabResultInquiry is an object that holds details on both the tab and a single payment made for that tab.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabResultInquiryRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/tab\/{tabUUID}\/tab-result-inquiry": { "get": { "tags": [ "tab-result-inquiry" ], "summary": "", "operationId": "List_all_TabResultInquiry_for_User_MonetaryAccount_CashRegister_Tab", "description": "Used to view a list of TabResultInquiry objects belonging to a tab.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "tabUUID", "description": "", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view TabResultInquiry objects belonging to a tab. A TabResultInquiry is an object that holds details on both the tab and a single payment made for that tab.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TabResultInquiryListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/tab-result-response\/{itemId}": { "get": { "tags": [ "tab-result-response" ], "summary": "", "operationId": "Read_TabResultResponse_for_User_MonetaryAccount", "description": "Used to view a single TabResultResponse belonging to a tab.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view TabResultResponse objects belonging to a tab. A TabResultResponse is an object that holds details on a tab which has been paid from the provided monetary account.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabResultResponseRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/tab-result-response": { "get": { "tags": [ "tab-result-response" ], "summary": "", "operationId": "List_all_TabResultResponse_for_User_MonetaryAccount", "description": "Used to view a list of TabResultResponse objects belonging to a tab.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view TabResultResponse objects belonging to a tab. A TabResultResponse is an object that holds details on a tab which has been paid from the provided monetary account.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TabResultResponseListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/tab-usage-multiple": { "post": { "tags": [ "tab-usage-multiple" ], "summary": "", "operationId": "Create_TabUsageMultiple_for_User_MonetaryAccount_CashRegister", "description": "Create a TabUsageMultiple. On creation the status must be set to OPEN", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabUsageMultiple" } } } }, "responses": { "200": { "description": "TabUsageMultiple is a Tab that can be paid by multiple users. Just like the TabUsageSingle it is created with the status OPEN, the visibility can be defined in the visibility object and TabItems can be added as long as the status is OPEN. When you change the status to PAYABLE any bunq user can use the tab to make a payment to your account. After an user has paid your TabUsageMultiple the status will not change, it will stay PAYABLE. For example: you can create a TabUsageMultiple with require_address set to true. Now show the QR code of this Tab on your webshop, and any bunq user can instantly pay and order something from your webshop.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabUsageMultipleCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "tab-usage-multiple" ], "summary": "", "operationId": "List_all_TabUsageMultiple_for_User_MonetaryAccount_CashRegister", "description": "Get a collection of TabUsageMultiple.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "TabUsageMultiple is a Tab that can be paid by multiple users. Just like the TabUsageSingle it is created with the status OPEN, the visibility can be defined in the visibility object and TabItems can be added as long as the status is OPEN. When you change the status to PAYABLE any bunq user can use the tab to make a payment to your account. After an user has paid your TabUsageMultiple the status will not change, it will stay PAYABLE. For example: you can create a TabUsageMultiple with require_address set to true. Now show the QR code of this Tab on your webshop, and any bunq user can instantly pay and order something from your webshop.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TabUsageMultipleListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/tab-usage-multiple\/{itemId}": { "put": { "tags": [ "tab-usage-multiple" ], "summary": "", "operationId": "Update_TabUsageMultiple_for_User_MonetaryAccount_CashRegister", "description": "Modify a specific TabUsageMultiple. You can change the amount_total, status and visibility. Once you change the status to PAYABLE the TabUsageMultiple will expire after a year (default). If you've created any TabItems for a Tab the sum of the amounts of these items must be equal to the total_amount of the Tab when you change its status to PAYABLE.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabUsageMultiple" } } } }, "responses": { "200": { "description": "TabUsageMultiple is a Tab that can be paid by multiple users. Just like the TabUsageSingle it is created with the status OPEN, the visibility can be defined in the visibility object and TabItems can be added as long as the status is OPEN. When you change the status to PAYABLE any bunq user can use the tab to make a payment to your account. After an user has paid your TabUsageMultiple the status will not change, it will stay PAYABLE. For example: you can create a TabUsageMultiple with require_address set to true. Now show the QR code of this Tab on your webshop, and any bunq user can instantly pay and order something from your webshop.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabUsageMultipleUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "tab-usage-multiple" ], "summary": "", "operationId": "Delete_TabUsageMultiple_for_User_MonetaryAccount_CashRegister", "description": "Close a specific TabUsageMultiple.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "TabUsageMultiple is a Tab that can be paid by multiple users. Just like the TabUsageSingle it is created with the status OPEN, the visibility can be defined in the visibility object and TabItems can be added as long as the status is OPEN. When you change the status to PAYABLE any bunq user can use the tab to make a payment to your account. After an user has paid your TabUsageMultiple the status will not change, it will stay PAYABLE. For example: you can create a TabUsageMultiple with require_address set to true. Now show the QR code of this Tab on your webshop, and any bunq user can instantly pay and order something from your webshop.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabUsageMultipleDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "tab-usage-multiple" ], "summary": "", "operationId": "Read_TabUsageMultiple_for_User_MonetaryAccount_CashRegister", "description": "Get a specific TabUsageMultiple.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "TabUsageMultiple is a Tab that can be paid by multiple users. Just like the TabUsageSingle it is created with the status OPEN, the visibility can be defined in the visibility object and TabItems can be added as long as the status is OPEN. When you change the status to PAYABLE any bunq user can use the tab to make a payment to your account. After an user has paid your TabUsageMultiple the status will not change, it will stay PAYABLE. For example: you can create a TabUsageMultiple with require_address set to true. Now show the QR code of this Tab on your webshop, and any bunq user can instantly pay and order something from your webshop.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabUsageMultipleRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/tab-usage-single\/{itemId}": { "put": { "tags": [ "tab-usage-single" ], "summary": "", "operationId": "Update_TabUsageSingle_for_User_MonetaryAccount_CashRegister", "description": "Modify a specific TabUsageSingle. You can change the amount_total, status and visibility. Once you change the status to WAITING_FOR_PAYMENT the TabUsageSingle will expire after 5 minutes (default) or up to 1 hour if a different expiration is provided.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabUsageSingle" } } } }, "responses": { "200": { "description": "TabUsageSingle is a Tab that can be paid once. The TabUsageSingle is created with the status OPEN. Optionally you can add TabItems to the tab using \/tab\/_\/tab-item, TabItems don't affect the total amount of the Tab. However, if you've created any TabItems for a Tab the sum of the amounts of these items must be equal to the total_amount of the Tab when you change its status to WAITING_FOR_PAYMENT. By setting the visibility object a TabUsageSingle with the status OPEN or WAITING_FOR_PAYMENT can be made visible to customers. As soon as a customer pays the TabUsageSingle its status changes to PAID, and it can't be paid again.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabUsageSingleUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "tab-usage-single" ], "summary": "", "operationId": "Delete_TabUsageSingle_for_User_MonetaryAccount_CashRegister", "description": "Cancel a specific TabUsageSingle.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "TabUsageSingle is a Tab that can be paid once. The TabUsageSingle is created with the status OPEN. Optionally you can add TabItems to the tab using \/tab\/_\/tab-item, TabItems don't affect the total amount of the Tab. However, if you've created any TabItems for a Tab the sum of the amounts of these items must be equal to the total_amount of the Tab when you change its status to WAITING_FOR_PAYMENT. By setting the visibility object a TabUsageSingle with the status OPEN or WAITING_FOR_PAYMENT can be made visible to customers. As soon as a customer pays the TabUsageSingle its status changes to PAID, and it can't be paid again.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabUsageSingleDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "tab-usage-single" ], "summary": "", "operationId": "Read_TabUsageSingle_for_User_MonetaryAccount_CashRegister", "description": "Get a specific TabUsageSingle.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "TabUsageSingle is a Tab that can be paid once. The TabUsageSingle is created with the status OPEN. Optionally you can add TabItems to the tab using \/tab\/_\/tab-item, TabItems don't affect the total amount of the Tab. However, if you've created any TabItems for a Tab the sum of the amounts of these items must be equal to the total_amount of the Tab when you change its status to WAITING_FOR_PAYMENT. By setting the visibility object a TabUsageSingle with the status OPEN or WAITING_FOR_PAYMENT can be made visible to customers. As soon as a customer pays the TabUsageSingle its status changes to PAID, and it can't be paid again.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabUsageSingleRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/monetary-account\/{monetary-accountID}\/cash-register\/{cash-registerID}\/tab-usage-single": { "post": { "tags": [ "tab-usage-single" ], "summary": "", "operationId": "Create_TabUsageSingle_for_User_MonetaryAccount_CashRegister", "description": "Create a TabUsageSingle. The initial status must be OPEN", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabUsageSingle" } } } }, "responses": { "200": { "description": "TabUsageSingle is a Tab that can be paid once. The TabUsageSingle is created with the status OPEN. Optionally you can add TabItems to the tab using \/tab\/_\/tab-item, TabItems don't affect the total amount of the Tab. However, if you've created any TabItems for a Tab the sum of the amounts of these items must be equal to the total_amount of the Tab when you change its status to WAITING_FOR_PAYMENT. By setting the visibility object a TabUsageSingle with the status OPEN or WAITING_FOR_PAYMENT can be made visible to customers. As soon as a customer pays the TabUsageSingle its status changes to PAID, and it can't be paid again.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TabUsageSingleCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "tab-usage-single" ], "summary": "", "operationId": "List_all_TabUsageSingle_for_User_MonetaryAccount_CashRegister", "description": "Get a collection of TabUsageSingle.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "monetary-accountID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "cash-registerID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "TabUsageSingle is a Tab that can be paid once. The TabUsageSingle is created with the status OPEN. Optionally you can add TabItems to the tab using \/tab\/_\/tab-item, TabItems don't affect the total amount of the Tab. However, if you've created any TabItems for a Tab the sum of the amounts of these items must be equal to the total_amount of the Tab when you change its status to WAITING_FOR_PAYMENT. By setting the visibility object a TabUsageSingle with the status OPEN or WAITING_FOR_PAYMENT can be made visible to customers. As soon as a customer pays the TabUsageSingle its status changes to PAID, and it can't be paid again.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TabUsageSingleListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/token-qr-request-ideal": { "post": { "tags": [ "token-qr-request-ideal" ], "summary": "", "operationId": "Create_TokenQrRequestIdeal_for_User", "description": "Create a request from an ideal transaction.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TokenQrRequestIdeal" } } } }, "responses": { "200": { "description": "Using this call you create a request for payment from an external token provided with an ideal transaction. Make sure your iDEAL payments are compliant with the iDEAL standards, by following the following manual: https:\/www.bunq.com\/terms-idealstandards. It's very important to keep these points in mind when you are using the endpoint to make iDEAL payments from your application.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TokenQrRequestIdealCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/token-qr-request-sofort": { "post": { "tags": [ "token-qr-request-sofort" ], "summary": "", "operationId": "Create_TokenQrRequestSofort_for_User", "description": "Create a request from an SOFORT transaction.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TokenQrRequestSofort" } } } }, "responses": { "200": { "description": "Using this call you can create a SOFORT Request assigned to your User by providing the Token of the request.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TokenQrRequestSofortCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/transferwise-quote\/{transferwise-quoteID}\/transferwise-transfer\/{itemId}": { "get": { "tags": [ "transferwise-transfer" ], "summary": "", "operationId": "Read_TransferwiseTransfer_for_User_TransferwiseQuote", "description": "Used to create Transferwise payments.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "transferwise-quoteID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to create Transferwise payments.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransferwiseTransferRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{itemId}": { "get": { "tags": [ "user" ], "summary": "", "operationId": "Read_User", "description": "Get a specific user.", "parameters": [ { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Using this call you can retrieve information of the user you are logged in as. This includes your user id, which is referred to in endpoints.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user": { "get": { "tags": [ "user" ], "summary": "", "operationId": "List_all_User", "description": "Get a collection of all available users.", "parameters": [ { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Using this call you can retrieve information of the user you are logged in as. This includes your user id, which is referred to in endpoints.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UserListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user-company\/{itemId}": { "get": { "tags": [ "user-company" ], "summary": "", "operationId": "Read_UserCompany", "description": "Get a specific company.", "parameters": [ { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "With UserCompany you can retrieve information regarding the authenticated UserCompany and update specific fields.Notification filters can be set on a UserCompany level to receive callbacks. For more information check the dedicated callbacks page<\/a>.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserCompanyRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "user-company" ], "summary": "", "operationId": "Update_UserCompany", "description": "Modify a specific company's data.", "parameters": [ { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserCompany" } } } }, "responses": { "200": { "description": "With UserCompany you can retrieve information regarding the authenticated UserCompany and update specific fields.Notification filters can be set on a UserCompany level to receive callbacks. For more information check the dedicated callbacks page<\/a>.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserCompanyUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user-payment-service-provider\/{itemId}": { "get": { "tags": [ "user-payment-service-provider" ], "summary": "", "operationId": "Read_UserPaymentServiceProvider", "description": "Used to view UserPaymentServiceProvider for session creation.", "parameters": [ { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Used to view UserPaymentServiceProvider for session creation.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserPaymentServiceProviderRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user-person\/{itemId}": { "get": { "tags": [ "user-person" ], "summary": "", "operationId": "Read_UserPerson", "description": "Get a specific person.", "parameters": [ { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "With UserPerson you can retrieve information regarding the authenticated UserPerson and update specific fields.Notification filters can be set on a UserPerson level to receive callbacks. For more information check the dedicated callbacks page<\/a>.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserPersonRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "user-person" ], "summary": "", "operationId": "Update_UserPerson", "description": "Modify a specific person object's data.", "parameters": [ { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserPerson" } } } }, "responses": { "200": { "description": "With UserPerson you can retrieve information regarding the authenticated UserPerson and update specific fields.Notification filters can be set on a UserPerson level to receive callbacks. For more information check the dedicated callbacks page<\/a>.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserPersonUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/whitelist-sdd\/{itemId}": { "get": { "tags": [ "whitelist-sdd" ], "summary": "", "operationId": "Read_WhitelistSdd_for_User", "description": "Get a specific SDD whitelist entry.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Whitelist an SDD so that when one comes in, it is automatically accepted.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WhitelistSddRead" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "put": { "tags": [ "whitelist-sdd" ], "summary": "", "operationId": "Update_WhitelistSdd_for_User", "description": "Whitelist an SDD so that when one comes in, it is automatically accepted.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WhitelistSdd" } } } }, "responses": { "200": { "description": "Whitelist an SDD so that when one comes in, it is automatically accepted.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WhitelistSddUpdate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "delete": { "tags": [ "whitelist-sdd" ], "summary": "", "operationId": "Delete_WhitelistSdd_for_User", "description": "Whitelist an SDD so that when one comes in, it is automatically accepted.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "in": "path", "name": "itemId", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Whitelist an SDD so that when one comes in, it is automatically accepted.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WhitelistSddDelete" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } }, "\/user\/{userID}\/whitelist-sdd": { "post": { "tags": [ "whitelist-sdd" ], "summary": "", "operationId": "Create_WhitelistSdd_for_User", "description": "Create a new SDD whitelist entry.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "requestBody": { "description": "", "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WhitelistSdd" } } } }, "responses": { "200": { "description": "Whitelist an SDD so that when one comes in, it is automatically accepted.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WhitelistSddCreate" } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } }, "get": { "tags": [ "whitelist-sdd" ], "summary": "", "operationId": "List_all_WhitelistSdd_for_User", "description": "Get a listing of all SDD whitelist entries for a target monetary account.", "parameters": [ { "in": "path", "name": "userID", "description": "", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/Cache-Control" }, { "$ref": "#\/components\/parameters\/User-Agent" }, { "$ref": "#\/components\/parameters\/X-Bunq-Language" }, { "$ref": "#\/components\/parameters\/X-Bunq-Region" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Request-Id" }, { "$ref": "#\/components\/parameters\/X-Bunq-Geolocation" }, { "$ref": "#\/components\/parameters\/X-Bunq-Client-Authentication" } ], "responses": { "200": { "description": "Whitelist an SDD so that when one comes in, it is automatically accepted.", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WhitelistSddListing" } } } }, "headers": { "X-Bunq-Client-Response-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Response-Id" }, "X-Bunq-Client-Request-Id": { "$ref": "#\/components\/headers\/X-Bunq-Client-Request-Id" }, "X-Bunq-Server-Signature": { "$ref": "#\/components\/headers\/X-Bunq-Server-Signature" } } }, "400": { "$ref": "#\/components\/responses\/GenericError" } } } } }, "tags": [ { "name": "amount-used", "description": "" }, { "name": "attachment", "description": "" }, { "name": "attachment-public", "description": "" }, { "name": "attachment-tab", "description": "" }, { "name": "avatar", "description": "" }, { "name": "billing-contract-subscription", "description": "" }, { "name": "bunqme-fundraiser-profile", "description": "" }, { "name": "bunqme-fundraiser-result", "description": "" }, { "name": "bunqme-tab", "description": "" }, { "name": "bunqme-tab-result-response", "description": "" }, { "name": "callback-url", "description": "" }, { "name": "card", "description": "" }, { "name": "card-batch", "description": "" }, { "name": "card-debit", "description": "" }, { "name": "card-name", "description": "" }, { "name": "cash-register", "description": "" }, { "name": "certificate-pinned", "description": "" }, { "name": "confirmation-of-funds", "description": "" }, { "name": "content", "description": "" }, { "name": "credential-password-ip", "description": "" }, { "name": "customer-statement", "description": "" }, { "name": "device", "description": "" }, { "name": "device-server", "description": "" }, { "name": "draft-payment", "description": "" }, { "name": "draft-share-invite-api-key", "description": "" }, { "name": "draft-share-invite-bank", "description": "" }, { "name": "event", "description": "" }, { "name": "export-annual-overview", "description": "" }, { "name": "export-rib", "description": "" }, { "name": "feature-announcement", "description": "" }, { "name": "generated-cvc2", "description": "" }, { "name": "ideal-merchant-transaction", "description": "" }, { "name": "installation", "description": "" }, { "name": "invoice", "description": "" }, { "name": "ip", "description": "" }, { "name": "legal-name", "description": "" }, { "name": "limit", "description": "" }, { "name": "mastercard-action", "description": "" }, { "name": "monetary-account", "description": "" }, { "name": "monetary-account-bank", "description": "" }, { "name": "monetary-account-joint", "description": "" }, { "name": "monetary-account-savings", "description": "" }, { "name": "name", "description": "" }, { "name": "note-attachment", "description": "" }, { "name": "note-text", "description": "" }, { "name": "notification-filter-push", "description": "" }, { "name": "notification-filter-url", "description": "" }, { "name": "oauth-client", "description": "" }, { "name": "payment", "description": "" }, { "name": "payment-batch", "description": "" }, { "name": "payment-service-provider-credential", "description": "" }, { "name": "pdf-content", "description": "" }, { "name": "qr-code", "description": "" }, { "name": "qr-code-content", "description": "" }, { "name": "replace", "description": "" }, { "name": "request-inquiry", "description": "" }, { "name": "request-inquiry-batch", "description": "" }, { "name": "request-response", "description": "" }, { "name": "reward", "description": "" }, { "name": "reward-recipient", "description": "" }, { "name": "reward-sender", "description": "" }, { "name": "sandbox-user", "description": "" }, { "name": "schedule", "description": "" }, { "name": "schedule-instance", "description": "" }, { "name": "schedule-payment", "description": "" }, { "name": "schedule-payment-batch", "description": "" }, { "name": "server-public-key", "description": "" }, { "name": "session", "description": "" }, { "name": "session-server", "description": "" }, { "name": "share-invite-bank-inquiry", "description": "" }, { "name": "share-invite-bank-response", "description": "" }, { "name": "share-invite-monetary-account-inquiry", "description": "" }, { "name": "share-invite-monetary-account-response", "description": "" }, { "name": "sofort-merchant-transaction", "description": "" }, { "name": "statement", "description": "" }, { "name": "switch-service-payment", "description": "" }, { "name": "tab", "description": "" }, { "name": "tab-item", "description": "" }, { "name": "tab-item-batch", "description": "" }, { "name": "tab-result-inquiry", "description": "" }, { "name": "tab-result-response", "description": "" }, { "name": "tab-usage-multiple", "description": "" }, { "name": "tab-usage-single", "description": "" }, { "name": "token-qr-request-ideal", "description": "" }, { "name": "token-qr-request-sofort", "description": "" }, { "name": "transferwise-transfer", "description": "" }, { "name": "user", "description": "" }, { "name": "user-company", "description": "" }, { "name": "user-payment-service-provider", "description": "" }, { "name": "user-person", "description": "" }, { "name": "whitelist-sdd", "description": "" } ] }