{% extends 'Layouts/Doc/default.html.twig' %} {% block title %} {{ 'app.documentation.menu.architecture.drivers'|trans }} {% endblock %} {% block headerPageTitle %} {{ 'app.documentation.menu.workflow.payments'|trans|upper }} {% endblock %} {% block body %}

Payment status: play a crucial role in the click and collect system, providing insights into the progress and outcome of payment transactions. These statuses help track the journey of a payment, from initiation to completion or cancellation. Understanding these payment statuses is essential for both customers and merchants to ensure a smooth and transparent payment experience. Here are some of the key payment statuses you may encounter:

{% include 'Doc/Diagram/payment.html.twig' %}
{% include 'Doc/States/states_constants_title.html.twig' %}
  • {% include 'Doc/States/states_constants.html.twig' with {'state': paymentConstants.new} %}

    • The new payment status typically indicates that a payment transaction has been initiated or recorded in the system but is awaiting further processing or verification.
    • When a customer completes the checkout process and proceeds to payment, the payment information is captured by the system directly, otherwise via notification from our payment solutions webhooks.
    • At this stage, the payment status is marked as new, to signify that the transaction is awaiting for updated on the payement.

  • {% include 'Doc/States/states_constants.html.twig' with {'state': paymentConstants.requires_action} %}

    • When a payment transaction encounters certain conditions or requires additional verification such as 3D Secure, the payment status may be set as Requires action.
    • This status signifies that there is an action needed on the customer end to proceed with the payment process.

  • {% include 'Doc/States/states_constants.html.twig' with {'state': paymentConstants.awaiting_payment} %}

    In case of an offline payment and during the creation of an order payment, the status becomes awaiting payment waiting to pay for the order.

  • {% include 'Doc/States/states_constants.html.twig' with {'state': paymentConstants.failed} %}

    • When a payment transaction fails, the payment status is set as failed to indicate that the payment could not be completed.
    • This status is typically triggered by various reasons, such as insufficient funds, invalid payment details, declined authorization, technical issues, or connectivity problems.

  • {% include 'Doc/States/states_constants.html.twig' with {'state': paymentConstants.processing} %}

    • When a customer submits the payment information, we usually recieve a pending event. In this stage the payment status is initially set as processing.
    • This status indicates that the payment transaction has been received and is being proccessed by the payment gateway or processor.

  • {% include 'Doc/States/states_constants.html.twig' with {'state': paymentConstants.partially_paid} %}

    This status indicates that an order is partially paid, and is awaiting full payment.

  • {% include 'Doc/States/states_constants.html.twig' with {'state': paymentConstants.cancelled} %}

    • The cancelled payment status is assigned when a payment transaction is intentionally terminated or invalidated before completion.
    • This status signifies that the payment process has been discontinued, and the associated funds have not been transferred or captured.

  • {% include 'Doc/States/states_constants.html.twig' with {'state': paymentConstants.paid} %}

    • The paid payment status is assigned when the payment transaction has been successfully authorized, processed, and the funds have been captured.
    • It signifies that the payment has been successfully completed, and the associated funds have been transferred from the customer's account to the merchant's account.

  • {% include 'Doc/States/states_constants.html.twig' with {'state': paymentConstants.partially_refunded} %}

    This status indicates that an order is partially refunded.

  • {% include 'Doc/States/states_constants.html.twig' with {'state': paymentConstants.refunded} %}

    Indicates that the payment was refunded due to order cancellation or rejection.

  • {% include 'Doc/States/states_constants.html.twig' with {'state': paymentConstants.expired} %}

    • The expired payment status is assigned when a payment transaction has not been completed within a predefined timeframe or has surpassed its validity period.
    • This status signifies that the payment attempt has become invalid and cannot be processed further.

{% endblock %}