Introduction

If you create a service you (or the merchant) can link payment methods to your merchant's website, physical store or cash register. If the service is added you will receive an SL-code with a secret. With this SL-code and secret you can process payments.

Using our API's

During the initial setup of your merchant the first service is created. In this service we have enabled the payment methods iDEAL, Bancontact and Bank transfer. If you want to further configure this services or want to add multiple services you can use our API's. These API's can be found here.

The following sections describes in more detail all functionalities.

Creating a service

It all starts with creating a service. In this API you can supply the basic information, like a name, description etc. You also need to indicate the correct category for your business. This is crucial information for our boarding department to determine the risk level. Please make sure that you choose the most relevant category for a smooth boarding processing.

The following recipe gives you a detailed overview how to create a service for your merchant.

Setting settings for a service

A service contains a lot of settings, e.g. which exchange method do you want to use etc. With the Services:UpdateSettings API you can set all settings that are applicable on a service. This section gives an overview of the settings that are available.

Understanding defaultValue vs value

Some settings can be configured both on merchant level or on sales location level. This structure is returned in the API response. In the code snippet below you see a fragment of the response, in this case only the verify object.

{
    "verify": {
      "strength": {
        "defaultValue": "REGULAR",
        "value": "STRONG"
      },
      "showScreen": {
        "defaultValue": true,
        "value": null
      },
      "level": {
        "defaultValue": "FULLSERVICE",
        "value": null
      },
      "group": {
        "defaultValue": 1,
        "value": null
      },
      "cnp": {
        "defaultValue": true,
        "value": false
      },
      "other": {
        "defaultValue": false,
        "value": null
      }
    }
}

As you can see we return a defaultValue and a value per setting:

• defaultValue; that is the value that is configured on merchant level
• value; if this is set the value is configured specific on this service

So in this case the setting strength contains a value "STRONG"which means that payments done on this service will use the verify module with the setting strength with value "STRONG"

In our portal we display this as follow:

If checkbox for a certain setting is set a service specific value (the value in the API response) is used. If not checked and the field is grayed out the setting on merchant level (thus the defaultValuein the API response is used).

Setting your exchange configuration

Most commonly used settings are the settings which relates to your exchange configuration. More information regarding exchanges can be found in the section 'Handling the exchange calls' . The following recipe gives you more detailed information regarding this exchange configuration.

Managing payment methods on a service

Before enabling payment methods on a service it is important to know that not each payment method is applicable for each merchant /service. It depends on the category where the merchant or service is active in. Also some payment methods (like Online card payment methods (CNP)) requires additional checks by our boarding department.

A complete list of all payment methods can be found here or access our PaymentMethods API to get all paymentmethods that Pay offers.

Get all available payment methods for your merchant /service

To get a list of all payment methods that are available for your merchant /service, including their boarding status and if they are active on your service you can use the Service:GetAvailablePaymentMethods.

The result set has the following structure:

{
  "paymentMethods": [
    {
      "id": 10,
      "name": "iDeal",
      "active": true,
      "boarding": {
        "status": "ACCEPTED",
        "completedAt": "2023-11-27T11:42:29+01:00"
      },
      "settings": {
        "idealFailoverType": {
          "defaultValue": 1,
          "value": 3
        }
      }
    },
    {
      "id": 3138,
      "name": "Mastercard",
      "active": false,
      "boarding": {
        "status": "IN_PROGRESS",
         "completedAt": null
      },
      "settings": null
    }
  ]
}

The boarding object indicates the status of the boarding. As mentioned before, some payment methods requires an additional boarding before they can be used.

If the status is "ACCEPTED" and the flag active is set to true the payment method can be used. If the boarding status is "IN_PROGRESS" our boarding department is checking the request.

Enabling a payment method

You can use the Service:EnabledPaymentMethod endpoint to enable payment methods. In the request URL you need to supply the SL-code and the paymentMethodId you want to enable. Note that you need to call this endpoint multiple times if you want to enable more paymentMethods.

Some paymentMethods support additional settings, please refer to the API reference for more information. Some of these settings also use the 'defaultValue vs value' construction, see here.

Updating settings for a payment method

If you have set settings for a payment method you can use the Service:UpdatePaymentMethod endpoint to update these settings. In the request URL you need to supply the SL-code and the paymentMethodId for which you want to update the settings.

Note; it can occur that if you change a setting a reboarding is triggered. The payment method becomes inactive if a reboarding is triggered.

Disabling a payment method

If you want to disable a payment method on a service you can use the Service:DisablePaymentMethod endpoint. In the request URL you need to supply the SL-code and the paymentMethodId you want to disable.

Get the details of a service

We have several API's to get information regarding your (or your merchant) services.

• Services:Browse; Get a (paginated) overview of all services available for a merchant. You can supply a merchant code if you want to get the services for your merchant.
• Services:Get; Get the basic information for a single service.
• Services:Info; Get detailed information for a single services; incl all settings and all enabled payments.