adyen.config module

class adyen.config.AbstractAdyenConfig

Bases: object

Abstract class for an Adyen config class.

Plugin users that want to create their own Adyen config class must comply with this interface.

get_action_url(request)

Get Adyen HPP URL to post payment request form to.

Parameters:request – Django HTTP request object.
Returns:Adyen HPP URL.
get_allowed_methods(request, source_type=None)

Get customers’s list of allowed Adyen payment methods.

Parameters:request – Django HTTP request object.
Returns:List (or tuple) of allowed payment methods.

New in version 0.6.0: Make sure to implement this method when using this new version.

get_identifier(request)

Get Adyen merchant identifier.

Parameters:request – Django HTTP request object.
Returns:Adyen merchant identifier as string.
get_ip_address_header()

Get the request HTTP header used to get customer’s IP.

Returns:appropriate request HTTP header.
get_signer_backend(request)

Get the signer backend class as a python path.

Parameters:request – Django HTTP request object.
Returns:The python path to the signer backend class to use.
Return type:str

The signer object will be used to sign payment request form and to verify Adyen payment result fields and/or notifications.

get_skin_code(request)

Get Adyen merchant skin code.

Parameters:request – Django HTTP request object.
Returns:Adyen merchant skin code.
get_skin_secret(request)

Get Adyen merchant skin secret key.

Parameters:request – Django HTTP request object.
Returns:Adyen merchant skin secret key.
adyen.config.get_config()

Returns an instance of the configured config class.

Returns:Project’s defined Adyen configuration.
Return type:AbstractAdyenConfig

By default, this function will return an instance of adyen.settings_config.FromSettingsConfig. If ADYEN_CONFIG_CLASS is defined, it will try to load this class and return an instance of this class instead.

Note

This function expects ADYEN_CONFIG_CLASS to be a string that represent the python import path of the Adyen config class, such as adyen.settings_config.FromSettingsConfig.