# Lemonway Documentation Documentation
> Lemonway API and functional documentation
## Guides
- [Build with Lemonway](https://documentation.lemonway.com/docs/home.md)
- [What's Your Business Model?](https://documentation.lemonway.com/docs/what-is-your-payment-scheme.md)
- [B2B Marketplaces](https://documentation.lemonway.com/docs/b2b-marketplaces-landing.md)
- [Step 1: Create a merchant account](https://documentation.lemonway.com/docs/create-a-merchant-account.md)
- [Step 2: B2B Onboarding & Verification](https://documentation.lemonway.com/docs/b2b-onboardingverification.md)
- [Step 3: Pay-In - Setting-up the first sale for a B2B](https://documentation.lemonway.com/docs/b2b-first-sale.md): Pay-In and Pay-Out
- [Step 4: Transferring Funds to a Merchant's Bank Account](https://documentation.lemonway.com/docs/transferring-funds-to-a-merchants-bank-account.md)
- [B2C Marketplaces](https://documentation.lemonway.com/docs/b2c-marketplacelanding.md)
- [Step 1: Create a seller account](https://documentation.lemonway.com/docs/b2ccreateselleraccount.md)
- [Step 2: B2C Onboarding & Verification](https://documentation.lemonway.com/docs/b2conboardingverification.md)
- [Step 3: Pay-In - Setting-up the first sale for a B2C](https://documentation.lemonway.com/docs/b2cfirst-successful-transaction.md): Pay-In and Pay-Out
- [Step 4: Pay-Out - Transfering Funds to Seller](https://documentation.lemonway.com/docs/b2crequesting-earned-payment.md)
- [Troubleshooting Seller Pay-outs](https://documentation.lemonway.com/docs/troubleshooting.md): Known common reasons payouts fail
- [C2C Marketplaces](https://documentation.lemonway.com/docs/c2c-marketplaces.md)
- [Step 1: Create a Seller Account (C2C)](https://documentation.lemonway.com/docs/step-1.md): _In C2C, your sellers are individuals. This step shows how to create an **individual Lemonway account** (seller profile) and retrieve the account information._
- [Step 2: Verify the Seller Identity (KYC)](https://documentation.lemonway.com/docs/step-2.md): This step verifies the seller’s identity and eligibility to receive payouts. For C2C platforms, KYC is a core compliance requirement and should be designed for high completion rates.
- [Step 3: First Successful C2C Transaction (Buyer Pay-In)](https://documentation.lemonway.com/docs/step-3.md): This step covers the first successful payment from a buyer to purchase an item/service from a C2C seller
- [Step 4: Release Funds to Seller (Pay-Out)](https://documentation.lemonway.com/docs/step-4.md): After successful payment and platform-defined checks, payout transfers the seller’s earnings from wallet balance to their bank account
- [Payment Flows](https://documentation.lemonway.com/docs/sqd.md): Sequence Diagrams that outline Lemonway payment flows
- [Pay by Card ](https://documentation.lemonway.com/docs/redirection-payments-flows.md)
- [Pay by Card - Direct Payment (PCI-DSS compliant only)](https://documentation.lemonway.com/docs/paybycarddirect-flows.md)
- [Pay by Card with Registered Card](https://documentation.lemonway.com/docs/registered-card-flows.md)
- [BNPL Payment](https://documentation.lemonway.com/docs/bnpl-flows.md)
- [Pay By Bank Payment](https://documentation.lemonway.com/docs/pay-by-bank-flows.md)
- [Apple Payments](https://documentation.lemonway.com/docs/applepayflows.md)
- [Connect Your Business to Lemonway](https://documentation.lemonway.com/docs/getting-started-lemonway.md)
- [Creating your Lemonway Account](https://documentation.lemonway.com/docs/creating-your-lemonway-account.md)
- [Pre-activation checks](https://documentation.lemonway.com/docs/before-account-activation.md)
- [Whitelisting an IP address](https://documentation.lemonway.com/docs/whitelisting-an-ip-address.md)
- [Accessing Lemonway Tools and Services](https://documentation.lemonway.com/docs/how-to-access-lemonway-tools-and-services.md)
- [Run Integration Tests](https://documentation.lemonway.com/docs/test-your-integration.md)
- [Test Lemonway API with Postman](https://documentation.lemonway.com/docs/postman.md)
- [Payment Methods We Support](https://documentation.lemonway.com/docs/supportedpayments.md): What payment modes does Lemonway offer?
- [Our Payment Modes](https://documentation.lemonway.com/docs/payment-modes.md): What payment modes does Lemonway offer?
- [Supported Cards](https://documentation.lemonway.com/docs/supported-card-payments.md)
- [Introduction](https://documentation.lemonway.com/docs/introduction-cards.md)
- [Online Payments: Security and Efficiency](https://documentation.lemonway.com/docs/online-payments-security-and-convenience.md): 3DSv2 Card Payments and Frictionless Payments
- [Pre-authorization](https://documentation.lemonway.com/docs/pre-authorization.md)
- [Redirection](https://documentation.lemonway.com/docs/redirection.md)
- [Redirection Guidelines](https://documentation.lemonway.com/docs/redirection-parameters.md)
- [3D Secure v2 and Card Payments](https://documentation.lemonway.com/docs/3ds-payments.md)
- [Frictionless Payments](https://documentation.lemonway.com/docs/frictionless-payments.md)
- [Pay By Link](https://documentation.lemonway.com/docs/pay-by-link.md)
- [Cheque](https://documentation.lemonway.com/docs/cheque-1.md)
- [Cheques](https://documentation.lemonway.com/docs/cheques.md)
- [Pay by Bank](https://documentation.lemonway.com/docs/pay-by-bank.md)
- [P2P transfers](https://documentation.lemonway.com/docs/p2p-transfers.md)
- [Bank Transfer](https://documentation.lemonway.com/docs/bank-transfer.md)
- [Bank Transfer Refunds](https://documentation.lemonway.com/docs/bank-trasfer-refunds.md)
- [Direct Debits](https://documentation.lemonway.com/docs/direct-debit.md)
- [SDD Refunds](https://documentation.lemonway.com/docs/sdd-refunds.md)
- [Supported Local Payment Methods](https://documentation.lemonway.com/docs/supported-payment-methods.md)
- [MBWay Payments](https://documentation.lemonway.com/docs/new-mbway-payments.md)
- [BNPL (Buy Now Pay Later)](https://documentation.lemonway.com/docs/buy-now-pay-later.md)
- [Pay 3x or 4x Payment Plan](https://documentation.lemonway.com/docs/payment-plans.md)
- [How to integrate BNPL on your platform](https://documentation.lemonway.com/docs/integrate-bnpl.md)
- [Make a BNPL Refund](https://documentation.lemonway.com/docs/bnpl-refunds.md)
- [BNPL MoneyIn](https://documentation.lemonway.com/docs/bnpl-moneyin-moneyout.md)
- [BNPL MoneyOut](https://documentation.lemonway.com/docs/bnpl-moneyout.md)
- [BNPL Error Codes and Messages](https://documentation.lemonway.com/docs/error-codes-bnpl.md)
- [PayPal Payments](https://documentation.lemonway.com/docs/paypal-payments.md)
- [Full Page PayPal Redirection](https://documentation.lemonway.com/docs/paypal-redirection.md)
- [PayPal Smart Button Integration](https://documentation.lemonway.com/docs/sdk-integration.md)
- [Delayed PayPal Payment Capture ](https://documentation.lemonway.com/docs/delayed-payment-capture.md)
- [Make a PayPal Refund](https://documentation.lemonway.com/docs/make-a-paypal-refund.md)
- [Dashboard PayPal Statuses](https://documentation.lemonway.com/docs/dashboard-paypal-statuses.md)
- [Apple Pay Payments](https://documentation.lemonway.com/docs/apple-pay-lemonway.md)
- [Multi-capture Payment](https://documentation.lemonway.com/docs/multicapture.md)
- [How to use the Multi-capture](https://documentation.lemonway.com/docs/how-to-use-the-multi-capture.md)
- [Capture and Track multi-capture payments](https://documentation.lemonway.com/docs/capture-and-track-multi-capture-payments.md)
- [Verification of Payee (VoP)](https://documentation.lemonway.com/docs/verification-of-payee-vop.md)
- [APM (Alternative Payment Methods)](https://documentation.lemonway.com/docs/apm.md)
- [Lemonway x Magento](https://documentation.lemonway.com/docs/lemonway-x-magento.md): Lemonway Payment Plugin
- [Prerequisites](https://documentation.lemonway.com/docs/pre-requisites.md)
- [Installation](https://documentation.lemonway.com/docs/installation.md)
- [Configuration](https://documentation.lemonway.com/docs/configuration.md)
- [Card Payments](https://documentation.lemonway.com/docs/card-payments.md)
- [Bank Transfer Payments](https://documentation.lemonway.com/docs/bank-transfer-payments.md)
- [SEPA Direct Debit payments](https://documentation.lemonway.com/docs/sepa-direct-debit-payments.md)
- [Developer documentation](https://documentation.lemonway.com/docs/developer-documentation.md)
- [Lemonway x Mirakl](https://documentation.lemonway.com/docs/lemonway-x-mirakl.md)
- [Getting Started with Lemonway x Mirakl connector](https://documentation.lemonway.com/docs/preequisites.md)
- [What services does Lemonway provide?](https://documentation.lemonway.com/docs/services-provided.md)
- [Use Case - TechGadgets Marketplace](https://documentation.lemonway.com/docs/lemonwayxmirakl-usecase.md)
- [CellfunPhones first sale!](https://documentation.lemonway.com/docs/firstsale.md)
- [Processing the buyer payment](https://documentation.lemonway.com/docs/payment-to-lemonway-by-mirakl.md)
- [Settling Payments](https://documentation.lemonway.com/docs/settlingpayments.md)
- [Refunding a buyer](https://documentation.lemonway.com/docs/refundingbuyer.md)
- [TechGadget - Money-Outs](https://documentation.lemonway.com/docs/lemonway-x-mirakl-money-outs.md)
- [Hosted Card Payment Fields](https://documentation.lemonway.com/docs/embedded-card-payment.md): Learn how to integrate Lemonway's Hosted Fields for secure, customizable payment forms. PCI-compliant solution with full design control, JavaScript SDK, and seamless integration with popular frameworks like React, Vue.js, and Angular.
- [Getting Started with a Basic Payment Form](https://documentation.lemonway.com/docs/getting-started-with-a-basic-payment-form.md)
- [SDK Buddle - Integration and SSR](https://documentation.lemonway.com/docs/sdk-bundle-integration-and-ssr.md)
- [Styling with SDK](https://documentation.lemonway.com/docs/styling-with-sdk.md): CSS Sanitization
- [Toggling Classes](https://documentation.lemonway.com/docs/toggling-classes.md)
- [Synthetic Events](https://documentation.lemonway.com/docs/synthetic-events.md)
- [Event Hooks](https://documentation.lemonway.com/docs/event-hooks.md)
- [Internationalization](https://documentation.lemonway.com/docs/internationalization.md)
- [Card Scheme Detection](https://documentation.lemonway.com/docs/card-scheme-detection.md)
- [Submit a Form](https://documentation.lemonway.com/docs/submit-a-form.md)
- [Example Styles](https://documentation.lemonway.com/docs/examples.md)
- [Lemonway Payment Page](https://documentation.lemonway.com/docs/lemonway-payment-page.md)
- [What is Lemonway Dashboard?](https://documentation.lemonway.com/docs/dashboardoverview.md)
- [Configure your dashboard](https://documentation.lemonway.com/docs/configure-your-dashboard.md)
- [System Configuration](https://documentation.lemonway.com/docs/user-admin.md): Create, manage and deactivate Lemonway Dashboard users.
- [Notifications](https://documentation.lemonway.com/docs/export-dashboard-data.md): Set up and configure automatic notifications in Lemonway Dashboard.
- [API Keys](https://documentation.lemonway.com/docs/access-invoices.md)
- [User Configuration](https://documentation.lemonway.com/docs/user-admin-1.md)
- [Manage Users](https://documentation.lemonway.com/docs/create-new-user.md)
- [Manage Roles](https://documentation.lemonway.com/docs/manage-roles.md)
- [Secure your dashboard](https://documentation.lemonway.com/docs/secure-your-dashboard.md)
- [Enable Two-factor Authentication](https://documentation.lemonway.com/docs/twofactor-authentication.md)
- [Whitelisting an IP Address](https://documentation.lemonway.com/docs/ipwhitelist.md)
- [Reset Passwords](https://documentation.lemonway.com/docs/reset-password.md)
- [Understand your dashboard](https://documentation.lemonway.com/docs/understand-your-dashboard.md)
- [Dashboard Menu](https://documentation.lemonway.com/docs/dashboard-menu.md)
- [Dashboard Tables](https://documentation.lemonway.com/docs/dashboard-tables.md)
- [Dashboard Languages](https://documentation.lemonway.com/docs/dashboard-languages.md): How to change the Dashboard display language.
- [Dashboard Updates](https://documentation.lemonway.com/docs/dashboard-updates.md)
- [Use your dashboard](https://documentation.lemonway.com/docs/use-your-dashboard.md)
- [Accounts](https://documentation.lemonway.com/docs/accounts.md)
- [Wallets](https://documentation.lemonway.com/docs/wallets.md)
- [Transactions](https://documentation.lemonway.com/docs/transactions.md)
- [Managing Transactions](https://documentation.lemonway.com/docs/managing-transactions.md)
- [Approval Workflow for Pay-Out](https://documentation.lemonway.com/docs/dashboard-approval-workflow.md)
- [Manage Your Products](https://documentation.lemonway.com/docs/manage-your-products.md)
- [Branding Lemonway Products in the Dashboard](https://documentation.lemonway.com/docs/branding-lemonway-products-in-the-dashboard.md)
- [🆕 Dashboard Add individual or Legal Entitiy Account](https://documentation.lemonway.com/docs/dashboard-approval-workflow-for-pay-out-copy.md)
- [Getting Started with Online Onboarding](https://documentation.lemonway.com/docs/getting-started-with-onboarding.md)
- [Why Onboarding is a Critical First Step](https://documentation.lemonway.com/docs/onboarding-is-a-critical-first-step.md)
- [Lemonway Online Onboarding](https://documentation.lemonway.com/docs/lemonway-online-onboarding-form.md)
- [Improving Account Onboarding: Why Change Matters](https://documentation.lemonway.com/docs/improving-account-onboarding.md)
- [Online Onboarding: Customization for a Better User Experience](https://documentation.lemonway.com/docs/onboarding-form-customisation.md)
- [Online Onboarding Essentials](https://documentation.lemonway.com/docs/onboarding-essentials.md)
- [Save and Resume an Online Onboarding](https://documentation.lemonway.com/docs/onboardingform-resume-anytime.md)
- [Online Onboarding live status](https://documentation.lemonway.com/docs/onboardingform-livestatus.md)
- [Online Onboarding an Individual](https://documentation.lemonway.com/docs/start-your-journey.md)
- [Individual Account Creation and Onboarding API Reference](https://documentation.lemonway.com/docs/onboarding-api-reference-individual.md)
- [Individual Account Creation and Onboarding](https://documentation.lemonway.com/docs/individuals.md)
- [Online onboarding Identity Validation](https://documentation.lemonway.com/docs/identify-validation.md)
- [Individual Online Onboarding Summary](https://documentation.lemonway.com/docs/individual-onboarding-summary.md)
- [Online Onboarding a Legal Entity](https://documentation.lemonway.com/docs/legal-entity-creation-and-onboarding.md)
- [Legal Entity Onboarding - API Reference](https://documentation.lemonway.com/docs/legalentity-onboarding.md)
- [Onboarding for Multiple Profiles & Wallets](https://documentation.lemonway.com/docs/online-onboarding-for-multiple-profiles-wallets.md)
- [Onboarding Checklist: Required Documents](https://documentation.lemonway.com/docs/onlineonboardingessentialdocsneeded.md)
- [Legal Entities: Non-Listed Company](https://documentation.lemonway.com/docs/legal-entities-non-listed-company.md)
- [Company Registered in the EU or Recognized Third Country](https://documentation.lemonway.com/docs/company-registered-in-the-eu.md)
- [Associations](https://documentation.lemonway.com/docs/associations.md)
- [Foundations](https://documentation.lemonway.com/docs/foundations.md)
- [Endowment Funds](https://documentation.lemonway.com/docs/endowment-funds.md)
- [Skilled Trades](https://documentation.lemonway.com/docs/skilled-trades.md)
- [Limited Liability Agricultural Company](https://documentation.lemonway.com/docs/llcompany.md)
- [Self-employed](https://documentation.lemonway.com/docs/selfemployed.md)
- [Investment funds](https://documentation.lemonway.com/docs/investmentfunds.md)
- [Unincorporated Funds (UIF)](https://documentation.lemonway.com/docs/unincorporated-funds.md)
- [Social and Economic Committee (SEC)](https://documentation.lemonway.com/docs/sec.md)
- [General Interest Groups](https://documentation.lemonway.com/docs/general-interest-groups.md)
- [Insurance company](https://documentation.lemonway.com/docs/insurance-company.md)
- [Parish or Church](https://documentation.lemonway.com/docs/parishorchurch.md)
- [Onboarding Help and FAQs](https://documentation.lemonway.com/docs/onboarding-faqs.md)
- [Online Onboarding - Troubleshooting for Developers](https://documentation.lemonway.com/docs/online-onboarding-troubleshooting-for-developers.md)
- [ Online Onboarding - Ask AI Prompts ](https://documentation.lemonway.com/docs/online-onboarding-ask-ai-prompts.md)
- [FAQs – Paper Identity Documents (EU/EEA)](https://documentation.lemonway.com/docs/faqs-paper-identity-documents-eueea.md)
- [Account & Wallet Usage with Applied Exemptions](https://documentation.lemonway.com/docs/exception-use-cases-for-wallet-usage.md)
- [KYC Update Sandbox Simulation](https://documentation.lemonway.com/docs/api-sandbox-only.md)
- [KYC Update - Use Cases](https://documentation.lemonway.com/docs/kyc-update-use-cases.md)
- [Handling KYC Updates - FAQs](https://documentation.lemonway.com/docs/kyc-update-faqs.md)
- [Safeguarding Customer Funds](https://documentation.lemonway.com/docs/safefunds.md): Find out how customer funds are safeguarded under European Banking regulations
- [Updates & Upgrades: Onfido (Entrust) Web SDK & Hosted Online Onboarding](https://documentation.lemonway.com/docs/stable-upgrades-opindo.md)
- [PSD3 - What can we expect?](https://documentation.lemonway.com/docs/psd3.md)
- [Marketplace VAT Regulation](https://documentation.lemonway.com/docs/marketplace-vat-regulation.md)
- [Lemonway Servers](https://documentation.lemonway.com/docs/location-of-lemonway-servers.md)
- [Instant Pay-Out - Eligible BIC Banks list](https://documentation.lemonway.com/docs/bic-instant-payouts.md)
- [Country Codes - ISO 21661](https://documentation.lemonway.com/docs/country-codes-iso.md)
- [Account holder death procedure](https://documentation.lemonway.com/docs/lemonway-account-holder-death.md)
- [Glossary](https://documentation.lemonway.com/docs/glossary.md): All the relevant terms that you might encounter while working with Lemonway
- [Tech](https://documentation.lemonway.com/docs/tech.md)
- [Payments](https://documentation.lemonway.com/docs/payments.md)
- [Security](https://documentation.lemonway.com/docs/security.md)
- [Lemonway Terminology](https://documentation.lemonway.com/docs/lemonway-specific-terms.md)
- [Regulations](https://documentation.lemonway.com/docs/regulations.md)
- [How to Contact Lemonway](https://documentation.lemonway.com/docs/how-to-contact-lemonway.md)
- [Site Map](https://documentation.lemonway.com/docs/site-map.md)
## API Reference
- [Create Individual Account for Onboarding](https://documentation.lemonway.com/reference/accountscontroller_createindividual.md): Creates a new individual Lemonway account for onboarding a new user. If the individual already has a Lemonway account but requires full onboarding, use POST /onboardings/individual and provide the user’s unique accountId. The is call estially validates you’ve provided all required bodyParams. • Creates an account record of type “individual.” • Associate a new wallet entry using the walletId. • Returns a populated account object (including an assigned Id) so you can pass it into subsequent onboarding calls.
- [Add Wallet to an Accepted Individual Profile](https://documentation.lemonway.com/reference/accountscontroller_createindividualwallet.md): Add a wallet to an existing profile that has already been accepted
- [Add Profile to an Accepted Individual Account](https://documentation.lemonway.com/reference/accountscontroller_createindividualprofile.md): Add a profile to an existing individual account that has already been accepted
- [Create Corporate Account with Legal Representative](https://documentation.lemonway.com/reference/accountscontroller_createlegalentity.md): Creates a new legal entity account by providing the entity’s details along with information about its legal representative. This request is typically the first step before initiating the onboarding process. Once created, the account will have an initial status (e.g., CREATED) and a profile status (e.g., AWAITING_INFORMATION)
- [Add Wallet to an Accepted Legal Entity Profile](https://documentation.lemonway.com/reference/accountscontroller_createlegalentitywallet.md): Add a wallet to an existing profile that has already been accepted
- [Add Profile to an Accepted Legal Entity Account](https://documentation.lemonway.com/reference/accountscontroller_createlegalentityprofile.md): Add a profile to an existing legal-entity account that has already been accepted
- [List Accounts (Individuals & Legal Entities)](https://documentation.lemonway.com/reference/accountscontroller_get.md): Retrieve a list of all individual (and/or corporate) accounts
- [Retrieve Account Overview (Profile, Wallets & Onboarding Status)](https://documentation.lemonway.com/reference/accountscontroller_find.md): Fetch details for a single account by its unique ID. The when endpoint is called the following information is provided: • Provides account information (id, identity, status) • Provides the Onboarding status • Profiles linked to this account • Wallets linked to this profile Note: When account details are retrieved using GET /accounts/{:id}, only the basic information submitted during account creation (POST /accounts) is returned if the end-user is still in the onboarding process. The full data set, including any submitted documents, becomes accessible once the onboarding is complete—meaning the account status is either ACCEPTED or DENIED
- [Get Account Document by ID and Type](https://documentation.lemonway.com/reference/accountscontroller_getfile.md): Fetches a previously uploaded document for a given account. The account is identified by its UUID (`accountId`), and the document by its name or logical identifier (`documentName`). ### Conditions - The account must be fully onboarded and accepted. - Document retrieval will fail if onboarding is incomplete or the account has not been approved. ### List of available documents - ApplicationForm (`APPLICATION_FORM`) - ArticlesOfAssociation (`ARTICLES_OF_ASSOCIATION`) - BoardMembersInformation (`BOARD_MEMBERS_INFORMATION`) - Brochure (`BROCHURE`) - CompanyRegistry (`COMPANY_REGISTRY`) - DrivingLicense (`DRIVING_LICENSE`) - EvidenceFile (`EVIDENCE_FILE`) - FamilyDocument (`FAMILY_DOCUMENT`) - LegalCapacityDocument (`LEGAL_CAPACITY_DOCUMENT`) - LegalRepresentativeDocument (`LEGAL_REPRESENTATIVE_DOCUMENT`) - MotionCapture (`MOTION_CAPTURE`) - NationalIdentityCard (`NATIONAL_IDENTITY_CARD`) - OfficialNotice (`OFFICIAL_NOTICE`) - Other (`OTHER`) - Passport (`PASSPORT`) - ProofOfAddress (`PROOF_OF_ADDRESS`) - ProofOfBankInformation (`PROOF_OF_BANK_INFORMATION`) - PublicationExcerpt (`PUBLICATION_EXCERPT`) - ResidencePermit (`RESIDENCE_PERMIT`) - ShareholdingStructureDocumentation (`SHAREHOLDING_STRUCTURE_DOCUMENTATION`) - SignedDocument (`SIGNED_DOCUMENT`) - TaxNotice (`TAX_NOTICE`) - UboDocument (`UBO_DOCUMENT`)
- [Start Individual Online Onboarding](https://documentation.lemonway.com/reference/onboardings_createonboarding.md): If the account’s profile status is awaiting_information, start the onboarding flow. To initiate the Online Onboarding process using the POST/onboardings/individual endpoint, you need to submit the same data you used for account creation, along with the accountId (Id) provided in the response. All other data are optional to initiate an Online Onboarding and will be collected directly from the end-user, ensuring compliance with KYC requirements without additional data input from your side. Note: Some end-user personal information may be pre-filled when they open onboarding page for the first time, notably the name, email and contact details. We use the initial end-user data you sent us to inject into online onboarding page. When you submit the payload, the API will: • Identify the account and link the KYC process to it. • All mandatory personal, contact, and address data for identity checks. • Assesses AML/PEP risk via political exposure, financial profile, and source of funds. • Verifies legal eligibility (age, capacity). • Understands the user’s business intent (FAREWELL project) and downstream beneficiary. • Redirects the user back to your specified redirectUrl once all steps succeed (or fail).
- [Add Document to an Individual in Onboarding](https://documentation.lemonway.com/reference/individualonboarding_uploaddocument.md): Upload a document associated with an individual currently being onboarded
- [Start Legal Entity Online Onboarding](https://documentation.lemonway.com/reference/onboardings_createcompanyonboarding.md): Initiates the online onboarding process for a legal entity whose profile status is AWAITING_INFORMATION. This call generates a secure onboarding session and returns a redirect URL where the end-user can complete their onboarding (e.g., KYC checks, document uploads).
- [Start Legal Entity Online Onboarding (Association)](https://documentation.lemonway.com/reference/onboardings_createassociationonboarding.md): Initiates the online onboarding process for a legal entity whose profile status is AWAITING_INFORMATION. This call generates a secure onboarding session and returns a redirect URL where the end-user can complete their onboarding (e.g., KYC checks, document uploads).
- [Start Legal Entity Online Onboarding (Sole-Trader)](https://documentation.lemonway.com/reference/onboardings_createsoletraderonboarding.md): Initiates the online onboarding process for a legal entity whose profile status is AWAITING_INFORMATION. This call generates a secure onboarding session and returns a redirect URL where the end-user can complete their onboarding (e.g., KYC checks, document uploads).
- [Add Document to a Legal Entity in Onboarding](https://documentation.lemonway.com/reference/legalentityonboarding_uploaddocument.md): Upload a document associated with a legal entity currently being onboarded
- [Get Onboarding Resume URL](https://documentation.lemonway.com/reference/onboardingscontroller_createurl-2.md): Retrieves a continuation (resume) URL for a previously-started, in-progress onboarding session. This allows an end-user to return to their onboarding process after leaving the session without completing it. Important: The onboardingId must be taken from the response returned by the onboarding creation endpoint (POST /onboardings/company, /association, /sole_trader, /individual). This ID is mandatory and must be included in the request path
- [Online Onboarding: Structure](https://documentation.lemonway.com/reference/online-onboarding-api-reference.md)
- [Onboarding Webhooks - Account and Profile Updates](https://documentation.lemonway.com/reference/online-onboarding-webhooks-statues.md): Account Creation and Status updates and Profile Status Updates
- [Hosted Online Onboarding](https://documentation.lemonway.com/reference/hosted-online-onboarding.md)
- [Onboarding Resources](https://documentation.lemonway.com/reference/resources.md)
- [Activity Rules](https://documentation.lemonway.com/reference/activity-rules-new.md)
- [Required Data for Indviduals & Legal Entities](https://documentation.lemonway.com/reference/required-data.md)
- [Additonal Data Requirements](https://documentation.lemonway.com/reference/additonal-data-requirements.md)
- [Validation Rules for Individuals](https://documentation.lemonway.com/reference/rules.md)
- [Validation Rules for Legal Entities](https://documentation.lemonway.com/reference/validation-rules-for-les.md)
- [Explorer Onboarding Payload Examples](https://documentation.lemonway.com/reference/onboardingpayload-examples.md)
- [Individual Payloads](https://documentation.lemonway.com/reference/individual-payloads.md)
- [Legal Entity Company](https://documentation.lemonway.com/reference/legal-entity-payloads.md)
- [Legal Entity Association](https://documentation.lemonway.com/reference/copy-of-legal-entity-company.md)
- [Onboarding HTTP Response Codes](https://documentation.lemonway.com/reference/online-onboarding-http-response-codes.md)
- [EU & UK Phone Regex Patterns](https://documentation.lemonway.com/reference/eu-uk-phone-regex-patterns.md)
- [API Deprecations - DirectKit API 2.0](https://documentation.lemonway.com/reference/api-deprecations.md)
- [OAuth Authentication ](https://documentation.lemonway.com/reference/authentication-oauth.md)
- [What is the Lemonway MCP?](https://documentation.lemonway.com/reference/mcp-x-lemonway.md)
- [Connecting Lemonway to Claude](https://documentation.lemonway.com/reference/connecting-to-claude.md)
- [How do I test cards on my Platform?](https://documentation.lemonway.com/reference/test-bank-cards.md)
- [Carte Bancaires (CB) Test Cards](https://documentation.lemonway.com/reference/cbtestcards.md)
- [Mastercard Test Cards](https://documentation.lemonway.com/reference/mastercardtestcards.md)
- [Visa Test Cards](https://documentation.lemonway.com/reference/visatestcards.md)
- [Get Detailed Payments Accounts Data](https://documentation.lemonway.com/reference/accounts_retrievepost.md): Lets your system to get detailed payment account information including:
payment account balance, account type, if the account is blocked, and account email address.
Fill at least one search field.
- [Generate an Electronic Signature of a Document](https://documentation.lemonway.com/reference/accounts_documentssigninitpost.md): This call lets you to generate an electronic signature.
**Note:** Only SDD mandates can be signed with this method.
**Prerequisite:** A Mandate needs to be registered with **RegisterSddMandate**
1. A call to `SignDocumentInit` of DirectKit to make the signature request and get a token.
2. A redirection from your website to the WebKit, with the token in GET parameter (see Finalize document signature).
3. A return page where your user will be redirected after the signature.
- [(Deprecated) Initialize a Deutsche Post POSTIDENT Identification](https://documentation.lemonway.com/reference/accounts_enrolmentinit.md)
- [Get Detailed Payment Account Data](https://documentation.lemonway.com/reference/accounts_accountsingleget.md): Enables your system to get detailed payment account information including:
* Payment account balance
* Account type
* Account status (if blocked or not)
* Account email address
- [Get Documents Associated with a Payment Account](https://documentation.lemonway.com/reference/accounts_documentget.md): Returns the document ID, document status, and document type of a users account.
**Note:** If you validate your Client's documentation using Lemonway's automated KYC, you will not receive a `validityDate` response.
- [Get Payment Account Balance History](https://documentation.lemonway.com/reference/accounts_balanceshistoryget.md): Enter an `accountId` and specify the `atDate` parameter to return an account balance.
**Important:** Payment account balances can not be viewed for special accounts SC **11** and LW **4** using the `accountId` parameter.
- [Get all Payment Account Balances](https://documentation.lemonway.com/reference/accounts_balancesget.md): Use `GetBalances` to get all payment accounts where the balance has changed since the input date, or all the balances of payment accounts with internal ID between payment `accountIdStart` and payment `accountIdEnd`.
**Important:** Payment account balances can not be viewed for special accounts SC **11** and LW **4** using the `accountId` parameter.
- [Get list of all Payment Account transactions](https://documentation.lemonway.com/reference/accounts_transactionsget.md): Use the `GetWalletTransHistory` to retrieve the list of **Money-In**, **Money-Out** and **P2P (payment between payment account)** of a given payment account.
The following numbered list corresponds to the payment type specified in the response attribute method:
0 Card
1 Bank transfer (MoneyIn)
3 Bank transfer (MoneyOut)
4 P2P
13 iDEAL
14 SEPA DirectDebit
15 Cheque
19 Multibanco
35 PayPal
---
**Important:** The following services have been discontinued.
16 Neosurf
17 Sofort
18 PFS Physical Card
20 Payshop
21 MBWAY
22 Polish Instant Transfer
23 Pagare
24 MobilePay
25 Paytrail
26 WeChat
27 P24
28 MoneyIn by TPE
29 Trustly
- [Block or Unblock an Account](https://documentation.lemonway.com/reference/accounts_blockedput.md)
- [Create a New Individual Account](https://documentation.lemonway.com/reference/accounts_individualpost.md): Lets you to create a individual payment account
1. Your Client enter their data on your platform, for example on their profile space.
2. Your server calls our Accounts API.
3. Lemonway creates the payment account in your environment.
4. Your system reads the method response and informs the user.
We apply our validation rules for different parameters.
**Check Injection:**
* String parameters (email, name and so on) must not contain odd characters.
**Names (first and last name)**
* Not made-up names: "name", "nom", "prénom", "prenom", "lastname", "last_name", "last name", "firstname", "first_name", "first name", "name", "test", "unknow"
* Names must have at least 2 characters with at least 1 vowel
* The first name must not be the same as the last name
* Using the same the same character 3 times in a row will cause an error
* We might apply other validation rules, for example: in the case VIP (politician)
- [Create an Ultimate Beneficial Owner](https://documentation.lemonway.com/reference/accounts_addultimatebeneficialowner.md): The method enables you to link an Ultimate Beneficial Owner to a legal payment account.
To be validated all Legal accounts need to provide their Ultimate Beneficial Owner information.
An Ultimate Beneficial Owner is a natural person that owns directly or indirectly (i.e. through another entity)
more than 25% of the shares/stock or voting rights of the legal entity, or a person having significant control over it
through other means. Any company established in EEA or EU is obliged to obtain and maintain this information with the competent
central register (as per article 30 of Directive 2015/843/EU).
Similar requirements may also exist in other countries.
In order to comply with AML-CTF legal provisions, payment institutions are required
to identify the beneficial owner(s) of a legal entity(i.e.a company or an organisation).
If the Legal Representative is also an Ultimate Beneficial Owner, you can specify this information when creating or updating a legal account.
- [Create a New Legal Account](https://documentation.lemonway.com/reference/accounts_legalpost.md): Lets you to create a legal payment account:
1. Your client enter their data on your platform, for example on their profile space.
2. Your server calls our Accounts API.
3. Lemonway creates the payment account in your environment.
4. Your system reads the method response and informs the user.
We apply validation rules for different parameters.
**Check Injection:**
* String parameters (email, name and so on) must not contain odd characters.
**Names (first and last name)**
* Not made-up names: "name", "nom", "prénom", "prenom", "lastname", "last_name", "last name", "firstname", "first_name", "first name", "name", "test", "unknow"
* Names must have at least 2 characters with at least 1 vowel
* The first name must not be the same as the last name
* Using the same the same character 3 times in a row will cause an error
* We might apply other validation rules, for example: in the case VIP (politician)
- [Upload Documents for KYC (Know Your Customers)](https://documentation.lemonway.com/reference/accounts_documentsuploadpost.md): KYC is a regulatory obligation for Payment Institutions. European Directive 2015/849 of the European Parliament states this requirement
for the prevention of the use of the financial system for the purposes of money laundering and terrorist financing.
To upload documents for KYC use the following guidelines:
* Use JPG, JPEG, PNG or PDF (maximum 2 pages) for ID documentation only (for example: Passport, Driving Licence and Residence Permit).
* Maximum file upload size is **4MB** for automatic verification.
* Minimum file upload size is **100KB**.
* Full Colour, and straighten file.
* Card ID: Scan both sides. One file should contain both sides (maximum 2 pages).
**Important** Documents over 4MB and upto 10MB will be manually validated.
**Note:** TIFF format is not accepted.
**Note:** If a document has been rejected, it is still possible to use the same slot to upload a new file.
- [Get all Ultimate Beneficial Owners associated to a payment account.](https://documentation.lemonway.com/reference/accounts_getultimatebeneficialowner.md): This method enables you get all the Ultimate Beneficial Owners associated to a legal payment account.
- [Find a user, document or an IBAN that has been modified since an entry date](https://documentation.lemonway.com/reference/accounts_kycstatusget.md): Use to find users, documents, IBAN for which the status has changed since a specified date.
**Note:** Returns the same user multiple times in the same request if his status has changed multiple time since a specified date.
- [Update Ultimate Beneficial Owner data](https://documentation.lemonway.com/reference/accounts_updateultimatebeneficialowner.md): This method enables you to update information related to an Ultimate Beneficial Owner.
- [Update Legal Payment Account Data](https://documentation.lemonway.com/reference/accounts_legalsingleput.md): This method enables you to update information relating to a **legal** client payment account.
1. The client enters their new data.
2. The client calls the Lemonway Webservice.
3. Lemonway records data when it exists.
4. The application processes Lemonway's response and displays a confirmation message.
- [Update Payment Account Status](https://documentation.lemonway.com/reference/accounts_kycstatusput.md): Allows certain payment account statuses to be updated.
- To close an account (status 12), the account must have zero balance.
- An account status can not be changed to bypass the KYC process. KYC statuses are updated by Lemonway.
- If an account is closed in status 6 (KYC 2) and you would like to reopen it, you must send a support request to Lemonway.
You can view all account statues [here.](https://documentation.lemonway.com/reference/wallet-status)
**Note:** This feature is subject to your contract.
- [Update Individual Payment Account Data](https://documentation.lemonway.com/reference/accounts_individualput.md): Enables you to update information related to a client payment account.
1. The client enters their new data.
2. The client calls the Lemonway Webservice.
3. Lemonway records data when it exists.
4. The application processes Lemonway's response and displays a confirmation message.
- [Initiate a Web Payment](https://documentation.lemonway.com/reference/moneyins_cardwebinitpost.md)
- [Initiate a Direct Payment (PCI-DSS compliant only)](https://documentation.lemonway.com/reference/moneyins_direct3dinitpost.md): **Payment with a New Card**
This method is more complex that non 3-D Secure payment, but 3-D Secure will ensure that your business is secure.
You will need 3 integration points:
1. By calling `POST /moneyins/card/direct/3dinit`, you receive a Authentication URL and a Transaction Id. If you want to register a card for to use card severval times or subscription payments set **registerCard=true.**
2. With the Authentication URL, you are able to redirect the end-user to the ACS (Bank Authentication Server) Page.
3. After 3D Secure Authentication, with the callback ReturnURL.
4. You need to then call `POST /moneyins/card/direct/{transactionid}/3dauthenticate` to verify the authentication process was done.
5. If the authentication was done then, you then call `PUT /moneyins/card/direct/{transactionid}/3dconfirm` specifying the returned Transaction Id to finalize the payment.
---
**Payment with a Registered Card**
1. Ensure you have a cardId then call `POST /moneyins/card/direct/3dinit` specifying the cardID parameter (cardId and CVV (optional)). If you want to improve the transaction success rate add the CVV code in the parameters.
2. Refer to **steps 2 - 5** as stated above.
**Note:** You require a cardId to make a transaction on a registered card. This id is displayed when you finalized your first payment with the registered card using `PUT /moneyins/card/direct/{transactionid}/3dconfirm`
Payments on a registered card use the following process:
Call MoneyIn3DInit ensuring that you include the `cardId` in the body of the request. Refer to steps **2 - 5** as stated above.
**Note:** To ensure that the client’s card has been registered, call the following method before you initiative payments on a registered card: `GetCard`
---
**Subscription Payments**
A prerequisite to setting up a subscription is that you have previously made a payment with a card and registered the card using `POST /moneyins/card/direct/3dinit`
**Note:** When you create a recurring payment ensure that the `recurringAvgAmount` is higher than totalAmount. If a lower amount is used for `recurringAvgAmount` you will receive a directkit error message 368: `recurringAvgAmount` should be greater than the transaction amount.
**Note:** After you have registered a card refer to `POST /moneyins/card/{cardid}/rebill` to begin setting up a subscription or payment by delivery system.
**Important:** To ensure the likelyhood of frictionless payments you must setup payments of equal recurring amounts.
- [Initiate Monthly Recurring Payments](https://documentation.lemonway.com/reference/moneyins_cardsubscriptionpost.md): Use the following steps to ensure a recurring payment can be setup:
1. Initiate a first transaction
If you are using the **PSP Payment** Page, you need to have initiated a Web Payment using `POST /moneyins/card/webinit` with **registerCard=true**.
If you are using the **Direct Mode** (PCI-DSS authorization required), you need to have registered a card using `POST /moneyins/card/register`.
2. You then need to initiate `POST /moneyins/card/{cardid}/subscription` specifying the Card Id returned from the first transaction, and the Subscription Id (a unique reference you indicate for this subscription).You will also need to precise the number of Recurring Payments you want us to initiate in count. The TotalAmount corresponds to the amount of each recurring payment. By default, the payment will be processed 15th of the month.
3. We will create scheduled transactions in the Lemonway Dashboard (status 14)
4. On each payment execution date, Lemonway will debit the card and change the pending transaction status to success, and then notify you.
- [Charge a Registered Card](https://documentation.lemonway.com/reference/moneyins_cardrebill.md)
- [Check Money-In 3D-Secure Status (PCI-DSS compliant only)](https://documentation.lemonway.com/reference/moneyins_carddirect3dauthenticatepost.md): After initializing a 3-D Secure transaction with POST /moneyins/card/direct/3dinit, you can choose not to debit the card, and only check if the user has successfully authenticated.
This is not a payment.
You can not use both POST /moneyins/card/direct/{transactionid}/3dauthenticate and PUT /moneyins/card/direct/{transactionid}/3dconfirm
- If you only want to check if the user was correctly authenticated use POST /moneyins/card/direct/{transactionid}/3dauthenticate)
- If you want to receive the payment using 3-DS use PUT /moneyins/card/direct/{transactionid}/3dconfirm
A typical use-case: you want to allow your user to save a card for rebills (RegisterCard), but first, you want to make sure that the card belongs to the user and that the user can authenticate successfully.
- [Credit an Account with Money-In with Card without PSP process](https://documentation.lemonway.com/reference/moneyins_cardcreatepost.md): Credit an account with Money-In with card without PSP process.
This functionality is available depending on your contract.
- [(Deprecated) Register a Card for Direct Payments (PCI-DSS compliant only)](https://documentation.lemonway.com/reference/moneyins_cardregisterpost.md): Register a card and associate it with a Payment Account. The end-user does not have to re-enter their card details for future payments.
Important: Ensure your website login is secured to avoid any security breach that may causes unauthorized access (for example, phishing).
Note: Lemonway does not recommend you use the MoneyIn method from January 2021. You should now use POST /moneyins/card/direct/3dini and PUT /moneyins/card/direct/{transactionid}/3dconfirm only.
- [(Deprecated) Credit an Account with a non 3-D Secure Card Payment (PCI-DSS compliant only)](https://documentation.lemonway.com/reference/moneyins_carddirectpost.md): If your system is not PCI-DSS do not to save any card data on your system.
This method enables you to credit an account with a non 3-D Secure card payment. Should only be used on mobile devices. For internet payments use 3-D Secure.
This method allows our system to credit a wallet and debit a card in real time. Your server has to send us the wallet ID to credit, all card data, the amount, and a comment.
Note: Lemonway does not recommend you use the MoneyIn method from January 2021. You should now use `POST /moneyins/card/direct/3dini` and `PUT /moneyins/card/direct/{transactionid}/3dconfirm` only.
- [Get the Card Associated to a Payment Account](https://documentation.lemonway.com/reference/moneyins_cardgetbyaccount.md)
- [Get Card Information](https://documentation.lemonway.com/reference/moneyins_cardget.md): Lets you retrieve card information.
- [Retrieve Payment Details](https://documentation.lemonway.com/reference/moneyins_moneyinget.md): Retrieves the details of a Payment that has previously been initiated.
- [Capture a Deferred Payment](https://documentation.lemonway.com/reference/moneyins_validateput.md): This call is only used in deferred payment. Pre-authroriztion validation can only be done once.
1. After initiating a pre-authorized Web Payment using `POST /moneyins/card/webinit`, you received a Transaction Id from Lemonway.
2. Depending on the number you specified as captureDelayedDays, funds are blocked between 1 to 6 days maximum.
3. To validate the pre-authorization, you need to call `PUT /moneyins/{transactionid}/validate`. If the capture is a success, then the original transaction status switches to Success.
- [Unregister a Card Token](https://documentation.lemonway.com/reference/moneyins_cardunregisterput.md): This method lets you unregister (break the link) between a card and a payment account.
- [Finalize a Direct Payment (PCI-DSS compliant only)](https://documentation.lemonway.com/reference/moneyins_carddirect3dconfirmput.md): This method finalizes the credit of a wallet by card after 3D Secure authentication of the client:
1. After initiating a Direct Payment using POST /moneyins/card/direct/3dinit, you receive an Authentication URL and a Transaction Id. If you want to register a card for future payments set **registerCard=true**
2. With the Authentication URL, you are able to redirect the end-user to the ACS (Bank Authentication Server) Page
3. After 3D Secure Authentication, you will be called back on the ReturnURL
4. You need to then call POST /moneyins/card/direct/{transactionid}/3dauthenticate to verify the authentication process was done.
5. If the authentication was done then call PUT /moneyins/card/direct/{transactionid}/3dconfirm specifying the return Transaction ID to finalize the payment.
For Subscriptions with equal recurring amounts: for the initial subscription payment, use the POST /moneyins/card/direct/3dinit and then POST /moneyins/card/direct/{transactionid}/3dauthenticate and PUT /moneyins/card/direct/{transactionid}/3dconfirm Ensure that you set: registerCard=true Use POST /moneyins/card/{cardid}/rebill for all subsequent payments.
- [MoneyIns | Apple Pay](https://documentation.lemonway.com/reference/moneyinsapplepay.md)
- [MoneyIns | Google Pay™](https://documentation.lemonway.com/reference/moneyins-google-pay.md)
- [Initiate Pay by PayPal](https://documentation.lemonway.com/reference/moneyins_moneyinpaypalinit.md): 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.
- [PayPal Resume](https://documentation.lemonway.com/reference/moneyins_paypaltransactionresume.md): 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](https://documentation.lemonway.com/reference/moneyins_paypaltransactioninit) to fully integrate.
- [Create New Pending Payment](https://documentation.lemonway.com/reference/moneyins_createbnplpayment.md): Depending on your activated payment plans this call will let you setup a new payment plan.
- [Get all Actived Payment Plans](https://documentation.lemonway.com/reference/moneyins_getbnplpaymentplans.md): Activated payment plans are summarized in a list that may consist of one, or more configured plans.
We offer 15 and 30 day deferment plans, and pay 3x and 4x plans.
**Note:** Payment plans are typically configured with a member of Lemonway's Implementation team.
- [Capture a Deferred Payment](https://documentation.lemonway.com/reference/capture-a-deferred-payment-2.md)
- [Create Payment Form (Pay by Link)](https://documentation.lemonway.com/reference/moneyins_cardpaymentformpost.md): Accept payments by an SMS, email, or document.
Create a form that permits your customers to make card payments by link.
- Payment forms are generated and managed by Lemonway.
- Payment forms are publicly accessible, making it possible for anyone to pay with a valid link.
- Payment by bank card is only supported.
Payment Scenerios:
1. **Benificary Wallet `walletReceiver` not specified**
You only specify `walletPayer` and not `walletReceiver` in the body parameters.
They make a card payment and funds are transfered to the `walletPayer` (a designated wallet)
2. **Payer and Benificary Wallet defined**
3. **Benificary pecified**
**Note:** Deferred payment is not supported.
- [Get Details of a Completed Payment Form](https://documentation.lemonway.com/reference/moneyins_paymentformcompletedget.md): This method lets you to retreive the status of a completed (or filled) payment form
Scenario