Select Confirm<\/strong>.<\/li>\n<\/ol>\nStep 3: Enable features in Mirakl<\/h2>\n
Contact Mirakl's support team to enable the following features for your marketplace:<\/p>\n
\n- KYC status<\/strong>: required for the connector to update Mirakl about the results of KYC checks and if applicable, further actions required.<\/li>\n
- Payment confirmation<\/strong>: required for the connector to mark invoices as Paid<\/strong>, allowing you to differentiate between invoices that have the Pending payment<\/strong> and Paid<\/strong> status.<\/li>\n<\/ul>\n
Step 4: Update email settings in Mirakl<\/h2>\n
The connector uses email notifications to inform you of any issues, for example, when payouts or the synchronization between Mirakl and Adyen fails.<\/p>\n
After the KYC status<\/strong> feature is enabled for your marketplace, Mirakl will also send emails to your sellers about the status of their KYC checks. We recommend to change the default template for a KYC failure to a custom one.<\/p>\nTo change the email template for a failed KYC:<\/p>\n
\n- In the Mirakl back office, go to Settings<\/strong> > Platform<\/strong> > Notifications<\/strong>.<\/li>\n
- Under the Email Templates<\/strong> tab, select the Shop account KYC failed<\/strong> template.<\/li>\n
- Replace the subject and body with our Email template<\/a>.<\/li>\n<\/ol>\n
To learn more about configuring email templates, see Mirakl documentation<\/a>.<\/p>\nStep 5: Send onboarding information to Adyen<\/h2>\n
To onboard you to the connector, we require the following information from you:<\/p>\n
\n- Connector settings<\/a><\/li>\n
- Mirakl settings<\/a><\/li>\n
- Adyen settings<\/a><\/li>\n<\/ul>\n
Reach out to your Adyen contact to provide this information.<\/p>\n
Connector settings<\/h3>\n
\n\n\n| Setting<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n |
\n\nHosted Onboarding Page (HOP)<\/nobr> marketplace name<\/td>\nYour marketplace's name that appears in the hyperlink that takes sellers back to your HOP return URL on the welcome page. (Back to MARKETPLACE_NAME<\/strong>)<\/td>\n<\/tr>\n\nHOP return URL<\/nobr><\/td>\n| The URL sellers will be redirected to after providing the required data for KYC checks. This is usually the URL of your marketplace.<\/td>\n<\/tr>\n | \nOperator emails<\/nobr><\/td>\n| The email addresses to receive notifications about the shop synchronization or invoices.<\/td>\n<\/tr>\n | \nMirakl HOP questions count<\/nobr><\/td>\nTo ensure security in the KYC process, you can protect the link to the HOP with a series of questions that only your seller knows how to answer. HOP will only load once all questions are answered correctly. The default value is 5<\/strong>.<\/td>\n<\/tr>\n\nMaximum Invoice Retry Count<\/nobr><\/td>\nThe maximum amount of retries after an invoice payout fails. The default value is 10<\/strong>.<\/td>\n<\/tr>\n\n| Locale<\/td>\n | The language of the text in the HOP. The default value is en-US<\/strong> (English). Set to another locale<\/a> to render the page in a different language.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n You can decide to enable the following additional settings in the connector. When providing onboarding data, inform your Adyen contact whether these features are enabled or disabled.<\/p>\n \n\n\n| Setting<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n | \n\nManage Payment Block<\/strong><\/nobr><\/td>\nIf there is a payment balance issue, KYC issue, or account sync issue with a seller, the block payments flag on Mirakl<\/a> is set automatically, meaning that the seller will be skipped in the billing cycle. The default value is enabled<\/strong>.<\/td>\n<\/tr>\n\nUse Subscription<\/strong><\/nobr><\/td>\nSeparates commission payouts and subscription payouts if enabled. The default value is disabled<\/strong>. When disabled, the connector triggers a single payout for commission and subscription payouts.<\/td>\n<\/tr>\n\nUnsuspend New Shops<\/strong><\/nobr><\/td>\nAutomatically unsuspends new shops in Mirakl after KYC success. The default value is enabled<\/strong>. The seller status in Adyen is determined separately.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\nMirakl settings<\/h3>\n\n\n\n| Setting<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n | \n\n| URL<\/td>\n | The service account URL of your Mirakl marketplace instance.<\/td>\n<\/tr>\n | \nMirakl Access Token<\/nobr><\/td>\nRequired for the connector to access Mirakl's APIs.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\nAdyen settings<\/h3>\n\n\n\n| Setting<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n | \n\nBalance platform name<\/nobr><\/td>\nThe name of your balance platform, as shown in your Customer Area<\/a>.<\/td>\n<\/tr>\n\nBalance account ID<\/nobr><\/td>\nThe liable balance account. Get it from your Customer Area<\/a> > Accounts & Balances<\/strong> > Balance accounts<\/strong>. This Balance account ID, where needed, should retain sufficient funds for scenarios like negative commissions. Otherwise, there is a risk of failed transfers.<\/td>\n<\/tr>\n\nBalance Platform API credential<\/nobr><\/td>\nThe username and API key of your Configuration API<\/a> and Transfers API<\/a> web service user. Username format: ws@BalancePlatform.[YourBalancePlatform]<\/code>. Get it from your Customer Area<\/a> > Developers<\/strong> > API Credentials<\/strong>. Make sure the \n Balance Platform BCL<\/strong>\n<\/a> role is enabled for your user.<\/td>\n<\/tr>\n\nScope (LEM) API credential<\/nobr><\/td>\nThe username and API key of your Legal Entity Management API<\/a> web service user. Username format: ws@Scope.BalancePlatform.[YourBalancePlatform]<\/code>. Get it from your Customer Area<\/a> > Developers<\/strong> > API Credentials<\/strong>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\nStep 6: Schedule synchronizations between Mirakl and Adyen<\/h2>\nThere are three different types of synchronizations that happen between Mirakl and Adyen:<\/p>\n \n- Partial Sync<\/strong>: synchronizes the shops which have been modified since the last sync.<\/li>\n
- Full Sync<\/strong>: synchronizes all shops.<\/li>\n
- Start Invoice Sync<\/strong>: schedules payouts.<\/li>\n<\/ul>\n
For the Start Invoice Sync<\/strong>, you additionally need to inform Adyen of the date the invoice sync should start from. This is to avoid syncing older invoices. For example, if you have an invoice generated on June 1st, the sync must be configured to start from May 31st to make sure this invoice is picked up.<\/p>\nContact our Support Team<\/a> to confirm this date for both test and live environments.<\/p>","url":"https:\/\/docs.adyen.com\/pt\/plugins\/mirakl\/set-up-the-connector","articleFields":{"description":"Integrate your Mirakl Marketplace with Adyen for Platforms.","feedback_component":true,"next_steps":[{"title":"Onboard sellers","description":"Learn how the onboarding process works with the Adyen Mirakl Connector.","url":"\/plugins\/mirakl\/onboard-sellers","required":true},{"title":"Set up payment flows","description":"Learn about splitting payments at captures, refunds, and chargebacks and seller payouts.","url":"\/plugins\/mirakl\/set-up-payment-flows","required":true}],"type":"page","_expandable":{"operations":""},"status":"current","page_id":"4df27dc6-f964-4602-aaf1-d33844c941af","filters_component":false,"decision_tree":"[]"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/plugins\/mirakl\/set-up-the-connector","title":"Set up the connector","content":"Step 1: Create an access token for the Adyen Mirakl connector\nRead more about generating access tokens in the Mirakl documentation.\nTo create an access token:\n\nIn the Mirakl back office, go to Settings > Platform > API integrations.\nSelect Create API integration.\nSelect the scope Operator API.\nSelect Access token.\nSelect Create, then copy the token and store it securely.\n\nStep 2: Add custom fields to Mirakl\nTo initiate the KYC verification checks and start processing split payments, you need to add custom fields in your Mirakl back office. The connector maps each custom field to an Adyen field and populates these fields when a seller's shop is synced with Adyen.\n\nIn the Mirakl backoffice, go to Settings > Shops > Profile configuration.\nSelect the Custom fields tab.\nSelect Add a custom field.\nCreate the following custom fields.\n\nFor all custom fields, select Marketplace for the Platform models field.\nThese fields must not be marked required.\n\n\n\nIf you have set up other custom fields that are marked as required, inform your Adyen contact. Required fields can prevent the connector from working correctly.\n\n\n\n\nCode\nLabel\nDescription\nType\nShop\u00a0account permissions\n\n\n\n\nadyen-v2-balance-account-id\nBalance\u00a0account\nYour seller's unique balance\u00a0account\u00a0ID.\nTextMax\u00a0length:\u00a02000\nInvisible\n\n\nadyen-v2-legal-entity-id\nAdyen Legal\u00a0entity\nYour seller's unique legal\u00a0entity\u00a0ID.\nTextMax\u00a0length:\u00a02000\nInvisible\n\n\nadyen-v2-account-holder-id\nAdyen Account\u00a0holder\nYour seller's unique account\u00a0holder\u00a0ID.\nTextMax\u00a0length:\u00a02000\nInvisible\n\n\nadyen-v2-transfer-instrument-id\nAdyen Transfer\u00a0instrument\nThe unique transfer\u00a0instrument\u00a0ID representing your seller's bank account.\nTextMax\u00a0length:\u00a02000\nInvisible\n\n\nadyen-v2-hop-url\nHOP\u00a0Url\nThe link to the generated Hosted\u00a0Onboarding\u00a0Page where your sellers can provide the details required for the KYC checks.\nLink\nRead-only\n\n\nadyen-kyc-vat\nVat Number for KYC\nOnly required if you need to make payouts to sellers who have a different VAT number for invoice purposes, because they operate in a country\/region different than their home country\/region. The VAT number of the parent entity for the KYC checks.\nTextMax length: 2000\nRead write\n\n\nadyen-v2-original-channel\nOriginal Shop Channel\nOnly required if you are using multiple channels. The first channel that was assigned to this shop.\nTextMax length: 2000\nInvisible\n\n\n\n\nSelect Confirm.\n\nStep 3: Enable features in Mirakl\nContact Mirakl's support team to enable the following features for your marketplace:\n\nKYC status: required for the connector to update Mirakl about the results of KYC checks and if applicable, further actions required.\nPayment confirmation: required for the connector to mark invoices as Paid, allowing you to differentiate between invoices that have the Pending payment and Paid status.\n\nStep 4: Update email settings in Mirakl\nThe connector uses email notifications to inform you of any issues, for example, when payouts or the synchronization between Mirakl and Adyen fails.\nAfter the KYC status feature is enabled for your marketplace, Mirakl will also send emails to your sellers about the status of their KYC checks. We recommend to change the default template for a KYC failure to a custom one.\nTo change the email template for a failed KYC:\n\nIn the Mirakl back office, go to Settings > Platform > Notifications.\nUnder the Email Templates tab, select the Shop account KYC failed template.\nReplace the subject and body with our Email template.\n\nTo learn more about configuring email templates, see Mirakl documentation.\nStep 5: Send onboarding information to Adyen\nTo onboard you to the connector, we require the following information from you:\n\nConnector settings\nMirakl settings\nAdyen settings\n\nReach out to your Adyen contact to provide this information.\nConnector settings\n\n\n\nSetting\nDescription\n\n\n\n\nHosted Onboarding Page (HOP) marketplace name\nYour marketplace's name that appears in the hyperlink that takes sellers back to your HOP return URL on the welcome page. (Back to MARKETPLACE_NAME)\n\n\nHOP return URL\nThe URL sellers will be redirected to after providing the required data for KYC checks. This is usually the URL of your marketplace.\n\n\nOperator emails\nThe email addresses to receive notifications about the shop synchronization or invoices.\n\n\nMirakl HOP questions count\nTo ensure security in the KYC process, you can protect the link to the HOP with a series of questions that only your seller knows how to answer. HOP will only load once all questions are answered correctly. The default value is 5.\n\n\nMaximum Invoice Retry Count\nThe maximum amount of retries after an invoice payout fails. The default value is 10.\n\n\nLocale\nThe language of the text in the HOP. The default value is en-US (English). Set to another locale to render the page in a different language.\n\n\n\nYou can decide to enable the following additional settings in the connector. When providing onboarding data, inform your Adyen contact whether these features are enabled or disabled.\n\n\n\nSetting\nDescription\n\n\n\n\nManage Payment Block\nIf there is a payment balance issue, KYC issue, or account sync issue with a seller, the block payments flag on Mirakl is set automatically, meaning that the seller will be skipped in the billing cycle. The default value is enabled.\n\n\nUse Subscription\nSeparates commission payouts and subscription payouts if enabled. The default value is disabled. When disabled, the connector triggers a single payout for commission and subscription payouts.\n\n\nUnsuspend New Shops\nAutomatically unsuspends new shops in Mirakl after KYC success. The default value is enabled. The seller status in Adyen is determined separately.\n\n\n\nMirakl settings\n\n\n\nSetting\nDescription\n\n\n\n\nURL\nThe service account URL of your Mirakl marketplace instance.\n\n\nMirakl Access Token\nRequired for the connector to access Mirakl's APIs.\n\n\n\nAdyen settings\n\n\n\nSetting\nDescription\n\n\n\n\nBalance platform name\nThe name of your balance platform, as shown in your Customer Area.\n\n\nBalance account ID\nThe liable balance account. Get it from your Customer Area > Accounts & Balances > Balance accounts. This Balance account ID, where needed, should retain sufficient funds for scenarios like negative commissions. Otherwise, there is a risk of failed transfers.\n\n\nBalance Platform API credential\nThe username and API key of your Configuration API and Transfers API web service user. Username format: ws@BalancePlatform.[YourBalancePlatform]. Get it from your Customer Area > Developers > API Credentials. Make sure the \n Balance Platform BCL\n role is enabled for your user.\n\n\nScope (LEM) API credential\nThe username and API key of your Legal Entity Management API web service user. Username format: ws@Scope.BalancePlatform.[YourBalancePlatform]. Get it from your Customer Area > Developers > API Credentials.\n\n\n\nStep 6: Schedule synchronizations between Mirakl and Adyen\nThere are three different types of synchronizations that happen between Mirakl and Adyen:\n\nPartial Sync: synchronizes the shops which have been modified since the last sync.\nFull Sync: synchronizes all shops.\nStart Invoice Sync: schedules payouts.\n\nFor the Start Invoice Sync, you additionally need to inform Adyen of the date the invoice sync should start from. This is to avoid syncing older invoices. For example, if you have an invoice generated on June 1st, the sync must be configured to start from May 31st to make sure this invoice is picked up.\nContact our Support Team to confirm this date for both test and live environments.","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Plugins","lvl2":"Mirakl","lvl3":"Set up the connector"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/plugins","lvl2":"https:\/\/docs.adyen.com\/pt\/plugins\/mirakl","lvl3":"\/pt\/plugins\/mirakl\/set-up-the-connector"},"levels":4,"category":"Plugins","category_color":"green","tags":["connector"]},"articleFiles":{"email-template.txt":"email-template.txt<\/p>"}}
| | | | | | | | | | | | | | | | | | | | | | | | |