UK Gateway

A processor is an entity that represents a payment processing connection between an organisation and a processing entity such as a card acquirer or an alternate payment method. The entity contains a configuration object that contains unique identifying information for the processing connection such as merchant identifiers or API keys. The information included depends on the configuration object type.

Refer to the API documentation for the complete set of possible processor configuration types and their associated parameters.

Processors are connected to organisations during their creation. Each account under an organisation that wishes to process payments needs to have a processor attached to it.

An account can only have one processor object of a particular configuration type attached to it. For example: one account can have one card processor attached to it, one iDEAL processor, etc. but not two different card processors. However, a single processor can be attached to multiple accounts. This specific allows for a payfac model where the the MIDs are shared for multiple merchants.

Scope

The scope of a processor and the users within the organisation the processor is linked to, are based on a top-down method. This means that a user can only view processors connected to this organisation or child organisations of this organisation.

Creating a Processor

The first part of a processor configuration object type parameter identifies the type of processor, while the second part identifies the unique party processing the payment. For example, If the processor entity has a configuration object with type = card_barclaycard, it identifies that the processor is of type 'card' with the processing party being 'barclaycard'. The processor configuration object in such a situation would have Barclaycard card processing specific parameters.

For a full overview including parameter descriptions of the /processor endpoint please visit the API documentation. The following sample POST call to $BASEURL/v1/processor can be used to create a processor:

{
  "configuration": {
    "_type": "string"
  },
  "name": "string",
  "organisation": "string",
  "mcc": "string"
}

Relationship to Processor

The following items can be linked to a processor:

• Accounts

More information on the relationships between processors and other items can be found here.

UI Guide

The following page describes how to create and edit a processor. In order to create, edit or view a processor you will need the ProviderAdmin role. More information on that can be found here.

1. Navigate to the Processor tab. Click 'Add New Processor'

2. Every processor will have a different method for authenticating. The fields required per processor are different. For this example we will use Payvision. Fill out the form with your processor details and click save:

• Name:Name of processor. Can be changed later.
• Organisation: The organisation the processor belongs to. Make sure this is the same as the account you intend to use it for. More information with regard to relationships between organisations and accounts can be found here. Cannot be changed later.
• Payment Product: Card. Cannot be changed later.
• Processor: Payvision. Other card processors can also be seen here.

3. After clicking save verify the processor was created: