Licences and Interfaces
Saferpay distinguishes between two licences:
- Saferpay eCommerce
- Saferpay Business
It is extremely important to clarify before the implementation of Saferpay, whether an eCommerce licence or a business license is to be used, as they provide different functions. The Saferpay Business licence is an extension of the eCommerce licence. If you have any questions, please contact your relevant contractually appointed person.
Inside the API specification, all "Business" requests are marked with the additional Business License tag, to indicate that they may only be used with Saferpay Business.
All Saferpay test accounts do have Business activated by default, for evaluation purposes.
Example of a "missing Business license"-API error
{
"ResponseHeader": {
"SpecVersion": "1.10",
"RequestId": "[your request id]"
},
"Behavior": "ABORT",
"ErrorName": "PERMISSION_DENIED",
"ErrorMessage": "Permission denied",
"ErrorDetail": [
"Invalid license"
]
}
Important Note: In case you are using Saferpay Business without the corresponding license, the API will throw an error (see above) in this case, you'll have three options to proceed:
Option 1: Get a Business license! You can contact your sales contact and ask for a change to Saferpay Business, so you have access to the needed functions.
Option 2: Redo the integration! If you are not happy with option 1, another option would be to redo the whole integration, with the Payment Page in mind.
Option 3: If you are using an official plug-in/integration from our partners, it may be only necessary to switch over to the Payment Page interface inside the shop-configuration. A complete re-integration won't be necessary in this particular case. When in doubt, please consult the user-manual, or contact the plug-in manufacturer directly.
Furthermore: If you have a Saferpay Business contract, but still recieve this error, please contact your sales contact.
The following table shows an overview of which functions are included in the two licence models:
| Interface | eCommerce | Business |
|---|---|---|
| PaymentPage Interface | ||
| Initialize Payment Page | ||
| Assert Payment Page | ||
| Transaction Interface | ||
| Transaction Initialize | ||
| Transaction Authorize | ||
| Transaction QueryPaymentMeans | ||
| Transaction AdjustAmount | ||
| Transaction Authorize Direct | ||
| Transaction Authorize Referenced | ||
| Transaction Capture | ||
| Transaction Cancel | ||
| Transaction Refund | ||
| Transaction Refund Direct | ||
| Transaction Redirect Payment | ||
| Transaction Assert Redirect Payment | ||
| Transaction AssertCapture | ||
| Transaction AssertRefund | ||
| Transaction MultipartCapture | ||
| Transaction MultipartFinalize | ||
| Secure Alias Store | ||
| Alias Insert | ||
| Alias Assert Insert | ||
| Alias Insert Direct | ||
| Alias Delete | ||
| Batch | ||
| Close |
The Interfaces
Saferpay consist of two main interfaces and a set of different additional modules that can be added to each interface depending on the business requriements and desired payment flow.
The main components of the Saferpay JSON API are:
- Payment Page Interface
- Transaction Interface
- and the additional Secure Card Data module
Important: It is important to understand the different intended uses and functionalities of each component to decide which Interface is best suited for your business and desired payment flows.
Supported Payment Methods
| Payment method | Transaction Interface | Payment Page |
|---|---|---|
| Visa | ||
| V PAY | ||
| Mastercard | ||
| Maestro International | ||
| American Express | ||
| Bancontact | ||
| Diners Club | ||
| JCB | ||
| Bonus Card | ||
| Postfinance E-Finance | * | |
| PostFinance Card | * | |
| MyOne | ||
| SEPA Direct Debit | ||
| PayPal | * | |
| ePrzelewy | ||
| eps | ||
| giropay | ||
| iDEAL | ||
| BillPay Purchase on Receipt | ||
| BillPay Direct Debit | ||
| SOFORT | ||
| paydirekt | ||
| Twint | ||
| Unionpay | ||
| Alipay | ||
| ApplePay (Wallet) |
||
| Klarna Payments | ||
| Crypto Currencies |
*Transaction Interface - Redirect Payment is deprecated and replaced by the Payment Page.. Please use the parameter PaymentMethods to directly select your desired provider.
What should i use?
Before implementing, it is important to clarify which functions are important for you.
Use the PaymentPage/ E-Commerce, if...
- You only want to do transactions: Do you have a small and simple web shop? Are refunds over the API, or recurring payments not important for you? The Payment Page and a regular E-Commerce contract probably sufficient for you.
- You want to have one solution for every payment method: The PaymentPage does support every payment method Saferpay has to offer. Once integrated, it is a simple matter of activating the payment methods you need and they will show up on the page.
Use the Transaction Interface/Saferpay Business, if...
- You want a more embedded/integrated solution: The Transaction Interface does offer a more integrated and personalized payment flow for credit cards, via the Saferpay Fields, or iframe integration. Think of it as the Payment Page reduced down to the card entry form, which can be embedded into every HTML-based application.
- You want to do recurring payments: Recurring Payments need special API functions, that are only available over Saferpay Business!
- You want to execute refunds via the API: Refunds via API (Consider that refunds are also possible via the Saferpay Backoffice) are only possible with the transaction interface and a Saferpay Business license.
- You want to save and use card data in our Secure Card Data store: Similar to recurring payments, but Secure Card Data can do more that just that. You could also spare your customer from entering his card data over and over again, even for 3D Secure payments!
Why not both?
If you have access to Saferpay Business, you also have access to all API functions Saferpay has to offer. You don't have to stick to one interface or the other, you can also mix both interfaces.
In some cases, you have to use the PaymentPage. For example, if you want to use PayPal, or any other 3rd party provider.
Another use case could be that you do all your normal authorizations over the PaymentPage, but then you use the Transaction Interface for Refunds.
If you decide to upgrade from E-Commerce to Business (For example for executing refunds via API) and already have a PaymentPage Integration, you can simply extend your integration for the functions you need, without changing the whole existing implementation.
Questions?
Still unsure what you need?
Contact the Saferpay Integration Support and we will help you deciding!