Worldline

Open Forms supports the Worldline payment backend (using a PSPID).

In order to make use of this module, administrators must create a Worldline merchant and a Worldline Webhook configuration in the admin interface.

  1. Navigate to Configuration > Configuration Overview. In the Payment Provider Plugin group, click on Add merchant for the Worldline merchant line (or configure an existing merchant).

  2. Complete the form fields to generate a merchant:

    • Label: Fill in a human readable label, for example: My Worldline

    • PSPID: Your Worldline PSPID

  3. Next, in another browser tab or window, head to Worldline’s Merchant Portal and click on Developers > Payment API in the sidebar on the left.

  4. Generate the following values:

    • API Key ID

    • Secret API Key

  5. Copy the API Key and Secret API Key into the corresponding fields in the Worldline Merchant that was accessed in the Open Forms admin, see previous step.

  6. Save the changes and verify that all configuration is correct.

  7. The previous steps configured the redirect flow between Open Forms and Worldline, the following steps will configure the webhook integration. Navigate in the Worldline Merchant Portal sidebar to: Developer > Webhooks

  8. Generate webhook credentials by clicking on the Generate webhook keys and save the Webhook ID and Secret webhook key values somewhere safe.

  9. Head back to the Open Forms admin and navigate to Configuration > Worldline webhook configuration.

  10. Copy the Webhook ID from the previous step into the Webhook Key ID form field and the Secret webhook key into the Webhook Key Secret form field.

  11. Copy the Feedback url from the webhook configuration page.

  12. Save the changes.

  13. Head back to Worldline’s Merchant Portal and navigate to the Webhooks section (see previous step). Click on the Add webhook endpoint button and fill in the Feedback url that was copied in the previous step and click Confirm.

Now that a Worldline Merchant is configured and the Worldline webhook configuration is set up, it is possible to select the Worldline payment backend under the Payment provider subsection in the Product & payment tab. In addition to selecting the merchant, there are also fields to configure the payments description (only shown in the Backoffice) and the template that should be used during the payment process, which is what the variant field is for.