Adding a payment method in Afosto

This guide explains how to add a payment method in Afosto. The process has two parts: creating the method itself and connecting a payment service provider (PSP). Because the method and the provider are decoupled, you can switch providers later without reconfiguring your method settings.

The bigger picture first

A payment method never stands entirely on its own in Afosto. There are three connected levels:

Payment condition - the moment and arrangement of paying (e.g. Pay directly, Down payment, Pay later).
Payment method - the concrete means within a condition (e.g. iDEAL, Bancontact, credit card).
Provider - the party that processes the method (e.g. Mollie or Pay.nl).

Pay directly is the default condition that always applies; other conditions are added as exceptions to it. You do not link methods to a condition manually: within a condition, the payment-method structure that applies to that context (sales channel, country, order amount) is automatically available.

This guide covers the method level. To set up conditions, see the guide 'Adding a payment condition'.

About 'Exceptions' (the Rule Builder)

In several places in Afosto you will encounter the Exceptions button. This is always the same Rule Builder, which lets you turn something on or off, or calculate it, based on conditions (order amount, country, customer group, etc.). You will find it in three places:

On a payment condition - determines when that condition applies.
On a payment method, under 'Payment method activated' - determines whether the method is shown or hidden.
On a payment method, under 'Payment method costs' - determines the (optionally conditional) costs.

The full behaviour, examples and points of attention are in the guide 'Payment method rules'. Pay attention to two things in particular: the order of rules matters (top to bottom, the first matching rule wins - drag to reorder), and for countries you use ISO ALPHA-2 codes (e.g. NL, DE).

Preparation

Make sure you are logged in to your Afosto admin account.
Make sure you have an account and the required API details with the payment service provider you want to connect (e.g. Mollie or Pay.nl). Without those details you cannot complete the connection.
In the menu, navigate to Payments > Payment methods.

The Payment methods screen has two tabs:

Online - methods that run through a provider (iDEAL, Bancontact, credit card, etc.).
Manual - methods without a provider, where you process the payment yourself (e.g. a manual bank transfer). For a manual method you skip connecting a provider.

The overview shows the columns Name, Provider, Active and Exceptions for each method.

Part 1 - Creating the method (online)

Go to Payments > Payment methods and select the Online tab.
Click + Online payment method in the top right. A screen opens with the settings for the new method.
Select the type of payment method (e.g. iDEAL, Bancontact, credit card or PayPal).
Give the method a name. This is the name your customers see at checkout.
Add a displayed description and/or customer instructions (optional).
Add translations if your webshop is multilingual, so the name and description appear in the customer's language.
Decide whether the method is active (under 'Payment method activated'). If you only want to show the method under certain conditions - such as a minimum order amount or for specific countries or customer groups - click Exceptions to set this in the Rule Builder.
Optionally set costs (under 'Payment method costs'). Costs can be a fixed amount or a percentage and follow the VAT settings of the sales channel; they appear as a separate line on the order. To make costs conditional, use Exceptions here as well.
Click Add (top right) to save the method.

Part 2 - Connecting a provider

Open the method you just created in the overview and choose the option to connect a provider.
Choose an existing provider integration or create a new one. For a new provider, enter the provider details and API details and save. For an existing provider, select it from the list; a connected provider can be reused for multiple methods.
Verify the connection (see below).

Checking that the method works

Optionally put your provider in test mode and place a test order.
If you reach the provider's screen during checkout (e.g. the iDEAL screen), that is usually a sign the connection works.
Check the Active column in the Payment methods overview: a green indicator means the method is active. The overview also shows the connected Provider and whether any Exceptions are set.

Note: an online method is only usable when it is both active and connected to a provider. An active method without a connected provider cannot be paid; make sure the Provider column is filled.

If an error occurs while connecting, first check that the API details are entered correctly and contact the provider if needed.

Adding a payment condition
Payment method rules - the Rule Builder for showing/hiding and costs
Adding a manual payment
Provider-specific step-by-step guides (incl. Mollie, Pay.)

On this page