***UPDATE:*** *We have released a [beta version of the new bunq API documentation.](https://beta.doc.bunq.com)* ***NOTICE:*** *We have updated the sandbox base url to `https://public-api.sandbox.bunq.com/v1/`. Please update your applications accordingly. Check here: for more info.* ***PSD2 NOTIC
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://public-api.sandbox.bunq.com/{basePath} https://api.bunq.com/{basePath}
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
***UPDATE:*** *We have released a [beta version of the new bunq API documentation.](https://beta.doc.bunq.com)* ***NOTICE:*** *We have updated the sandbox base url to `https://public-api.sandbox.bunq.com/v1/`. Please update your applications accordingly. Check here: for more info.* ***PSD2 NOTICE:*** *The second Payment Services Directive (PSD2) may affect your current or planned usage of our
| method | path | what the vendor says it does |
|---|---|---|
POST | /attachment-public | Create a new public attachment. Create a POST request with a payload that contains a binary representation of |
GET | /attachment-public/{attachment-publicUUID}/content | Get the raw content of a specific attachment. content |
GET | /attachment-public/{itemId} | Get a specific attachment's metadata through its UUID. The Content-Type header of the response will describe t |
POST | /avatar | Avatars are public images used to represent you or your company. Avatars are used to represent users, monetary |
GET | /avatar/{itemId} | Avatars are public images used to represent you or your company. Avatars are used to represent users, monetary |
GET | /device | Get a collection of Devices. A Device is either a DevicePhone or a DeviceServer. device |
GET | /device-server | Get a collection of all the DeviceServers you have created. device-server |
POST | /device-server | Create a new DeviceServer providing the installation token in the header and signing the request with the priv |
GET | /device-server/{itemId} | Get one of your DeviceServers. device-server |
GET | /device/{itemId} | Get a single Device. A Device is either a DevicePhone or a DeviceServer. device |
GET | /installation | You must have an active session to make this call. This call returns the Id of the the Installation you are us |
POST | /installation | This is the only API call that does not require you to use the "X-Bunq-Client-Authentication" and "X-Bunq-Clie |
GET | /installation/{installationID}/server-public-key | Show the ServerPublicKey for this Installation. server-public-key |
GET | /installation/{itemId} | You must have an active session to make this call. This call is used to check whether the Id you provide is th |
POST | /payment-service-provider-credential | Register a Payment Service Provider and provide credentials payment-service-provider-credential |
GET | /payment-service-provider-credential/{itemId} | Register a Payment Service Provider and provide credentials payment-service-provider-credential |
GET | /place-lookup/{place-lookupID}/photo/{photoID}/content | View endpoint for place opening periods. content |
POST | /sandbox-user-company | Used to create a sandbox userCompany. sandbox-user-company |
POST | /sandbox-user-person | Used to create a sandbox userPerson. sandbox-user-person |
POST | /server-error | An endpoint that will always throw an error. server-error |
POST | /session-server | Create a new session for a DeviceServer. Provide the Installation token in the "X-Bunq-Client-Authentication" |
DELETE | /session/{itemId} | Deletes the current session. session |
GET | /user | Get a collection of all available users. user |
GET | /user-company/{itemId} | Get a specific company. user-company |
PUT | /user-company/{itemId} | Modify a specific company's data. user-company |
GET | /user-company/{user-companyID}/name | Return all the known (trade) names for a specific user company. name |
GET | /user-payment-service-provider/{itemId} | Used to view UserPaymentServiceProvider for session creation. user-payment-service-provider |
GET | /user-person/{itemId} | Get a specific person. user-person |
PUT | /user-person/{itemId} | Modify a specific person object's data. user-person |
GET | /user/{itemId} | Get a specific user. user |
GET | /user/{userID}/attachment/{attachmentID}/content | Get the raw content of a specific attachment. content |
GET | /user/{userID}/attachment/{itemId} | Get a specific attachment. The header of the response contains the content-type of the attachment. attachment |
GET | /user/{userID}/billing-contract-subscription | Get all subscription billing contract for the authenticated user. billing-contract-subscription |
GET | /user/{userID}/bunqme-fundraiser-profile | bunq.me public profile of the user. bunqme-fundraiser-profile |
GET | /user/{userID}/bunqme-fundraiser-profile/{itemId} | bunq.me public profile of the user. bunqme-fundraiser-profile |
GET | /user/{userID}/card | Return all the cards available to the user. card |
POST | /user/{userID}/card-batch | Used to update multiple cards in a batch. card-batch |
POST | /user/{userID}/card-batch-replace | Used to replace multiple cards in a batch. card-batch-replace |
POST | /user/{userID}/card-credit | Create a new credit card request. card-credit |
POST | /user/{userID}/card-debit | Create a new debit card request. card-debit |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/bunq/doc/master/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.