Lemonway MoneyIns | Cheque API

openapi: 3.2.0
info:
  version: v2
  title: Lemonway DirectKit API 2.0 MoneyIns | Cheque API
servers:
- url: https://ws.lemonway.fr/mb/env-name/prod/directkitrest/
tags:
- name: MoneyIns | Cheque
paths:
  /v2/moneyins/cheque:
    get:
      tags:
      - MoneyIns | Cheque
      summary: Search for Cheque Money-In by Date or by Token
      description: Use GET /moneyins/cheque to obtain the list of all money-in by cheque (received by Lemonway), starting from an entry date given in input to this method, or by merchant token.
      operationId: MoneyIns_ChequeGet
      parameters:
      - name: updateDate
        in: query
        required: false
        schema:
          type: string
          pattern: ^-?\d{1,12}$
      - name: updateEndDate
        in: query
        description: End Date UTC Unix Timestamp
        required: false
        schema:
          type: string
          pattern: ^-?\d{1,12}$
      - name: chequeType
        in: query
        description: 'Cheque Payment (by default) or Pagaré:

          15 = Cheque payment.<br/>23 = Pagaré.'
        required: false
        schema:
          type: integer
          format: int32
          enum:
          - 15
          - 23
      - name: reference
        in: query
        description: Unique ID generated by your server
        required: false
        schema:
          type: string
          minLength: 0
          maxLength: 50
      - name: page
        in: query
        description: Index start from 1, let null to get all
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: Default 20, let it null if no pagination
        required: false
        schema:
          type: integer
          format: int32
      - 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/GetMoneyInChequeDetailsOutput'
              examples:
                response:
                  value:
                    transactions:
                      value:
                      - receiverAccountId: pizza
                        creditAmount: 1500
                        scheduledNumber: null
                        refundAmount: 0
                        bankReference: '12345678'
                        ChequeSendingAddress_CorporateName: null
                        ChequeSendingAddress_Street: null
                        ChequeSendingAddress_City: null
                        ChequeSendingAddress_PostCode: null
                        id: 255
                        method: 0
                        date: 1784563474
                        commissionAmount: 100
                        comment: Order number 2457765AX2
                        status: 0
                        executionDate: 0
                        reference: null
        '401':
          description: Unauthorized
        '500':
          description: InternalServerError
  /v2/moneyins/cheque/init:
    post:
      tags:
      - MoneyIns | Cheque
      summary: Register a Cheque
      description: 'The following rules apply:

        If you want to pre-enter the cheques in our system, use the POST /moneyins/cheque/init method


        The cheque must be made out to Lemonway


        On the back of the cheque, please enter a code to facilitate reconciliation. It will be of the following form: XXXXX-YYYYYYYYYY


        "XXXXX: code identifying you as indicated in your production configuration form


        -: a separation dash:


        YYYYYYYYY : external identifier of your user''s payment account


        The holder of the cheque must be identical to that of the payment account to be credited'
      operationId: MoneyIns_ChequeInitPost
      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/MoneyInChequeInitInput'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoneyInChequeInitOutput'
              examples:
                response:
                  value:
                    transaction:
                      receiverAccountId: Pizza56
                      creditAmount: 1500
                      scheduledNumber: null
                      refundAmount: 0
                      bankReference: null
                      ChequeSendingAddress_CorporateName: null
                      ChequeSendingAddress_Street: null
                      ChequeSendingAddress_City: null
                      ChequeSendingAddress_PostCode: null
                      id: 677
                      method: 0
                      date: 1784563474
                      commissionAmount: 200
                      comment: '245'
                      status: 0
                      executionDate: 0
                      reference: Dze8778
        '401':
          description: Unauthorized
        '500':
          description: InternalServerError
components:
  schemas:
    Link:
      type: object
      properties:
        href:
          type: string
        templated:
          type: boolean
          readOnly: true
        method:
          type: string
        type:
          type: string
        deprecation:
          type: string
        name:
          type: string
        profile:
          type: string
        title:
          type: string
        hreflang:
          type: string
    LemonWayCommission:
      type: object
      properties:
        idp2p:
          type: string
        amount:
          format: int32
          description: 'Amounts are represented as integer in cents (Euro)

            Represented as an integer in cents (Euro)'
          type: integer
    TransactionIn:
      type: object
      properties:
        receiverAccountId:
          description: Credited Account
          type: string
        creditAmount:
          format: int32
          description: 'Credited Amount

            Amounts represented in integer (cents)'
          type: integer
        scheduledDate:
          description: ''
          type: string
        scheduledNumber:
          description: ''
          type: string
        maskedLabel:
          type: string
        PSP:
          $ref: '#/components/schemas/PSP'
        card:
          $ref: '#/components/schemas/Card'
        bankStatus:
          type: string
        refundAmount:
          format: double
          type: number
        bankReference:
          description: Bank reference
          type: string
        ChequeSendingAddress_CorporateName:
          description: A specified postal address for the cheque
          type: string
        ChequeSendingAddress_Street:
          description: Cheque sending address street name
          type: string
        ChequeSendingAddress_City:
          description: Cheque sending address city name
          type: string
        ChequeSendingAddress_PostCode:
          description: Cheque sending address post code
          type: string
        threeDS:
          $ref: '#/components/schemas/ThreeDs'
        buyNowPayLaterInfo:
          $ref: '#/components/schemas/BnplInfo'
        id:
          format: int64
          description: Transaction ID
          type: integer
        method:
          format: int32
          description: "Payment Method  \n0 Card    \n1 Bank transfer (MoneyIn)     \n3 Bank transfer (MoneyOut)     \n4 P2P    \n13 iDEAL    \n14 SEPA DirectDebit    \n15 Cheque    \n19 Multibanco    \n21 MBWAY    \n30 BNPL  \n35 PayPal\n\n ---\n **Important:** The following services have been discontinued. \n \n16 Neosurf  \n17 Sofort  \n18 PFS Physical Card  \n20 Payshop  \n22 Polish Instant Transfer  \n23 Pagare  \n24 MobilePay\n25 Paytrail\n26 WeChat  \n27 P24  \n28 MoneyIn by TPE  \n29 Trustly"
          type: integer
        methodDetails:
          format: int32
          description: 'Payment Method Details

            0 Standard

            1 Pay By Bank<br/>0 = STANDARD.<br/>1 = PAY_BY_BANK.<br/>'
          enum:
          - 0
          - 1
          type: integer
        date:
          format: int32
          description: Transaction initialization date, UTC Unix timestamp
          type: integer
        commissionAmount:
          format: int32
          description: 'Your fee

            Amounts are given as integer numbers in cents'
          type: integer
        comment:
          description: Comment
          type: string
        status:
          format: int32
          description: "**For the following endpoints uses the below status code**   \n  \n/v2/accounts/{accountId}/transactions\n/v2/moneyins\n/v2/moneyins/card/direct\n/v2/moneyins/card/{cardid}/rebill\n/v2/moneyins/card/{cardid}/subscription\n/v2/moneyins/{transactionid}/validate\n/v2/moneyins/sdd/init\n/v2/moneyins/sdd\n/v2/moneyins/{transactionid}/cancel\n/v2/refund/{transactionid}\n/v2/refundcreate/{transactionId}\n            \n0: Success  \n3: Lemonway Error  \n4: Pending  \n6: PSP error  \n7: Cancelled  \n16: Validation pending  \n\n**For the following endpoints uses the below status code**  \n\n/v2/disputes\n/v2/moneyins/bankwire\n/v2/moneyins/card/direct/3dinit\n/v2/moneyouts\n/v2/p2p\n/v2/p2p/{transactionid?}\n            \n0: Waiting for finalization    \n3: Success    \n4: Lemonway Error"
          type: integer
        executionDate:
          format: int32
          description: Transaction execution date
          type: integer
        lemonWayCommission:
          $ref: '#/components/schemas/LemonWayCommission'
        reference:
          description: Unique ID generated by your server
          type: string
        remainingAmount:
          format: int32
          type: integer
        substatus:
          description: Is Payment token consumed?
          type: string
    Error:
      type: object
      properties:
        code:
          format: int32
          type: integer
        message:
          type: string
        psp:
          $ref: '#/components/schemas/PSP'
    GetMoneyInChequeDetailsOutput:
      type: object
      properties:
        transactions:
          $ref: '#/components/schemas/Transactions_TransactionIn'
        _links:
          $ref: '#/components/schemas/Links'
        error:
          $ref: '#/components/schemas/Error'
    BnplInfo:
      type: object
      properties:
        paymentPlanId:
          format: int64
          description: Payment Plan ID
          type: integer
        type:
          description: Payment plan type.
          type: string
        secondInstallmentPaymentDate:
          description: 'Second installment payment date.

            Format: yyyy-MM-dd'
          type: string
        deferredPaymentDate:
          description: 'Deferred payment date.

            Format: yyyy-MM-dd'
          type: string
    ThreeDs:
      type: object
      properties:
        threeDSModeRequested:
          description: "3DS Exemption Request  \nPossible value:  \n\nNO_PREFERENCE: The issuing Bank can choose to activate or not 3DS v2."
          type: string
        threeDSResult:
          description: "3DS Authentication Result  \nPossible values:  \n\n- CHALLENGE: 3DS v2 was activated and the card owner was asked to be strongly authenticated.  \n- FRICTIONLESS: 3DS v2 was not activated.  \n- NONE: We could not get the SCA result."
          type: string
    Links:
      type: object
      properties:
        first:
          $ref: '#/components/schemas/Link'
        last:
          $ref: '#/components/schemas/Link'
        previous:
          $ref: '#/components/schemas/Link'
        next:
          $ref: '#/components/schemas/Link'
        self:
          $ref: '#/components/schemas/Link'
    MoneyInChequeInitOutput:
      type: object
      properties:
        transaction:
          $ref: '#/components/schemas/TransactionIn'
        error:
          $ref: '#/components/schemas/Error'
    PSP:
      type: object
      properties:
        message:
          description: Get the Error Message from PSP
          type: string
    Transactions_TransactionIn:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/TransactionIn'
    Card:
      type: object
      properties:
        id:
          format: int64
          description: ''
          type: integer
        is3DS:
          description: Card with 3-DS authentication
          type: boolean
        country:
          description: Card issuing country
          type: string
        authorizationNumber:
          description: Authorization number
          type: string
        maskedNumber:
          description: Masked card number
          type: string
        expiration:
          description: Expiration date (if available)
          type: string
        type:
          description: 'Card type (example: Visa or Mastercard)'
          type: string
        isRegistered:
          description: Card is registered
          type: boolean
        holderName:
          description: Card's holder name
          type: string
    MoneyInChequeInitInput:
      required:
      - accountId
      type: object
      properties:
        transferId:
          description: Leave Empty
          maxLength: 8
          minLength: 0
          type: string
        partner:
          description: Leave empty
          maxLength: 256
          minLength: 0
          type: string
        chequeType:
          format: int32
          description: Cheque payment (by default) or Pagaré:<br/>15 = Cheque payment.<br/>23 = Pagaré.<br/>
          enum:
          - 15
          - 23
          type: integer
        ChequeNumber:
          description: The seven-digit number at the bottom left-hand corner of the cheque.
          maxLength: 7
          minLength: 0
          type: string
        BankIdentifier:
          description: Zone Interbancaire (ZIB). The twelve-digit number used to identify the cheque holder’s bank.
          maxLength: 12
          minLength: 0
          type: string
        InternalIdentifier:
          description: Zone Interne (ZIN). The twelve-digit number used to identify the cheque holder’s account.
          maxLength: 12
          minLength: 0
          type: string
        RLMC:
          format: int32
          description: La Clé de Recomposition de la Ligne Magnétique du Chèque. These 2 numbers help identify a potential counterfeit cheque. (only France)
          type: integer
        CheckFnci:
          description: Fichier National des Chèques Irréguliers de la Banque de France. This FNCI check allows to make a verification on the cheque information. (only France) Please contact our support for this feature.
          type: boolean
        reference:
          description: Unique ID of the call, generated by your server. This ID can be used as a search field when looking for operation details
          maxLength: 50
          minLength: 0
          type: string
        accountId:
          description: Payment Account ID to Credit
          maxLength: 256
          minLength: 0
          type: string
        totalAmount:
          format: int32
          description: 'Amount to Debit

            Amounts are given as integer numbers in cents'
          type: integer
        commissionAmount:
          format: int32
          description: 'Your Fee

            Amounts are given as integer numbers in cents'
          type: integer
        comment:
          description: Comment Regarding the Transaction
          maxLength: 140
          minLength: 0
          type: string
        autoCommission:
          description: "If true:\n1. [amountCom] will be ignored and will be replaced with Lemonway's fee  \n2. You will not receive any fee"
          type: boolean
      example:
        chequeType: 15
        ChequeNumber: '1067924'
        BankIdentifier: 092008206908
        InternalIdentifier: '065041500251'
        RLMC: 46
        CheckFnci: false
        reference: Dze8778
        accountId: '33612345678'
        totalAmount: 1500
        commissionAmount: 100
        comment: Order number 2457765AX2
        autoCommission: false
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