Payment Provider¶

class odoo.addons.payment.models.payment_provider.PaymentProvider[source]¶

_compute_feature_support_fields()[source]¶

Compute the feature support fields based on the provider.

Feature support fields are used to specify which additional features are supported by a given provider. These fields are as follows:

support_express_checkout: Whether the « express checkout » feature is supported. False by default.
support_manual_capture: Whether the « manual capture » feature is supported. False by default.
support_refund: Which type of the « refunds » feature is supported: None, 'full_only', or 'partial'. None by default.
support_tokenization: Whether the « tokenization feature » is supported. False by default.

For a provider to specify that it supports additional features, it must override this method and set the related feature support fields to the desired value on the appropriate payment.provider records.

Renvoie: None

_get_compatible_providers(company_id, partner_id, amount, currency_id=None, force_tokenization=False, is_express_checkout=False, is_validation=False, report=None, **kwargs)[source]¶

Search and return the providers matching the compatibility criteria.

The compatibility criteria are that providers must: not be disabled; be in the company that is provided; support the country of the partner if it exists; be compatible with the currency if provided. If provided, the optional keyword arguments further refine the criteria.

Paramètres

company_id (int) – The company to which providers must belong, as a res.company id.
partner_id (int) – The partner making the payment, as a res.partner id.
amount (float) – The amount to pay. 0 for validation transactions.
currency_id (int) – The payment currency, if known beforehand, as a res.currency id.
force_tokenization (bool) – Whether only providers allowing tokenization can be matched.
is_express_checkout (bool) – Whether the payment is made through express checkout.
is_validation (bool) – Whether the operation is a validation.
report (dict) – The report in which each provider’s availability status and reason must be logged.
kwargs (dict) – Optional data. This parameter is not used here.

Renvoie

The compatible providers.

Type renvoyé

payment.provider

_get_redirect_form_view(is_validation=False)[source]¶

Return the view of the template used to render the redirect form.

For a provider to return a different view depending on whether the operation is a validation, it must override this method and return the appropriate view.

Note: self.ensure_one()

Paramètres: is_validation (bool) – Whether the operation is a validation.
Renvoie: The view of the redirect form template.
Type renvoyé: record of ir.ui.view

_get_validation_amount()[source]¶

Return the amount to use for validation operations.

For a provider to support tokenization, it must override this method and return the validation amount. If it is 0, it is not necessary to create the override.

Note: self.ensure_one()

Renvoie: The validation amount.
Type renvoyé: float

_get_validation_currency()[source]¶

Return the currency to use for validation operations.

The validation currency must be supported by both the provider and the payment method. If the payment method is not passed, only the provider’s supported currencies are considered. If no suitable currency is found, the provider’s company’s currency is returned instead.

For a provider to support tokenization and specify a different validation currency, it must override this method and return the appropriate validation currency.

Note: self.ensure_one()

Renvoie: The validation currency.
Type renvoyé: recordset of res.currency

_is_tokenization_required(**kwargs)[source]¶

Return whether tokenizing the transaction is required given its context.

For a module to make the tokenization required based on the payment context, it must override this method and return whether it is required.

Paramètres: kwargs (dict) – The payment context. This parameter is not used here.
Renvoie: Whether tokenizing the transaction is required.
Type renvoyé: bool

_should_build_inline_form(is_validation=False)[source]¶

Return whether the inline payment form should be instantiated.

For a provider to handle both direct payments and payments with redirection, it must override this method and return whether the inline payment form should be instantiated (i.e. if the payment should be direct) based on the operation (online payment or validation).

Paramètres: is_validation (bool) – Whether the operation is a validation.
Renvoie: Whether the inline form should be instantiated.
Type renvoyé: bool

_get_removal_values()[source]¶

Return the values to update a provider with when its module is uninstalled.

For a module to specify additional removal values, it must override this method and complete the generic values with its specific values.

Renvoie: The removal values to update the removed provider with.
Type renvoyé: dict

Edit on GitHub