Lemonway MoneyIns | Virtual IBAN API

openapi: 3.2.0
info:
  version: v2
  title: Lemonway DirectKit API 2.0 MoneyIns | Virtual IBAN API
servers:
- url: https://ws.lemonway.fr/mb/env-name/prod/directkitrest/
tags:
- name: MoneyIns | Virtual IBAN
paths:
  /v2/moneyins/bankwire/iban/count:
    get:
      tags:
      - MoneyIns | Virtual IBAN
      summary: Get VIBANs count
      description: This endpoint enables you to retrieve the VIBAN count, the remaining VIBAN count and the max VIBAN thresholds.
      operationId: MoneyIns_BankwireIbanCountGet
      parameters:
      - name: Authorization
        in: header
        description: Authorization bearer (OAuth 2)
        required: true
        schema:
          type: string
      - name: PSU-Accept-Language
        in: header
        description: Response language accepted by final client (PSU). English by default
        required: false
        schema:
          type: string
      - name: PSU-IP-Address
        in: header
        description: IP address of the final client (PSU).
        required: true
        schema:
          type: string
      - name: PSU-User-Agent
        in: header
        description: User-agent of the final client (PSU).
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVibanCountOutput'
              examples:
                response:
                  value:
                    activeVibanCount: 100
                    inactiveVibanCount: 100
                    remainingVibanCount: 900
                    maxVibanThreshold: 1000
                    maxVibanPerWalletThreshold: 100
        '401':
          description: Unauthorized
        '500':
          description: InternalServerError
  /v2/moneyins/bankwire/iban/create:
    post:
      tags:
      - MoneyIns | Virtual IBAN
      summary: Create Dedicated Virtual IBANs
      description: This feature enables you to create dedicated (virtual) IBANs. These IBANs are linked to a dedicated payment account and give the possibility to you to receive wire transfers directly to these accounts. The payment schema must be validated prior with Lemonway. This method should be called once you are certain a payment will be received. We advise against associating an IBAN to a payment account preventively. Please contact your account manager to have this function activated.
      operationId: MoneyIns_BankwireIbanCreatePost
      parameters:
      - name: Authorization
        in: header
        description: Authorization bearer (OAuth 2)
        required: true
        schema:
          type: string
      - name: PSU-Accept-Language
        in: header
        description: Response language accepted by final client (PSU). English by default
        required: false
        schema:
          type: string
      - name: PSU-IP-Address
        in: header
        description: IP address of the final client (PSU).
        required: true
        schema:
          type: string
      - name: PSU-User-Agent
        in: header
        description: User-agent of the final client (PSU).
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateIBANInput'
          text/json:
            schema:
              $ref: '#/components/schemas/CreateIBANInput'
          application/xml:
            schema:
              $ref: '#/components/schemas/CreateIBANInput'
          text/xml:
            schema:
              $ref: '#/components/schemas/CreateIBANInput'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateIBANInput'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateIBANOutput'
              examples:
                response:
                  value:
                    id: 255
                    iban: FR1420041010050500013M02606
                    bic: ABCDEFGHIJK
                    holder: Lemonway
                    domiciliation: 8 rue du Sentier, 75002 Paris, France
                    status: 5
                    maxAvailableIbanPerWallet: 5
                    maxAvailableIban: 120
                    pdf: RXhlbXBsZSBwZGYgYmFzZTY0Cg==...
                    qrCode: RXhlbXBsZSBRUiBDT0RFIGJhc2U2NAo=...
        '401':
          description: Unauthorized
        '500':
          description: InternalServerError
  /v2/moneyins/bankwire/iban/{ibanid}/disable:
    post:
      tags:
      - MoneyIns | Virtual IBAN
      summary: Disable a Dedicated Virtual IBAN
      description: This functionality enables you to disable dedicated IBANs.
      operationId: MoneyIns_BankwireIbanDisablePost
      parameters:
      - name: ibanid
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: Authorization
        in: header
        description: Authorization bearer (OAuth 2)
        required: true
        schema:
          type: string
      - name: PSU-Accept-Language
        in: header
        description: Response language accepted by final client (PSU). English by default
        required: false
        schema:
          type: string
      - name: PSU-IP-Address
        in: header
        description: IP address of the final client (PSU).
        required: true
        schema:
          type: string
      - name: PSU-User-Agent
        in: header
        description: User-agent of the final client (PSU).
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisableIBANInput'
          text/json:
            schema:
              $ref: '#/components/schemas/DisableIBANInput'
          application/xml:
            schema:
              $ref: '#/components/schemas/DisableIBANInput'
          text/xml:
            schema:
              $ref: '#/components/schemas/DisableIBANInput'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DisableIBANInput'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisableIBANOutput'
              examples:
                response:
                  value:
                    id: 33612345678
                    status: 8
        '401':
          description: Unauthorized
        '500':
          description: InternalServerError
components:
  schemas:
    CreateIBANInput:
      required:
      - wallet
      - country
      type: object
      properties:
        wallet:
          description: Payment Account ID.
          maxLength: 256
          minLength: 0
          type: string
        country:
          description: 'ISO2 code of the country from which the IBAN must be generated

            We currently serve 4 countries:

            <ul><li>BE: Belgium</li><li>ES: Spain</li><li>FR: France</li><li>IT: Italy</li></ul>'
          maxLength: 2
          minLength: 0
          type: string
        generatePDFAndQrCode:
          description: If activated, this function will return a PDF document describing the virtual IBAN, along with a <a href="https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/quick-response-code-guidelines-enable-data-capture-initiation" target="_blank">standard EPC QR-Code</a> image. Please store these documents in your datawarehouse, as they are not accessible through Lemonway's API after the virtual IBAN has been generated.
          type: boolean
        pdfLanguage:
          description: 'ISO 639-1 language code for the PDF document. The supported languages are:

            <ul><li>en: English</li><li>es: Spanish</li><li>fr: French</li><li>it: Italian</li></ul>

            This field is ignored if generatePDFAndQrCode is false.'
          maxLength: 2
          minLength: 0
          type: string
      example:
        wallet: '33612345678'
        country: FR
        generatePDFAndQrCode: true
        pdfLanguage: en
    CreateIBANOutput:
      type: object
      properties:
        id:
          format: int64
          description: IBAN ID
          type: integer
        iban:
          description: IBAN
          type: string
        bic:
          description: BIC/SWIFT Code
          type: string
        holder:
          description: IBAN Owner = Lemonway
          type: string
        domiciliation:
          description: Domiciliation
          type: string
        status:
          format: int32
          description: IBAN Status
          type: integer
        maxAvailableIbanPerWallet:
          format: int32
          description: IBAN left that can be generated for this wallet
          type: integer
        maxAvailableIban:
          format: int32
          description: IBAN left that can be generated in total
          type: integer
        pdf:
          description: PDF in base64
          type: string
        qrCode:
          description: QR Code PNG in base64
          type: string
        error:
          $ref: '#/components/schemas/Error'
    Error:
      type: object
      properties:
        code:
          format: int32
          type: integer
        message:
          type: string
        psp:
          $ref: '#/components/schemas/PSP'
    DisableIBANInput:
      required:
      - wallet
      type: object
      properties:
        wallet:
          description: Payment Account ID
          maxLength: 256
          minLength: 0
          type: string
      example:
        wallet: '33612345678'
    PSP:
      type: object
      properties:
        message:
          description: Get the Error Message from PSP
          type: string
    DisableIBANOutput:
      type: object
      properties:
        id:
          format: int64
          description: IBAN ID
          type: integer
        status:
          format: int32
          description: IBAN Status
          type: integer
        error:
          $ref: '#/components/schemas/Error'
    GetVibanCountOutput:
      type: object
      properties:
        activeVibanCount:
          format: int32
          type: integer
        inactiveVibanCount:
          format: int32
          type: integer
        remainingVibanCount:
          format: int32
          type: integer
        maxVibanThreshold:
          format: int32
          type: integer
        maxVibanPerWalletThreshold:
          format: int32
          type: integer
        error:
          $ref: '#/components/schemas/Error'
x-provenance:
  method: searched
  source: https://documentation.lemonway.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://documentation.lemonway.com/reference/accounts_accountsingleget.md
  - https://documentation.lemonway.com/reference/accounts_addultimatebeneficialowner.md
  - https://documentation.lemonway.com/reference/accounts_balancesget.md
  - https://documentation.lemonway.com/reference/accounts_balanceshistoryget.md
  - https://documentation.lemonway.com/reference/accounts_blockedput.md
  - https://documentation.lemonway.com/reference/accounts_documentget.md
  - https://documentation.lemonway.com/reference/accounts_documentssigninitpost.md
  - https://documentation.lemonway.com/reference/accounts_documentsuploadpost.md
  - https://documentation.lemonway.com/reference/accounts_enrolmentinit.md
  - https://documentation.lemonway.com/reference/accounts_getultimatebeneficialowner.md
  - https://documentation.lemonway.com/reference/accounts_individualpost.md
  - https://documentation.lemonway.com/reference/accounts_individualput.md
  - https://documentation.lemonway.com/reference/accounts_kycstatusget.md
  - https://documentation.lemonway.com/reference/accounts_kycstatusput.md
  - https://documentation.lemonway.com/reference/accounts_legalpost.md
  - https://documentation.lemonway.com/reference/accounts_legalsingleput.md
  - https://documentation.lemonway.com/reference/accounts_retrievepost.md
  - https://documentation.lemonway.com/reference/accounts_transactionsget.md
  - https://documentation.lemonway.com/reference/accounts_updateultimatebeneficialowner.md
  - https://documentation.lemonway.com/reference/disputes_disputesget.md
  - https://documentation.lemonway.com/reference/moneyins_accountcardget.md
  - https://documentation.lemonway.com/reference/moneyins_bankwireget.md
  - https://documentation.lemonway.com/reference/moneyins_bankwireibancountget.md
  - https://documentation.lemonway.com/reference/moneyins_bankwireibancreatepost.md
  - https://documentation.lemonway.com/reference/moneyins_bankwireibandisablepost.md
  - https://documentation.lemonway.com/reference/moneyins_cancelput.md
  - https://documentation.lemonway.com/reference/moneyins_cardcreatepost.md
  - https://documentation.lemonway.com/reference/moneyins_carddirect3dconfirmput.md
  - https://documentation.lemonway.com/reference/moneyins_cardget.md
  - https://documentation.lemonway.com/reference/moneyins_cardpaymentformpost.md
  - https://documentation.lemonway.com/reference/moneyins_cardrebill.md
  - https://documentation.lemonway.com/reference/moneyins_cardsubscriptionpost.md
  - https://documentation.lemonway.com/reference/moneyins_cardunregisterput.md
  - https://documentation.lemonway.com/reference/moneyins_cardwebinitpost.md
  - https://documentation.lemonway.com/reference/moneyins_chequeget.md
  - https://documentation.lemonway.com/reference/moneyins_chequeinitpost.md
  - https://documentation.lemonway.com/reference/moneyins_createbnplpayment.md
  - https://documentation.lemonway.com/reference/moneyins_getbnplpaymentplans.md
  - https://documentation.lemonway.com/reference/moneyins_getmoneyinbanks.md
  - https://documentation.lemonway.com/reference/moneyins_mandateget.md
  - https://documentation.lemonway.com/reference/moneyins_mandategetdocument.md
  - https://documentation.lemonway.com/reference/moneyins_mbwayinitpost.md
  - https://documentation.lemonway.com/reference/moneyins_mobilepayinitpost.md
  - https://documentation.lemonway.com/reference/moneyins_moneyinapminitasync.md
  - https://documentation.lemonway.com/reference/moneyins_moneyinget.md
  - https://documentation.lemonway.com/reference/moneyins_moneyinpaypalinit.md
  - https://documentation.lemonway.com/reference/moneyins_moneyintransferinit.md
  - https://documentation.lemonway.com/reference/moneyins_multibancoinitpost.md
  - https://documentation.lemonway.com/reference/moneyins_paymentformcompletedget.md
  - https://documentation.lemonway.com/reference/moneyins_paymentformdisableput.md
  - https://documentation.lemonway.com/reference/moneyins_paypaltransactionresume.md
  - https://documentation.lemonway.com/reference/moneyins_payshopinitpost.md
  - https://documentation.lemonway.com/reference/moneyins_paytrailinitpost.md
  - https://documentation.lemonway.com/reference/moneyins_sddget.md
  - https://documentation.lemonway.com/reference/moneyins_sddinitpost.md
  - https://documentation.lemonway.com/reference/moneyins_sddmandatepost.md
  - https://documentation.lemonway.com/reference/moneyins_sddmandateunregisterput.md
  - https://documentation.lemonway.com/reference/moneyins_sofortinitpost.md
  - https://documentation.lemonway.com/reference/moneyins_trustlyinitpost.md
  - https://documentation.lemonway.com/reference/moneyins_validateput.md
  - https://documentation.lemonway.com/reference/moneyouts_cancelput.md
  - https://documentation.lemonway.com/reference/moneyouts_ibanextendedpost.md
  - https://documentation.lemonway.com/reference/moneyouts_ibanget.md
  - https://documentation.lemonway.com/reference/moneyouts_ibanpost.md
  - https://documentation.lemonway.com/reference/moneyouts_ibanunregisterput.md
  - https://documentation.lemonway.com/reference/moneyouts_moneyoutget.md
  - https://documentation.lemonway.com/reference/moneyouts_moneyoutpostasync.md
  - https://documentation.lemonway.com/reference/p2ps_p2pget.md
  - https://documentation.lemonway.com/reference/p2ps_p2ppost.md
  - https://documentation.lemonway.com/reference/refunds_refundcreateput.md
  - https://documentation.lemonway.com/reference/refunds_refundput.md
  merge:
    pages: 71
    deduped: 281
    conflicts_kept_first: 0