Hosted Checkout Page
- Delegate handling sensitive data to us for PCI compliancy
- Flexible and easy visual adaptation
- Easy integration, instant payment!
Erste Schritte
Um Transaktionen auf unserer Plattform mit dieser Lösung zu verarbeiten, stellen Sie Folgendes sicher:
- Sie haben ein Konto auf unserer Plattform
- Mindestens eine dieser Zahlungsarten ist in Ihrem Konto aktiviert Überprüfen Sie dies im Back Office via Konfiguration > Zahlungsmethoden
- Sie haben Ihren API Key und API Secret in Ihrem Konto konfiguriert
- Ihr Server kann Server-zu-Server-Anfragen über unsere RESTful-API senden. Mit einem unserer Server SDKs wird diese Aufgabe erheblich erleichtert
Sind Sie bereit? Dann erfahren Sie im nächsten Kapitel, wie Sie unsere Hosted Checkout Page-Lösung einsetzen können!
How it works
Bevor Sie Live-Transaktionen verarbeiten, sollten Sie unsere Testumgebung nutzen. Lernen Sie unsere Lösung ohne Kosten oder Verpflichtungen kennen! Wenn Sie Ihre Website freischalten wollen, sehen Sie hier, wie Sie ein Livekonto erhalten oder kontaktieren Sie uns!
Aktuellste API Basis-URL nutzen
Wir raten Ihnen, immer die aktuellste API Basis-URL zu nutzen, wenn Sie Anfragen an unsere Plattform senden. In unseren ausführlichen Anleitungen finden Sie eine komplette Übersicht:
Für einen reibungslosen Übergang bleiben vorherige API Basis-URLs bis auf weiteres verfügbar.
Ways to integrate
1Use our SDKs
Use our Server SDKs to seamlessly connect your server environment to the Ingenico Direct platform's Server API. These SDKs simplify the API's functionality with easy-to-use platform-specific objects.
2Use our plugins
Our Plugins provide a seamless link between your webshop and our platform. By effectively wrapping our RESTful API, these plugins save you time on writing code and make integration quick and easy.
Integration steps
At one point during the checkout process, you send your customers to our secure payment page. They enter their card details, we send them to your acquirer and provide you with the result.
Our Hosted Checkout Page works with all payment methods available on our platform. If your customers choose a redirection payment method, we will redirect your customers directly to the third-party provider.
The following chapters cover a high-level overview of a typical flow. It describes all the steps you need to follow for processing Hosted Checkout Page transactions. Find a detailed overview including optional steps, 3-D Secure authentication etc. in the dedicated chapter.
- Initialise Server SDK
- Create Hosted Checkout session
- Redirect customer to Hosted Checkout Page
- Get transaction result
- Show result & redirect customer to webshop
Initialise Server SDK
Ansteuern der Endpunkt-URLs in der Test-/Live-Umgebung
Unsere Plattform ermöglicht es Ihnen, Anfragen entweder an unsere Test- oder Live-Umgebung zu senden:
- Endpunkt-URL TEST: https://payment.preprod.direct.worldline-solutions.com/v2/MERCHANT_ID/hostedcheckouts
- Endpunkt-URL LIVE: https://payment.direct.worldline-solutions.com/v2/MERCHANT_ID/hostedcheckouts
Bei Verwendung unserer Server SDKs steuert Ihre Anwendung automatisch die entsprechende Umgebungs-/Integrationsmodus-URL über Objektinstanzen von CommunicatorConfiguration / IClient / CreateHostedCheckoutRequest an. Detaillierte Informationen darüber, wie Sie dies erreichen können, finden Sie im nächsten Kapitel.Dieses enthält auch vollständige Codebeispiele.
Create Hosted Checkout session
Send your customers to our secure payment page to enter the card details. To do so, you need a redirection URL to our Hosted Checkout Page. Get this URL by sending a CreateHostedCheckout request to our platform.
A CreateHostedCheckout session is valid for three hours. Make sure to execute the subsequent steps within this period.
Redirect customer to Hosted Checkout Page
Our platform sends a response in the instance of CreateHostedCheckoutResponse you created upon your request. Use the redirectUrl property to redirect your customers to our Hosted Checkout Page.
// Properties of createHostedCheckoutResponse
{
"RETURNMAC": "12345678-90ab-cdef-1234-567890abcdef",
"hostedCheckoutId": "123456",
"merchantReference": "7e21badb48fe45848bbc1efef2a88504",
"partialRedirectUrl": "preprod.direct.worldline-solutions.com/hostedcheckout/PaymentMethods/Selection/e61340e579e04172a740676ffdda162e"
"redirectUrl": "https://payment.preprod.direct.worldline-solutions.com/hostedcheckout/PaymentMethods/Selection/e61340e579e04172a740676ffdda162e"
}
- If you are loading the partialRedirectUrl/redirectUrl inside a WebView, embedded in your mobile application, make sure to initialise the option settings.setDomStorageEnabled(true); when creating the WebView. This will avoid issues with the redirection.
- The redirectUrl is valid for three hours. Make sure to redirect your customers within this period.
- We strongly recommend not iframing the partialRedirectUrl/redirectUrl on your checkout page, as this can lead to undesired behaviour during the checkout process. If you prefer an <iframe>-based solution, our Hosted Tokenization Page is the ideal solution for you!
Get transaction result
Your customers enter their card details on the Hosted Checkout Page which we submit to your acquirer. We receive the transaction result which you can request via a GetHostedCheckoutStatus request. Use the hostedCheckoutId from the CreateHostedCheckoutResponse
Learn in our dedicated Status guide more about the properties from the response, their meaning and how to proceed appropriately depending on the transactions’s status.
- The hostedCheckoutId is valid for three hours during which you can send a GetHostedCheckoutStatus request.
- After that period, you can receive the result via webhooks or request the transaction status any time via a GetPaymentDetails request.
Show result & redirect customer to webshop
Once our platform has received the transaction result, we redirect your customers to your webshop. Define a hostedCheckoutSpecificInput.returnUrl in the initial CreateHostedCheckout request for this redirection. Display the transaction result you have received in the previous step on your returnUrl.
Flows
Find a full transaction flow involving every party and (optional) steps in this overview:
- Your customer goes to your check-out page and finalises the purchase.
- You send a CreateHostedCheckout request to our platform.
- Our platform returns a redirectionUrl.
- You redirect your customer to the redirectionUrl.
4'(optional). We perform a fraud prevention check. - We redirect the customer to her/his issuing bank for 3-D Secure authentication. The customer identifies herself/himself.
- Our platform receives the 3-D Secure authentication result from the issuer. Based on the result, two scenarios are possible:
a) If the identification was unsuccessful, we redirect your customers to your returnUrl , ending the flow. You request the transaction result as described in step 9.
b) If the identification was successful, the flow continues at step 8. - We process the transaction and receive the result from the acquirer.
- We redirect your customer to your returnUrl.
- You request the transaction result from our platform and display it on your returnUrl.
- If the transaction was successful, you can deliver the goods / service.
Unsere Hosted Checkout Page-Lösung bietet noch viel mehr Möglichkeiten. Erfahren Sie hier alles über die verfügbaren Funktionen.
Nutzen Sie ein Token für wiederkehrende Zahlungen
Direktkäufe sind eine großartige Möglichkeit, die Ihnen dabei helfen kann, die Zahlungserfahrung Ihrer Kunden zu verbessern und Ihre Konversionsrate zu erhöhen. Durch die Verwendung eines vorhandenen Tokens können Sie die Hosted Checkout Page für Ihre Kunden vorab ausfüllen:
Anpassen des Erscheinungsbilds der Zahlungsseite
Unsere Plattform ermöglicht es Ihnen, das Erscheinungsbild unserer Hosted Checkout Page zu einem großen Teil anzupassen. Das Anpassen der Zahlungsseite an Ihren Unternehmensauftritt regt Ihre Kunden zum Abschluss Ihrer Bestellung an, nachdem Sie sie auf die Hosted Checkout Page weitergeleitet haben.
- Unsere Hosted Checkout Page ist in verschiedenen Sprachen verfügbar. Weisen Sie Locale einen entsprechenden Wert zu, um die von Ihren Kunden bevorzugte Sprache anzuzeigen. Der Wert ist eine Kombination aus ISO 639-1- (Sprache) und ISO 3166-1-Code (Land):
createHostedCheckoutRequest.HostedCheckoutSpecificInput.locale = "en_EN";
Wir unterstützen die folgenden Sprachen:
Arabisch
Chinesisch
Dänisch
Deutsch
Englisch
Finnisch
Flämisch
Französisch
Griechisch
HebräischItalienisch
Japanisch
Katalanisch
Koreanisch
Lituauisch
Niederländisch
Norwegisch
Polnisch
Portugiesisch
RumänischPortuguese
Romanian
Russian
Simplified Chinese
Slovak
Slovenian
Spanish
Swedish
Turkish - Die Hosted Checkout Page lässt sich mit unserem Template Builder an Ihren Unternehmensauftritt anpassen. Es ist ein leistungsstarkes Tool mit unzähligen Möglichkeiten zum Optimieren der Zahlungserfahrung Ihrer Kunden. Steigern Sie Ihre Konversionsrate durch Anpassung unserer Tipps und Tricks.
Sobald Sie Ihre Vorlage(n) in Ihr Konto hochgeladen haben, sollten Sie Variant in Ihrer Anfrage den Dateinamen der Vorlage als Wert zuweisen:
createHostedCheckoutRequest.HostedCheckoutSpecificInput.Variant = "YourTemplate.html";
Customise template
We provide two distinct approaches for implementing a customised template:
Method 1: Create a customised template and upload it in the Back Office
Create a fully customised template from scratch using our powerful Template Builder. Alternatively, you can download and customise the necessary files directly from our GitHub repository. This approach offers a high degree of customisation but requires some technical skills to implement effectively.
Once you have created a template that matches your webshop's look and feel, upload it and all necessary .css / image files on our platform. To do so, follow these steps:
- Log in to the Back Office.
- Go to Configuration > Template > File Manager > Upload Template Files. Click on „File...” and select the .html (and if applicable, additional .css / image files).
- After a couple of minutes, our system will have validated the files (In “Uploaded Files”, they appear as “Validated” in column “Status”). They will then be ready to be used on the Hosted Checkout Page.
Method 2: Customise the Template in the Merchant Portal
While it offers lower flexibility compared to method 1, it does not require any technical skills. Refer to the dedicated chapter in our Merchant Portal guide to learn how to personalise your customers' payment experience with ease.
Our platform allows you to upload multiple template files. Use the one of your choice by populating property hostedCheckoutSpecificInput.variant
with the file name in the CreateHostedCheckout request.
Verfügbare Zahlungsmethoden vorauswählen
Um Ihre Kunden zum Abschluss ihrer Bestellung anzuregen, ist das Reduzieren der Zahlungsschritte wichtig. HostedCheckOutSpecificInput enthält Eigenschaften, mit denen Sie
- Den Zahlungsauswahlbildschirm überspringen und Ihre Kunden direkt zum Zahlungsformular für eine bestimmte Zahlungsart weiterleiten können. Dies gilt auch für Weiterleitungen zu einer dritten Partei (z. B. Paypal).
Alle unsere Zahlungsarten haben eine individuelle „Payment product id“. Diese finden Sie auf dem "Überblick"-Tab der jeweiligen Zahlungsmethode
Dieses Codebeispiel leitet Ihre Kunden direkt zum PayPal-Portal weiter, nachdem sie zur redirectURL/PartialRedirectUrl geleitet wurden:
- Erfahren Sie mehr über diese Eigenschaften und ihren akzeptierten Wertebereich in unserer API
- Stellen Sie Sicher, dass die Bezahlmethode, die Sie benutzen wollen, in Ihrem Test-/Livekonto aktiv ist. Überprüfen Sie dies im Back Office via Configuration > Payment methods
Zahlungsgruppen/Produkte auf dem Auswahlbildschirm für die Zahlungsart einschließen/ausschließen können. Verwenden Sie entweder eine Auswahl von "Payment Product Ids" oder vordefinierte Gruppen:
Kreditkarten zu einer Gruppe zusammenfassen
Mithilfe der Eigenschaft hostedCheckoutSpecificInput.cardPaymentMethodSpecificInput.groupCards=true lassen sich alle Kreditkarten-Zahlungsarten in einer Gruppe “Karten” auf der Hosted Checkout Page zusammenfassen.
Die Gruppierung kann zum übersichtlicheren Gestalten des Zahlungsauswahlbildschirms praktisch sein.
Alle Ihrer aktiven Kartenzahlungsarten in Ihrem Konto sind in dieser Gruppe enthalten. Sobald Ihre Kunden die Option “Karten” auswählen, leiten wir sie auf die Zahlungsmaske zur Eingabe der Kartennummer weiter
Unsere Plattform erkennt das Kartensystem automatisch, sobald Ihre Kunden beginnen, die Nummer einzugeben. Dies gilt auch für co-badged-Karten (wo dies relevant is)
Wenn Ihre Kunden eine Nummer aus einem beliebigen Kartensystem eingeben, das nicht in Ihrem Back Office verfügbar ist, wird in der Zahlungsmaske "Card number incorrect or incompatible" angezeigt.
Daher raten wir Ihnen dringend, Ihre Kunden in Ihrer Webshop-Umgebung über alle verfügbaren Kartenzahlungsarten zu informieren, bevor Sie Ihre Kunden auf die Hosted Checkout Page weiterleiten.
Control number of payment attempts
Property hostedCheckoutSpecificInput.allowedNumberOfPaymentAttempts allows you to limit the number of retry attempts to pay for your customers’ orders.
This will help
- Mitigating fraud (as fraudsters will try different card numbers and/or payment methods).
- Reducing your transaction costs (as Direct and/or your acquirer might charge you for each retry, depending on your contract).
To do so, add this property to a standard CreateHostedCheckout request with a value between 1 and 10. After every unsuccessful payment attempt (i.e. because of a declined authorisation or a failed 3-D Secure check), we redirect your customers to our intermediate status page. If there are still retries left, it will display a "Retry" button, allowing the customers to try another card and/or payment method (depending on your pre-selection of available payment methods). If the last retry is unsuccessful, our intermediate status page will say "You have reached the maximum number of attempts". Our platform will then redirect your customers to your returnURL.
- If you leave out
allowedNumberOfPaymentAttempts
in your request, our platform grants 10 retries. - Find detailed information about this property in our API Reference.