Skip to content
Create account
 or
Sign in
The Stripe Docs logo
/
Create account
Sign in

Mirakl Plugin configuration

Define your integration variables.

Before installing the plugin , prepare a file with the variables below.

We provide a configuration file sample in our repository that you can copy and rename to .env.

General settings

ParameterDescription
APP_SECRETTo be generated. Commonly used to add more entropy to security related operations. Learn more on the Symfony documentation.
OPERATOR_PASSWORDTo be generated. Used to secure requests to the API exposed by the plugin . Set the X-AUTH-TOKEN header to this value when calling the API.
DATABASE_URLThe connection URL to your database. Learn more on the Doctrine documentation. For example, pgsql://symfony:symfony@db:5432/symfony?charset=UTF-8.
MESSENGER_TRANSPORT_DSNThe transport used for the queuing system. See the Symfony Messenger documentation for supported transports. For example, amqp://guest:guest@localhost:5672/%2f/messages. Defaults to doctrine://default.
STRIPE_CLIENT_SECRETYour Stripe API secret key available in your API keys settings. We recommend creating a specific API key for the plugin. Restricted keys are not supported.
MIRAKL_HOST_NAMEHost name of your Mirakl Instance. For example, https://mymarketplace.mirakl.net.
MIRAKL_API_KEYThe Mirakl operator key. Can be generated as a Mirakl operator in your API settings. We recommend creating a specific operator for the plugin.

Onboarding

ParameterDescription
REDIRECT_ONBOARDINGThe plugin redirects the seller to this URL after completing their account creation on Stripe. Defaults to $MIRAKL_HOST_NAME/mmp/shop/account/shop.
BASE_HOSTThe domain of the server hosting your plugin. For example, stripe-mirakl.example.com.
SCHEMEThe scheme used by your base host. Defaults to https.
STRIPE_SELLERS_WEBHOOK_SECRETYour Stripe webhook secret available in your Connect webhook settings when adding the endpoint, see below.
MIRAKL_CUSTOM_FIELD_CODECode of the custom field that you have to add, see below. Defaults to stripe-url.

Add a Stripe webhook endpoint for connected accounts

  1. Go to your webhook settings.
  2. Add a webhook endpoint.
  3. Set the URL to <BASE_HOST>/api/public/webhook/sellers.
  4. Select Listen to events on Connected accounts.
  5. Add account.updated in the Events to send:
  6. Click Add endpoint.
  7. Use the webhook secret for the STRIPE_SELLERS_WEBHOOK_SECRET environment variable.

Add a custom field to your Mirakl shops

  1. Log in to your Mirakl back office as an Operator.
  2. Visit Settings > Advanced Parameters > Shops.
  3. Go to the Custom Fields tab.
  4. Use the following values to create a new field:
Parameter Description
CodeUse stripe-url unless you chose a different key in your environment file.
TypeLink
Shops permissionsRead only
Required fieldNo

Payments

ParameterDescription
PAYMENT_METADATA_COMMERCIAL_ORDER_IDMetadata key used in Charges to convey the Mirakl commercial order ID. Defaults to mirakl_commercial_order_id.
ENABLE_PRODUCT_PAYMENT_SPLITEnable the payment split workflow for product orders. Defaults to false.
ENABLE_SERVICE_PAYMENT_SPLITEnable the payment split workflow for service orders. Defaults to false.
ENABLE_PRODUCT_PAYMENT_REFUNDEnable the payment refund workflow for product orders. Defaults to false.
ENABLE_SERVICE_PAYMENT_REFUNDEnable the payment refund workflow for service orders. Defaults to false.
STRIPE_OPERATOR_WEBHOOK_SECRETYour Stripe webhook secret available in your account webhook settings when adding the endpoint, see below.

Add a Stripe webhook endpoint for your account

  1. Go to your webhook settings.
  2. Add a webhook endpoint for your account.
  3. Set the URL to <BASE_HOST>/api/public/webhook/operator.
  4. Add the following in the Events to send: charge.succeeded, charge.updated.
  5. Click Add endpoint.
  6. Use the webhook secret for the STRIPE_OPERATOR_WEBHOOK_SECRET environment variable.

Notifications and alerting

ParameterDescription
MAILER_DSNThe entire Symfony Mailer configuration using a DSN-like URL format. Learn more on the Symfony documentation. For example, smtp://user:pass@host:port. Defaults to smtp://null (mailer disabled).
TECHNICAL_ALERT_EMAILThe recipicient of all technical alerts. For example, myemail@example.com. Defaults to empty. Required if mailer is enabled per MAILER_DSN.
TECHNICAL_ALERT_EMAIL_FROMThe sender of all technical emails. Defaults to empty, required if mailer is configured. For example, noreply@example.com.
OPERATOR_NOTIFICATION_URLThe endpoint on your server set to receive notifications from the plugin. Defaults to empty (notifications disabled).
MAIL_ON_NOTIFICATION_ENDPOINT_DOWNEnable email alerts if a URL is provided in OPERATOR_NOTIFICATION_URL and that URL is not available or responds with an error. Defaults to true.
MAIL_ON_NOTIFICATION_ENDPOINT_DOWN_COOLDOWNTime between each email alert. Use 0 to disable throttling. The maximum value depends on the notification worker maximum life, that is, 3600 by default. Defaults to 10.

See also

Was this page helpful?
YesNo