bunq Transferwise Recipient Requirement API

openapi: 3.2.0
info:
  title: bunq Transferwise Recipient Requirement API
  description: '***UPDATE:*** *We have released a beta version of the new bunq API documentation.*


    ***NOTICE:*** *We have updated the sandbox base url to `https://public-api.sandbox.bunq.com/v1/`. Please update your applications accordingly. Check here: for more info.*


    ***PSD2 NOTICE:*** *The second Payment Services Directive (PSD2) may affect your current or planned usage of our public API, as some of the API services are now subject to a permit. Please be aware that using our public API without the required PSD2 permit is at your own risk and take notice of our updated API Terms and Conditions on for more information.*


    # Introduction


    Welcome to bunq! - The bunq API is organised around REST. JSON will be returned in almost all responses from the API, including errors but excluding binary (image) files. - Please configure your implementation to send its API requests to `https://public-api.sandbox.bunq.com/v1/`

    - There is a version of the Android app that connects to the bunq Sandbox environment. To create accounts for the Sandbox app, please follow the steps in the Android Emulator section. ## Getting started


    Before you start sending API requests, you need to get an API key and activate it. API activation happens when you install the API key and link your IP address and device to it *(create an API context)*. The steps below will guide you through what you need to do to start sending custom API requests. Here is an overview of what you can use to get started with the bunq API:

    1. **Create an API key.** You can do it either in our developer portal or in the bunq app *(Profile → Security & Settings → Developers → API keys)*. If you want to test our sandbox first, our bunq Developer is the best place to start. 2. **Register a device.** A device can be a phone (private), computer or a server (public). You can register a new device by using the `POST /installation` and `POST /device-server` calls. This will activate your API key. You only need to do this once. 3. **Open a session.** Sessions are temporary and expire after the auto-logout time set for the user account. It can be changed by the account owner in the bunq app. 4. **Make your first call!**


    !bunq_API_context


    ## Versioning


    Developments in the financial sector, changing regulatory regimes and new feature requests require us to be flexible. This means we can iterate quickly to improve the API and related tooling. Therefore, we have chosen not to attach any version numbers to the changes just yet. We will inform you in a timely manner of any important changes we make before they are deployed on together.bunq.com. You can also subscribe to our API newsletter to make sure you don''t miss any important updates. # OAuth


    ## What is OAuth? OAuth 2.0 is a protocol that will let your app connect to bunq users in a safe and easy way. Please be aware that if you will gain access to the account information of other bunq users or initiate a payment for them, you may require a PSD2 permit. ## Get started with OAuth for bunq


    To initiate authorization into the bunq user accounts, you need to create an OAuth Client and register at least 1 redirect URL for it. You can have 1 OAuth Client at a time. Reuse your OAuth credentials for every authorization request. The list of steps below will help you to get started:


    1. Register an OAuth Client by creating an app in bunq Developer_._

    2. Add one or more Redirect URLs. 3. Get your `client_id` and `secret` from your app information tab in bunq Developer. 4. Redirect your users to the OAuth authorization request URL. 5. If the user accepts the authorization request, they will be redirected to the previously specified `redirect_uri` with an authorization `code` parameter. 6. Use the token endpoint to exchange the authorization `code` for an `access_token`. 7. Use the `access_token` as a normal API Key. Open a session or use our SDKs to get started. You can set up an OAuth Client and add redirect URLs to it using the dedicated endpoints too.'
  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
tags:
- name: transferwise-recipient-requirement
  description: ''
paths:
  /user/{userID}/transferwise-quote/{transferwise-quoteID}/transferwise-recipient-requirement:
    post:
      tags:
      - transferwise-recipient-requirement
      summary: CREATE transferwise recipient requirement for user transferwise quote
      operationId: CREATE_TransferwiseRecipientRequirement_for_User_TransferwiseQuote
      description: Used to determine the recipient account requirements for Transferwise transfers.
      parameters:
      - in: path
        name: userID
        description: ''
        required: true
        schema:
          type: integer
      - in: path
        name: transferwise-quoteID
        description: ''
        required: true
        schema:
          type: integer
      - $ref: '#/components/parameters/Cache-Control'
      - $ref: '#/components/parameters/User-Agent'
      - $ref: '#/components/parameters/X-Bunq-Language'
      - $ref: '#/components/parameters/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/TransferwiseAccountRequirement'
      responses:
        '200':
          description: Used to determine the recipient account requirements for Transferwise transfers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferwiseAccountRequirementCreate'
          headers:
            X-Bunq-Client-Response-Id:
              $ref: '#/components/headers/X-Bunq-Client-Response-Id'
            X-Bunq-Client-Request-Id:
              $ref: '#/components/headers/X-Bunq-Client-Request-Id'
            X-Bunq-Server-Signature:
              $ref: '#/components/headers/X-Bunq-Server-Signature'
        '400':
          $ref: '#/components/responses/GenericError'
      x-summary-source: derived
    get:
      tags:
      - transferwise-recipient-requirement
      summary: List all transferwise recipient requirement for user transferwise quote
      operationId: List_all_TransferwiseRecipientRequirement_for_User_TransferwiseQuote
      description: Used to determine the recipient account requirements for Transferwise transfers.
      parameters:
      - in: path
        name: userID
        description: ''
        required: true
        schema:
          type: integer
      - in: path
        name: transferwise-quoteID
        description: ''
        required: true
        schema:
          type: integer
      - $ref: '#/components/parameters/Cache-Control'
      - $ref: '#/components/parameters/User-Agent'
      - $ref: '#/components/parameters/X-Bunq-Language'
      - $ref: '#/components/parameters/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 determine the recipient account requirements for Transferwise transfers.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TransferwiseAccountRequirementListing'
          headers:
            X-Bunq-Client-Response-Id:
              $ref: '#/components/headers/X-Bunq-Client-Response-Id'
            X-Bunq-Client-Request-Id:
              $ref: '#/components/headers/X-Bunq-Client-Request-Id'
            X-Bunq-Server-Signature:
              $ref: '#/components/headers/X-Bunq-Server-Signature'
        '400':
          $ref: '#/components/responses/GenericError'
      x-summary-source: derived
components:
  schemas:
    TransferwiseAccountRequirementCreate:
      type: object
      properties:
        Id:
          type: object
          description: The id of the created item
          readOnly: true
          writeOnly: false
          $ref: '#/components/schemas/BunqId'
    TransferwiseRequirementFieldGroup:
      type: object
      properties:
        key:
          type: string
          description: The key of the field. This is the value to send as input.
          readOnly: true
          writeOnly: false
        type:
          type: string
          description: 'The field''s input type: "text", "select" or "radio".'
          readOnly: true
          writeOnly: false
        name:
          type: string
          description: The field name.
          readOnly: true
          writeOnly: false
        refresh_requirements_on_change:
          type: boolean
          description: Indicates that any changes in this field affect the requirements, if this field is changed, the requirements endpoint must be called again to recheck if there are any additional requirements.
          readOnly: true
          writeOnly: false
        required:
          type: boolean
          description: Whether or not the field is required.
          readOnly: true
          writeOnly: false
        display_format:
          type: string
          description: Formatting mask to guide user input.
          readOnly: true
          writeOnly: false
        example:
          type: string
          description: An example value for this field.
          readOnly: true
          writeOnly: false
        min_length:
          type: string
          description: The minimum length of the field's value.
          readOnly: true
          writeOnly: false
        max_length:
          type: string
          description: The maximum length of the field's value.
          readOnly: true
          writeOnly: false
        validation_regexp:
          type: string
          description: A regular expression which may be used to validate the user input.
          readOnly: true
          writeOnly: false
        validation_async:
          type: object
          description: Details of an endpoint which may be used to validate the user input.
          readOnly: true
          writeOnly: false
          $ref: '#/components/schemas/TransferwiseRequirementFieldGroupValidationAsync'
        values_allowed:
          type: object
          description: Shows which values are allowed for fields of type "select" or "radio".
          readOnly: true
          writeOnly: false
          $ref: '#/components/schemas/TransferwiseRequirementFieldGroupValuesAllowed'
    TransferwiseRequirementFieldGroupValuesAllowed:
      type: object
      properties:
        key:
          type: string
          description: The key.
          readOnly: true
          writeOnly: false
        name:
          type: string
          description: The label.
          readOnly: true
          writeOnly: false
    TransferwiseRequirementFieldGroupValidationAsync:
      type: object
      properties:
        url:
          type: string
          description: The url to be used to validate user input.
          readOnly: true
          writeOnly: false
        params:
          type: object
          description: The parameters to send when validating user input.
          readOnly: true
          writeOnly: false
          $ref: '#/components/schemas/TransferwiseRequirementFieldGroupValidationAsyncParams'
    TransferwiseAccountRequirement:
      type: object
      properties:
        country:
          type: string
          description: The country of the receiving account.
          readOnly: false
          writeOnly: true
        name_account_holder:
          type: string
          description: The name of the account holder.
          readOnly: false
          writeOnly: true
        type:
          type: string
          description: The chosen recipient account type. The possible options are provided dynamically in the response endpoint.
          readOnly: false
          writeOnly: false
        detail:
          type: array
          description: The fields which were specified as "required" and have since been filled by the user. Always provide the full list.
          readOnly: false
          writeOnly: true
          items:
            $ref: '#/components/schemas/TransferwiseRequirementField'
      required:
      - name_account_holder
      - type
    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.
    TransferwiseAccountRequirementListing:
      type: object
      properties:
        type:
          type: string
          description: A possible recipient account type.
          readOnly: true
          writeOnly: false
        label:
          type: string
          description: The label of the possible recipient account type to show to the user.
          readOnly: true
          writeOnly: false
        fields:
          type: array
          description: The fields which the user needs to fill.
          readOnly: true
          writeOnly: false
          items:
            $ref: '#/components/schemas/TransferwiseRequirementField'
    BunqId:
      type: object
      properties:
        id:
          type: integer
          description: An integer ID of an object. Unique per object type.
          readOnly: false
          writeOnly: false
    TransferwiseRequirementFieldGroupValidationAsyncParams:
      type: object
      properties:
        key:
          type: string
          description: The parameter key.
          readOnly: true
          writeOnly: false
        parameter_name:
          type: string
          description: The parameter label.
          readOnly: true
          writeOnly: false
        required:
          type: boolean
          description: Shows whether the parameter is required or not.
          readOnly: true
          writeOnly: false
    TransferwiseRequirementField:
      type: object
      properties:
        key:
          type: string
          description: The name of the required field.
          readOnly: false
          writeOnly: true
        value:
          type: string
          description: The value of the required field.
          readOnly: false
          writeOnly: true
        name:
          type: string
          description: The descriptive label of the field.
          readOnly: true
          writeOnly: false
        group:
          type: object
          description: The field group.
          readOnly: true
          writeOnly: false
          $ref: '#/components/schemas/TransferwiseRequirementFieldGroup'
      required:
      - key
      - value
  parameters:
    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: false
      in: header
      name: X-Bunq-Geolocation
    Cache-Control:
      description: The standard HTTP Cache-Control header is required for all signed requests.
      schema:
        type: string
      required: false
      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-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: false
      in: header
      name: X-Bunq-Client-Request-Id
    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: false
      in: header
      name: X-Bunq-Region
    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: false
      in: header
      name: X-Bunq-Language
    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
  headers:
    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
    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: false
    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
  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'
x-provenance:
  method: harvested
  publisher: bunq
  source: https://raw.githubusercontent.com/bunq/doc/master/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)