PayOne - Direct Debit Payment

Edit on GitHub

Front-End Integration

Run the antelope build yves after you include the javascript file for credit card check inside the payment step template (e.g. src/<project_name>/Yves/Checkout/Theme/<custom_theme_name>/checkout/payment.twig)

{% block content %}
<script src="/assets/default/js/spryker-yves-payone-main.js"></script>
{% endblock %}```

In order to display SEPA mandate text and references, apply next modifications to project templates:

To display SEPA mandate text on summary page of checkout, add the following reference into `src/<project_name>/Yves/Checkout/Theme/<custom_theme_name>/checkout/summary.twig`
{% include '@payone/checkout/partials/summary-payment-details.twig' %}

To display a link to the SEPA mandate in PDF format on checkout success page, add the following reference into src/<project_name>/Yves/Checkout/Theme/<custom_theme_name>/checkout/success.twig

{% include '@payone/checkout/partials/success-payment-details.twig' %}

To display link to SEPA mandate in PDF format on order details page in customer cabinet, add the following reference into src/<project_name>/Yves/Customer/Theme/<custom_theme_name>/order/details.twig

{% include '@payone/order/partials/details-payment-data.twig' %}

To adjust frontend appearance, provide following templates in your theme directory:

  • src/<project_name>/Yves/Payone/Theme/<custom_theme_name>/direct_debit.twig
  • src/<project_name>/Yves/Payone/Theme/<custom_theme_name>/index/get-file.twig
  • src/<project_name>/Yves/Payone/Theme/<custom_theme_name>/checkout/partials/summary-payment-details.twig
  • src/<project_name>/Yves/Payone/Theme/<custom_theme_name>/checkout/partials/success-payment-details.twig
  • src/<project_name>/Yves/Payone/Theme/<custom_theme_name>/order/partials/details-payment-data.twig

State Machine Integration

The Payone module provides demo state machine for Direct Debit payment method which implements Pre-Authorization/Capture flow. It’s also possible to implement Authorization flow using corresponding command.

To enable the demo state machine, extend the configuration with following values:

 PayoneConfig::PAYMENT_METHOD_DIRECT_DEBIT => 'PayoneDirectDebit',

$config[OmsConstants::ACTIVE_PROCESSES] = [

Direct Debit Payment Flow:

  1. When customer enters the payment details on checkout, a manage mandate request is submitted to Payone, which serves for automatic bank account data translation into IBAN/BIC pair(only for DE), IBAN/BIC validation and for SEPA mandate management (either an existing one will be used or a new one will be created).
  2. If a new mandate was created, the customer is presented with a SEPA mandate text on checkout summary step. User agrees with SEPA mandate terms by placing an order. There’s no agreement text displayed if existing SEPA mandate was found and was recognized by Payone.
  3. On order placement, authorize (or preauthorize) command confirms user agreement with SEPA mandate terms. The customer is presented with a link to mandate in PDF format on successful order placement. Same link is available inside the order details page in customer cabinet.