Project guidelines for the Stripe app

Edit on GitHub

This document provides guidelines for projects using the Stripe app.

OMS configuration for the project

The complete default payment OMS configuration is available at vendor/spryker/sales-payment/config/Zed/Oms/ForeignPaymentStateMachine01.xml.

The payment flow of the default OMS involves authorizing the initial payment, which means that the amount is temporarily blocked when the payment method permits. Then, the OMS sends requests to capture, that is, transfer of the previously blocked amount from the customer’s account to the store account.

The Payment/Capture command initiates the capture action. By default, this command is initiated when a Back office user clicks Ship on the Order Overview page.

Optionally, you can change and configure your own payment OMS based on ForeignPaymentStateMachine01.xml from the core package and change this behavior according to your business flow. See Install the Order Management feature for more information about the OMS feature and its configuration.

To configure your payment OMS based on ForeignPaymentStateMachine01.xml, copy ForeignPaymentStateMachine01.xml with Subprocess folder to the project root config/Zed/oms. Then, change the file’s name and the value of <process name= in the file.

This example demonstrates how to configure the order state machine transition from ready for dispatch to payment capture pending:

<?xml version="1.0"?>

    <process name="SomeProjectProcess" main="true">

        <!-- other configurations -->


            <!-- other states -->

          <state name="payment capture pending" display=""/>

            <!-- other states -->



            <!-- other transitions -->

            <transition happy="true">
              <source>ready for dispatch</source>
              <target>payment capture pending</target>
              <event>capture payment</event>

            <!-- other transitions -->



            <!-- other events -->

            <event name="capture payment" onEnter="true" command="Payment/Capture"/>

            <!-- other events -->




By default, the timeout for the payment authorization action is set to 7 days. This means that if the order is in the payment authorization pending state, the OMS will wait for a day and then change the order state to payment authorization failed. Another day later, the order is automatically transitioned to the payment authorization canceled state. Therefore, if you need to decrease or increase timeouts or change the states, modify the config/Zed/oms/Subprocess/PaymentAuthorization01.xml file according to your requirements.

For more information about ACP payment methods integration with your project OMS configuration, see Integrate ACP payment apps with Spryker OMS configuration.

Checkout payment step

If you have rewritten @CheckoutPage/views/payment/payment.twig on the project level, do the following:

  1. Make sure that a form molecule uses the following code for the payment selection choices:

{% for name, choices in data.form.paymentSelection.vars.choices %}
    {% embed molecule('form') with {
        data: {
            form: data.form[data.form.paymentSelection[key]],
    {% embed molecule('form') with {
        data: {
            form: data.form[data.form.paymentSelection[key]],
    {% endembed %}
{% endfor %}
  1. If you want to change the default payment provider or method names, do the following:
    1. Make sure the names are translated in your payment step template:

{% for name, choices in data.form.paymentSelection.vars.choices %}
    <h5>{{ name | trans }}</h5>
{% endfor %}

2. Add translations to your glossary data import file:
Stripe,Pay Online with Stripe,en_US
3. Run the data import command for the glossary:
console data:import glossary

Processing refunds

In the default OMS configuration, a refund can be done for an order or an individual item. The refund action is initiated by a Back Office user triggering the Payment/Refund command. The selected item enters the payment refund pending state, awaiting the response from Stripe.

During this period, Stripe attempts to process the request, which results in success or failure:

  • Success: the items transition to the payment refund succeeded state, although the payment isn’t refunded at this step.
  • Failure: the items transition to the payment refund failed state.

These states serve to track the refund status and inform the Back Office user. Over the following days, Stripe finalizes the refund, causing the item states to change accordingly. For example, previously successful refunds may be declined and vice versa.

If a refund fails, the Back Office user can go to the Stripe Dashboard to identify the cause of the failure. After resolving the issue, the item can be refunded again.

In the default OMS configuration, seven days are allocated to Stripe to complete successful payment refunds. This is reflected in the Back Office by transitioning the items to the payment refunded state.

Retrieving and using payment details from Stripe

For instructions on using payment details, like the payment reference, from Stripe, see Retrieve and use payment details from third-party PSPs