Mirakl Connector Reference

    Learn about the scheduled jobs and notifications provided by the connector.

    Scheduled Jobs

    Sellers onboarding

    Job: connector:sync:onboarding

    php bin/console connector:sync:onboarding 5 -q 2>&1
    • Default setting: every minute.
    • Recommended setting: as often as possible.
    • Description: fetch newly created Mirakl Sellers (S20) and add the onboarding link to their back office.

    Payments

    Job: connector:dispatch:process-transfer

    php bin/console connector:dispatch:process-transfer -q 2>&1
    • Default setting: every 5 minutes.
    • Recommended setting: < 1 hour.
    • Description: fetch newly created Mirakl Orders (OR11) and create Stripe Transfers from the platform account to the connected account.

    Refunds

    Job: connector:dispatch:process-refund

    php bin/console connector:dispatch:process-refund -q 2>&1
    • Default setting: every 5 minutes.
    • Recommended setting: < 1 hour.
    • Description: fetch pending Mirakl Refunds (PA12) and create Stripe Refunds.

    Payouts

    Job: connector:dispatch:process-payout

    php bin/console connector:dispatch:process-payout -q 2>&1
    • Default setting: everyday at 1am.
    • Recommended setting: synchronized with your Mirakl billing cycles.
    • Description: fetch newly created Mirakl Invoices (IV01) and create Stripe Transfers from the connected account to the platform account and Stripe Payouts from the connected account to their external bank account.

    Alerting

    Job: connector:notify:failed-operation

    php bin/console connector:notify:failed-operation -q 2>&1
    • Default setting: everyday at 8am.
    • Recommended setting: according to your preference.
    • Description: Aggregate all failed Transfers and Payouts and send an email to the TECHNICAL_ALERT_EMAIL with information about each failure.

    Notifications

    If enabled, the connector sends notifications via HTTPS to your configured URL in the following events.

    Account updated

    Trigger: a Stripe Connected account is updated. This can happen if the seller updates their information, documents or external bank account, or if Stripe requires further information for verification purposes.

    Payload:

    { "type": "account.updated", "payload": { "miraklShopId": 2000, "stripeUserId": "acct_xxx" } }

    Transfer failed

    Trigger: a transfer has failed during the connector:dispatch:process-transfer job.

    Payload:

    { "type": "transfer.failed", "payload": { "internalId": 5, "miraklId": 123, "type": "TRANSFER_ORDER", "stripeAccountId": "acct_xxx", "miraklShopId": 2003, "transferId": null, "transactionId": null, "amount": 3400, "status": "TRANSFER_FAILED", "failedReason": "Insufficient funds", "currency": "EUR" } }

    Payout failed

    Trigger: a payout has failed during the connector:dispatch:process-payout job.

    Payload:

    { "type": "payout.failed", "payload": { "internalId": 12, "amount": 2300, "currency": "EUR", "miraklInvoiceId": 2000, "stripePayoutId": null, "status": "PAYOUT_FAILED", "failedReason": "Could not find Stripe-Mirakl Mapping", } }

    See also

    Was this page helpful?

    Feedback about this page?

    Thank you for helping improve Stripe's documentation. If you need help or have any questions, please consider contacting support.

    On this page