Developer tools
Plugins
Mirakl
Payouts

Payouts

Learn about the payouts automated by the Mirakl Connector.

The connector follows the instructions provided by Mirakl to pay out the Sellers.

  1. The payouts job fetches newly created Mirakl Invoices via IV01.
  1. For every new Invoice, the connector reads the instructions sent by Mirakl and acts accordingly:
Invoice attribute Action taken
total_other_credits_incl_tax Create a Transfer from the Platform account (Operator) to the Connected account (Seller).
total_other_invoices_incl_tax Create a Transfer from the Connected account (Seller) to the Platform account (Operator).
total_subscription_incl_tax Create a Transfer from the Connected account (Seller) to the Platform account (Operator).
amount_transferred Create a Payout from the Connected account (Seller) to their external bank accounts.

For each Transfer, the connector creates a StripeTransfer record with status=TRANSFER_PENDING and a new ProcessTransfer message is added to the queuing system.

For the Payout, the connector creates a StripePayout record with status=PAYOUT_PENDING and a new ProcessTransfer message is added to the queuing system.

  1. ProcessTransfer and ProcessPayout messages are consumed. The connector attempts to create the Transfers and Payout on Stripe.

The invoiceId and miraklShopId are added to the Transfers and Payout metadata so you can track each money movement.

  1. The StripeTransfer and StripePayout records are updated to either a successful or failed status. Failed transfers or payouts are attempted again three times.

Alerting

Once a day, the alerting job sends an email with all failed transfers and payouts along with the reason.

Was this page helpful?
Questions? Contact us.
Developer tutorials on YouTube.
You can unsubscribe at any time. Read our privacy policy.