PAYONE Documentation Platform

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="author" content="PAYONE"> <title>PAYONE Documentation Platform | Startpage </title> <meta name="description" content="Documentation of PAYONE API"> <link rel="icon" href="https://docs.payone.com/bl-themes/payone-docs/img/favicon.ico" type="image/png"> <link rel="stylesheet" type="text/css" href="https://docs.payone.com/bl-themes/payone-docs/css/font-line-aw-1.3.0/css/line-awesome.min.css?version=3.15.0">  <link rel="stylesheet" type="text/css" href="https://docs.payone.com/bl-themes/payone-docs/css/bulma.min.css?version=3.15.0"> <link rel="stylesheet" type="text/css" href="https://docs.payone.com/bl-themes/payone-docs/css/bulma-tooltip.min.css?version=3.15.0"> <link rel="stylesheet" type="text/css" href="https://docs.payone.com/bl-themes/payone-docs/css/bulma.overrides.css?version=3.15.0"> <link rel="stylesheet" type="text/css" href="https://docs.payone.com/bl-themes/payone-docs/css/payone.icons.css?version=3.15.0"> <link rel="stylesheet" type="text/css" href="https://docs.payone.com/bl-themes/payone-docs/css/payone.misc.css?version=3.15.0">  <link rel="stylesheet" type="text/css" href="https://docs.payone.com/bl-themes/payone-docs/css/highlight.github.min.css?version=3.15.0">  <link rel="stylesheet" type="text/css" href="https://docs.payone.com/bl-themes/payone-docs/php/api/api-template.css?version=3.15.0">  <link rel="canonical" href="https://docs.payone.com/startpage"/>  </head> <body>  <div class="site_container" id="payone-sitecontainer">  <div id="navbardiv_on_index"> <nav class="navbar" role="navigation" aria-label="main navigation"> <div class="navbar-brand"> <a class="navbar-item" href="https://docs.payone.com"> <img src="/bl-themes/payone-docs/img/logo.svg" width="150" height="44" class="mt-3 mb-3"> </a> <a role="button" class="navbar-burger" data-target="navbarMenuContent" aria-label="menu" aria-expanded="false"> <span aria-hidden="true"></span> <span aria-hidden="true"></span> <span aria-hidden="true"></span> </a> </div> <div id="static top right sight" class="navbar-menu" style="display: block !important;"> <div class="navbar-end"> <div class="navbar-item"><div class="field has-addons"><div class="control"><input type="hidden" id="jspluginPayoneSearchMinChars" value="3" readonly><span id="jspluginPayoneSearchTextTooltip"><input type="text" class="input is-primary" id="jspluginPayoneSearchText" /> </span></div><div class="control"><button id="jspluginPayoneSearchButton" class="button is-primary" onClick="pluginPayoneSearch()" ><i class="payone-icon-tiny payone-white-search"></i></button></div></div></div><script> function openMinCharsMessage() { const tooltip = document.getElementById("jspluginPayoneSearchTextTooltip"); const minChars = document.getElementById("jspluginPayoneSearchMinChars").value; const message = 'Please enter at least ' + minChars + ' characters!'; tooltip.dataset.tooltip = message; tooltip.classList.add( 'has-tooltip-left', 'has-tooltip-arrow', 'has-tooltip-primary', 'has-tooltip-active' ); } function pluginPayoneSearch() { const text = document.getElementById("jspluginPayoneSearchText").value; const minChars = document.getElementById("jspluginPayoneSearchMinChars").value; const valid = (text.length >= minChars); if (!valid) { openMinCharsMessage(); return false; } window.open('https://docs.payone.com/'+'search/'+text, '_self'); return true; } document.getElementById("jspluginPayoneSearchText").onkeypress = function(e) { if (!e) e = window.event; var keyCode = e.keyCode || e.which; if (keyCode == '13'){ pluginPayoneSearch(); return false; } } </script> <div id="login" class="navbar-item"> <div class="buttons"> <a class="btn btn-outline-primary" type="button" href="https://login.pay1.de/"> Login PMI </a> </div> </div>  </div> </div> </nav> <nav class="navbar payone-hide-navbar-mobile"> <div id="navbarMenuContent" class="navbar-menu box"> <div class="navbar-start"> <a class="navbar-item" href="/pcp/payone-commerce-platform"> PAYONE Commerce Platform </a> <a class="navbar-item" href="/payment-methods/"> Payment Methods </a> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link" href="/integration"> Integration </a> <div class="navbar-dropdown"> <a class="navbar-item" href="/integration/plugins"> Plugins </a> <hr class="navbar-divider"> <a class="navbar-item" href="/integration/channel-server-api"> Server API </a> <hr class="navbar-divider"> <a class="navbar-item" href="/integration/channel-client-api"> Client API </a> <hr class="navbar-divider"> <a class="navbar-item" href="/integration/channel-payone-link"> Channel PAYONE Link </a> <hr class="navbar-divider"> <a class="navbar-item" href="/integration/channel-frontend"> Channel Frontend </a> <hr class="navbar-divider"> <a class="navbar-item" href="/integration/response-handling"> Response Handling </a> <hr class="navbar-divider"> <a class="navbar-item" href="/integration/testdata"> Testdata </a> </div> </div> <a class="navbar-item" href="/advanced-features"> Advanced Features </a> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link"> Security & Risk Management </a> <div class="navbar-dropdown"> <a class="navbar-item" href="/security-risk-management/3d-secure"> 3DS </a> <hr class="navbar-divider"> <a class="navbar-item" href="/security-risk-management/fraudprevention"> Fraud </a> <hr class="navbar-divider"> <a class="navbar-item" href="/security-risk-management/consumerscore"> Consumer score </a> </div> </div> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link"> Information </a> <div class="navbar-dropdown"> <a class="navbar-item" href="/information/general-information"> General information </a> <hr class="navbar-divider"> <a class="navbar-item" href="/information/platform-codes"> Platform codes </a> <hr class="navbar-divider"> <a class="navbar-item" href="/information/payone-merchant-interface"> PAYONE Merchant Interface (PMI) </a> <hr class="navbar-divider"> <a class="navbar-item" href="/information/sequence-diagrams"> Sequence diagrams </a> <hr class="navbar-divider"> <a class="navbar-item" href="/information/privacy-policy"> Privacy Policy </a> <hr class="navbar-divider"> <a class="navbar-item" href="https://www.payone.com/DE-de/service/kontakt" target="_blank"> Contact (DE) </a> <hr class="navbar-divider"> <a class="navbar-item" href="https://www.payone.com/DE-de/service/feedback-beschwerde" target="_blank"> Report an issue (DE) </a> </div> </div> </div> </div> </nav> </div> <div class="payone-breadcrumbs"> <nav class="breadcrumb has-arrow-separator is-small" aria-label="breadcrumbs"> <ul>  </ul> </nav> </div> <div class="docs-container is-flex">  <section class="section_startpage"> <div class="column is-12 mb-3 payone-sitedivs"> <div style="display: flex; flex-direction: column; align-items: center; margin-bottom: 200px;"><video autoplay="autoplay" muted="muted" loop="loop"> <source src="https://docs.payone.com/bl-content/uploads/PAYONE_Docs_05.mp4" type="video/mp4"> Your browser does not support the video tag. </video> <h1 style="text-align: center; margin-top: 70px;">ONLINE PAYMENTS DESIGNED FOR BUSINESS GROWTH</h1> <div class="is-align-self-center" style="width: 75%;"> <p class="mb-6 p-large" style="text-align: center;">PAYONE enables businesses of all sizes to scale their eCommerce offering. Embrace customer habits by accessing new channels, customise your payment pages to your brand, accept a wide range of payment methods and protect your business with real-time fraud tools. We鈥檙e here to make it easy for you to grow your online business!</p> </div> <div><a class="btn btn-primary has-text-white" target="_blank" href="https://www.payone.com/DE-de/formulare/enterprise" rel="noopener"> Contact our Sales Team </a></div> </div> <div class="payone-white-content-section mt-6 white-section-startpage"> <table border="0" style="border-collapse: collapse; border-style: hidden;"> <tbody> <tr> <td style="width: 45.5324%; padding: 10px; text-align: center; vertical-align: top;"><img class="img-start" src="https://docs.payone.com/bl-content/uploads/pages/a9c04041f9da1cf0111cad1a31e00a6e/iStock-1190969143.jpg" alt="" width="389" height="259"></td> <td style="width: 54.4676%;"> <h2 class="h2Header-startpage">Everything to grow.</h2> <p class="mb-6 p-large">Whether your customers prefer to pay with credit cards, online bank transfer or digital wallets we've got you covered. Our platform supports a wide range of payment methods, including Visa, Mastercard, American Express, PayPal, Alipay+, and many more. By offering multiple payment methods, you can make it easy for your customers to pay in a way that's convenient and familiar to them, increasing the likelihood of completing a purchase and driving sales for your business.</p> <div class="payment-logos-container"> <div><img src="https://media3.payone.com/f/64176/2560x644/0448159fe9/alipay_logo.png" alt="Alipay" width="80px"></div> <div><img src="https://media3.payone.com/f/64176/1024x197/b1d9062f16/amazon_pay_logo.png" alt="Amazonpay" width="86" height="16"></div> <div><img src="https://docs.direct.worldline-solutions.com/dA/59aa146c02/smallImage/pp_logo_302_v1.png?language_id=1" alt="Apple Pay" width="80" height="56"></div> <div><img src="https://docs.payone.com/bl-themes/payone-docs/img/logos/american_express_logo.png" alt="Apple Pay" width="56" height="56"></div> <div><img src="https://docs.payone.com/bl-themes/payone-docs/img/logos/mastercard_logo.png" alt="Apple Pay" width="54" height="33"></div> <div><img src="https://docs.payone.com/bl-themes/payone-docs/img/logos/visa_logo.png" alt="Apple Pay" width="61" height="20"></div> <div><img src="https://media3.payone.com/f/64176/980x364/68a2eb2754/giropay.png" alt="giropay" width="80px"></div> <div><img src="https://media3.payone.com/f/64176/1040x1040/3286fb31b0/ideal_logo.png" alt="iDEAL" width="57" height="57"></div> <div><img src="https://docs.payone.com/bl-themes/payone-docs/img/logos/Klarna_logo.svg" alt="Klarna" width="80px"></div> <div><img src="https://docs.payone.com/bl-themes/payone-docs/img/icons/payone/payment/Lastschrift.svg" alt="PDD" width="57" height="57"></div> <div><img src="https://docs.payone.com/bl-content/uploads/pages/a774f2716fae320759ddec334bbdc20f/de-pp-logo-200px.png" alt="paypal" width="80"></div> <div><img src="https://media3.payone.com/f/64176/2560x729/bc1f84c4ec/postfinance_logo.png" alt="pstfinance" width="80"></div> <div><img src="https://media3.payone.com/f/64176/900x500/43648f2cb7/przelewy24_logo.png" alt="P24" width="80" height="44"></div> <div><img src="https://docs.payone.com/bl-themes/payone-docs/img/logos/sofortueberweisunglogo.svg" alt="Visa" width="80" height="30"></div> <div><img src="https://media3.payone.com/f/64176/820x251/83ab7f28bd/wechat_pay_logo.png" alt="WeChat Pay" width="80" height="24"></div> </div> </td> </tr> </tbody> </table> <div class="mt-5" style="text-align: center;"><a class="btn btn btn-outline-primary" target="_blank" href="https://docs.payone.com/payment-methods" rel="noopener"> Browse all payment methods </a></div> </div> <div class="payone-white-content-section mt-6 white-section-startpage"> <table border="1" style="border-collapse: collapse; width: 100%; border-style: hidden;"> <tbody> <tr> <td style="width: 75%; border-style: hidden; padding-right: 70px;"> <h2 class="h2Header-startpage">All it takes is a few minutes.</h2> <p class="mb-6 p-large">We're constantly optimising our solutions to provide you with rapid integration and efficient checkout pages. Whether you choose to integrate via shopping cart <a href="https://docs.payone.com/integration/plugins" target="_blank" rel="noopener"><strong>plugins</strong></a>,聽via <a href="https://docs.payone.com/integration/channel-server-api" target="_blank" rel="noopener"><strong>API</strong></a> or <a href="https://docs.payone.com/integration/channel-payone-link" target="_blank" rel="noopener"><strong>Payment Link</strong></a>, get your eCommerce business up and running swiftly.</p> </td> <td style="width: 25%; vertical-align: middle;"> <div class="payment-logos-container"> <div><img src="https://docs.payone.com/bl-themes/payone-docs/img/logos/shops/Magento_Logo2.svg" alt="Magento"></div> <div><img src="https://docs.payone.com/bl-themes/payone-docs/img/logos/shops/shopware_logo.svg" alt="shopware"></div> <div><img src="https://docs.payone.com/bl-themes/payone-docs/img/logos/shops/oxid-esales-logo.png" alt="oxid"></div> <div><img src="https://docs.payone.com/bl-themes/payone-docs/img/logos/shops/woocommerce.svg" alt="Woo"></div> <div><img src="https://docs.payone.com/bl-themes/payone-docs/img/logos/shops/jtl.svg" alt="jtl"></div> <div><img src="https://docs.payone.com/bl-themes/payone-docs/img/logos/shops/SAP.svg" alt="SAP"></div> </div> </td> </tr> </tbody> </table> <div class="mt-5" style="text-align: center;"><a class="btn btn-outline-primary" href="https://docs.payone.com/integration" target="_blank" rel="noopener"> Check how to integrate</a></div> </div> <div class="payone-white-content-section mt-6 white-section-startpage" style="text-align: center;"> <h2 class="h2Header-startpage" style="text-align: center;">CASHLESS</h2> <h2 class="h2Header-startpage" style="color: #575665;">ANYTIME AND ANYWHERE</h2> 聽 <p class="p-large" style="text-align: center;">Modern consumers buy anywhere, anytime. They move between the Worlds seamlessly: 'online' and 'offline' are increasingly merging, rigid boundaries between channels dissolve.<br>With PAYONE Omnichannel your customers are able to pay at all touchpoints!</p> <p class="p-large" style="text-align: center;">Offer your customers flexible shopping experiences!</p> <p></p> <p><img src="https://docs.payone.com/bl-content/uploads/pages/8a801078aef0b844e3f3cea246c25e81/omnichannel2.png" alt="" width="627" height="367" style="display: block; margin-left: auto; margin-right: auto;"></p> <div style="text-align: center;"><a class="btn btn-outline-primary mt-6" target="_blank" href="https://docs.payone.com/pcp/payone-commerce-platform" rel="noopener"> Tryout out Omnichannel Solution</a></div> </div> <div class="payone-white-content-section mt-6 white-section-startpage"> <h2 class="h2Header-startpage" style="text-align: center;">Save time.</h2> <h2 class="h2Header-startpage" style="color: #575665; text-align: center;">Every single day.</h2> <p></p> <table border="1" style="border-collapse: collapse; width: 100%; border-style: hidden;"> <tbody> <tr> <td style="width: 45.5324%; text-align: center; vertical-align: middle; padding: 10px;"><img src="https://docs.payone.com/bl-content/uploads/pages/a9c04041f9da1cf0111cad1a31e00a6e/iStock-1182777182.jpg" alt="" width="389" height="259" style="float: left; border-radius: 16px;"></td> <td style="width: 60%; border-style: hidden;"> <p class="p-large">Make the most of our built-in tools and <strong>value-added services</strong>, so that nothing holds you back from running your business smoothly. Access insights into your transactions and settlements, perform refunds and monitor your performance with our intuitive and responsive <a href="https://login.pay1.de/" target="_blank" rel="noopener">Merchant Portal</a>. Explore our Template Builder for the PAYONE payment link to customise your payment pages to your brand and eplore more features.</p> </td> </tr> </tbody> </table> <p></p> <div class="mt-5" style="text-align: center;"><a class="btn btn-outline-primary" target="_blank" href="https://login.pay1.de/" rel="noopener">Login / Sign Up PMI</a></div> </div> <div class="payone-white-content-section mt-6 white-section-startpage" style="text-align: center;"> <h2 class="h2Header-startpage" style="text-align: center;">Rely on our experts.</h2> <table border="0" style="border-collapse: collapse; width: 104.534%; border-style: hidden; margin-left: auto; margin-right: auto;"> <tbody> <tr> <td style="width: 20%;">聽<i class="payone-icon-very-large payone-blue-handshake"></i>聽</td> <td style="width: 80%;"> <p class="mb-2 p-large">We鈥檙e here for you. Whether you鈥檙e already a client or you鈥檇 like to become one, feel free to reach out to our experts.</p> </td> </tr> </tbody> </table> <a class="btn btn-outline-primary mt-6" target="_blank" href="https://www.payone.com/DE-de/angebote/anfrageformular?sfcampaign_ID=70168000000Pt77AAC" rel="noopener"> Arrange a Consultation</a></div> </div> </section>  <script src="https://docs.payone.com/bl-kernel/js/jquery.min.js?version=3.15.0"></script> <script src="https://docs.payone.com/bl-themes/payone-docs/js/highlight.min.js?version=3.15.0"></script> <script src="https://docs.payone.com/bl-themes/payone-docs/js/jquery-resizable.js?version=3.15.0"></script> <script src="https://docs.payone.com/bl-themes/payone-docs/js/payone.misc.js?version=3.15.0"></script> <script src="https://docs.payone.com/bl-themes/payone-docs/php/api/jquery.json-editor.min.js?version=3.15.0"></script> <script src="https://docs.payone.com/bl-themes/payone-docs/php/api/stickyNavigator.js?version=3.15.0"></script> <script src="https://docs.payone.com/bl-themes/payone-docs/php/api/autosize.js?version=3.15.0"></script> <script> hljs.initHighlighting(); </script> <script> autosize(document.querySelectorAll('.codetext')); </script> <script> $(function() { /***************************************** PHP generated Sidebar Add Active Navigation Class Based on URL *****************************************/ const browserPath = (location.pathname).slice(1); $('ul.tree li a').each(function(){ var $this = $(this); // We need to extract path from anchor href, so we can do exact comparision const checkLink = $this.attr('href'); const extractedPathWithDomain = checkLink.replace(/http(s)?(:)?(\/\/)?|(\/\/)/g, ''); const pathParts = extractedPathWithDomain.split('/'); pathParts.shift(); const extractedPath = pathParts.join('/'); if(browserPath === extractedPath) { $this.parent().addClass('is-active'); $this.parent().children('ul').show() } // for localhost only // or (window.location.hostname === "localhost" && window.location.pathname==="/bludit/") if (window.location.pathname==="/bludit-commercetools/") { $this.parent().removeClass('is-active'); } }); /************************ Sidebar SVG icon ************************/ jQuery('.svgCl').each(function(){ jQuery(this).css({'height': $(this).closest('ul').height($(this).height() + 5) + 'px'}); jQuery(this).css({'display': 'inline-block'}); }); /************************ Sidebar Nav items toggle open/close ************************/ $( 'ul.tree li' ).each( function() { if($(this).children('ul').length > 0) { $(this).addClass('parentLi'); $('li.parentLi > a').attr('href'); } if ($(this).find('ul > li').hasClass('is-active')) { $(this).addClass('activated'); $(this).children('ul').show(); // ul > display:none is hardcoded in sidebar.php } }); $( 'ul.tree li > ul > li' ).each( function() { $(this).addClass('parentLi'); if ($(this).hasClass('is-active')) { $(this).addClass('activated'); } }); }); // doc ready </script> <script> /************************ Copy to clipboard ************************/ function copyToClipboard(text) { var aux = document.createElement("input"); aux.setAttribute("value", text); document.body.appendChild(aux); aux.select(); document.execCommand("copy"); document.body.removeChild(aux); } function copyToClipboardAsFormatted(text) { navigator.clipboard.writeText(text); } function stripHtml(inputHtml) { const brToNewline = inputHtml.replace(/<br\s*[\/]?>/gi, "\n"); const content = brToNewline.replace(/<\/?[^>]+(>|$)/g, ""); return content; } $(function() { $( ".payone-copy-text" ).on( "click", function() { const currentCopyBtn = $(this); let parentNode = currentCopyBtn.closest('div.divcopybtn'); let payloadbox; if (parentNode.length > 0) { payloadbox = parentNode.next('div.payloadbox'); } else { parentNode = currentCopyBtn.closest('div.samplebox'); parentNode = parentNode.children('table'); parentNode = parentNode.children('tbody'); parentNode = parentNode.children('tr'); payloadbox = parentNode.children('td'); } if (payloadbox.length == 0) { return; } const preNode = payloadbox.children('pre'); const htmlContent = preNode.html(); const content = stripHtml(htmlContent); copyToClipboardAsFormatted(content); }); }); $(function() { $("h2").click(function() { var id = $(this).attr("id"); var permalink = "https://docs.payone.com/startpage"; var link = permalink+"#"+id; copyToClipboard(link); }); }); // doc ready </script> <script> /************************ Sticky navbar ************************/ // Declare the function first var myFunction; // When the user scrolls the page, assign myFunction window.onscroll = function() { if (typeof myFunction === "function") { myFunction(); } }; // Get the navbar var navbar = document.getElementById("subnavbar"); // Check if the navbar exists if (navbar) { // Get the offset position of the navbar var sticky = navbar.offsetTop; // Define the function myFunction = function() { if (window.scrollY >= sticky) { navbar.classList.add("sticky"); } else { navbar.classList.remove("sticky"); } }; } </script> <script src="https://docs.payone.com/bl-themes/payone-docs/php/api/api-template.js?version=3.15.0"></script>  </div> </div> <div class="site_footer" id="footcontainer"> <footer class="footer site-footer">  <div class="container">  <div class="footer-column"> <h3 class="h3Footer">PAYONE</h3> <ul> <li><a href="https://www.payone.com/DE-de/agb">Terms and Conditions</a></li> <li><a href="https://www.payone.com/DE-de/impressum">Legal Notice</a></li> <li><a href="/information/privacy-policy">Privacy Policy</a></li> <li><a href="https://www.payone.com/DE-de/ueber-uns/presse">Press</a></li> </ul> </div>  <div class="footer-column"> <h3 class="h3Footer">Service</h3> <ul> <li><a href="https://www.payone.com/DE-de/service/kundenportale">Customer Portals</a></li> <li><a href="https://www.payone.com/DE-de/ueber-uns/partner">Partner</a></li> <li><a href="https://github.com/PAYONE-GmbH">Github</a></li> <li><a href="https://www.payone.com/DE-de/service/downloads">Downloads</a></li> <li><a href="https://www.payone.com/DE-de/service/kontakt">Contact</a></li> <li><a href="https://www.payone.com/DE-de/service/feedback-beschwerde">Feedback</a></li> </ul> </div>  <div class="footer-column"> </div>  <div class="footer-column-social">  <div class="social-links" style="width: 100%;justify-content: space-evenly;"> <p> <a href="https://www.instagram.com/payone_gmbh/" style="padding: 5px;"> <i class="payone-icon-medium payone-black-instagram"></i></a> <a href="https://www.linkedin.com/company/payone_gmbh" style="padding: 5px;"> <i class="payone-icon-medium payone-black-linkedin"></i></a> <a href="https://www.facebook.com/PAYONEGmbH/"><i class="payone-icon-medium payone-black-facebook"></i></a> <a href="https://github.com/PAYONE-GmbH/" style="padding: 5px;"> <i class="payone-icon-medium payone-black-github"></i></a> <a href="https://www.youtube.com/channel/UCM7Eky84PKzkyTILI6xga-Q" style="padding: 5px;"> <i class="payone-icon-medium payone-black-youtube"></i></a> </p> </div> </div> <div class="footer-column-copyright">  <div class="footer-powered-copyright"> <p ><span style="font-size:13px;">© PAYONE GmbH, Powered by <a target="_blank" class="text-white" href="https://www.bludit.com">Bludit</a></span></p> </div> </div> <div class="footer-column-worldline">  <div class="logo-text"> <img src="//media3.payone.com/f/64176/4200x387/933f1413c4/payone_worldline_endorsement_dunkelgrau.png" alt="" style="max-width:200px;"> </div> </div> </div> </footer> </div> <button id="backToTopBtn" title="Go to page start"></button> </body> </html>

CINXE.COM

PAYONE Documentation Platform | Startpage