pay.integration
===============

.. py:module:: pay.integration


Attributes
----------

.. autoapisummary::

   pay.integration.INSUFFICIENT_FUNDS


Classes
-------

.. autoapisummary::

   pay.integration.PayApp
   pay.integration.PaymentError


Functions
---------

.. autoapisummary::

   pay.integration.get_js_path
   pay.integration.get_pay_assets
   pay.integration.process_payment


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

.. py:class:: PayApp

   Bases: :py:obj:`more.webassets.WebassetsApp`


   Provides payment integration for
   :class:`onegov.core.framework.Framework` based applications.



   .. py:property:: session
      :type: collections.abc.Callable[[], sqlalchemy.orm.Session]



   .. py:method:: configure_payment_providers(*, payment_providers_enabled: bool = False, payment_provider_defaults: dict[str, Any] | None = None, **cfg: Any) -> None

      Configures the preconfigured parameters for payment providers.

      Takes one dictionary for each availble provider. Available providers
      can be found in the models/payment_providers folder. Additionally,
      it is possible to enable/disable custom payment providers for the
      whole site.

      For example::

          payment_providers_enabled: true
          payment_provider_defaults:
              stripe_connect:
                  client_id: foo
                  client_secret: bar

      Since multiple payment providers (even of the same type) may exist,
      and because some information stored on the payment providers need
      to be configured differently for each application_id (and possibly
      set up through OAuth) we only provide default parameters.

      When we create a new payment provider, these default values may be
      read by the payment provider.




   .. py:method:: default_payment_provider() -> onegov.pay.PaymentProvider[Any] | None


   .. py:method:: adjust_price(price: onegov.pay.utils.Price | None) -> onegov.pay.utils.Price | None

      Takes the given price object and adjusts it depending on the
      settings of the payment provider (for example, the fee might be
      charged to the user).




.. py:function:: get_js_path() -> str

.. py:function:: get_pay_assets() -> collections.abc.Iterator[str]

.. py:class:: PaymentError

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints


   .. py:attribute:: INSUFFICIENT_FUNDS
      :value: 1



.. py:data:: INSUFFICIENT_FUNDS

.. py:function:: process_payment(method: onegov.pay.types.PaymentMethod, price: onegov.pay.utils.Price, provider: onegov.pay.PaymentProvider[Any] | None = None, token: str | None = None) -> onegov.pay.models.payment.Payment | PaymentError | None

   Processes a payment using various methods.

   This method returns one of the following:

       * The processed payment if successful.
       * None if an unknown error occurred.
       * An error code (see below).

   Possible error codes:

       * INSUFFICIENT_FUNDS - the card has insufficient funds.

   Available methods:

       'free': Payment may be done manually or by credit card
       'cc': Payment must be done by credit card
       'manual': Payment must be done manually