shop.payment_providers.prepayment
=================================

.. py:module:: shop.payment_providers.prepayment


Attributes
----------

.. autoapisummary::

   shop.payment_providers.prepayment.logger


Classes
-------

.. autoapisummary::

   shop.payment_providers.prepayment.Prepayment
   shop.payment_providers.prepayment.PrePayment


Module Contents
---------------

.. py:data:: logger

.. py:class:: Prepayment(*, image_path = None, is_available = None)

   Bases: :py:obj:`shop.payment_providers.PaymentProviderAbstract`


   Prepayment method for the ViUR Shop.

   Allows customers to place orders with the agreement to pay in advance.
   The order is marked as ready to ship (RTS) once payment is received.

   The customer pays this order in the next x days, shipping will wait.

   Note:
      Payment receipt verification (The customer pays this order in the next x days,
      shipping will wait) is handled externally and not within this module.


   .. py:attribute:: name
      :type:  Final[str]
      :value: 'prepayment'


      Define the internal name of the payment provider



   .. py:method:: checkout(order_skel)


   .. py:method:: charge(order_skel, payment = None)


   .. py:method:: check_payment_state(order_skel)

      Check the payment state from the PaymentProvider API/service

      Access :attr:`OrderSkel.is_paid` to get the payment state of an order.



   .. py:method:: return_handler()

      Frontend Endpoint where the might be redirected to by the payment provider during the payment flow



   .. py:method:: webhook()

      API Endpoint (Webhook) to listen for events from payment provider



   .. py:method:: get_debug_information()

      Provide information about the payment of an order.

      Only for debugging purposes. It's not an API endpoint.



.. py:class:: PrePayment(*, image_path = None, is_available = None)

   Bases: :py:obj:`Prepayment`


   Prepayment method for the ViUR Shop.

   Allows customers to place orders with the agreement to pay in advance.
   The order is marked as ready to ship (RTS) once payment is received.

   The customer pays this order in the next x days, shipping will wait.

   Note:
      Payment receipt verification (The customer pays this order in the next x days,
      shipping will wait) is handled externally and not within this module.