pay.models.payment_provider
===========================

.. py:module:: pay.models.payment_provider


Attributes
----------

.. autoapisummary::

   pay.models.payment_provider._P


Classes
-------

.. autoapisummary::

   pay.models.payment_provider.PaymentProvider


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

.. py:data:: _P

.. py:class:: PaymentProvider

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`, :py:obj:`onegov.core.orm.mixins.ContentMixin`, :py:obj:`Generic`\ [\ :py:obj:`_P`\ ]


   Represents a payment provider. 


   .. py:attribute:: __tablename__
      :value: 'payment_providers'



   .. py:attribute:: id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: type
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: default
      :type:  sqlalchemy.Column[bool]


   .. py:attribute:: enabled
      :type:  sqlalchemy.Column[bool]


   .. py:attribute:: __mapper_args__


   .. py:attribute:: __table_args__


   .. py:attribute:: payments
      :type:  sqlalchemy.orm.relationship[list[onegov.pay.models.payment.Payment]]


   .. py:property:: payment_class
      :type: type[_P]



   .. py:method:: payment(*, amount: decimal.Decimal | None = None, currency: str = 'CHF', remote_id: str | None = None, state: onegov.pay.types.PaymentState = 'open', **kwargs: Any) -> _P

      Creates a new payment using the correct model. 



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

      Called by client implementations this method allows to adjust the
      price by adding a fee to it.

      By default no change is made.




   .. py:method:: charge(amount: decimal.Decimal, currency: str, token: str) -> onegov.pay.models.payment.Payment
      :abstractmethod:


      Given a payment token, charges the customer and creates a payment
      which is returned.




   .. py:property:: title
      :type: str

      :abstractmethod:


      The title of the payment provider (i.e. the product name). 



   .. py:property:: url
      :type: str

      :abstractmethod:


      The url to the backend of the payment provider. 



   .. py:property:: public_identity
      :type: str

      :abstractmethod:


      The public identifier of this payment provider. For example, the
      account name.




   .. py:property:: identity
      :type: str | None

      :abstractmethod:


      Uniquely identifies this payment provider amongst other providers
      of the same type (say the private key of the api). Used to be able
      to tell if a new oauth connection is the same as an existing one.

      This identity is not meant to be displayed.




   .. py:property:: connected
      :type: bool


      Returns True if the provider is properly hooked up to the
      payment provider.




   .. py:method:: get_token(request: onegov.core.request.CoreRequest) -> str | None
      :abstractmethod:


      Extracts this provider's specific token from the request. 



   .. py:method:: checkout_button(label: str, amount: decimal.Decimal | None, currency: str | None, complete_url: str, request: onegov.core.request.CoreRequest, **extra: Any) -> markupsafe.Markup
      :abstractmethod:


      Renders a checkout button. 



   .. py:method:: prepare_oauth_request(redirect_url: str, success_url: str, error_url: str, user_fields: dict[str, Any] | None = None) -> str
      :abstractmethod:


      Registers the oauth request with the oauth_gateway and returns
      an url that is ready to be used for the complete oauth request.




   .. py:method:: process_oauth_response(request_params: collections.abc.Mapping[str, Any]) -> None
      :abstractmethod:


      Processes the oauth response using the parameters passed by
      the returning oauth request via the gateway.




   .. py:method:: sync() -> None

      Updates the local payment information with the information from
      the remote payment provider.




   .. py:property:: payment_via_get
      :type: bool


      Whether or not we're allowed to submit a payment via `GET` request.

      Ideally this is always `False`, but some payment providers only
      support a redirect via `GET`. Make sure the token retrieval is
      sufficiently secure to make up for this shortcoming.