Lemonway

https://documentation.lemonway.com/docs
Admin
Lemonway is a European Payment Institution providing payment services, an API, and a compliant,...
Tokens:186,043
Snippets:1,298
Trust Score:9.9
Update:7 months ago
Show doc for...
Tokens:
Raw
### Construct Payment URL (Example)

Source: https://documentation.lemonway.com/docs/redirection-parameters

This example demonstrates how to construct the Lemonway Payment URL by appending the 'moneyintoken', 'lang', and 'tpl' parameters. The 'moneyintoken' is obtained from the payment initiation response. The URL structure differs for production and sandbox environments.

```plaintext
Production: https://webkit.lemonway.fr/mb/YourEnvironmentName/prod/?moneyintoken=XXXXXXX&lang=XX&tpl=XXX
Sandbox: https://sandbox-webkit.lemonway.fr/YourEnvironmentName/dev/?moneyintoken=XXXXXXX&lang=XX&tpl=XXX
```

--------------------------------

### Start Company Legal Entity Onboarding (POST)

Source: https://documentation.lemonway.com/docs/b2b-onboardingverification

Initiates the onboarding process for a company legal entity. This endpoint is crucial for integrating merchant verification into your platform, allowing you to manage the entire journey without starting from scratch. It requires the necessary authentication and payload for company details.

```HTTP
POST /onboardings/company
```

--------------------------------

### POST /onboardings/company

Source: https://documentation.lemonway.com/docs/b2conboardingverification

Initiates the onboarding process for a company legal entity. This is the primary endpoint for starting the verification journey for businesses.

```APIDOC
## POST /onboardings/company

### Description
Start onboarding for a company legal entity. This endpoint is used to initiate the seller verification process for businesses on your platform.

### Method
POST

### Endpoint
/onboardings/company

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **company_name** (string) - Required - The name of the company.
* **registration_number** (string) - Required - The company's registration number.
* **address** (object) - Required - The company's address.
  * **street** (string) - Required
  * **city** (string) - Required
  * **postal_code** (string) - Required
  * **country_code** (string) - Required - ISO 3166-1 alpha-2 country code.
* **contact_email** (string) - Required - The primary contact email for the company.
* **contact_phone** (string) - Optional - The primary contact phone number for the company.

### Request Example
```json
{
  "company_name": "Example Corp",
  "registration_number": "123456789",
  "address": {
    "street": "123 Main St",
    "city": "Anytown",
    "postal_code": "12345",
    "country_code": "US"
  },
  "contact_email": "contact@example.com",
  "contact_phone": "+15551234567"
}
```

### Response
#### Success Response (201 Created)
- **onboarding_id** (string) - A unique identifier for the onboarding process.
- **status** (string) - The current status of the onboarding (e.g., 'PENDING', 'IN_PROGRESS').

#### Response Example
```json
{
  "onboarding_id": "onb_abc123xyz",
  "status": "PENDING"
}
```
```

--------------------------------

### Resume In-Progress Onboarding (GET)

Source: https://documentation.lemonway.com/docs/b2conboardingverification

Retrieves a resume link for an onboarding process that is currently in progress. Requires the onboarding ID in the URL.

```HTTP
GET /onboardings/{onboardingId}/resume
```

--------------------------------

### Resume Online Onboarding Endpoint (GET)

Source: https://documentation.lemonway.com/docs/onboardingform-resume-anytime

This snippet demonstrates how to resume an online onboarding process. It involves calling the GET endpoint `/onboardings/{accountId}/resume` to fetch the user's last saved session. This is typically implemented via a button or link.

```http
GET /onboardings/{accountId}/resume
```

--------------------------------

### Start Individual Seller Onboarding (POST)

Source: https://documentation.lemonway.com/docs/step-2

Initiates the onboarding process for an individual seller. This endpoint is crucial for integrating seller verification into your platform.

```HTTP
POST /onboardings/individual
```

--------------------------------

### Load Lemonway SDK (HTML)

Source: https://documentation.lemonway.com/docs/getting-started-with-a-basic-payment-form

Includes the Lemonway Hosted Fields SDK script in your HTML for production or sandbox environments. This allows for the creation and management of payment form fields.

```html
<script src="https://webkit.lemonway.fr/hosted-fields/sdk/@lw/hosted-fields-sdk-2.0.0.js" integrity="sha384-HE1ZALjbEZrCWdWTvn/y8j5sIGJbGql/Aa8iXwQrDdNwOFTigxLgBxJv5Qd0H7/K-" crossorigin="anonymous"></script>

```

```html
<script src="https://sandbox-webkit.lemonway.fr/hosted-fields/sdk/@lw/hosted-fields-sdk-2.0.0.js" integrity="sha384-oP56IGQvqCCNWXYmN1StTtGnUwruuc3wtzpvts3kVjI+I90TTWjwNDxOou2AW+Gx" crossorigin="anonymous"></script>

```

--------------------------------

### Lazy Load Lemonway SDK (JavaScript)

Source: https://documentation.lemonway.com/docs/getting-started-with-a-basic-payment-form

Demonstrates how to lazily import the Lemonway Hosted Fields SDK using dynamic import for improved website performance. This ensures the SDK is only loaded when needed.

```javascript
let LwHostedFields = (await import("https://webkit.lemonway.fr/hosted-fields/sdk/@lw/hosted-fields-sdk-2.0.0.js")).default

```

```javascript
let LwHostedFields = (await import("https://sandbox-webkit.lemonway.fr/hosted-fields/sdk/@lw/hosted-fields-sdk-2.0.0.js")).default

```

--------------------------------

### Start Company Onboarding

Source: https://documentation.lemonway.com/docs/b2conboardingverification

Initiates the onboarding process for a company. Requires account details and legal entity information. Returns a unique onboarding URL for user redirection.

```HTTP
POST https://onboarding-api.lemonway.com/onboardings/company
```

--------------------------------

### Create Individual Onboarding Link

Source: https://documentation.lemonway.com/docs/step-2

Initiates an individual onboarding process by creating a unique onboarding URL. Requires an account ID and seller details. Returns an onboarding ID and a redirect URL for the seller to complete KYC.

```http
POST https://onboarding-api.lemonway.com/onboardings/individual
```

--------------------------------

### Create Legal Entity - JSON Request

Source: https://documentation.lemonway.com/docs/online-onboarding-for-multiple-profiles-wallets

This JSON object represents a request to create a legal entity, including wallet ID and project details like description and website. It's used for initial setup or registration.

```json
{
 "walletId": "unique-wallet-id",
 "project": {
   "description": "Project description",
   "website": "example.com"
 }
}
```

--------------------------------

### Check Payment Status API Call (Webkit Webservice)

Source: https://documentation.lemonway.com/docs/pay-by-bank-flows

This is an example of an API call made by the Lemonway API Private Webservice to Tink to check the status of a payment. It uses a GET request to a specific endpoint with an authorization header.

```Shell
https://api.tink.com/api/v1/payments/requests/18408f41163f4748b87da9b9a68b6df8/transfers \
   -H 'Authorization: Bearer {YOUR_CLIENT_ACCESS_TOKEN}' \
   -H 'Content-Type: application/json'
```

--------------------------------

### Create Individual Onboarding

Source: https://documentation.lemonway.com/docs/step-2

Initiates an individual onboarding process. You provide seller data, and the API returns an onboarding URL for the user to complete their KYC process.

```APIDOC
## POST /onboardings/individual

### Description
Starts an individual onboarding process by creating a new onboarding application. The response includes a unique URL that redirects the user to Lemonway's hosted platform to complete their KYC verification and provide necessary details.

### Method
POST

### Endpoint
https://onboarding-api.lemonway.com/onboardings/individual

### Parameters
#### Query Parameters
None

#### Request Body
- **accountId** (string) - Required - The Lemonway account ID associated with the onboarding.
- **redirectUrl** (string) - Required - The URL to redirect the user to upon successful completion of the onboarding.
- **individual** (object) - Required - An object containing the individual's personal data.
  - **firstName** (string) - Required - The individual's first name.
  - **lastName** (string) - Required - The individual's last name.
  - **birthDate** (string) - Required - The individual's date of birth (YYYY-MM-DD).
  - **email** (string) - Required - The individual's email address.
  - **address** (object) - Required - The individual's address details.
    - **country** (string) - Required - The ISO 3166-1 alpha-2 country code.
  - **birthCountry** (string) - Required - The ISO 3166-1 alpha-2 country code of birth.
  - **nationalities** (array of strings) - Required - An array of ISO 3166-1 alpha-2 country codes representing nationalities.

### Request Example
```json
{
  "accountId": "acc_8f3c2b1a",
  "redirectUrl": "https://www.yourcompany.com/success",
  "individual": {
    "firstName": "Camille",
    "lastName": "Dubois",
    "birthDate": "1992-06-01",
    "email": "camille.dubois@example.com",
    "address": {
      "country": "FR"
    },
    "birthCountry": "FR",
    "nationalities": ["FR"]
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created onboarding.
- **url** (string) - The URL to redirect the user to for completing the onboarding process.

#### Response Example
```json
{
  "id": "onb_2c91b0a4",
  "url": "https://onboarding.sandbox.lemonway.com/2c91b0a4/welcome"
}
```
```

--------------------------------

### Get Bank List Query and Output (JSON)

Source: https://documentation.lemonway.com/docs/pay-by-bank

This snippet shows an example JSON request to retrieve a list of banks for a specified country code (e.g., 'FR') and the corresponding JSON output containing bank details like parent name, logo URL, bank name, and bank ID.

```json
{
   "countryCode": ["FR"]
}
```

```json
{
        "banks": {
        "FR": [
            {
                "countryCode": "FR",
                "parentName": "Crédit Agricole",
                "logoURL": "https://cdn.tink.se/provider-images/frfr-creditagricole.png",
                "bankName": "Banque Chalus",
                "bankId": "fr-creditagricolebanquechalus-ob",
                "segments": [
                    "PERSONAL"
                ]
            },
            {
                "countryCode": "FR",
                "parentName": "Banque Populaire",
                "logoURL": "https://cdn.tink.se/provider-images/fr/                   fr-banquepopulaire.png",
                "bankName": "Banque Populaire Alsace Lorraine                         Champagne",
                "bankId": "fr-bpalsacelorrainechampagne-ob",
                "segments": [
                    "PERSONAL"
                ]
            },
            {
                "countryCode": "FR",
                "parentName": "Banque Populaire",
                "logoURL": "https://cdn.tink.se/provider-images/fr/                   fr-banquepopulaire.png",
                "bankName": "Banque Populaire Aquitaine Centre                        Atlantique",
                "bankId": "fr-bpaquitainecentreatlantique-ob",
                "segments": [
                    "PERSONAL"
                ]
            },
            {
                "countryCode": "FR",
                "parentName": "Banque Populaire",
                "logoURL": "https://cdn.tink.se/provider-images/fr/                   fr-banquepopulaire.png",
                "bankName": "Banque Populaire Auvergne et                             Rhône-Alpes",
                "bankId": "fr-bpauvergneetrhonealpes-ob",
                "segments": [
                    "PERSONAL"
                ]
            },
            {
                "countryCode": "FR",
                "parentName": "Banque Populaire",
                "logoURL": "https://cdn.tink.se/provider-images/fr/                   fr-banquepopulaire.png",
                "bankName": "Banque Populaire Bourgogne                               Franche-Comté",
                "bankId": "fr-bpbourgognefranchecomte-ob",
                "segments": [
                    "PERSONAL"
                ]
            }
         ]
     }
    }
```

--------------------------------

### Get BNPL Payment Plans

Source: https://documentation.lemonway.com/docs/integrate-bnpl

Retrieves a list of active BNPL payment plans configured with Lemonway. This call does not require any parameters or a request body. The response contains a list of payment plans, each with a unique ID, provider, type, and installment information. An empty list indicates no active plans.

```json
{
    "paymentPlans": [
        {
            "id": 1,
            "provider": "Oney",
            "type": "installments",
            "installments": 4
        }
    ]
}
```

```json
{
    "paymentPlans": [
        {
            "id": 20001,
            "provider": "Oney",
            "type": "Payment 4x Oney Payment",
            "installments": 4
        },
        {
            "id": 2,
            "provider": "Oney",
            "type": "Payment Oney 3x Free ",
            "installments": 3
        }
    ]
}
```

```json
{
    "paymentPlans": []
}
```

--------------------------------

### POST /moneyins/card/webinit/

Source: https://documentation.lemonway.com/docs/applepayflows

Initiates a web-based payment process, likely for Apple Pay integration, returning a token for further steps.

```APIDOC
## POST /moneyins/card/webinit/

### Description
Initiates a web-based payment process, likely for Apple Pay integration, returning a token for further steps.

### Method
POST

### Endpoint
/moneyins/card/webinit/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **transactionDetails** (object) - Required - Details of the transaction.
  * **amount** (integer) - Required - The transaction amount in cents.
  * **currency** (string) - Required - The ISO currency code (e.g., "978" for EUR).
  * **returnUrl** (string) - Required - The URL to redirect the user to after payment.
  * **orderNumber** (string) - Optional - A unique identifier for the order.
  * **statementDescriptor** (string) - Optional - A descriptor for the transaction statement.

### Request Example
```json
{
  "transactionDetails": {
    "amount": 1000,
    "currency": "978",
    "returnUrl": "https://example.com/return",
    "orderNumber": "ORDER123",
    "statementDescriptor": "My Service"
  }
}
```

### Response
#### Success Response (200)
* **webkitToken** (string) - A token required for subsequent Apple Pay operations.

#### Response Example
```json
{
  "webkitToken": "some_webkit_token_value"
}
```
```

--------------------------------

### Install Lemonway Payment Plugin using Composer

Source: https://documentation.lemonway.com/docs/installation

This snippet shows the Composer command to install the Lemonway payment plugin. It is a prerequisite for integrating the plugin into your Adobe Commerce store.

```bash
composer require lemonway/payment
```

--------------------------------

### POST /onboardings/company

Source: https://documentation.lemonway.com/docs/b2conboardingverification

Initiates the onboarding process for a company. This endpoint requires seller data and an account ID, returning a unique onboarding URL for the user to complete verification.

```APIDOC
## POST /onboardings/company

### Description
Initiates the onboarding process for a company. This endpoint requires seller data and an account ID, returning a unique onboarding URL for the user to complete verification.

### Method
POST

### Endpoint
https://onboarding-api.lemonway.com/onboardings/company

### Parameters
#### Request Body
- **accountId** (string) - Required - The Lemonway account ID.
- **redirectUrl** (string) - Required - The URL to redirect the user to after onboarding completion.
- **legalEntity** (object) - Required - Information about the legal entity.
  - **name** (string) - Required - The legal name of the company.
  - **brandName** (string) - Optional - The brand name of the company.
  - **registrationNumber** (string) - Required - The company's registration number.
  - **registrationDate** (string) - Required - The company's registration date (YYYY-MM-DD).
  - **vatNumber** (string) - Optional - The company's VAT number.
  - **address** (object) - Required - The company's address.
    - **street** (string) - Required - Street name and number.
    - **city** (string) - Required - City.
    - **postalCode** (string) - Required - Postal code.
    - **country** (string) - Required - Country code (ISO 3166-1 alpha-2).
- **legalRepresentative** (object) - Required - Information about the legal representative.
  - **firstName** (string) - Required - First name.
  - **lastName** (string) - Required - Last name.
  - **birthDate** (string) - Required - Date of birth (YYYY-MM-DD).
  - **birthCountry** (string) - Required - Country of birth code (ISO 3166-1 alpha-2).
  - **email** (string) - Required - Email address.
  - **phoneNumber** (string) - Required - Phone number.
  - **nationalities** (array) - Required - Array of nationality codes (ISO 3166-1 alpha-2).
  - **address** (object) - Optional - The legal representative's address.
    - **country** (string) - Required - Country code (ISO 3166-1 alpha-2).

### Request Example
```json
{
    "accountId": "a35f9d5a-9d5b-4f1e-86b2-bfd067fd07d1",
    "redirectUrl": "https://www.yourcompany.com/success",
    "legalEntity": {
        "name": "Chloe Rossi Corp",
        "brandName": "Chloe brand",
        "registrationNumber": "246810-357",
        "registrationDate": "2021-06-15",
        "vatNumber": "VAT845726",
        "address": {
            "street": "45 Avenue Victor Hugo",
            "city": "Paris",
            "postalCode": "75008",
            "country": "FR"
        }
    },
    "legalRepresentative": {
        "firstName": "Louis",
        "lastName": "Bianchi",
        "birthDate": "1991-11-03",
        "birthCountry": "FR",
        "email": "louis.bianchi@example.com",
        "phoneNumber": "+33678787878",
        "nationalities": [
            "FR"
        ],
        "address": {
            "country": "PT"
        }
    }
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique ID of the onboarding process.
- **url** (string) - The URL for the Lemonway hosted onboarding platform.

#### Response Example
```json
{
  "id": "ff928147-d51e-4f22-b26c-d2c1a2sebd8d",
  "url": "https://onboarding.sandbox.lemonway.com/d6795611-e957-457f-83fc-dd1c03775c08/welcome"
}
```
```

--------------------------------

### Upgrade Adobe Commerce Instance after Plugin Installation

Source: https://documentation.lemonway.com/docs/installation

After installing or updating the Lemonway payment plugin, this command upgrades your Adobe Commerce instance to apply the changes. This is a standard step in Magento extension management.

```bash
bin/magento setup:upgrade
```

--------------------------------

### Install Composer Package with Increased Memory Limit

Source: https://documentation.lemonway.com/docs/installation

This command installs a Composer package while temporarily increasing the PHP memory limit to unlimited. This is a workaround for 'Allowed memory size exhausted' errors during Composer operations.

```bash
php -d memory_limit=-1 vendor/bin/composer require lemonway/payment
```

--------------------------------

### POST /accounts/individual

Source: https://documentation.lemonway.com/docs/individuals

Initiates the creation of an individual account and starts the onboarding process. This is the first step for new user onboarding. If KYC is required, an onboarding page link can be generated.

```APIDOC
## POST /accounts/individual

### Description
This method provides the minimum necessary information required to create an individual account at Lemonway. This is the first step for any onboarding of a new user. With this information, we can initiate the onboarding process. If a KYC onboarding is required, you can generate an Onboarding page link associated with this account. This link can then be sent to your user to submit the essential data and documents needed for legal onboarding.

### Method
POST

### Endpoint
/accounts/individual

### Parameters
#### Request Body
- **individual** (object) - Required - Contains the personal details of the individual.
  - **firstName** (string) - Required - The first name of the individual.
  - **lastName** (string) - Required - The last name of the individual.
  - **birthDate** (string) - Required - The date of birth of the individual (ISO 8601 format).
  - **email** (string) - Required - The email address of the individual.
  - **birthCity** (string) - Required - The city of birth of the individual.
  - **birthCountry** (string) - Required - The country of birth of the individual (ISO 3166-1 alpha-2 code).
  - **phoneNumber** (string) - Required - The phone number of the individual (E.164 format).
  - **nationalities** (array of strings) - Required - A list of the individual's nationalities (ISO 3166-1 alpha-2 codes).
  - **address** (object) - Required - The residential address of the individual.
    - **street** (string) - Required - The street name and number.
    - **complementaryStreetInfo** (string) - Optional - Additional street information (e.g., apartment number, building name).
    - **postalCode** (string) - Required - The postal code.
    - **city** (string) - Required - The city.
    - **residenceCountry** (string) - Required - The country of residence (ISO 3166-1 alpha-2 code).
- **profile** (string) - Required - The profile type for the account (e.g., "PROJECT_HOLDER").
- **walletId** (string) - Required - The ID of the wallet associated with the account.
- **solutionName** (string) - Required - The name of the solution being used.

### Request Example
```json
{
    "individual": {
        "firstName":  "Johnathan",
        "lastName": "Lamary",
        "birthDate": "1973-06-01T10:10:57.870Z",
        "email": "JLamry55@gmail.com",
        "birthCity": "Paris",
        "birthCountry": "FR",
        "phoneNumber": "+33675869559",
        "nationalities": [
            "FR",
            "GB"
        ],
        "address": {
            "street": "24 rue des peupliers",
            "complementaryStreetInfo": "bis",
            "postalCode": "92130",
            "city": "Issy",
            "residenceCountry": "FR"
        }
  },
  "profile": "PROJECT_HOLDER",
  "walletId": "f2470b35-4dd4-4fe1-bab2-f8c763ebcef5",
  "solutionName": "lemonway"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created account.
- **status** (string) - The current status of the account (e.g., "CREATED").
- **profileStatus** (string) - The status of the account's profile, which may be "AWAITING_INFORMATION" if onboarding is required.

#### Response Example
```json
{
   "id": "cfbaea10-77b9-4dd9-ba6a-0255ba39d135",
   "status": "CREATED",
   "profileStatus": "AWAITING_INFORMATION"
}
```
```

--------------------------------

### Compile DI and Deploy Static Content for Production Mode

Source: https://documentation.lemonway.com/docs/installation

For Adobe Commerce installations in production mode, these commands are necessary after installing or updating the Lemonway payment plugin. They compile the dependency injection configuration and deploy static view files.

```bash
bin/magento setup:di:compile
bin/magento setup:static-content:deploy
```

--------------------------------

### Clear Adobe Commerce Cache

Source: https://documentation.lemonway.com/docs/installation

This command clears the Adobe Commerce cache after installing or updating the Lemonway payment plugin. Caching issues can prevent new configurations from taking effect.

```bash
bin/magento cache:clear
```

--------------------------------

### Submit Document for Onboarding (POST)

Source: https://documentation.lemonway.com/docs/step-2

Allows for the submission of documents related to an ongoing individual seller onboarding process. Requires the onboarding ID to associate the document with the correct user.

```HTTP
POST /onboarding/{onboardingId}/document
```

--------------------------------

### View Composer Authentication File

Source: https://documentation.lemonway.com/docs/installation

This command displays the content of the `auth.json` file, which stores your Composer authentication keys. Verifying these keys is crucial for resolving installation errors related to package availability.

```bash
cat /path/to/auth.json
```

--------------------------------

### Individual Onboarding API

Source: https://documentation.lemonway.com/docs/step-2

Endpoints for initiating and managing the individual seller onboarding process.

```APIDOC
## POST /onboardings/individual

### Description
Starts the onboarding process for an individual seller.

### Method
POST

### Endpoint
/onboardings/individual

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
(Details not provided in the source text)

### Request Example
(Not provided in the source text)

### Response
#### Success Response (200)
(Details not provided in the source text)

#### Response Example
(Not provided in the source text)

## POST /onboarding/{onboardingId}/document

### Description
Submits a document for an ongoing onboarding process.

### Method
POST

### Endpoint
/onboarding/{onboardingId}/document

### Parameters
#### Path Parameters
- **onboardingId** (string) - Required - The unique identifier for the onboarding process.

#### Query Parameters
None

#### Request Body
(Details not provided in the source text)

### Request Example
(Not provided in the source text)

### Response
#### Success Response (200)
(Details not provided in the source text)

#### Response Example
(Not provided in the source text)
```
Tokens:
Raw