Onboarding sellers
You can use Express or Custom accounts with the transfers capability to onboard your sellers.
Standard accounts aren’t supported.
Seller account initiation
The workflow starts when you create a new shop. If you invite the seller via email, the workflow starts when they submit the initial Mirakl form.
- The onboarding job fetches newly created Mirakl shops.
- The connector adds an onboarding link to each shop.
- The seller finds the link in their Mirakl back office under My Account.
- They complete their KYC/KYB on Stripe.
- The seller is redirected to the connector to complete the connection.
- The payout frequency is set to manual. This triggers a seller account update.
- The seller is redirected to the
REDIRECT_ONBOARDING
URL.
Stripe then performs verification, asking for more information when needed. To handle this, see the communication guidelines.
Initiate the onboarding outside of Mirakl
You can add an onboarding link to the seller’s account page on your website.
To generate a similar link to the one set by the connector in the first step, use the following API request:
curl -X POST "https://connector-url/api/onboarding" \ -H "accept: application/json" \ -H "X-AUTH-TOKEN:
" \ -H "Content-Type: application/json" \ -d "{ \"miraklShopId\": 123}"$OPERATOR_PASSWORD
The response contains the URL:
{ "redirect_url": "https://connect.stripe.com/express/oauth/..." }
Don’t send this link in email—redirect the seller from their secure space on your website.
The rest of the flow matches steps 4 to 7 of the seller account initiation.
Use Custom accounts
- Integrate Custom accounts by following our documentation.
Make sure to set settings[payouts][schedule]=manual
as required by the payouts workflow.
- Use the following API request to map the Stripe account with the Mirakl shop:
curl \ -X POST "https://connector-url/api/mappings" \ -H "accept: application/json" \ -H "X-AUTH-TOKEN:
" \ -H "Content-Type: application/json" \ -d "{ \"miraklShopId\": 123, \"stripeUserId\": \"acct_1032D82eZvKYlo2C\"}"$OPERATOR_PASSWORD
Seller account update
The workflow starts with the seller intending to update their information on Stripe.
- The seller finds the link in their Mirakl back office under My Account.
- They update their information on Stripe.
- The shop custom field is updated with a fresh login link to their Express dashboard.
- The KYC status is updated on Mirakl.
The last two steps are also performed when accounts are updated by the connector during the account initiation workflow or when accounts are updated by Stripe, e.g., a new document needs to be provided. You can receive a notification when that happens, see the Account updated notification.
Stripe then performs verification, asking for more information when needed. To handle this, see the communication guidelines.
Communication
You can customize the visual appearance of the Stripe form with your brand’s name, color, and icon in your Connect settings page.
Be sure to tell your sellers about the link available in their Mirakl account settings and the need to complete the onboarding on Stripe to receive their payouts. For example, you could customize some of the email templates sent to your sellers by Mirakl under Settings > Notifications.
If we require more information from your sellers, we’ll email them directly for Express accounts. You must inform the sellers yourself if you decided to use Custom accounts.
In test mode, no emails are sent.