# Lemonway Documentation Documentation
## Guides
- [How to Contact Lemonway](https://documentation.lemonway.com/docs/how-to-contact-lemonway.md)
- [Site Map](https://documentation.lemonway.com/docs/site-map.md)
- [Improving Account Onboarding: Why Change Matters](https://documentation.lemonway.com/docs/improving-account-onboarding.md)
- [Getting Started with Online Onboarding](https://documentation.lemonway.com/docs/getting-started-with-onboarding.md)
- [Lemonway Online Onboarding](https://documentation.lemonway.com/docs/lemonway-online-onboarding-form.md)
- [Online Onboarding Essentials](https://documentation.lemonway.com/docs/onboarding-essentials.md)
- [Online Onboarding: Customization for a Better User Experience](https://documentation.lemonway.com/docs/onboarding-form-customisation.md)
- [Why Onboarding is a Critical First Step](https://documentation.lemonway.com/docs/onboarding-is-a-critical-first-step.md)
- [Online Onboarding live status](https://documentation.lemonway.com/docs/onboardingform-livestatus.md)
- [Save and Resume an Online Onboarding](https://documentation.lemonway.com/docs/onboardingform-resume-anytime.md)
- [KYC Update Sandbox Simulation](https://documentation.lemonway.com/docs/api-sandbox-only.md)
- [Account & Wallet Usage with Applied Exemptions](https://documentation.lemonway.com/docs/exception-use-cases-for-wallet-usage.md)
- [Handling KYC Updates - FAQs](https://documentation.lemonway.com/docs/kyc-update-faqs.md)
- [KYC Update - Use Cases](https://documentation.lemonway.com/docs/kyc-update-use-cases.md)
- [FAQs – Paper Identity Documents (EU/EEA)](https://documentation.lemonway.com/docs/faqs-paper-identity-documents-eueea.md)
- [Onboarding Help and FAQs](https://documentation.lemonway.com/docs/onboarding-faqs.md)
- [ Online Onboarding - Ask AI Prompts ](https://documentation.lemonway.com/docs/online-onboarding-ask-ai-prompts.md)
- [Online Onboarding - Troubleshooting for Developers](https://documentation.lemonway.com/docs/online-onboarding-troubleshooting-for-developers.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)
- [Online onboarding Identity Validation](https://documentation.lemonway.com/docs/identify-validation.md)
- [Online Onboarding an Individual](https://documentation.lemonway.com/docs/start-your-journey.md)
- [Individual Online Onboarding Summary](https://documentation.lemonway.com/docs/individual-onboarding-summary.md)
- [Individual Account Creation and Onboarding](https://documentation.lemonway.com/docs/individuals.md)
- [Individual Account Creation and Onboarding API Reference](https://documentation.lemonway.com/docs/onboarding-api-reference-individual.md)
- [Onboarding for Multiple Profiles & Wallets](https://documentation.lemonway.com/docs/online-onboarding-for-multiple-profiles-wallets.md)
- [Associations](https://documentation.lemonway.com/docs/associations.md)
- [Company Registered in the EU or Recognized Third Country](https://documentation.lemonway.com/docs/company-registered-in-the-eu.md)
- [Endowment Funds](https://documentation.lemonway.com/docs/endowment-funds.md)
- [Foundations](https://documentation.lemonway.com/docs/foundations.md)
- [General Interest Groups](https://documentation.lemonway.com/docs/general-interest-groups.md)
- [Onboarding Checklist: Required Documents](https://documentation.lemonway.com/docs/onlineonboardingessentialdocsneeded.md)
- [Insurance company](https://documentation.lemonway.com/docs/insurance-company.md)
- [Investment funds](https://documentation.lemonway.com/docs/investmentfunds.md)
- [Legal Entities: Non-Listed Company](https://documentation.lemonway.com/docs/legal-entities-non-listed-company.md)
- [Limited Liability Agricultural Company](https://documentation.lemonway.com/docs/llcompany.md)
- [Parish or Church](https://documentation.lemonway.com/docs/parishorchurch.md)
- [Social and Economic Committee (SEC)](https://documentation.lemonway.com/docs/sec.md)
- [Self-employed](https://documentation.lemonway.com/docs/selfemployed.md)
- [Skilled Trades](https://documentation.lemonway.com/docs/skilled-trades.md)
- [Unincorporated Funds (UIF)](https://documentation.lemonway.com/docs/unincorporated-funds.md)
- [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)
- [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 2: B2B Onboarding & Verification](https://documentation.lemonway.com/docs/b2b-onboardingverification.md)
- [Step 1: Create a merchant account](https://documentation.lemonway.com/docs/create-a-merchant-account.md)
- [B2B Marketplaces](https://documentation.lemonway.com/docs/b2b-marketplaces-landing.md)
- [Step 4: Transferring Funds to a Merchant's Bank Account](https://documentation.lemonway.com/docs/transferring-funds-to-a-merchants-bank-account.md)
- [Step 1: Create a seller account](https://documentation.lemonway.com/docs/b2ccreateselleraccount.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 2: B2C Onboarding & Verification](https://documentation.lemonway.com/docs/b2conboardingverification.md)
- [Step 4: Pay-Out - Transfering Funds to Seller](https://documentation.lemonway.com/docs/b2crequesting-earned-payment.md)
- [B2C Marketplaces](https://documentation.lemonway.com/docs/b2c-marketplacelanding.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
- [Apple Payments](https://documentation.lemonway.com/docs/applepayflows.md)
- [BNPL Payment](https://documentation.lemonway.com/docs/bnpl-flows.md)
- [Payment Flows](https://documentation.lemonway.com/docs/sqd.md): Sequence Diagrams that outline Lemonway payment flows
- [Pay By Bank Payment](https://documentation.lemonway.com/docs/pay-by-bank-flows.md)
- [Pay by Card - Direct Payment (PCI-DSS compliant only)](https://documentation.lemonway.com/docs/paybycarddirect-flows.md)
- [Pay by Card ](https://documentation.lemonway.com/docs/redirection-payments-flows.md)
- [Pay by Card with Registered Card](https://documentation.lemonway.com/docs/registered-card-flows.md)
- [Event Hooks](https://documentation.lemonway.com/docs/event-hooks.md)
- [Example Styles](https://documentation.lemonway.com/docs/examples.md)
- [Getting Started with a Basic Payment Form](https://documentation.lemonway.com/docs/getting-started-with-a-basic-payment-form.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.
- [Internationalization](https://documentation.lemonway.com/docs/internationalization.md)
- [SDK Buddle - Integration and SSR](https://documentation.lemonway.com/docs/sdk-buddle-integration-and-ssr.md)
- [Styling with SDK](https://documentation.lemonway.com/docs/styling-with-sdk.md): CSS Sanitization
- [Submit a Form](https://documentation.lemonway.com/docs/submit-a-form.md)
- [Synthetic Events](https://documentation.lemonway.com/docs/synthetic-events.md)
- [Toggling Classes](https://documentation.lemonway.com/docs/toggling-classes.md)
- [Lemonway Payment Page](https://documentation.lemonway.com/docs/lemonway-payment-page.md)
- [Bank Transfer Payments](https://documentation.lemonway.com/docs/bank-transfer-payments.md)
- [Card Payments](https://documentation.lemonway.com/docs/card-payments.md)
- [Configuration](https://documentation.lemonway.com/docs/configuration.md)
- [Developer documentation](https://documentation.lemonway.com/docs/developer-documentation.md)
- [Lemonway x Magento](https://documentation.lemonway.com/docs/lemonway-x-magento.md): Lemonway Payment Plugin
- [Installation](https://documentation.lemonway.com/docs/installation.md)
- [Prerequisites](https://documentation.lemonway.com/docs/pre-requisites.md)
- [SEPA Direct Debit payments](https://documentation.lemonway.com/docs/sepa-direct-debit-payments.md)
- [Lemonway x Mirakl](https://documentation.lemonway.com/docs/lemonway-x-mirakl.md)
- [CellfunPhones first sale!](https://documentation.lemonway.com/docs/firstsale.md)
- [Use Case - TechGadgets Marketplace](https://documentation.lemonway.com/docs/lemonwayxmirakl-usecase.md)
- [TechGadget - Money-Outs](https://documentation.lemonway.com/docs/lemonway-x-mirakl-money-outs.md)
- [Processing the buyer payment](https://documentation.lemonway.com/docs/payment-to-lemonway-by-mirakl.md)
- [Refunding a buyer](https://documentation.lemonway.com/docs/refundingbuyer.md)
- [Settling Payments](https://documentation.lemonway.com/docs/settlingpayments.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)
- [Configure your dashboard](https://documentation.lemonway.com/docs/configure-your-dashboard.md)
- [Manage Users](https://documentation.lemonway.com/docs/create-new-user.md)
- [User Configuration](https://documentation.lemonway.com/docs/user-admin-1.md)
- [Manage Roles](https://documentation.lemonway.com/docs/manage-roles.md)
- [API Keys](https://documentation.lemonway.com/docs/access-invoices.md)
- [Notifications](https://documentation.lemonway.com/docs/export-dashboard-data.md): Set up and configure automatic notifications in Lemonway Dashboard.
- [System Configuration](https://documentation.lemonway.com/docs/user-admin.md): Create, manage and deactivate Lemonway Dashboard users.
- [🆕 Dashboard Add individual or Legal Entitiy Account](https://documentation.lemonway.com/docs/dashboard-approval-workflow-for-pay-out-copy.md)
- [What is Lemonway Dashboard?](https://documentation.lemonway.com/docs/dashboardoverview.md)
- [Branding Lemonway Products in the Dashboard](https://documentation.lemonway.com/docs/branding-lemonway-products-in-the-dashboard.md)
- [Manage Your Products](https://documentation.lemonway.com/docs/manage-your-products.md)
- [Secure your dashboard](https://documentation.lemonway.com/docs/secure-your-dashboard.md)
- [Whitelisting an IP Address](https://documentation.lemonway.com/docs/ipwhitelist.md)
- [Reset Passwords](https://documentation.lemonway.com/docs/reset-password.md)
- [Enable Two-factor Authentication](https://documentation.lemonway.com/docs/twofactor-authentication.md)
- [Dashboard Languages](https://documentation.lemonway.com/docs/dashboard-languages.md): How to change the Dashboard display language.
- [Dashboard Menu](https://documentation.lemonway.com/docs/dashboard-menu.md)
- [Dashboard Tables](https://documentation.lemonway.com/docs/dashboard-tables.md)
- [Dashboard Updates](https://documentation.lemonway.com/docs/dashboard-updates.md)
- [Understand your dashboard](https://documentation.lemonway.com/docs/understand-your-dashboard.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)
- [Approval Workflow for Pay-Out](https://documentation.lemonway.com/docs/dashboard-approval-workflow.md)
- [Managing Transactions](https://documentation.lemonway.com/docs/managing-transactions.md)
- [Transactions](https://documentation.lemonway.com/docs/transactions.md)
- [Glossary](https://documentation.lemonway.com/docs/glossary.md): All the relevant terms that you might encounter while working with Lemonway
- [Lemonway Terminology](https://documentation.lemonway.com/docs/lemonway-specific-terms.md)
- [Payments](https://documentation.lemonway.com/docs/payments.md)
- [Regulations](https://documentation.lemonway.com/docs/regulations.md)
- [Security](https://documentation.lemonway.com/docs/security.md)
- [Tech](https://documentation.lemonway.com/docs/tech.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)
- [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)
- [Lemonway Servers](https://documentation.lemonway.com/docs/location-of-lemonway-servers.md)
- [Marketplace VAT Regulation](https://documentation.lemonway.com/docs/marketplace-vat-regulation.md)
- [PSD3 - What can we expect?](https://documentation.lemonway.com/docs/psd3.md)
- [Pre-activation checks](https://documentation.lemonway.com/docs/before-account-activation.md)
- [Creating your Lemonway Account](https://documentation.lemonway.com/docs/creating-your-lemonway-account.md)
- [Accessing Lemonway Tools and Services](https://documentation.lemonway.com/docs/how-to-access-lemonway-tools-and-services.md)
- [Connect Your Business to Lemonway](https://documentation.lemonway.com/docs/getting-started-lemonway.md)
- [Run Integration Tests](https://documentation.lemonway.com/docs/test-your-integration.md)
- [Whitelisting an IP address](https://documentation.lemonway.com/docs/whitelisting-an-ip-address.md)
- [Explore the Lemonway API in Postman](https://documentation.lemonway.com/docs/postman.md)
- [APM (Alternative Paymet Methods)](https://documentation.lemonway.com/docs/apm.md)
- [Capture and Track multi-capture payments](https://documentation.lemonway.com/docs/capture-and-track-multi-capture-payments.md)
- [How to use the Multi-capture](https://documentation.lemonway.com/docs/how-to-use-the-multi-capture.md)
- [Multi-capture Payment](https://documentation.lemonway.com/docs/multicapture.md)
- [Apple Pay Payments](https://documentation.lemonway.com/docs/apple-pay-lemonway.md)
- [Bank Transfer Refunds](https://documentation.lemonway.com/docs/bank-trasfer-refunds.md)
- [Bank Transfer](https://documentation.lemonway.com/docs/bank-transfer.md)
- [BNPL MoneyIn](https://documentation.lemonway.com/docs/bnpl-moneyin-moneyout.md)
- [BNPL MoneyOut](https://documentation.lemonway.com/docs/bnpl-moneyout.md)
- [Make a BNPL Refund](https://documentation.lemonway.com/docs/bnpl-refunds.md)
- [BNPL Error Codes and Messages](https://documentation.lemonway.com/docs/error-codes-bnpl.md)
- [BNPL (Buy Now Pay Later)](https://documentation.lemonway.com/docs/buy-now-pay-later.md)
- [How to integrate BNPL on your platform](https://documentation.lemonway.com/docs/integrate-bnpl.md)
- [Pay 3x or 4x Payment Plan](https://documentation.lemonway.com/docs/payment-plans.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)
- [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
- [Pay By Link](https://documentation.lemonway.com/docs/pay-by-link.md)
- [Pre-authorization](https://documentation.lemonway.com/docs/pre-authorization.md)
- [Redirection Guidelines](https://documentation.lemonway.com/docs/redirection-parameters.md)
- [Redirection](https://documentation.lemonway.com/docs/redirection.md)
- [Supported Cards](https://documentation.lemonway.com/docs/supported-card-payments.md)
- [Cheques](https://documentation.lemonway.com/docs/cheques.md)
- [Cheque](https://documentation.lemonway.com/docs/cheque-1.md)
- [Direct Debits](https://documentation.lemonway.com/docs/direct-debit.md)
- [SDD Refunds](https://documentation.lemonway.com/docs/sdd-refunds.md)
- [Our Payment Modes](https://documentation.lemonway.com/docs/payment-modes.md): What payment modes does Lemonway offer?
- [MBWay Payments](https://documentation.lemonway.com/docs/new-mbway-payments.md)
- [Supported Local Payment Methods](https://documentation.lemonway.com/docs/supported-payment-methods.md)
- [P2P transfers](https://documentation.lemonway.com/docs/p2p-transfers.md)
- [Pay by Bank](https://documentation.lemonway.com/docs/pay-by-bank.md)
- [Dashboard PayPal Statuses](https://documentation.lemonway.com/docs/dashboard-paypal-statuses.md)
- [Delayed PayPal Payment Capture ](https://documentation.lemonway.com/docs/delayed-payment-capture.md)
- [PayPal Payments](https://documentation.lemonway.com/docs/paypal-payments.md)
- [Make a PayPal Refund](https://documentation.lemonway.com/docs/make-a-paypal-refund.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)
- [Payment Methods We Support](https://documentation.lemonway.com/docs/supportedpayments.md): What payment modes does Lemonway offer?
- [Verification of Payee (VoP)](https://documentation.lemonway.com/docs/verification-of-payee-vop.md)
## API Reference
- [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 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 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 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 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
- [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.
- [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.
- [Block or Unblock an Account](https://documentation.lemonway.com/reference/accounts_blockedput.md)
- [Get all Ultimate Beneficial Owners associated to a payment account.](https://documentation.lemonway.com/reference/accounts_getultimatebeneficialowner-1.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-1.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.
- [Create an Ultimate Beneficial Owner](https://documentation.lemonway.com/reference/accounts_addultimatebeneficialowner-1.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.
- [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.
- [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 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)
- [Update Ultimate Beneficial Owner data](https://documentation.lemonway.com/reference/accounts_updateultimatebeneficialowner-1.md): This method enables you to update information related to an Ultimate Beneficial Owner.
- [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.
- [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 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.
- [Get list of disputes from a given date](https://documentation.lemonway.com/reference/disputes_disputesget.md)
- [Initializes an APM transaction.](https://documentation.lemonway.com/reference/moneyins_moneyinapminitasync.md)
- [Capture a Deferred Payment](https://documentation.lemonway.com/reference/capture-a-deferred-payment-2.md)
- [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.
- [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 Card Information](https://documentation.lemonway.com/reference/moneyins_cardget.md): Lets you retrieve card information.
- [Get the Card Associated to a Payment Account](https://documentation.lemonway.com/reference/moneyins_cardgetaccount.md)
- [Retrieve Payment Details](https://documentation.lemonway.com/reference/moneyins_moneyinget.md): Retrieves the details of a Payment that has previously been initiated.
- [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.
- [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.
- [Charge a Registered Card](https://documentation.lemonway.com/reference/moneyins_cardrebill.md): Important: Due to PSD2 requirements for strong authentication, rebilling with a registered card for amounts that change on each transaction is no longer available. In the short-term, for completely new transactions, we kindly ask you to use POST /moneyins/card/webinit and ask your clients to re-enter their card details in the payment page.
Use this method to ask to credit a payment account with a card linked to the payment account:
1. The payment account ID to credit
2. The card ID
3. The amount to credit
4. A comment explaining the rebill
It is important that you clarify why the card was rebilled for security and fraud reasons. Consider the following questions:
Is it a monthly payment for a service?, if so, which service?
What is name of the purchase website?, what was ordered?, and what email was used? Ensure that you add all information regarding the rebill
in the provided comment field.
Important: We may request further information to answer complains directly coming
to our Customer Service from your customers, or from Banks,Police,Visa/Mastercard, or from the financial regulator.
Recurring Payments
Initiate a first transaction
a. If you are using the PSP Payment Page, you need to have initiated a Web Payment using POST /moneyins/card/webinit with registerCard=true. The amount of the first transaction has to be higher than the recurring payments.
b. If you are using the Direct Mode (PCI-DSS complient only), you need to have registered a Card using POST /moneyins/card/register.
Recurring payments
You need to call POST /moneyins/card/{cardid}/rebill each time you want to make a recurring payment, precising the Card Id returned from step 1.
Payment Upon Delivery (Web PSP Payment only)
a. The day of the purchase: you need to have initiated a Web Payment using POST /moneyins/card/webinit with registerCard=true. You also need to indicate in captureDelayedDays, a number between 1 and 6 days. The amount of the first transaction has to be the same than the one captured later.
b. The day of the service or product delivery: you need to call POST /moneyins/card/{cardid}/rebill precising the Card Id returned from step 1.
- [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.
- [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.
- [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.
- [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.
- [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.
- [Search for Cheque Money-In by Date or by Token](https://documentation.lemonway.com/reference/moneyins_chequeget.md): 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.
- [Register a Cheque](https://documentation.lemonway.com/reference/moneyins_chequeinitpost.md): 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