1.1.1 Issuers & Brands

Both issuers and brands are used for AdyenIssuer objects for different payment options. Some will use one adyen_id for one issuer while some others will use a list of adyen_ids for allowed brands.

1.3.1 Management command

There is a management command that will sync the payment methods for you. This can be used if you want the users to select a payment method/issuer on your own site.

manage.py sync_payment_methods

There is a command that will call the function process_notification to handle notifications. This can be added to a crontab.

manage.py adyen_maintenance

1.3.2 Required settings

• DJADYEN_SERVER_KEY This is the server key. This should be a secret string.

• DJADYEN_CLIENT_KEY This is the client key. This key will be used in the components in the frontend.

• DJADYEN_MERCHANT_ACCOUNT This is the merchant accont that is used in Adyen.

• DJADYEN_ORDER_MODELS A list of models that are used to store Orders (Inherit from AdyenOrder). The models should be strings in the . form

• DJADYEN_NOTIFICATION_KEY The key to verify the notifications are from adyen

1.3.3 Optional settings

• DJADYEN_CURRENCYCODE (default=‘EUR’) This can be set to any other currency Adyen supports.

• DJADYEN_ENVIRONMENT (default=‘test’) This can be ‘test’ or ‘live’.

• DJADYEN_APPNAME (default=‘Djadyen Payment’) This is the name that will be send along with the payment.

• DJADYEN_REFETCH_OLD_STATUS (default=False) This is so you will always have the latest saved status. This will cause an extra db query!

• DJADYEN_HANDLE_NOTIFICATION_MINUTES_AGO (default=15) This defaults to 15 minutes. You can change the value to make this shorter or longer depending on the need.

# settings.py
DJADYEN_STYLES = {
    'base': {
        'color': '#000000',
        'fontSize': '16px',
        'fontFamily': 'Arial, sans-serif',
    },
    'placeholder': {
        'color': '#999999',
    },
    'error': {
        'color': '#ff0000',
    },
    'validated': {
        'color': '#00ff00',
    }
}

1.3.4 Order object

There is an abstract order in this package. This will save you some time on creating an order for adyen. There are some features on the order that will make it easier to integrate your order with this package.

The added fields are:

• status This is the status of the object. This will be changed by adyen.

• created_at This field is used for when the order is created.

• reference This field is a communication field. It is not used outside the communication. This will be set by uuid4, but can be overwritten.

• psp_reference This field is the reference from Adyen. With this field you are able to search in the Adyen inderface.

• payment_option This is the Adyen payment option from this package.

• issuer This is the Adyen issuer from this package.

You should implement the following methods

• get_price_in_cents Return the price to be paid for this order

• process_authorized_notification Process a ‘authorized’ notification which adyen has sent

• process_notification Process the notification, if you are using the adyen-maintenance management command

1.3.5 AdyenPaymentView

This view is used to show the payment page.

This page can be customized in 2 ways.

1. overwrite the template (adyen/pay.html)

2. Overwrite the view and changing the template_name

from djadyen.views import AdyenPaymentView


class PaymentView(AdyenPaymentView):
    template_name = "my_adyen/pay.html"  # Optional

Adyen requires a language locale i.e. nl-NL or en-US instead of nl or en. If Django’s uses language codes, adyen_language should be converted in the view context similarly to this:

ADYEN_LANGUAGES = {
    "nl": "nl-NL",
    "en": "en-US",
}

class PaymentView(AdyenPaymentView):
    ...

    def get_locale(self):
        return ADYEN_LANGUAGES[self.request.LANGUAGE_CODE]

1.3.6 AdyenResponseView

Adyen also creates a response. This will help you with catching the response. This view will check if the response from Adyen is valid. It will also provide some useful functions so you don’t have to overwrite anything.

In this example the order is automatically fetched from the reference that is passed in the merchantReference. It will also set the order in the self object for easy access. In the done function the order is saved and the template will be rendered.

from djadyen.views import AdyenResponseView
from djadyen.choices import Status


class ConfirmationView(AdyenResponseView):
    template_name = 'my_project/confirmation.html'
    model = Order

    def handle_authorised(self):
        self.order.status = Status.Authorised
        return self.done()

1.3.7 AdyenAdvancedPaymentView

Similar to the AdyenPaymentView but uses the advanced checkout from adyen-web. This allows for more payment methods and allows for the new Giving donation component. The advanced view can handle adyen responses and does not need the AdyenResponseView.

The view should implement the adyen_advanced_payment_component template tag in the template. The AdyenAdvancedPaymentView also needs to override get_locale to get the correct locale if it is not already.

from djadyen.views import AdyenAdvancedPaymentView

class AdvancedPaymentView(AdyenAdvancedPaymentView):
    template_name = 'my_project/confirmation.html'
    model = Order