Interfaces
Integration Guide
Iframe Integration and CSS
The Saferpay Payment Page, the transaction interface and Secure Card Data offer the options for iframe integration and custom design using Cascading Style Sheets (CSS). The following describes how these features can be used and what needs to be adhered to.
Iframe Integration
iframe integration is supported for these methods/flows:
The response message includes a respective RedirectURL, if successful executed. This URL needs to be embedded in the iframe.
Iframe support
The following payment methods do not support the Iframe integration.
In case of these Payment methods, Saferpay will break out of the Iframe, so the payment may be performed, using a full-size payment page.
Please note, that your ReturnUrls, will then also be displayed in full size and not within your iFrame.
Apple Pay
​Apple Pay specifically will not be displayed, if the Payment Page is opened in an Iframe, due to restrictions emposed by Apple. Thus, you must make sure, that you do not open the Payment Page in an Iframe, if you want to use Applepay.
Integration
The integration is really simple. Simply execute a Payment Page Initialize, Transaction initialize, or an Alias Insert and use the RedirectUrl as the src-attribute value for the iFrame:
1
<iframe name="fields-card-number" scrolling="no" src="<%= REDIRECT URL %>"></iframe>
Copied!
iFrames and the CORS-policy
​Cross-Origin Resource Sharing (CORS) is a security policy, that handles the sharing of external ressources on a given website, for instance externally hosted JavaScript libraries, but also iFrames. If this policy is not followed in a correct manner, it can happen, that the iFrame is blocked by the respective browser. When integrating Saferpay into an iFrame, please always consider this policy.
Size of the iframe
The size of the iframe is communicated to the merchant via an HTTP-POST message, which can be captured using JavaScript. The iframe can thus be dynamically adapted to the content.
1
<html lang="en">
2
<head>
3
<title>Payment Form</title>
4
</head>
5
<body>
6
<h1>Payment Form</h1>
7
<iframe src= "<%= RedirectUrl %>"> </iframe>
8
</body>
9
</html>
Copied!
The POST message is transmitted in JSON format:
1
{
2
"message":"css",
3
"height":450,
4
"width":650
5
}
Copied!
JavaScript example for receipt of message (for jQuery >= 1.9)
1
$(window).bind("message", function (e) {
2
if (e.originalEvent.data.height <= 450) return;
3
$("#iframe").css("height", e.originalEvent.data.height + "px");
4
});
Copied!
Not every page reports its size to the merchant’s system. However, Saferpay has to forward users to third parties during the payment process (Like with the 3D Secure procedure), thus we recommend a minimum size of 450x450 pixels, in case this feature is not supported by the site.
Using CSS
The CSS feature should not be used with the Saferpay Payment Page as the feature is deprectaed there. Please use the Payment Page Configuration instead.
The use of Cascading Style Sheets (CSS) is available via the following methods/flows:
With a request using the Styling container, the CssUrl parameter must be forwarded, alongside a reference to the CSS file which is to be used.
CSS Elements
All browsers include tools that simplify designing with CSS. CSS can thus be edited directly in the browser, and the results can be observed.
Example for Chrome browser
With the right mouse button, click the item to be edited:
(click to enlarge)
It opens a menu which shows the HTML code and the CSS classes with the corresponding attributes:
(click to enlarge)
As an example, the text colour is adjusted here (CSS attributes can also be added and removed, if supported by the browser):
(click to enlarge)
The change is immediately displayed in the browser. Then, the code simply needs to be transferred to the CSS file:
(click to enlarge)
The following elements should NOT be used:
- Element ID: Element ID should not be used because the ID used may change without notice.
- Element Attribute: Element attributes should not be used, because attributes (name, value, data-*, etc.) can change without notice.
CSS Selectors
As a principle, all CSS selectors for CSS1, CSS2 and CSS3 are supported, depending on the used browser.
More Information
- The CSS file that is referenced by the CssUrl parameter must be stored on a web server that supports HTTPS.
- When aiming for the PCI DSS SAQ-A compliance, you must set the ContentSecurityEnabled parameter inside the Styling-container to true. Furthermore, you have to consider the following things:
- Every bit of code must be contained within the same CSS file. Importing more than one file is not supported!
- Image files must be loaded via a Data-Url within the CSS file itself!
- It is recommended to display a progress bar while something is loading in an iframe.
- The PCI specifications DO NOT allow jumping into the iframe with JavaScript. So manipulating it, using JavaScript, is strictly prohibited!
- Some third party payment providers (e.g. PayPal) DO NOT support the integration inside an iframe. Thus, the PaymentPage will break out of the iframe beforehand.
- Integrating Saferpay via an iframe will also cause the SuccessUrls to be called inside said frame. If you want to present the return pages in full size, you can break out of the frame yourself, using JavaScript.
Example of iframe break out in JavaScript
Executing this code will re-load the return page, resulting in it being called twice.
1
<html lang="en">
2
<head>
3
<title>Success Page</title>
4
<script type="text/javascript">
5
function iframe_breakout()
6
{
7
if (top.location !== location){
8
top.location.href = document.location.href;
9
}
10
}
11
</script>
12
</head>
13
<body onload="iframe_breakout()">
14
15
SOME HTML…
16
17
</body>
18
</html>
Copied!