Payment Provider

class odoo.addons.payment.models.payment_provider.PaymentProvider

_build_request_auth(**_kwargs)

Set the basic HTTP Auth of the request.

This method serves as a hook to allow providers to build the request's basic HTTP Auth.

Tham số

_kwargs (dict) -- Provider-specific data.

Trả về

The basic HTTP Auth, if any.

Kiểu trả về

tuple

_build_request_headers(method, endpoint, payload, **_kwargs)

Build the headers of the request.

This method serves as a hook to allow providers to build the request headers.

Tham số

• method (str) -- The HTTP method of the request.

• endpoint (str) -- The endpoint of the API to reach with the request.

• payload (dict) -- The payload of the request.

• _kwargs (dict) -- Provider-specific data.

Trả về

The request headers.

Kiểu trả về

dict

_build_request_url(endpoint, **_kwargs)

Build the URL of the request.

This method serves as a hook to allow providers to build the request URL.

Tham số

• endpoint (str) -- The endpoint of the API to reach with the request.

• _kwargs (dict) -- Provider-specific data.

Trả về

The request URL.

Kiểu trả về

str

_compute_feature_support_fields()

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.

Trả về

None

_find_available_payment_methods(partner_id, *, currency_id=None, force_tokenization=False, is_express_checkout=False, report=None, **_kwargs)

Find the providers' payment methods available for the given payment context.

Tham số

• partner_id (int) -- The partner making the payment, as a res.partner id

• currency_id (int) -- The payment currency, as a res.currency id

• force_tokenization (bool) -- Whether payment methods must support tokenization

• is_express_checkout (bool) -- Whether payment methods must support express checkout

• report (dict) -- The report into which availability statuses are to be logged

Trả về

The available payment methods

Kiểu trả về

payment.method

_find_available_providers(company_id, partner_id, amount, *, currency_id=None, force_tokenization=False, is_express_checkout=False, is_validation=False, report=None, **kwargs)

Find the providers available for the given payment context.

Tham số

• 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, as a res.currency id

• force_tokenization (bool) -- Whether providers must allow tokenization

• is_express_checkout (bool) -- Whether providers must allow express checkout

• is_validation (bool) -- Whether the operation is a validation

• report (dict) -- The report into which availability statuses are to be logged

• kwargs (dict) -- Forwarded to _is_tokenization_required and available to overrides

Trả về

The available providers

Kiểu trả về

payment.provider

_find_available_tokens(partner_id, **_kwargs)

Find the providers' tokens available for the given payment context.

Tham số

partner_id (int) -- The partner making the payment, as a res.partner id

Trả về

The available tokens

Kiểu trả về

payment.token

_get_code()

Return the code of the provider.

Note: self.ensure_one()

Trả về

The code of the provider.

Kiểu trả về

str

_get_default_payment_method_codes()

Return the default payment methods for this provider.

Note: self.ensure_one()

Trả về

The default payment method codes.

Kiểu trả về

set

_get_pm_from_code(generic_code, mapping=None)

Return the payment method with the given code linked to the provider.

If a mapping is given, the search uses the generic payment method code that corresponds to the given provider-specific code.

Tham số

• generic_code (str) -- The provider-specific code of the payment method to get

• mapping (dict) -- A non-exhaustive mapping of generic payment method codes to provider-specific codes

Trả về

The matching payment method, if any

Kiểu trả về

payment.method

_get_redirect_form_view(is_validation=False)

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()

Tham số

is_validation (bool) -- Whether the operation is a validation.

Trả về

The view of the redirect form template.

Kiểu trả về

record of ir.ui.view

_get_provider_domain(provider_code, **_kwargs)

Return the payment provider domain.

Tham số

• provider_code (str) -- The code of the provider to search for.

• _kwargs (dict) -- Additional keyword arguments.

Trả về

The domain to search for the provider.

Kiểu trả về

list[tuple]

_get_removal_values()

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.

Trả về

The removal values to update the removed provider with.

Kiểu trả về

dict

_get_supported_currencies()

Return the supported currencies for the payment provider.

By default, all currencies are considered supported, including the inactive ones. For a provider to filter out specific currencies, it must override this method and return the subset of supported currencies.

Note: self.ensure_one()

Trả về

The supported currencies.

Kiểu trả về

res.currency

_get_validation_amount()

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()

Trả về

The validation amount.

Kiểu trả về

float

_get_validation_currency()

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()

Trả về

The validation currency.

Kiểu trả về

recordset of res.currency

_is_tokenization_required(**_kwargs)

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.

Tham số

_kwargs (dict) -- The payment context

Trả về

Whether tokenizing the transaction is required

Kiểu trả về

bool

_parse_response_content(response, **_kwargs)

Retrieve the JSON-formatted content of the response.

This method serves as a hook to allow providers to parse the response content.

Tham số

• response (requests.Response) -- The response to parse.

• _kwargs (dict) -- Provider-specific data.

Trả về

The response content.

Kiểu trả về

dict

_parse_response_error(response)

Retrieve the error message from the response.

This method serves as a hook to allow providers to parse the response's error message.

Tham số

response (requests.Response) -- The response to parse.

Trả về

The error message.

Kiểu trả về

str

_send_api_request(method, endpoint, *, params=None, data=None, json=None, reference=None, **kwargs)

Send a request to the API.

Whenever possible, calls to this method should be wrapped in a try-except block to prevent the ValidationError that is raised when the request fails from bubbling up. Exceptions to this rule include calls from a controller that must return the error message to the client.

Note: self.ensure_one()

Tham số

• method (str) -- The HTTP method of the request.

• endpoint (str) -- The endpoint of the API to reach with the request.

• params (dict) -- The query string parameters of the request.

• data (dict|str) -- The body of the request.

• json (dict) -- The JSON-formatted body of the request.

• reference (str) -- The reference of the transaction, if any.

• kwargs (dict) -- Provider-specific data forwarded to the specialized helper methods.

Trả về

The formatted content of the response.

Kiểu trả về

dict|str

Đưa ra

ValidationError -- If an HTTP error occurs.