Before you begin
Download the latest version of the connector from our GitHub page.
The connector requires a Java 8 Runtime Environment, and can be installed in any operating system supporting Java 8 including Linux, Windows Server, and Mac OS.
Before you start setting up the connector, make sure that you have performed the following steps:
- Sign up for a test account with Adyen at https://www.adyen.com/signup, and contact our Support Team to enable Adyen for Platforms.
- Arrange a hosting environment for deploying the connector.
Step 1: Configure the connector
Adyen for Platforms
- To allow the connector to interact with Adyen for Platforms, define the following system environment variables in your system:
Variable | Description |
---|---|
ADYEN_ENV |
Specifies whether you are using Adyen live or test environment. Possible values:
|
ADYEN_USER_NAME |
Your Adyen API credential username, for example: ws_99999@MarketPlace.[YourMerchantAccount] To find this:
|
ADYEN_PASS |
The password for your Adyen API credential. To generate this:
|
ADYEN_NOTIFY_URL |
Internet accessible endpoint for receiving webhook notifications: https://www.[*YOUR-DOMAIN*].com/api/adyen-notifications |
ADYEN_LIABLE_ACCOUNT_CODE |
The
|
Mirakl Marketplace
-
Create a Mirakl user exclusively for the Adyen connector:
- In the Mirakl back office menu bar, go to Administration > User Management.
- Select Add an operator account user.
This opens a window for adding the details for the new user. - In the User name box, enter the email address of the user.
Associate the user to the following roles, by checking the corresponding boxes:- Shop, Sales and Inventory Administration
- API Access
- To allow the connector to interact with Mirakl Marketplace, define the following system environment variables in your system:
Variable | Description |
---|---|
MIRAKL_OPERATOR_EMAIL | The email address of the operator user who receives notification emails from the connector. This email also appears in the from field of emails sent to sellers. |
MIRAKL_API_OPERATOR_KEY |
The API key for the Adyen connector. To generate this:
|
MIRAKL_ENV_URL | Operator API path for the Mirakl environment. Example: https://dev.mirakl.net |
MIRAKL_SDK_USER and MIRAKL_SDK_PASSWORD | Your credentials for the Mirakl Artifactory Repository, needed for the connector to retrieve the Java SDK. To get these credentials, contact the Mirakl Support Team. |
MIRAKL_TIMEZONE | The timezone of your Mirakl Marketplace. Example: Europe/Amsterdam |
Mail server (SMTP)
- To allow the connector to interact with your email server, define the following system environment variables in your system:
Variable | Description |
---|---|
MAIL_HOST | Host name of the SMTP server |
MAIL_PORT | Port of SMTP server |
MAIL_USER | SMTP username |
MAIL_PASS | SMTP password |
You can customize the emails that the connector sends to the operator and the sellers. To do that, fork the adyen-mirakl repository, and modify the Thymeleaf templates.
Notifications
-
To encrypt webhook notifications that the connector receives from Adyen, you need to set up basic authentication credentials by defining the following environment variables in your system:
Variable Description NOTIFY_USERNAME Your username for notifications. NOTIFY_PASSWORD Your password for notifications. -
Use the above credentials to configure an endpoint for receiving payment vouchers from Mirakl:
- Log in to the Mirakl back office as the Adyen connector user.
- Go to Administration > Technical Settings > Shop Payments.
- Set the Transmission type to HTTP.
- In the URL box, enter:
https://[NOTIFY_USERNAME:NOTIFY_PASSWORD@YourConnectorHostname]/api/mirakl-notifications/payout - Set Method to Post.
- Select Save.
Step 2: Set up database connection
The connector requires a connection to a Java Persistence API (JPA) compatible database such as MySQL, Percona, Postgres, Oracle RAC, or MS SQL Server.
By default, the connector attempts to connect to localhost MySQL server, and use a database called adyenmiraklconnector with root user.
To define the database URL:
- Go to the config package: /adyen-mirakl/src/main/resources/config
- Modify the following files:
- application-dev.yml – for development.
- application-prod.yml – for production.
In development mode, you can also use an internal database. The database is visible through the console: http://localhost:8080/h2-console.
Step 3: Add custom fields to Mirakl
For the KYC process, you need to add custom fields and document fields in your Mirakl back office.
- In the Mirakl back office, go to Settings > Shops > Custom fields.
-
Select Add a custom field, and fill in the information as indicated in the table below.
- The Code and Type field have to be set exactly as indicated in the table below.
- For adyen-legal-entity-type, set Shop permission to Read only.
For other fields, set Shop permission to Read write. - If you only want to onboard individual sellers, only add fields tagged with Individual.
If you only want to onboard business sellers, you can omit all fields tagged with Individual.
Code | Label | Description | Type |
---|---|---|---|
adyen-legal-entity-type | Legal Entity Type | Whether the seller is an Individual or Business |
Single values list Accepted values:
|
adyen-individual-dob Individual |
Individual - Date of Birth | Enter Date of Birth for Identity Checks | Date |
adyen-individual-nationality Individual |
Individual - Nationality | Nationality - in ISO 2 format (i.e. GB = Great Britain) |
Single values list Accepted values:
|
adyen-individual-housenumber Individual |
Individual - House Number | Provide your home address number or name that will be used to validate your account | Text |
adyen-individual-photoidtype Individual |
Individual - Photo ID Type | The Type of Photo ID you have uploaded |
Single values list Accepted values:
|
adyen-individual-idnumber Individual |
Individual - ID Number | The ID Number from the Photo ID you have uploaded | Text |
adyen-business-registeredname | Business - Registered Name | Business - Registered Name (only needed if different from Legal Company Name) | Text |
adyen-business-housenumber | Business - Building Number or Name | Business - Building Number / Name | Text |
adyen-business-phonetype | Business - Phone Type | Business - Phone Type |
Single values list Accepted values:
|
adyen-business-phonecountry | Business - Phone Country | Business - Phone Country |
Single values list Accepted values:
|
adyen-ubo1-civility | UBO 1 - Civility | Shareholder - Title |
Single values list Accepted values:
|
adyen-ubo1-firstname | UBO 1 - First Name | Shareholders - First Name | Text |
adyen-ubo1-lastname | UBO 1 - Last Name | Shareholders - Last Name | Text |
adyen-ubo1-email | UBO 1 - Email | Shareholders - Email | Text |
adyen-ubo1-dob | UBO 1 - Date of Birth | Shareholders - Date of Birth | Date |
adyen-ubo1-nationality | UBO 1 - Nationality | Shareholders - Nationality |
Single values list Accepted values:
|
adyen-ubo1-idnumber | UBO 1 - ID Number | Shareholders - ID Number of Photo ID | Text |
adyen-ubo1-photoidtype | UBO 1 - Photo ID Type | Shareholders - The Type of Photo ID for the shareholder uploaded |
Single values list Accepted values:
|
adyen-ubo1-housenumber | UBO 1 - House Name or Number | Shareholders - House Name or Number | Text |
adyen-ubo1-streetname | UBO 1 - Street Name | Shareholders - Street Name | Text |
adyen-ubo1-city | UBO 1 - City | Shareholders - City | Text |
adyen-ubo1-zip | UBO 1 - Zip | Shareholders - Zip or Postal Code | Text |
adyen-ubo1-country | UBO 1 - Country | Shareholders - Home Country |
Single values list Accepted values:
|
adyen-ubo1-phonetype | UBO 1 - Phone Type | Shareholders - Type of Phone |
Single values list Accepted values:
|
adyen-ubo1-phonecountry | UBO 1 - Phone Number Country | Shareholders - Phone country |
Single values list Accepted values:
|
adyen-ubo1-phonenumber | UBO 1 - Home Country Contact Number | Shareholders - Phone number | Text |
adyen-ubo2-civility | UBO 2 - Title | Shareholders - Title |
Single values list Accepted values:
|
adyen-ubo2-firstname | UBO 2 - First Name | Shareholders - First Name | Text |
adyen-ubo2-lastname | UBO 2 - Last Name | Shareholders - Last Name | Text |
adyen-ubo2-email | UBO 2 - Email | Shareholders - Email | Text |
adyen-ubo2-dob | UBO 2 - Date of Birth | Shareholders - Date of Birth | Date |
adyen-ubo2-nationality | UBO 2 - Nationality | Shareholders - Nationality |
Single values list Accepted values:
|
adyen-ubo2-idnumber | UBO 2 - ID Number | Shareholders - ID Number of Photo ID | Text |
adyen-ubo2-photoidtype | UBO 2 - Photo ID Type | Shareholders - The Type of Photo ID for the shareholder uploaded |
Single values list Accepted values:
|
adyen-ubo2-housenumber | UBO 2 - House Name or Number | Shareholders - House Name or Number | Text |
adyen-ubo2-streetname | UBO 2 - Street Name | Shareholders - Street Name | Text |
adyen-ubo2-city | UBO 2 - City | Shareholders - City | Text |
adyen-ubo2-zip | UBO 2 - Zip | Shareholders - Zip | Text |
adyen-ubo2-country | UBO 2 - Country | Shareholders - Country |
Single values list Accepted values:
|
adyen-ubo2-phonetype | UBO 2 - Phone Type | Shareholders - Type of Phone |
Single values list Accepted values:
|
adyen-ubo2-phonecountry | UBO 2 - Phone Country | Shareholders - Phone country |
Single values list Accepted values:
|
adyen-ubo2-phonenumber | UBO 2 - Phone Number | Shareholders - Phone Number | Text |
adyen-ubo3-civility | UBO 3 - Title | Shareholders - Title |
Single values list Accepted values:
|
adyen-ubo3-firstname | UBO 3 - First Name | Shareholders - First Name | Text |
adyen-ubo3-lastname | UBO 3 - Last Name | Shareholders - Last Name | Text |
adyen-ubo3-email | UBO 3 - Email | Shareholders - Email | Text |
adyen-ubo3-dob | UBO 3 - Date of Birth | Shareholders - Date of Birth | Date |
adyen-ubo3-nationality | UBO 3 - Nationality | Shareholders - Nationality |
Single values list Accepted values:
|
adyen-ubo3-idnumber | UBO 3 - ID Number | Shareholders - ID Number of Photo ID | Text |
adyen-ubo3-photoidtype | UBO 3 - Photo ID Type | Shareholders - The Type of Photo ID for the shareholder uploaded |
Single values list Accepted values:
|
adyen-ubo3-housenumber | UBO 3 - House Name or Number | Shareholders - House Name or Number | Text |
adyen-ubo3-streetname | UBO 3 - Street Name | Shareholders - Street Name | Text |
adyen-ubo3-city | UBO 3 - City | Shareholders - City | Text |
adyen-ubo3-zip | UBO 3 - Zip | Shareholders - Zip | Text |
adyen-ubo3-country | UBO 3 - Country | Shareholders - Country |
Single values list Accepted values:
|
adyen-ubo3-phonetype | UBO 3 - Phone Type | Shareholders - Type of Phone |
Single values list Accepted values:
|
adyen-ubo3-phonecountry | UBO 3 - Phone Country | Shareholders - Phone Country |
Single values list Accepted values:
|
adyen-ubo3-phonenumber | UBO 3 - Phone Number | Shareholders - Phone Number | Text |