Connector overview

Understand your marketplace account structure, and how Adyen's Mirakl connector manages onboarding and payouts to sellers.

Account structure

MarketPay accounts

For more information about account structure in Adyen MarketPay, refer to our MarketPay documentation.

For each of your sellers in Mirakl Marketplace, you will have a corresponding  account holder in Adyen MarketPay.  The account holder represents the seller's business entity, if onboarding a company, or individual entity, if onboarding a person.  Know Your Customer (KYC) verification  is performed against the account holder.

Each account holder has an account for receiving payouts.

Sellers that create shops in Mirakl for multiple currencies are treated as different legal entities. Each shop has its own account holder, and needs to be onboarded separately.

Your marketplace will have its own account, which we refer to as the liable account, and a corresponding accountCode for receiving the subscription fees. 

Onboarding and KYC checks

To verify the identity of your sellers, each of them has to go through a series of KYC checks. With Adyen's Mirakl connector, you don't need to manually perform KYC checks. After the seller submits the required data in their Mirakl back office, the connector will automatically take care of the verification.  

Scheduling

When initialized, the connector pulls from Mirakl all shop information and documents that were added on that day. After that, shop updates are pulled every 5 minutes. Failed documents are retried daily at 2:30 AM. 

To customize the above process, modify the following properties in:

adyen-mirakl/src/main/resources/config/application.yml

Property Description Default Value
initialDeltaDaysBack

Specifies how many days back worth of shop updates the connector includes when first initialized.

For example, if you want to include shops that were added 7 days ago, set this to 7.

0
miraklPullCron

Cron-expression for scheduling how often the connector pulls Mirakl for shop and document updates. By default, this happens every 5 minutes.

0 * / 5 * * * ?
retryDocsCron

Cron-expression for scheduling how often the connector retries failed documents. By default, this happens nightly at 2:30 AM.

30 2 * * * ?

Payouts

When a payout voucher is issued in Mirakl, the connector will pay out all the sellers listed in the file. If you charge a subscription fee, the connector will also transfer this from the seller's account to the operator's liable account.

After the payout voucher was successfully sent to the connector, Mirakl marks all sellers listed in the file as Paid

In case of an issue with processing the transfer, the connector notifies the operator with an email. Failed transfers are retried up to 10 times, nightly at 1:30 AM. Failed transfers are also retried when a seller status changes to Payouts: Allowed, even if the payout has already been retried 10 times. 

To customize the above process, modify the following properties in:

adyen-mirakl/src/main/resources/config/application.yml

Property Description Default
maxPayoutFailed The number of times a failed transfer is retried. 10
payoutRetryCron

Cron-expression for scheduling how often the connector retries failed transfers. By default, this happens nightly at 1:30 AM.

30 1 * * * ?

You can find the failed payouts in the connector database, in the adyen_payout_error table.

Email notifications

The connector sends notification emails to the operator and sellers to inform them of:

  • Results of onboarding.
  • Need for more data, for example when the seller has to upload additional documents.
  • Successful payouts and subscription fee transfers.
  • Issues with processing payouts and subscription fees.
  • Changes in seller statuses.

Failed emails are retried every 10 minutes. Successfully sent emails are removed from the connector database nightly at 2:00 AM.

To customize the above process, modify the following properties in:

adyen-mirakl/src/main/resources/config/application.yml

Property Description Schedule Default value
emailRetryCron Cron-expression for scheduling how often the connector retries sending failed emails. Every 10 Minutes 0 */10 * * * ?
removeSentEmailsCron

Cron-expression for scheduling how often successfully sent emails are removed form the connector database.

2AM 0 0 2 * * ?

You can find the email delivery failures in the connector database, in the email_error table.

Application configurations

The config package (/adyen-mirakl/src/main/resources/config) contains the following Spring Boot YML files, used to store non-sensitive configuration parameters:

  • application-dev.yml
  • application-herokubutton.yml
  • application-prod.yml
  • application.yml

By default, the application loads the application.yml file. The other files can be used to override the default configuration for different environmentsTo add more files, use the --spring.profiles.active property in the application.yml file. 

For example, adding: --spring.profiles.active=prod,herokubutton loads:

  • application.yml
  • application-prod.yml
  • application-herokubutton.yml

Next steps

Test and go live

Test your integration. Start onboarding sellers and making payouts.

link