> For the complete documentation index, see [llms.txt](https://docs.saferpay.com/home/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.saferpay.com/home/master.md). # An Introduction to Saferpay Integration and User Guides, Developer-Zone and Changelog Learn all about integration, interface configuration and how to use Saferpay to ensure your payment solution integrates smoothly with your business application from the start. Saferpay is a modern and secure payment service provider for business applications. You can use it to process domestic and international e-payments through a secure interface.\ Easy integration with ERP and CRM systems is guaranteed. All key programming languages and operating systems are also supported, without the need for an SDK. Interfaces, such as the payment page, are optimized for all common devices. You decide how to integrate Saferpay into your online shop. Whether it’s using a web shop plugin, a partner application or a seamless API integration, Saferpay offers solutions for every requirement. This page will guide you in deciding what you need and where to find it. ## Finding what you need First and foremost, it is important to know what you want to do and what you need in order to do it. When first starting with Saferpay, it can seem intimidating to be handed tools that are new to you. So let's try to point you in the right direction: {% tabs %} {% tab title="Integration free" %} ## The Saferpay Backoffice The Saferpay Backoffice offers a wide array of tools, settings, payment options, analytics and user administration tools to make using Saferpay as easy and complete as possible. ### User Administration Not strictly a type of integration, user administration is a very important tool for managing access to the Saferpay Backoffice for you and your company. It allows you to create new logins, manage access and permissions, and offers basic user management tools, such as password resets and access revocation. It is the ideal solution for merchants with many employees involved in the payment process, accounting and similar tasks, without the need to share one login for all. [Click here, if you want to learn more.](/home/interfaces/backoffice/settings/user-administration.md) ### Secure PayGate - Creating Payment Links for Invoicing The Secure PayGate (SPG) is probably the most versatile, yet easy-to-use solution provided by Saferpay. The SPG allows the creation of payment links and QR codes for secure e-commerce payments. Send them via email, invoices, or SMS, or embed them on your website. The SPG uses the Saferpay Payment Page, which offers the full array of payment methods supported by Saferpay. It requires no extensive integration and is available directly in the Saferpay Backoffice. Due to its nature, you also benefit from liability shift through 3D Secure. The SPG is therefore not just interesting for smaller merchants, but also for cases where you want to invoice your customer for your services. One example is hospitality, where you invoice customers during their stay without the need for a physical terminal. [Click here, if you want to learn more.](/home/interfaces/backoffice/secure-paygate.md) ### Mail Phone Order Of course, Saferpay also supports classic Mail Phone Order use cases through the Backoffice. It is PCI-certified and secure, with no integration needed. [Click here, if you want to learn more](/home/interfaces/backoffice/transactions/authorization-and-payment.md). {% endtab %} {% tab title="Plug & Play" %} ## Plug-Ins For common webshop systems, Saferpay offers an array of plug-ins to make integration as easy as possible. Just download, install, configure, and you are done. [Please refer to this chapter](/home/master/web-shop-plug-ins.md) for a list of certified interfaces and their release information, in terms of supported features. {% endtab %} {% tab title="Custom Integration" %} ## Payment API For merchants with special needs, Saferpay also offers the Payment API, so a custom integration can fit these needs. Such a custom integration offers many options to fit Saferpay to your needs. These include: ### Payment Page The Saferpay Payment Page offers an easy-to-integrate solution for all merchants who want minimal integration effort, yet also access to all of Saferpay's supported payment methods. Its integration is meant to be as easy as possible, not just in terms of first-time integration, but also in terms of future extensions, such as new payment methods. [Click here, if you want to learn more.](/home/integration-guide/licences-and-interfaces/payment-page.md) ### Transaction Interface The Transaction Interface is for merchants who want a more flexible and integrated solution. It offers a wide array of options to customize Saferpay and fit it specifically to your needs. #### Credit Cards First and foremost, the Transaction Interface offers a more integrated and seamless solution for credit card payments inside your shop. Unlike the Payment Page, it is meant to be embedded directly in your webshop. [Click here, if you want to learn more.](/home/integration-guide/licences-and-interfaces/transaction-interface.md) #### Saferpay Fields The Saferpay Fields are an extension of the former flow and offer an even more flexible and seamless integration for credit card payments. They are ideal for one-page checkouts and other solutions that require a high degree of flexibility and integration. However, even for less sophisticated needs, the Saferpay Fields may be exactly what you are looking for. [Click here, if you want to learn more.](/home/integration-guide/licences-and-interfaces/saferpay-fields.md) #### Refunds via API The Payment API, of course, also allows you to execute refunds. It is ideal for merchants with ERP systems and accounting software. This way, you keep track of both your normal transactions and your refunds. [Click here, if you want to learn more.](/home/integration-guide/licences-and-interfaces/transaction-interface/refunds.md) #### Recurring Payments Recurring Payments do not just encompass subscriptions, but also all kinds of unscheduled transactions to charge your customers for additional services without their presence. [Click here, if you want to learn more.](/home/integration-guide/licences-and-interfaces/transaction-interface/recurring-payments.md) {% hint style="warning" %} Merchants inside the European Economic Area (EEA) must also follow the PSD2 law when capturing card data for any kind of recurring payments. [Please carefully follow the guide here.](/home/integration-guide/general-information/psd2.md) {% endhint %} #### Partial Captures Partial Captures offer the possibility of splitting the payout for one transaction into smaller parts. They are ideal for merchants whose goods are delivered in multiple stages or packages. Legal requirements in certain countries also require some merchants to only capture the money if the goods can be delivered. Partial Captures allow you to transfer only the amount needed at the time. [Click here, if you want to learn more.](/home/integration-guide/licences-and-interfaces/capture-and-daily-closing/partial-captures.md) ## Saving cards with Secure Card Data Certain flows and needs require the secure storage of card details, for instance in the case of [recurring payments](#recurring-payments), or simply to make checkout inside your shop as comfortable as possible, without the cardholder having to re-enter their card details. Since the storage of card data [is subject to heavy restrictions and requires extensive PCI certification](/home/integration-guide/general-information/data-security-and-pci-dss.md), storing card data themselves is not a viable option for most merchants. Saferpay Secure Card Data offers a PCI-certified and easy-to-use solution for this conundrum. [Click here, if you want to learn more.](/home/integration-guide/licences-and-interfaces/secure-card-data.md) ## Management API The Management API is involved with everything that concerns the [Saferpay Backoffice](/home/interfaces/backoffice.md). It allows the creation of [Secure PayGate](/home/interfaces/backoffice/secure-paygate.md) offers, configuration of certain features, and gathering information about your terminals, such as activated payment methods and currencies, via API. This allows for a great deal of automation. It is ideal for integrators who offer services to multiple merchants that want to use Saferpay. [Click here, if you want to learn more.](/home/interfaces/management-api.md) ## Omni Channel Omni Channel is the fusion of two previously strictly separated worlds: E-commerce and Point of Sale (POS). The Saferpay Omni Channel solution allows the transfer of card data and even whole transactions between the POS side and Saferpay/E-commerce. This allows for a new approach to handling your customers' experience, for example: A customer could order goods in your webshop while paying when picking up their order at one of your local affiliates. The other way around may also be possible if a customer orders goods locally, but pays for them later. You can transfer card data from your POS to Saferpay in order to perform recurring payments or refunds. There are multiple use cases for Omni Channel. [Click here, if you want to learn more.](/home/integration-guide/licences-and-interfaces/omni-channel.md) ## Mix and match All these features are part of one API and can work in conjunction with each other. A custom integration gives you the freedom to choose and combine whatever you need, so it fits your needs exactly. Want to use the Payment Page for transactions, but also the transaction interface for refunds, or recurring payments? This is all possible and, in some cases, even needed, such as with third-party payment methods. ### Mobile Integration Likewise, these integration methods can be used to integrate Saferpay into mobile apps for Android and iOS. [Click here, if you want to learn more.](/home/integration-guide/licences-and-interfaces/mobile-integration.md) ### Questions? Do you have questions about a feature? Are you unsure if your desired flow is supported, or do you simply want to make sure that you understood everything correctly? Feel free to [contact our Integration Support](/home/integration-guide/support.md#integration-support). {% endtab %} {% endtabs %} ## Getting things started So you have decided what you want to use, but what are the next steps? ### Demo & Testing Saferpay offers an extensive test environment where you can try out all these features. Especially if you have decided on a custom integration, you should first register for a test account, so you can start integrating. [Please see this chapter](/home/integration-guide/testing-and-go-live.md) about how to get your own test account and test data, such as credit card numbers. #### Want to take a look at Saferpay, before you start your integration? Take a look at our [Demo](/home/integration-guide/saferpay-demo.md) to see how Saferpay works and can be integrated into your system. ### Specification Please also consider [the technical specification](https://saferpay.github.io/jsonapi/) if you decide to use the Saferpay APIs. It covers all available parameters and requests. ### Getting your Live Account In order to get your live account, please [contact our Sales Team](/home/integration-guide/support.md#worldline-sales-team) to get access to our live environment. This process may take a while, so you should do this as soon as possible while your integration is underway in the test environment. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.saferpay.com/home/master.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.