Worldline Polska Saferpay App User Guide
- June 15, 2024
- Worldline Polska
Table of Contents
Worldline Polska Saferpay App
Product Information
Specifications
- Status : Released
- Author : Worldline (A741251)
- Document Date : 22 June 2022
- Classification : Public
- Version : 1.8.2
Product Usage Instructions
STEP 1: Testing
You can use the Saferpay (Test) App to test the payment process in your shop
in advance. The Saferpay (Test) App is pre-installed and preconfigured with a
general test account. You can immediately use the app to make test payments.
If you do not wish to use the general test account, you can create an
individual test account by visiting the following link: Createindividual
test account (EN).
STEP 2: Installing Live App
After your live account has been set up successfully, you will receive all the
required data for the Saferpay (live) app via email. The email will contain
the following data:
- Your Saferpay username
- A temporary password for your first login
Note that you will be prompted to define a new password after your first login. Please make sure to use only the newly created password for future logins.
Creating JSON API authentication credentials
To start accepting real payments in your Beyond shop, you must create the
payment credentials required for the Saferpay (live) App. Follow the steps
below:
- Use your Saferpay username and the corresponding password provided in step 2.0 to log into the Saferpay Backoffice.
- Navigate to Settings and click on JSON API Basic Authentication.
- Click on the button “Create new JSON API Login.” A new window will pop up.
FAQ
Can I use the Saferpay (Test) App to make test payments?
Yes, the Saferpay (Test) App is pre-installed and preconfigured with a
general test account. You can use it immediately to make test payments.
Alternatively, you can create an individual test account if you do not wish to
use the general test account.
How do I create JSON API authentication credentials?
To create JSON API authentication credentials, log into the Saferpay
Backoffice using your Saferpay username and corresponding password. Navigate
to Settings and click on JSON API basic Authentication. Then, click on the
“Create new JSON API Login” button to create the credentials.
STEP 1: Testing
You can use the Saferpay (Test) App to test the payment process in your shop in advance. The Saferpay (Test) App is pre-installed and preconfigured with a general test account. You can therefore use the app immediately to make test payments. However, you can also create an individual test account if you do not wish to use the general test account: Create individual test account: https://test.saferpay.com/BO/SignUp?lang=en
STEP 2: Installing Live App
You will receive all the required data for the Saferpay (live) app after your live account has been set up successfully. You will receive an email with the following data:
- Saferpay username (e.g. „e24xxxx001“) for the Saferpay back office
- Saferpay initial password for the Saferpay Backoffice – This password will be used once; you will be prompted to define a new password after your first login. Please make sure to use only the newly created password for future logins
- Saferpay customer ID: Your customer identification number
- Saferpay terminal ID: The virtual terminal identification number on which the different payment methods are activated.
Creating JSON API authentication credentials
To start accepting real payments in your Beyond shop you must create
payment credentials that are required for the Saferpay (live) App:
-
Use your Saferpay username and the corresponding password that was provided in 2.0 to login into the Saferpay Backoffice to create the JSON API credentials and the API Key
-
After successful login, navigate to “Settings” and then click on “JSON API basic Authentication”
-
Click on the button “Create new JSON API Login”. A new window will pop up.
-
Enter a password that fits the password requirements (hover the mouse over the icon for more info on the password requirements)
Tipp: Copy and paste the password to a text editing program like text editor or Word
Optional : Provide a description- Press “Create” to create the JSON API Credentials
-
The following screen will be shown after the JSON API credentials have been created successfully.
- Copy the username (value starting with “API_xxxxxx_xxxxxxxx”, marked red)
**Creating API Key
**
The next step is to create the Saferpay Fields Access Token to generate an API Key
-
Navigate to “Settings” and then click on “Saferpay Fields Access Tokens”
-
Click on the button “Create Saferpay Fields Access Token”. A new window will pop up.
-
In the Terminal dropdown field select the “E-commerce Terminal”
Optional: Provide a description
Copy and paste the following URL in the field “Source URL(s) “https://saferpay.webionate.de/ “
IMPORTANT : Make sure that you copy and paste this URL correctly.
Press “Create” to create the API Key.
TEST ACCOUNT: For your individual test account, alternatively enter the following URL in the “Source URL(s)” field: https://saferpay-beyond- staging.herokuapp.com/ -
The following screen will be shown after the Saferpay Fields Access Token has been created successfully.Copy the API Key (marked red)
You should now have all the required data:
- Saferpay API Key
- Saferpay JSON API username
- Saferpay JSON API password
- Saferpay Customer ID
- Saferpay Terminal ID (eCommerce Terminal)
Tip : In case you are not sure how to find the terminal ID or customer ID. These values can be found on the Saferpay Fields Access Tokens setup page:
Configuring Saferpay App
Now that you have all the required data you need to install the Saferpay app.
- Login into your Web-shop Cockpit (e.g. https://MyShop.wlonline.store/cockpit/ or https://MyShop.beyondshop.cloud/cockpit/ )
- Navigate to “Website” and then click on “Payments”
- Click on the new window “Add payment methods”.
- You can activate and edit the required payment methods by clicking on “Activate” next to each payment method. Important : Please be aware that each payment method has a dedicated test version. Those are marked with the word „Test“ Please make sure to always activate the correct version in your shop.
- Click in the new window „Connect“.
- You will be prompted to provide the Saferpay credentials. Copy and paste the previously collected data into the respective fields and click on “Confirm Saferpay Credentials” to save the configuration.
- If the payment method has been successfully connected with your shop, you can activate it via the button on the top right.
Tip : You can always (de-)activate and configure supported payment methods under „Settings“ and then „Payments“
Configuring third-party payment methods
Make sure to configure third-party payment methods in case you want to
integrate them with Saferpay. Please also take notice of the special features
of these third-party payment methods. These are the third-party payment
methods that need to be configured before they can be integrated with
Saferpay:
- PayPal (configuration guide)
- Apple Pay (configuration guide)
- Sofortüberweisung by Klarna (configuration guide)
- Klarna Payments (Pay Later, Pay Now) (configuration guide)
STEP 3: Testing of live integration
You should intensively test your live integration with real cards and payment
details to verify the correct end-to-end set up and functionality. Please
provide your customer ID or terminal ID and a detailed description of the
issues/error, when contacting our support team. Also point out whether you are
integrating on the test or live environment. The more detailed your
description and provided data are, the better and quicker our team can assist
you with finding a suitable solution.
More information on payments
You can find more information on payments in our Help Center: https://online-
help.zendesk.com/hc/en-us/sections/360002137693-Payment
Support Contacts
Do you have questions or a technical problem? Our specialized service teams
can provide you with expert information. Find your contact information in your
beyondshop.cloud Cockpit in the menu under Help & Support
References
- Apple Pay - Saferpay Documentation
- Klarna Payments - Saferpay Documentation
- PayPal - Saferpay Documentation
- Sofort by Klarna - Saferpay Documentation
- Commerce Cockpit
- Saferpay Backoffice
- Saferpay Backoffice
Read User Manual Online (PDF format)
Read User Manual Online (PDF format) >>