Lemonway MoneyIns | PayPal API

openapi: 3.2.0
info:
  version: v2
  title: Lemonway DirectKit API 2.0 MoneyIns | PayPal API
servers:
- url: https://ws.lemonway.fr/mb/env-name/prod/directkitrest/
tags:
- name: MoneyIns | PayPal
paths:
  /v2/moneyins/paypal/init:
    post:
      tags:
      - MoneyIns | PayPal
      summary: Initiate Pay by PayPal
      description: Lets you integrate PayPal payments on your platform. The integration is implemented as a standard web page redirect to PayPal.com, it enables buyers to login to their accounts and make a payment to your organization.
      operationId: MoneyIns_MoneyInPayPalInit
      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/InitPayPalTransactionInput'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitPayPalTransactionOutput'
              examples:
                response:
                  value:
                    id: 830236
                    redirectionUrl: https://www.sandbox.paypal.com/checkoutnow?token=77D22413X7638172U
                    payPalOrderId: 77D22413X7638172U
        '401':
          description: Unauthorized
        '500':
          description: InternalServerError
  /v2/moneyins/paypal/{transactionId}/resume:
    post:
      tags:
      - MoneyIns | PayPal
      summary: PayPal Resume
      description: 'PayPal''s SDK Integration method lets you customize your offering. It enables you to define content based on the data that passed. There are a number of parameters that can be defined,

        for example, buyer currency, buttons, messages and hosted fields.


        Use this API to integrate PayPal Javascript SDK, in addition you must use Initiate a PayPal Payment to fully integrate.'
      operationId: MoneyIns_PayPalTransactionResume
      parameters:
      - name: transactionId
        in: path
        description: ''
        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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoneyInOutput'
        '401':
          description: Unauthorized
        '500':
          description: InternalServerError
components:
  schemas:
    Transaction:
      description: Transcation
      required:
      - reference
      - accountId
      - totalAmount
      - commissionAmount
      type: object
      properties:
        reference:
          description: Reference
          type: string
        accountId:
          description: Account Id
          type: string
        totalAmount:
          format: int32
          description: Total Amount
          type: integer
        commissionAmount:
          format: int32
          description: Commission Amount
          type: integer
        comment:
          description: Comment
          type: string
        autoCommission:
          description: Auto Commission
          type: boolean
        isPreAuth:
          type: boolean
        captureMode:
          format: int32
          description: 'Specifies the capture mode for the payment:

            Automatic results in a Capture type, and Manual results in an Authorize type.<br/>1 = Automatic.<br/>2 = Manual.<br/>'
          enum:
          - 1
          - 2
          type: integer
    Redirections:
      description: Redirection urls
      required:
      - returnUrl
      - errorUrl
      - cancelUrl
      type: object
      properties:
        returnUrl:
          description: Return URL
          maxLength: 2048
          minLength: 0
          type: string
        errorUrl:
          description: Error URl
          maxLength: 2048
          minLength: 0
          type: string
        cancelUrl:
          description: Cancel URL
          maxLength: 2048
          minLength: 0
          type: string
    MoneyInOutput:
      type: object
      properties:
        transaction:
          $ref: '#/components/schemas/TransactionIn'
        error:
          $ref: '#/components/schemas/Error'
    Receiver:
      description: Receiver
      required:
      - fullName
      type: object
      properties:
        fullName:
          description: Full name
          maxLength: 255
          minLength: 0
          type: string
    PaypalDeliveryAddress:
      description: Address
      required:
      - country
      - city
      - street
      - postCode
      type: object
      properties:
        country:
          description: ISO 3166-1 alpha-2
          maxLength: 2
          minLength: 2
          type: string
        city:
          description: City
          maxLength: 140
          minLength: 0
          type: string
        street:
          description: Number and street
          maxLength: 256
          minLength: 0
          type: string
        postCode:
          description: Postcode/ZIP
          maxLength: 10
          minLength: 0
          type: string
        state:
          description: Postcode/ZIP
          maxLength: 255
          minLength: 0
          type: string
    InitPayPalTransactionInput:
      description: Init PayPal transaction input
      required:
      - redirections
      - transaction
      - items
      type: object
      properties:
        redirections:
          $ref: '#/components/schemas/Redirections'
        transaction:
          $ref: '#/components/schemas/Transaction'
        amountBreakdown:
          $ref: '#/components/schemas/AmountBreakdown'
        delivery:
          $ref: '#/components/schemas/Delivery'
        items:
          description: Items
          type: array
          items:
            $ref: '#/components/schemas/PurchaseItem'
        riskData:
          description: Risk data
          type: object
          additionalProperties:
            type: string
    Error:
      type: object
      properties:
        code:
          format: int32
          type: integer
        message:
          type: string
        psp:
          $ref: '#/components/schemas/PSP'
    PurchaseItem:
      description: Item
      required:
      - merchantAccountId
      - description
      - quantity
      - unitAmount
      - type
      type: object
      properties:
        merchantAccountId:
          description: Merchant account id
          type: string
        description:
          description: Description
          maxLength: 127
          minLength: 0
          type: string
        quantity:
          format: int32
          description: Quantity
          maximum: 2147483647
          minimum: 0
          type: integer
        unitAmount:
          format: int32
          description: Unit amount
          maximum: 2147483647
          minimum: 0
          type: integer
        type:
          format: int32
          description: Type<br/>1 = Physical.<br/>2 = Digital.<br/>
          enum:
          - 1
          - 2
          type: integer
        taxAmount:
          format: int32
          description: Tax amount
          maximum: 2147483647
          minimum: 0
          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
    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
    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
    PSP:
      type: object
      properties:
        message:
          description: Get the Error Message from PSP
          type: string
    Delivery:
      description: Delivery
      required:
      - receiver
      - address
      type: object
      properties:
        receiver:
          $ref: '#/components/schemas/Receiver'
        address:
          $ref: '#/components/schemas/PaypalDeliveryAddress'
    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
    AmountBreakdown:
      description: The amount breakdown.
      type: object
      properties:
        totalItems:
          format: int32
          description: The subtotal for all items.
          maximum: 2147483647
          minimum: 0
          type: integer
        totalItemTaxes:
          format: int32
          description: The total tax for all items.
          maximum: 2147483647
          minimum: 0
          type: integer
        shipping:
          format: int32
          description: The shipping fee for all items.
          maximum: 2147483647
          minimum: 0
          type: integer
        handling:
          format: int32
          description: The handling fee for all items.
          maximum: 2147483647
          minimum: 0
          type: integer
        insurance:
          format: int32
          description: The insurance fee for all items.
          maximum: 2147483647
          minimum: 0
          type: integer
        shippingDiscount:
          format: int32
          description: The shipping discount for all items.
          maximum: 2147483647
          minimum: 0
          type: integer
        discount:
          format: int32
          description: The discount for all items.
          maximum: 2147483647
          minimum: 0
          type: integer
    InitPayPalTransactionOutput:
      description: Init PayPal transaction Output
      required:
      - id
      - redirectionUrl
      - payPalOrderId
      type: object
      properties:
        id:
          format: int64
          description: Money-in Id
          type: integer
        redirectionUrl:
          description: Redirection Url
          type: string
        payPalOrderId:
          description: PayPal Order Id
          type: string
        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