Documentazione

1The Basic Concept of Processors

It is important to have a clear understanding about the different terms and their meaning. It is especially important that you understand the difference and how these concepts are related to each other. Especially the difference between payment method, processor and connector.

1.1Anatomy

In order for a payment method to appear on the payment page the following entities have to be configured in a proper way:

  • Processor: A processor represents a single integration to a third party which is capable of processing payments. For each processor a configuration has to be created in order to accept payments through the processor.

  • Payment Method: A payment method represents a single mean how a customer can pay. A payment method can also be configured to control specific properties of the payment method. In order to accept payments with a particular payment method a configuration for this payment method has to be created.

  • Connector: A connector links the payment method together with the processor. It is like a single connection to the processor. A processor has a final set of connectors. To use a connector it requires to be configured. The connector executes actually the payment and hence you need the connector configuration in order to accept payments.

For every of this entity you can of course have multiple configurations. You can also have multiple configurations of the same type and separate them by conditions or link them to a specific space view.

1.2Processor

You can create a processor configuration under Space > Payment Configuration > Processors.

A processor represents the API Integration towards a third party. The processor list shows all supported processors.

In the processor configuration you can generally specify the following settings:

  • Activate or deactivate the processor configuration. When the processor configuration is deactivated all connector configurations linked with the processor configuration will be not considered anymore for using for authorizing transactions. A deactivated configuration can be activated again.

  • Switch between live and test mode.

  • Set the credentials in order to use the API of the processor. E.g. these are the credentials provided by the processor.

You can have multiple instances of the same processor. Which allows to use multiple accounts of the same processor. This allows to use different accounts depending on some transaction property (e.g. amount, country etc.).

Example

Use different terminals based on a specific criteria:

If you want to use a different processor based on some transaction criteria (i. e.the transaction amount) you can apply the conditions on the respective connector configuration (see below) to select the correct payment Service provider.

1.3Payment Methods

In order to create a configuration for a payment method go to Space > Payment Configuration > Payment Methods.

A payment method configuration defines how the payment is processed. We support a multitude of different payment methods. Note that not every payment method can be processed by every processor. The payment method list shows all supported payment methods.

In the payment method configuration you can generally specify the following settings:

  • Activate and deactivate a payment method configuration. When a payment method configuration is deactivated no more transaction with this particular payment method configuration is not used anymore for authorizing transactions. A deactivated configuration can be activated again.

  • Define the name of the payment method shown to the customer.

  • Define the order in which the payment method is shown to the customer.

  • Define the image which is used for the payment method.

  • Some payment methods allows the collection of the payment information directly on our payment page. In this situation you can select if you prefer to collect the data on the third party payment page (offsite) or if we should collect the data (onsite). This option will only appear when you can control this for a particular payment method. Not all payment connectors support both ways of the data collection and hence you may want first to check whether your preferred connector is supporting the selected data collection type. Once the data collection type is set on a payment method configuration it cannot be changed anymore.

You can create multiple configurations of the same payment method.

1.4Connector Configurations

In order to create a connector configuration go to Space > Payment Configuration > Connectors.

A connector configuration links the characteristics of the payment methods to the capabilities of your processor (i. e. not every payment method can be processed by every payment processor. Some processor can only process certain payment methods offsite respectively only onsite).

The available settings depend very highly on the capabilities of the connector and the characteristics of the payment method.

In the payment method configuration you can generally specify the following settings:

  • Activate and deactivate the connector configuration. A deactivate connector configuration is not considered for authorizing transactions. A deactivated configuration can be activated again.

  • The order in which the connectors are applied to transactions.

  • The conditions which gets applied on the connector. This allows to control under which circumstances the connector will be used.

  • Restrict the connector to a set of space views.

  • The authorization email template and the invoice email template.

  • The invoice template which is applied for transactions of this connector.

  • Connector specific settings such as fraud settings.

In order to link your configured payment method to the processor you can create for every of you intended cases a separate connector configuration.

Example

Use different terminals based on a specific criteria

If you want to use a different processor based on some transaction criteria (i.e. the transaction amount) you can create multiple configurations and then apply the conditions in the respective connector configuration.

2Applying Condition on Connectors

Conditions is our way to select a connector configuration for a transaction. You can create condition configurations under Space > Payment Configuration > Conditions.

Conditions can be set based on multiple transaction criteria. The condition type list shows all possible types. Each type defines different criteria how to filter transactions. Those conditions can be also grouped together in a logical or group. Which allows to formulate complex conditions.

Conditions are managed centrally because they can be applied to multiple configurations like:

  • Connector Configuration: The conditions act here as mechanism for routing transactions.

  • Charge Flow Configuration: The conditions controls which flow is applied on the transaction.

Note
If there are still multiple options after a condition was applied, the selection process will be carried out based on the defined priority in the configuration. The application of conditions and the priority allows to specify a routing of transactions.

3Payment Data Collection

The payment information can be collected either by our hosted payment form (onsite) or we can redirect the customer to the processor for the data collection (offsite).

  • Onsite data collection implies that the data collection form is generated by us and hence it can be customized by editing the corresponding form elements via the resource editor.

  • Offsite data collection implies that the customization of the form has to be done via the processor’s facilities.

Note
Some payment method support only one or the other collection types. In this case the payment method configuration can be setup for either offsite or onsite data collection. This means that depending on the set up of the payment method configuration it can be that you can not select every processor when you set up you connector configuration.