CINXE.COM

<!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 | Server API - Preauthorization </title> <meta name="description" content=""> <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/integration/channel-server-api/server-api-preauthorization"/>  </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> <button id="mobileSubmenu" title="Open submenu"></button> </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> <li class=""><a href="/integration">Integration</a></li><li class=""><a href="/integration/channel-server-api">Channel-Server-API</a></li><li class="is-active"><a href="/integration/channel-server-api/server-api-preauthorization">Server API - Preauthorization</a></li> </ul> </nav> </div> <div class="docs-container is-flex"> <aside id="aside" class="column is-2 is-narrow-mobile is-fullheight is-hidden-touch"><ul class="tree"><li><a target="_self" href="https://docs.payone.com/integration">Integration</a><ul style="display:none"><li><a target="_self" href="https://docs.payone.com/integration/plugins">Plugins</a><ul style="display:none"><li><a target="_self" href="https://docs.payone.com/integration/plugins/integration-guide-shopware-6">Integration Guide Shopware 6 </a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/shopware-6-integrationsanleitung">Integrationsanleitung Shopware 6 </a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integration-guide-magento-2">Integration Guide Magento 2</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integrationsanleitung-magento-2">Integrationsanleitung Magento 2</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integration-guide-shopware-5">Integration Guide Shopware 5</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integrationsanleitung-shopware-5">Integrationsanleitung Shopware 5</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integration-guide-woocommerce">Integration Guide WooCommerce</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integrationsanleitung-woocommerce">Integrationsanleitung WooCommerce</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integrationsanleitung-oxid-6">Integrationsanleitung Oxid 6</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integration-guide-oxid-6">Integration Guide Oxid 6</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integrationsanleitung-oxid-7">Integrationsanleitung Oxid 7</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integration-guide-oxid-7">Integration Guide Oxid 7</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/installationsanleitung-magento-1">Installationsanleitung Magento 1</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integration-guide-magento-1">Integration Guide Magento 1</a></li></ul></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api">Channel-Server-API</a><ul style="display:none"><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-preauthorization">Server API - Preauthorization</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-authorization">Server API - Authorization</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-capture">Server API - Capture</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-refund">Server API - Refund</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-debit">Server API - Debit</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-managemandate">Server API - Managemandate</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-getinvoice">Server API - Getinvoice</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-getfile">Server API - Getfile</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-vauthorizatuion">Server API - Vauthorization</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-creditcardcheck">Server API - Creditcardcheck</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-getuser">Server API - Getuser</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-updateuser">Server API - Updateuser</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-3dscheck">Server API - 3dscheck</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-bankaccountcheck">Server API - Bankaccountcheck</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-addresscheck">Server API - Addresscheck</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-createaccess">Server API - Createaccess</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-updateaccess">Server API - Updateaccess</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-updatereminder">Server API - Updatereminder</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-general-definitions">Server API - General Interface Definitions</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-checkout-demo-app">Server API - checkout demo app</a></li></ul></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api">Channel-Client-API</a><ul style="display:none"><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-preauthorization">Client API - Preauthorization</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-bankaccountcheck">Client API - Bankaccountcheck</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-creditcardcheck">Client API - Creditcardcheck</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-managemandate">Client API - Managemandate</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-general-interface-definitions">Client API - General Interface Definitions</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-createaccess">Client API - Createaccess</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-vauthorization">Client API - Vauthorization</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-authorization">Client API - Authorization</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-ajax-mode">Client API - AJAX-Mode</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-redirect-mode">Client API - Redirect-Mode</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-addresscheck">Client API - Addresscheck</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-hosted-iframe-mode">Client API - Hosted iFrame Mode </a><ul style="display:none"><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-hosted-iframe-mode/hosted-iframe-examples">Hosted Iframe Examples</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-hosted-iframe-mode/client-api-additional-tips">Client API - Additional Tips</a></li></ul></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/calculation-of-the-hash-value">Client API - Calculation of the HASH value</a></li></ul></li><li><a target="_self" href="https://docs.payone.com/integration/channel-payone-link">PAYONE Link</a><ul style="display:none"><li><a target="_blank" href="https://docs.payone.com/integration/channel-payone-link/payone-link-api?fullwidth=1">PAYONE Link - API</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-payone-link/payone-link-notification-api">PAYONE Link - Notification-API</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-payone-link/how-to-verify-notifications">PAYONE Link - How to Verify Notifications</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-payone-link/payone-link-authorization">PAYONE Link - Authorization + Linkstatus</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-payone-link/payone-link-complete-bash-example">PAYONE Link - Complete Bash Example + HMAC SHA256 Examples</a></li></ul></li><li><a target="_self" href="https://docs.payone.com/integration/channel-frontend">Channel-Frontend</a><ul style="display:none"><li><a target="_self" href="https://docs.payone.com/integration/channel-frontend/frontend-available-payment-types">Frontend - Available payment types</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-frontend/payment-portals-access-shop">Payment portals (Access - Shop Versions)</a></li></ul></li><li><a target="_self" href="https://docs.payone.com/integration/response-handling">Response Handling</a><ul style="display:none"><li><a target="_self" href="https://docs.payone.com/integration/response-handling/transactionstatus-notification"> Transactionstatus Notifications - Samples and Responses</a></li><li><a target="_self" href="https://docs.payone.com/integration/response-handling/json-responses">JSON-Responses</a></li><li><a target="_self" href="https://docs.payone.com/integration/response-handling/json-examples">JSON Examples</a></li></ul></li><li><a target="_self" href="https://docs.payone.com/integration/testdata">Testdata</a></li></ul></li></ul></aside> <div id="payone-modal-submenu" class="modal"> <div class="modal-background"></div> <div class="modal-card"> <header class="modal-card-head"> <p class="modal-card-title"> Integration </p> <button class="delete payone-primary-background" aria-label="close"></button> </header> <section class="modal-card-body"> <ul class="tree"> <li><a target="_self" href="https://docs.payone.com/integration">Integration</a><ul style="display:none"><li><a target="_self" href="https://docs.payone.com/integration/plugins">Plugins</a><ul style="display:none"><li><a target="_self" href="https://docs.payone.com/integration/plugins/integration-guide-shopware-6">Integration Guide Shopware 6 </a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/shopware-6-integrationsanleitung">Integrationsanleitung Shopware 6 </a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integration-guide-magento-2">Integration Guide Magento 2</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integrationsanleitung-magento-2">Integrationsanleitung Magento 2</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integration-guide-shopware-5">Integration Guide Shopware 5</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integrationsanleitung-shopware-5">Integrationsanleitung Shopware 5</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integration-guide-woocommerce">Integration Guide WooCommerce</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integrationsanleitung-woocommerce">Integrationsanleitung WooCommerce</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integrationsanleitung-oxid-6">Integrationsanleitung Oxid 6</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integration-guide-oxid-6">Integration Guide Oxid 6</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integrationsanleitung-oxid-7">Integrationsanleitung Oxid 7</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integration-guide-oxid-7">Integration Guide Oxid 7</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/installationsanleitung-magento-1">Installationsanleitung Magento 1</a></li><li><a target="_self" href="https://docs.payone.com/integration/plugins/integration-guide-magento-1">Integration Guide Magento 1</a></li></ul></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api">Channel-Server-API</a><ul style="display:none"><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-preauthorization">Server API - Preauthorization</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-authorization">Server API - Authorization</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-capture">Server API - Capture</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-refund">Server API - Refund</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-debit">Server API - Debit</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-managemandate">Server API - Managemandate</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-getinvoice">Server API - Getinvoice</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-getfile">Server API - Getfile</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-vauthorizatuion">Server API - Vauthorization</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-creditcardcheck">Server API - Creditcardcheck</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-getuser">Server API - Getuser</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-updateuser">Server API - Updateuser</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-3dscheck">Server API - 3dscheck</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-bankaccountcheck">Server API - Bankaccountcheck</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-addresscheck">Server API - Addresscheck</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-createaccess">Server API - Createaccess</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-updateaccess">Server API - Updateaccess</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-updatereminder">Server API - Updatereminder</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-general-definitions">Server API - General Interface Definitions</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-server-api/server-api-checkout-demo-app">Server API - checkout demo app</a></li></ul></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api">Channel-Client-API</a><ul style="display:none"><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-preauthorization">Client API - Preauthorization</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-bankaccountcheck">Client API - Bankaccountcheck</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-creditcardcheck">Client API - Creditcardcheck</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-managemandate">Client API - Managemandate</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-general-interface-definitions">Client API - General Interface Definitions</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-createaccess">Client API - Createaccess</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-vauthorization">Client API - Vauthorization</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-authorization">Client API - Authorization</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-ajax-mode">Client API - AJAX-Mode</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-redirect-mode">Client API - Redirect-Mode</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-addresscheck">Client API - Addresscheck</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-hosted-iframe-mode">Client API - Hosted iFrame Mode </a><ul style="display:none"><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-hosted-iframe-mode/hosted-iframe-examples">Hosted Iframe Examples</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/client-api-hosted-iframe-mode/client-api-additional-tips">Client API - Additional Tips</a></li></ul></li><li><a target="_self" href="https://docs.payone.com/integration/channel-client-api/calculation-of-the-hash-value">Client API - Calculation of the HASH value</a></li></ul></li><li><a target="_self" href="https://docs.payone.com/integration/channel-payone-link">PAYONE Link</a><ul style="display:none"><li><a target="_blank" href="https://docs.payone.com/integration/channel-payone-link/payone-link-api?fullwidth=1">PAYONE Link - API</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-payone-link/payone-link-notification-api">PAYONE Link - Notification-API</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-payone-link/how-to-verify-notifications">PAYONE Link - How to Verify Notifications</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-payone-link/payone-link-authorization">PAYONE Link - Authorization + Linkstatus</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-payone-link/payone-link-complete-bash-example">PAYONE Link - Complete Bash Example + HMAC SHA256 Examples</a></li></ul></li><li><a target="_self" href="https://docs.payone.com/integration/channel-frontend">Channel-Frontend</a><ul style="display:none"><li><a target="_self" href="https://docs.payone.com/integration/channel-frontend/frontend-available-payment-types">Frontend - Available payment types</a></li><li><a target="_self" href="https://docs.payone.com/integration/channel-frontend/payment-portals-access-shop">Payment portals (Access - Shop Versions)</a></li></ul></li><li><a target="_self" href="https://docs.payone.com/integration/response-handling">Response Handling</a><ul style="display:none"><li><a target="_self" href="https://docs.payone.com/integration/response-handling/transactionstatus-notification"> Transactionstatus Notifications - Samples and Responses</a></li><li><a target="_self" href="https://docs.payone.com/integration/response-handling/json-responses">JSON-Responses</a></li><li><a target="_self" href="https://docs.payone.com/integration/response-handling/json-examples">JSON Examples</a></li></ul></li><li><a target="_self" href="https://docs.payone.com/integration/testdata">Testdata</a></li></ul></li> </ul> </section> <footer class="modal-card-foot"> <div class="buttons"> <button class="btn btn-outline-primary">Cancel</button> </div> </footer> </div> </div>  <section class="section"> <div class="column is-12 mb-3 payone-sitedivs"> <h3>Introduction</h3> <div class="payone-white-content-section"> <p>With the preauthorization request the transmitted amount is reserved. According to the type of payment, specific functions are carried out.</p> <p>This option is only available in the "Shop" option.</p> </div> <h4>Overview</h4> <div class="payone-white-content-section"> <p>Initialing a payment reservation with the different payment types causes the following actions:</p> <table style="border-collapse: collapse; width: 81.921%;"> <tbody> <tr style="height: auto; vertical-align: top; padding: 10px;"> <th style="width: 25%;"> <p><strong>Credit card</strong></p> </th> <td style="width: 75%;"> <p>Credit card data is verified and stored.<br>The amount is reserved on the customer's card</p> </td> </tr> <tr style="height: auto; vertical-align: top; padding: 10px;"> <th style="width: 25%;"> <p><strong>Debit payment</strong></p> </th> <td style="width: 75%;"> <p>Account data is verified and stored.</p> </td> </tr> <tr style="height: auto; vertical-align: top; padding: 10px;"> <th style="width: 25%;"> <p><strong>Online Bank Transfer</strong></p> </th> <td style="width: 75%;"> <p>Account data is verified<br>Online transfer session is initialised<br>Amount will be charged to the account directly after payment is completed</p> </td> </tr> <tr style="height: auto; vertical-align: top; padding: 10px;"> <th style="width: 25%;"> <p><strong>e-wallet</strong></p> </th> <td style="width: 75%;"> <p>E-wallet session is initialised<br>Amount is reserved after the payment has been completed</p> </td> </tr> <tr style="height: auto; vertical-align: top; padding: 10px;"> <th style="width: 25%;"> <p><strong>Prepayment</strong></p> </th> <td style="width: 75%;"> <p>Data is stored<br>Payment process is initialised</p> </td> </tr> <tr style="height: auto; vertical-align: top; padding: 10px;"> <th style="width: 25%;"> <p><strong>Invoice</strong></p> </th> <td style="width: 75%;"> <p>Data is stored<br>Payment process is initialised</p> </td> </tr> <tr style="height: auto; vertical-align: top; padding: 10px;"> <th style="width: 25%;"> <p><strong>Cash on delivery</strong></p> </th> <td style="width: 75%;"> <p>Data is stored<br>Payment process is initialised</p> </td> </tr> <tr style="height: auto; vertical-align: top; padding: 10px;"> <th style="width: 25%;"> <p><strong>Financing</strong></p> </th> <td style="width: 75%;"> <p>Payment type Klarna require item data, billing and delivery address need to be identical.</p> </td> </tr> </tbody> </table> </div> <div class="payone-white-content-section"> <div class="columns api-content" title="requestpayment"> <div class="column is-two-thirds middleAC"> <pre class="full-pre mb-3 "><span class="typ ">POST</span> Request - Preauthorization</pre> <h5 class="h5Param">Account Parameters</h5> <table title="account_parameter" class="ac-isParent"> <tbody> <tr title="request"> <td class="ac-isParentTD pTDa" title="request"><span class="sLborder"></span>request <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Fixed Value: preauthorization</span></div> </td> </tr> <tr title="mid"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>mid <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">your merchant ID, 5-digit numeric</span></div> </td> </tr> <tr title="aid"> <td class="ac-isParentTD pTDa" title="subaccountId"><span class="sLborder"></span>aid <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">your subaccount ID, 5-digit numeric</span></div> </td> </tr> <tr title="portalID"> <td class="ac-isParentTD pTDa" title="portalId"><span class="sLborder"></span>portalId <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">your Portal ID, 7-digit numeric</span></div> </td> </tr> <tr title="key"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>key <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">your key value, alpha-numeric</span></div> </td> </tr> </tbody> </table> <h5 class="h5Param">common Parameters</h5> <table title="common_parameter" class="ac-isParent"> <tbody> <tr title="clearingtype"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>clearingtype <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Fixed Value wtl/fnc/sb/cc/vor/rec</span></div> </td> </tr> <tr title="clearingsubtype"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>clearingsubtype<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Fixed Value POV</span></div> <div class="wfptf"> <p>Only valid with “clearingtype=rec”. Used for PAYONE Secure Invoice.</p> </div> </td> </tr> <tr title="mode"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>mode <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Fixed Value test/live</span></div> <div class="wfptf"> <p>Can be either test environment (test) or live environment (live)</p> </div> </td> </tr> <tr title="reference"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>reference <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..255)</span></div> <div class="wfptf"> <p>A unique ID that will be displayed in your shop backend and for the customer</p> </div> </td> </tr> <tr title="amount"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>amount <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(1..10)</span></div> <div><span class="dmLkmF lVyis">Permitted values max. +/- 19 999 999 99</span></div> <div class="wfptf"> <p>Specifies the total gross amount of a payment transaction.</p> <p>Value is given in smallest currency unit, e.g. Cent of Euro.</p> <p>The amount must be less than or equal to the amount of the corresponding booking.</p> </div> </td> </tr> <tr title="currency"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span><span class="property-name">currency</span> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div><span class="dmLkmF lVyis">Permitted values ISO 4217 (currencies) 3-letter-codes</span></div> <div><span class="dmLkmF lVyis">Samples</span></div> <div>EUR</div> <div>USD</div> <div>GBP</div> </td> </tr> <tr title="param"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>param <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..255)</span></div> <div> <div class="wfptf"> <p>Individual parameter (per payment process)</p> </div> </div> </td> </tr> <tr title="narrative_text"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>narrative_text <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..81)</span></div> <div class="wfptf"> <p>Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements.</p> </div> </td> </tr> <tr title="customer_is_present"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>customer_is_present <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div><span class="dmLkmF lVyis">Permitted Values</span></div> <p>yes</p> <p>no</p> <div class="wfptf"> <p>Indicates whether customer is “present” and can enter their data in the shop (=yes). Or customer is not present and can not enter any data (=no).</p> </div> </td> </tr> <tr title="recurrence"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>recurrence<br> <div class="reqUOO optUn">optional</div> <div class="reqUOO reqUn"> <br><br><br><br></div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div class="wfptf"> <table class="payone-simpleTable"> <thead> <tr> <th class="payone-simpleTh" style="width: 16.1215%;">Value</th> <th class="payone-simpleTh" style="width: 83.8785%;">Comment</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd">none</td> <td class="payone-simpleTd">a non recurring payment, i.e. a single authorization which might be captures at once or later in one or multiple charges</td> </tr> <tr> <td class="payone-simpleTd">oneclick</td> <td class="payone-simpleTd">a form of payment on which the cardholder is authenticated only on the initial transaction. Follow-up transactions are authorized without active interaction of the cardholder</td> </tr> <tr> <td class="payone-simpleTd">recurring</td> <td class="payone-simpleTd">a recurring payment, which has an a priori defined frequency and limit/threshold</td> </tr> <tr> <td class="payone-simpleTd">installment</td> <td class="payone-simpleTd">a recurring payment, which has an a priori defined frequency, limit/threshold and end date</td> </tr> </tbody> </table> </div> <div class="wfptf"> <p>Indicates recurring payments. Currently only supported for PayPal and Credit Card.</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">PERSONAL DATA Parameters</h5> <table title="PERSONAL_DATA_Parameters" class="ac-isParent"> <tbody> <tr title="customerid"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>customerid <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..20) <br>Permitted Symbols [0-9, a-z, A-Z, .,-,_,/] </span></div> <div class="wfptf"> <p>Merchant's customer ID, defined by you / merchant to refer to the customer record.</p> <div class="tryoutbox"> <p>"customerid" can be used to identify a customer record. <br>If "customerid" is used then stored customer data are loaded automatically.</p> </div> </div> </td> </tr> <tr title="userid"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>userid <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(6..12)</span></div> <div class="wfptf"> <p>PAYONE User ID, defined by PAYONE</p> </div> </td> </tr> <tr title="salutation"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>salutation <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..10)</span></div> <div class="wfptf"> <p>The customer's salutation</p> </div> </td> </tr> <tr title="title"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>title <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..20)</span></div> <div><span class="dmLkmF lVyis">Samples</span></div> <p>Dr</p> <p>Prof.</p> <p>Dr.-Ing.</p> <div class="wfptf"> <p>Title of the customer</p> </div> </td> </tr> <tr title="firstname"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>firstname <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..50)</span></div> <div class="wfptf"> <p>First name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname"</p> </div> </td> </tr> <tr title="lastname"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>lastname <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..50)</span></div> <div class="wfptf"> <p>Last name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname"</p> </div> </td> </tr> <tr title="businessrelation"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>businessrelation<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div class="wfptf"> <table class="payone-simpleTable"> <thead> <tr> <th class="payone-simpleTh" style="width: 16.1215%;">Value</th> <th class="payone-simpleTh" style="width: 83.8785%;">Comment</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd">b2c</td> <td class="payone-simpleTd"> <p>Indicates business to private customer</p> </td> </tr> <tr> <td class="payone-simpleTd" style="width: 16.1215%;">b2b</td> <td class="payone-simpleTd" style="width: 83.8785%;"> <p>indicates business to business customer (company)</p> </td> </tr> </tbody> </table> </div> <div class="wfptf"> <p>Value specifies business relation between merchant and customer</p> </div> </td> </tr> <tr title="company"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>company <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..50)</span></div> <div class="wfptf"> <p>Comany name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname"</p> </div> </td> </tr> <tr title="street"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>street <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..50)</span></div> <div class="wfptf"> <p>Street number and name (required: at least one character)</p> </div> </td> </tr> <tr title="addressaddition"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>addressaddition <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..50)</span></div> <div><span class="dmLkmF lVyis">Samples</span></div> <p>7th floor</p> <p>c/o Maier</p> <div class="wfptf"> <p>Specifies an additional address line for the invoice address of the customer.</p> </div> </td> </tr> <tr title="zip"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>zip <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..50)</span></div> <div><span class="dmLkmF lVyis">Permitted Symbols [0-9][A-Z][a-z][_.-/ ]</span></div> <div class="wfptf"> <p>Postcode</p> </div> </td> </tr> <tr title="city"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>city <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..50)</span></div> <div class="wfptf"> <p>City of customer</p> </div> </td> </tr> <tr title="country"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>country <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div><span class="dmLkmF lVyis">Permitted values ISO 3166 2-letter-codes</span></div> <div><span class="dmLkmF lVyis">Samples</span></div> <p>DE</p> <p>GB</p> <p>US</p> <div> <div class="tryoutbox">Specifies country of address for the customer.<br>Some countries require additional information in parameter "state".</div> </div> </td> </tr> <tr title="state"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>state <br> <div class="reqUOO reqUn">required (in CN)</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div><span class="dmLkmF lVyis">Permitted values: ISO 3166-2 States (regions) 2-letter-codes</span></div> <div class="wfptf"> <table class="payone-simpleTable"> <thead> <tr> <th class="payone-simpleTh" style="width: 50%;">Samples US</th> <th class="payone-simpleTh" style="width: 50%;">Samples CA</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd">AK</td> <td class="payone-simpleTd">AB</td> </tr> <tr> <td class="payone-simpleTd">AL</td> <td class="payone-simpleTd">BC</td> </tr> </tbody> </table> </div> <div class="wfptf"> <p>Specifies state / region of country for the customer. <br>"state" is required for these countries: US, CA, CN, JP, MX, BR, AR, ID, TH, IN and must not be used for all other countries.</p> </div> </td> </tr> <tr title="email"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>email <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(5..254)</span></div> <div><span class="dmLkmF lVyis">Permitted Symbols RFC 5322</span></div> <div class="wfptf"> <p>Special Remark email validation:</p> <p>Max. length for email is 254 characters. Validation is set up in the following way:</p> <p>Username = Max. 63 characters</p> <p>Domain Name = Max. 63 characters <br>Domain Suffixes = Max. 4 suffixes with max. 124 characters <br>Example: username[63]@domain_name[63].suffix[60].suffix[60].suffix[4]</p> <p>"@" and "." is counted as a character as well; in case of a total of three suffixes, this would allow a total of 254 characters.</p> <p>email-address of customer</p> </div> </td> </tr> <tr title="telephonenumber"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>telephonenumber <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..30)</span></div> <div class="wfptf"> <p>Phone number of customer</p> </div> </td> </tr> <tr title="birthday"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>birthday <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format DATE(8), YYYYMMDD</span></div> <div><span class="dmLkmF lVyis">Samples</span></div> <p>20190101</p> <p>19991231</p> <div class="wfptf"> <p><span style="font-weight: 400; text-align: inherit;">Date of birth of customer</span></p> </div> </td> </tr> <tr title="language"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>language <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div><span class="dmLkmF lVyis">Permitted values ISO 639-1 (Language)2-letter-codes</span></div> <div class="wfptf"> <p>Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display).</p> <p>If the language is not transferred, the browser language will be used. For a non-supported language English will be used.</p> </div> </td> </tr> <tr title="vatid"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>vatid <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..50)</span></div> <div class="wfptf"> <p>VAT identification number. Used for b2b transactions to indicate VAT number of customer.</p> </div> </td> </tr> <tr title="gender"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>gender <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div><span class="dmLkmF lVyis">Permitted values: f / m / d*</span></div> <div class="wfptf"> <p>Gender of customer (female / male / diverse* )</p> <p>* currently not in use</p> </div> </td> </tr> <tr title="personalid"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>personalid <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..32)</span></div> <div><span class="dmLkmF lVyis">Permitted Symbols [0-9][A-Z][a-z][+-./()]</span></div> <div class="wfptf"> <p>Person specific numbers or characters, e.g. number of passport / ID card</p> </div> </td> </tr> <tr title="ip"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>ip <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..39)</span></div> <div class="wfptf"> <p>Customer's IP-V4-address (123.123.123.123) or IP-V6-address</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">Delivery data Parameters</h5> <table title="Delivery_data_Parameters" class="ac-isParent"> <tbody> <tr title="shipping_firstname"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>shipping_firstname <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..50)</span></div> <div class="wfptf"> <p>First name of delivery address</p> </div> </td> </tr> <tr title="shipping_lastname"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>shipping_lastname <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..50)</span></div> <div class="wfptf"> <p>Surname of delivery address</p> </div> </td> </tr> <tr title="shipping_company"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>shipping_company <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..50)</span></div> <div class="wfptf"> <p>Company name of delivery address</p> </div> </td> </tr> <tr title="shipping_street"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>shipping_street <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..50)</span></div> <div class="wfptf"> <p>Street number and name of delivery address</p> </div> </td> </tr> <tr title="shipping_zip"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>shipping_zip <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..50)</span></div> <div class="wfptf"> <p>Postcode of delivery address</p> </div> </td> </tr> <tr title="shipping_city"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>shipping_city<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..50)</span></div> <div class="wfptf"> <p>City of delivery address</p> </div> </td> </tr> <tr title="shipping_addressaddition"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>shipping_addressaddition <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..50)</span></div> <div class="wfptf"> <p>Specifies an additional address line for the delivery address of the customer, e.g. "7th floor", "c/o Maier".</p> </div> </td> </tr> <tr title="shipping_country"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>shipping_country <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div><span class="dmLkmF lVyis">Permitted values ISO 3166 2-letter-codes</span></div> <div><span class="dmLkmF lVyis">Samples</span></div> <p>DE</p> <p>GB</p> <p>US</p> <div class="wfptf"> <div class="tryoutbox"> <p>Specifies country of address for the customer.</p> <p>Some countries require additional information in parameter "state"</p> </div> </div> </td> </tr> <tr title="shipping_state"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>shipping_state <br> <div class="reqUOO reqUn">required (in CN)</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div><span class="dmLkmF lVyis">Permitted values ISO 3166-2 States (regions) 2-letter-codes</span></div> <div class="wfptf"> <table class="payone-simpleTable"> <thead> <tr> <th class="payone-simpleTh" style="width: 50%;">Samples US</th> <th class="payone-simpleTh" style="width: 50%;">Samples CA</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd">AK</td> <td class="payone-simpleTd">AB</td> </tr> <tr> <td class="payone-simpleTd">AL</td> <td class="payone-simpleTd">BC</td> </tr> </tbody> </table> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">URL PARAMETERS</h5> <table title="url_parameter" class="ac-isParent"> <tbody> <tr title="successurl"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>successurl <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..255)</span></div> <div><span class="dmLkmF lVyis">Scheme <scheme>://<host>/<path><br> <scheme>://<host>/<path>?<query><br> </span></div> <div><span class="dmLkmF lVyis">scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}</span></div> <div class="wfptf"> <p>URL for "payment successful"</p> </div> </td> </tr> <tr title="errorurl"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>errorurl <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..255)</span></div> <div><span class="dmLkmF lVyis">Scheme <scheme>://<host>/<path><br> <scheme>://<host>/<path>?<query><br> </span></div> <div><span class="dmLkmF lVyis">scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}</span></div> <div class="wfptf"> <p>URL for "faulty payment"</p> </div> </td> </tr> <tr title="backurl"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>backurl <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..255)</span></div> <div><span class="dmLkmF lVyis">Scheme <scheme>://<host>/<path><br> <scheme>://<host>/<path>?<query><br> </span></div> <div><span class="dmLkmF lVyis">scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}</span></div> <div class="wfptf"> <p>URL for "Back" or "Cancel"</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">Article Parameters</h5> <table title="article_parameter" class="ac-isParent" style="width: 99.7546%;"> <tbody> <tr title="it[n]"> <td class="ac-isParentTD pTDa" style="width: 24.9575%;"><span class="sLborder"></span>it[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb" style="width: 74.8689%;"> <div> <table class="payone-simpleTable"> <thead> <tr> <th class="payone-simpleTh" style="width: 50%;">it[n]</th> <th class="payone-simpleTh" style="width: 50%;">Comments</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd">goods</td> <td class="payone-simpleTd">Goods</td> </tr> <tr> <td class="payone-simpleTd">shipment</td> <td class="payone-simpleTd">Shipping Charges</td> </tr> <tr> <td class="payone-simpleTd">handling</td> <td class="payone-simpleTd">Handling fee</td> </tr> <tr> <td class="payone-simpleTd">voucher</td> <td class="payone-simpleTd">Voucher / discount</td> </tr> </tbody> </table> </div> <div class="wfptf"> <p>required for physical goods in order to ensure PayPal seller protection</p> </div> </td> </tr> <tr title="id[n]"> <td class="ac-isParentTD pTDa" style="width: 24.9575%;"><span class="sLborder"></span>id[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb" style="width: 74.8689%;"> <div><span class="dmLkmF lVyis">Format CHAR(1..32)</span></div> <div><span class="dmLkmF lVyis">Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div><span class="dmLkmF lVyis">Permitted Symbols [0-9][a-z][A-Z], .,-,_,/</span></div> <div class="wfptf"> <p>International Article Number (EAN bzw. GTIN)</p> <p>Product number, SKU, etc. of this item.</p> </div> </td> </tr> <tr title="pr[n]"> <td class="ac-isParentTD pTDa" style="width: 24.9575%;"><span class="sLborder"></span>pr[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb" style="width: 74.8689%;"> <div><span class="dmLkmF lVyis">Format NUMERIC(10) max. 19 999 999 99</span></div> <div><span class="dmLkmF lVyis">Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div class="wfptf"> <p style="text-align: inherit;">Unit gross price of the item in smallest unit! e.g. cent.</p> <span class="dmLkmF lVyis"></span></div> </td> </tr> <tr title="no[n]"> <td class="ac-isParentTD pTDa" style="width: 24.9575%;"><span class="sLborder"></span>no[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb" style="width: 74.8689%;"> <div><span class="dmLkmF lVyis">Format NUMERIC(6)</span></div> <div><span class="dmLkmF lVyis">Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div class="wfptf"> <p>Quantity of this item.</p> </div> </td> </tr> <tr title="de[n]"> <td class="ac-isParentTD pTDa" style="width: 24.9575%;"><span class="sLborder"></span>de[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb" style="width: 74.8689%;"> <div><span class="dmLkmF lVyis">Format CHAR(1..255)</span></div> <div><span class="dmLkmF lVyis">Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div class="wfptf"> <p>Required for physical goods in order to ensure PayPal seller protection</p> <p>Description of this item. Will be printed on documents to customer.</p> </div> </td> </tr> <tr title="va[n]"> <td class="ac-isParentTD pTDa" style="width: 24.9575%;"><span class="sLborder"></span>va[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb" style="width: 74.8689%;"> <div><span class="dmLkmF lVyis">Format NUMERIC(4)<br></span></div> <div class="wfptf"> <p>VAT rate (% or bp)</p> <p>Array elements [n] starting with [1]; serially numbered; max [400]</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">online TRANSFER PARAMETERS</h5> <table class="ac-isParent"> <tbody> <tr title="onlinebanktransfertype"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>onlinebanktransfertype<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div class="wfptf"> <table class="payone-simpleTable"> <tbody> <tr> <th class="payone-simpleTh" style="width: 26.7596%;">BCT</th> <td class="payone-simpleTd" style="width: 72.969%;">Bancontact</td> </tr> <tr> <th class="payone-simpleTh">EPS</th> <td class="payone-simpleTd">eps – online transfer (AT)</td> </tr> <tr> <th class="payone-simpleTh">IDL</th> <td class="payone-simpleTd">iDEAL (NL)</td> </tr> <tr> <th class="payone-simpleTh">MBC</th> <td class="payone-simpleTd">Multibanco</td> </tr> <tr> <th class="payone-simpleTh">MYB</th> <td class="payone-simpleTd">MyBank</td> </tr> <tr> <th class="payone-simpleTh">P24</th> <td class="payone-simpleTd">Przelewy24 (PL)</td> </tr> <tr> <th class="payone-simpleTh">PFF</th> <td class="payone-simpleTd">PostFinance E-Finance (CH)</td> </tr> <tr> <th class="payone-simpleTh">PFC</th> <td class="payone-simpleTd">PostFinance Card (CH)</td> </tr> <tr> <th class="payone-simpleTh">PNT</th> <td class="payone-simpleTd">SOFORT Überweisung</td> </tr> <tr> <th class="payone-simpleTh">TRL</th> <td class="payone-simpleTd">Trustly</td> </tr> <tr> <th class="payone-simpleTh">VKP</th> <td class="payone-simpleTd">Verkkopankki</td> </tr> </tbody> </table> </div> <div class="wfptf"></div> </td> </tr> <tr title="bankgrouptype"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>bankgrouptype<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div class="wfptf"> <table class="payone-simpleTable"> <tbody> <tr> <td class="payone-simpleTd" style="width: 43.2304%;">List of supported EPS banks</td> <td class="payone-simpleTd" style="width: 56.4982%;">Bank Groups (EPS) (bankgrouptype)</td> </tr> <tr> <td class="payone-simpleTd" style="width: 43.2304%;">List of supported iDEAL banks</td> <td class="payone-simpleTd" style="width: 56.4982%;">Bank Groups (iDEAL) (bankgrouptype)</td> </tr> </tbody> </table> </div> <div class="wfptf"> <p>Issuer of Online-Bank-Transfer used for iDEAL and EPS<br> </p> </div> </td> </tr> <tr title="bankcountry"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>bankcountry <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div><span class="dmLkmF lVyis">Permitted Values DE; DK; EE; ES; FI; IT; MT; NL; NO; PL; SE</span></div> <div class="wfptf"> <p>Account type/ country for use with BBAN (i.e. bankcode, bankaccount): DE</p> <p>DE: Mandatory with bankcode, bankaccount, optional with IBAN</p> <p>For other countries than DE please use IBAN or IBAN/BIC</p> </div> </td> </tr> <tr title="iban"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>iban <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(8 or 11) Only capital letters and digits, no spaces</span></div> <div><span class="dmLkmF lVyis">Permitted Symbols [0-9][A-Z]</span></div> <div class="wfptf"> <p>Bank Identifier Code to be used for payment or to be checked</p> </div> </td> </tr> <tr title="bic"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>bic <br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(8 or 11) Only capital letters and digits, no spaces</span></div> <div><span class="dmLkmF lVyis">Permitted Symbols [0-9][A-Z]</span></div> <div class="wfptf"> <p>BIC is optional for all Bank transfers within SEPA. For Accounts from Banks outside of SEPA, BIC is still required.</p> </div> </td> </tr> <tr title="bankaccount"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>bankaccount<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(1..10)</span></div> <div class="wfptf"> <p>DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions.<br>Not DE: Please use IBAN or IBAN / BIC.</p> </div> </td> </tr> <tr title="bankcode"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>bankcode<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(8)</span></div> <div class="wfptf"> <p>DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions.<br>Not DE: Please use IBAN or IBAN / BIC.</p> </div> </td> </tr> <tr title="bankaccountholder"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>bankaccountholder<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..50)</span></div> <div class="wfptf"> <p>Account holder</p> </div> </td> </tr> <tr title="mandate_identification"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>mandate_identification<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..35)</span></div> <div><span class="dmLkmF lVyis">Permitted Symbols [A-Z,a-z,0-9,+,-,.,(,)]</span></div> <div class="wfptf"> <p>A SEPA mandate can be created if a payment is initiated (amount > 0). Can be used to enforce a merchant specific mandate identification. The mandate_identification has to be unique.</p> <div class="tryoutbox"> <p>If the mandate_identification is not set PAYONE will create an unique mandate identification (pattern: PO-nnnnnnnnnn).</p> </div> <div class="alertbox"><span>PPS (PAYONE Payment Service): This parameter must not be used! For PPS the PAYONE platform defines the mandate_identification</span></div> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">Wallet Parameter</h5> <table class="ac-isParent"> <tbody> <tr title="wallettype"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>wallettype<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST </span></div> <div class="wfptf"> <table class="payone-simpleTable"> <tbody> <tr> <td class="payone-simpleTd" style="width: 28.0024%;">ALP</td> <td class="payone-simpleTd" style="width: 71.8446%;">Alipay</td> </tr> <tr> <td class="payone-simpleTd">AMZ</td> <td class="payone-simpleTd">Amazon Payments</td> </tr> <tr> <td class="payone-simpleTd">PDT</td> <td class="payone-simpleTd">Giropay</td> </tr> <tr> <td class="payone-simpleTd">PPE</td> <td class="payone-simpleTd">PayPal</td> </tr> <tr> <td class="payone-simpleTd">PSC</td> <td class="payone-simpleTd">paysafecard</td> </tr> <tr> <td class="payone-simpleTd">APL</td> <td class="payone-simpleTd">Apple Pay</td> </tr> </tbody> </table> </div> <div class="wfptf"> <p>Used with "clearingtype=wlt" to identify wallet payment types</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">Cash on Delivery PARAMETER</h5> <table class="ac-isParent"> <tbody> <tr title="shippingprovider"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>shippingprovider<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST </span></div> <div><span class="dmLkmF lVyis">Fixed Value DHL</span></div> <div class="wfptf"> <p>Only mandatory for cash on delivery</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">Credit Card Parameters</h5> <table class="ac-isParent"> <tbody> <tr title="cardpan"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>cardpan<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Primary account number of credit card</span></div> <div><span class="dmLkmF lVyis">Format NUMERIC(13..19)</span></div> <div class="wfptf"> <div class="alertbox"><span>If your system handles "cardpan" directly you can not be PCI DSS SAQ A compliant.<br>For simple PCI DSS SAQ A compliance please use PAYONE hosted iFrames together with pseudocardpan. </span></div> </div> </td> </tr> <tr title="cardtype"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>cardtype<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div class="wfptf"> <p>Card type of credit card</p> <p>Primary account number of credit card</p> </div> <div class="wfptf"> <table class="payone-simpleTable" style="width: 99.6422%;"> <thead> <tr> <th class="payone-simpleTh" style="width: 13.2452%;">Value</th> <th class="payone-simpleTh" style="width: 32.1412%;">Comment</th> <th class="payone-simpleTh" style="width: 54.4606%;">BIN-Range for automatic card type detection</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd" style="width: 13.2452%;">V</td> <td class="payone-simpleTd" style="width: 32.1412%;">Visa</td> <td class="payone-simpleTd" style="width: 54.4606%;">4</td> </tr> <tr> <td class="payone-simpleTd" style="width: 13.2452%;">M</td> <td class="payone-simpleTd" style="width: 32.1412%;">MasterCard</td> <td class="payone-simpleTd" style="width: 54.4606%;">51-55,2221-2720</td> </tr> <tr> <td class="payone-simpleTd" style="width: 13.2452%;">A</td> <td class="payone-simpleTd" style="width: 32.1412%;">American Express</td> <td class="payone-simpleTd" style="width: 54.4606%;">34, 37</td> </tr> <tr> <td class="payone-simpleTd" style="width: 13.2452%;">D</td> <td class="payone-simpleTd" style="width: 32.1412%;">Diners / Discover</td> <td class="payone-simpleTd" style="width: 54.4606%;"> <p>300-305,3095,36,38,39</p> <p>601, 64, 65</p> </td> </tr> <tr> <td class="payone-simpleTd" style="width: 13.2452%;">J</td> <td class="payone-simpleTd" style="width: 32.1412%;">JCB</td> <td class="payone-simpleTd" style="width: 54.4606%;">3528-3589</td> </tr> <tr> <td class="payone-simpleTd" style="width: 13.2452%;">O</td> <td class="payone-simpleTd" style="width: 32.1412%;">Maestro International</td> <td class="payone-simpleTd" style="width: 54.4606%;">50, 56-58,602, 61, 620, 627, 63, 67</td> </tr> <tr> <td class="payone-simpleTd" style="width: 13.2452%;">P</td> <td class="payone-simpleTd" style="width: 32.1412%;">China Union Pay</td> <td class="payone-simpleTd" style="width: 54.4606%;">62212600-62299800,624-626, 6282-6288</td> </tr> <tr> <td class="payone-simpleTd" style="width: 13.2452%;">U</td> <td class="payone-simpleTd" style="width: 32.1412%;">UATP / Airplus</td> <td class="payone-simpleTd" style="width: 54.4606%;">1220, 1920 -> coming soon; not available yet</td> </tr> <tr> <td class="payone-simpleTd" style="width: 13.2452%;">G</td> <td class="payone-simpleTd" style="width: 32.1412%;">girocard</td> <td class="payone-simpleTd" style="width: 54.4606%;">68*</td> </tr> </tbody> </table> </div> <div class="wfptf"> <p>*girocard is currently only viable for e-commerce-payments via Apple Pay.</p> </div> </td> </tr> <tr title="cardexpiredate"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>cardexpiredate <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(4), YYMM</span></div> <div class="wfptf"> <p>Credit card expiry date YYMM</p> </div> </td> </tr> <tr title="cardcvc2"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>cardcvc2<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"><span class="dmLkmF lVyis">Format NUMERIC(3..4)</span> <div class="alertbox">For SAQ A compliance: PAYONE Frontend hosted iFrame must be used. This parameter must not be used.</div> </td> </tr> <tr title="cardholder"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>cardissuenumber<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(1..2)</span></div> <div class="wfptf"> <p>Card issue number (only Maestro UK cards)</p> </div> </td> </tr> <tr title="cardholder"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>cardholder<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..50)</span></div> <div class="wfptf"> <p>Cardholder of credit card.</p> </div> </td> </tr> <tr title="ecommercemode"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>ecommercemode<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div class="wfptf"> <table class="payone-simpleTable"> <thead> <tr> <th class="payone-simpleTh">Value</th> <th class="payone-simpleTh">Comments</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd">internet</td> <td class="payone-simpleTd">eCommerce Transaction (SSL secured)</td> </tr> <tr> <td class="payone-simpleTd">3dsecure</td> <td class="payone-simpleTd">3-D Secure transaction (can be enabled alternatively in the risk settings)</td> </tr> <tr> <td class="payone-simpleTd">moto</td> <td class="payone-simpleTd">Mail or telephone order transaction</td> </tr> </tbody> </table> </div> <div class="wfptf"> <p>Specifies how the payment transaction should be processed - if not default.</p> </div> </td> </tr> <tr title="pseudocardpan"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>pseudocardpan<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(16..19)</span></div> <div class="wfptf"> <p>Pseudo primary account number for a credit card.</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">3-D Secure Parameters</h5> <table class="ac-isParent"> <tbody> <tr title="xid"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>xid<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..60)</span></div> <div><span class="dmLkmF lVyis"></span> <ul> <li>either "xid" (from previous 3dscheck)</li> <li>or "successurl", "errorurl", "backurl" must be given.</li> </ul> </div> <div class="wfptf"> <p>3-D Secure transaction ID (if the request "3dscheck" was used previous transactions), i.e.:</p> <ul> <li>value for "xid" is returned by request 3dscheck (optional request)</li> <li>and then has to be used for request authorization, preauthorization or createaccess in request data</li> </ul> </div> </td> </tr> <tr title="cavv"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>cavv<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..40)</span></div> <div class="wfptf"> <p>3-D Secure authentication value</p> </div> </td> </tr> <tr title="eci"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>eci<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..2)</span></div> <div class="wfptf"> <p>3-D Secure e-commerce indicator</p> </div> </td> </tr> <tr title="successurl"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>successurl<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..255)</span></div> <div><span class="dmLkmF lVyis">Scheme <scheme>://<host>/<path><br> <scheme>://<host>/<path>?<query><br> </span></div> <div><span class="dmLkmF lVyis">scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}</span></div> <div class="wfptf"> <p>- either "xid" (from previous 3dscheck)<br>- or "successurl", "errorurl", "backurl" must be given<br>- or default "successurl" and "backurl" for a portal are configured within PMI.<br> </p> <p>URL for "payment successful"</p> </div> </td> </tr> <tr title="errorurl"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>errorurl<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..255)</span></div> <div><span class="dmLkmF lVyis">Scheme <scheme>://<host>/<path><br> <scheme>://<host>/<path>?<query><br> </span></div> <div><span class="dmLkmF lVyis">scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}</span></div> <div class="wfptf"> <p>- either "xid" (from previous 3dscheck)<br>- or "successurl", "errorurl", "backurl" must be given.<br> </p> <p>URL for "faulty payment"</p> </div> </td> </tr> <tr title="backurl"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>backurl<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(2..255)</span></div> <div><span class="dmLkmF lVyis">Scheme <scheme>://<host>/<path><br> <scheme>://<host>/<path>?<query><br> </span></div> <div><span class="dmLkmF lVyis">scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}</span></div> <div class="wfptf"> <p>- either "xid" (from previous 3dscheck)<br>- or "successurl", "errorurl", "backurl" must be given<br>- or default "successurl" and "backurl" for a portal are configured within PMI.<br> </p> <p>URL for "Back" or "Cancel"</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">Financing Parameters</h5> <table class="ac-isParent"> <tbody> <tr title="financingtype"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>financingtype<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div class="wfptf"> <p>Used with "clearingtype=fnc" to identify Financing type</p> </div> <div class="wfptf"> <table class="payone-simpleTable"> <thead> <tr> <th class="payone-simpleTh" style="width: 15.2281%;">Value</th> <th class="payone-simpleTh" style="width: 84.6189%;">Comment</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd">RPV</td> <td class="payone-simpleTd">Ratepay Open Invoice</td> </tr> <tr> <td class="payone-simpleTd">RPS</td> <td class="payone-simpleTd">Ratepay Installments</td> </tr> <tr> <td class="payone-simpleTd">RPP</td> <td class="payone-simpleTd">Ratepay Prepayment</td> </tr> <tr> <td class="payone-simpleTd">RPD</td> <td class="payone-simpleTd">Ratepay Direct Debit</td> </tr> <tr> <td class="payone-simpleTd">PYV</td> <td class="payone-simpleTd">Unzer Invoice</td> </tr> <tr> <td class="payone-simpleTd">PYS</td> <td class="payone-simpleTd">Unzer Installment</td> </tr> <tr> <td class="payone-simpleTd">PYM</td> <td class="payone-simpleTd">Unzer Monthly</td> </tr> <tr> <td class="payone-simpleTd">PYD</td> <td class="payone-simpleTd">Unzer Direct Debit</td> </tr> <tr> <td class="payone-simpleTd">PPI</td> <td class="payone-simpleTd">PayPal Installment</td> </tr> <tr> <td class="payone-simpleTd">KLV</td> <td class="payone-simpleTd">Klarna Checkout Invoice</td> </tr> <tr> <td class="payone-simpleTd">KLS</td> <td class="payone-simpleTd">Klarna Checkout Installment</td> </tr> <tr> <td class="payone-simpleTd">KIS</td> <td class="payone-simpleTd">Klarna Payments "Slice it" (Installments)</td> </tr> <tr> <td class="payone-simpleTd">KIV</td> <td class="payone-simpleTd">Klarna Payments "Pay now" (Invoice)</td> </tr> <tr> <td class="payone-simpleTd">KDD</td> <td class="payone-simpleTd">Klarna Payments "Pay now" (Direct Debit)</td> </tr> <tr> <td class="payone-simpleTd">KBT</td> <td class="payone-simpleTd">Klarna Payments "Pay now" (Bank Transfer)</td> </tr> <tr> <td class="payone-simpleTd">PIV</td> <td class="payone-simpleTd">PAYONE Secured Invoice</td> </tr> <tr> <td class="payone-simpleTd">PDD</td> <td class="payone-simpleTd">PAYONE Secured Direct Debit</td> </tr> <tr> <td class="payone-simpleTd">PIN</td> <td class="payone-simpleTd">PAYONE Secured Installment</td> </tr> </tbody> </table> </div> </td> </tr> <tr title="workorderid"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>workorderid<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..50)</span></div> <div class="wfptf"> <p>The workorderid is a technical id returned from the PAYONE platform to identify a workorder. A workorder is a part of a payment process (identified by a txid). The workorderid is used for the genericpayment request.</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">Response Parameters</h5> <table class="ac-isParent"> <tbody> <tr title="status"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span> <button aria-label="expand properties"><span class="property-name">status</span></button></td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Permitted Values <br></span></div> <div><span class="dmLkmF lVyis">APPROVED</span><br><span class="dmLkmF lVyis">PENDING</span><br><span class="dmLkmF lVyis">REDIRECT<br>ERROR </span></div> </td> </tr> </tbody> </table> <div class="responsesDIV"><button class="notiBtn has-text-primary-dark has-background-success-light" aria-expanded="false"> <svg class="svg-Up svg2" version="1.1" viewbox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true" style="fill: currentColor; color: #00947e;"> <polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon> </svg><span>200 </span><span class="sc-jcwpoC DVwyR"></span></button> <h5 class="h5Param">Response Parameter (approved)</h5> <table class="ac-isParent"> <tbody> <tr title="txid"> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span><span class="property-name">txid</span></td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(9..12)</span></div> <div class="wfptf"> <p>The txid specifies the payment process within the PAYONE platform</p> </div> </td> </tr> <tr title="userid"> <td class="ac-isParentTD pTDa" title="hostedCheckoutSpecificInput"><span class="sLborder"></span><button aria-label="expand properties"><span class="property-name">userid</span></button></td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(6..12)</span></div> <div class="wfptf"> <p>PAYONE User ID, defined by PAYONE</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">Response Parameter (approved) - credit card – if AVS has been ordered</h5> <table class="ac-isParent"> <tbody> <tr title="protect_result_avs"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>protect_result_avs</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format A1</span></div> <div class="wfptf"> <p>AVS return value, see AVS-Returns (protect_result_avs)</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">Response Parameter (Approved) - Prepayment/cash on delivery</h5> <table class="ac-isParent"> <tbody> <tr title="clearing_bankaccountholder"> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span>clearing_bankaccountholder</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format AN..35</span></div> <div class="wfptf"> <p>Recipient bank account holder</p> </div> </td> </tr> <tr title=""> <td class="ac-isParentTD pTDa" title="hostedCheckoutSpecificInput"><span class="sLborder"></span> clearing_bankcountry</td> <td class="pTDb"> <div> <p>Recipient account type/ country (e.g. DE, AT, etc.)</p> </div> </td> </tr> <tr title=""> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span> clearing_bankaccount</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format AN..26</span></div> <div class="wfptf"> <p>Recipient account number</p> </div> </td> </tr> <tr title=""> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span> clearing_bankcode</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format AN..11</span></div> <div class="wfptf"> <p>Recipient sort code</p> </div> </td> </tr> <tr title=""> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span> clearing_bankiban</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format AN..35</span></div> <div class="wfptf"> <p>Recipient IBAN</p> </div> </td> </tr> <tr title=""> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span> clearing_bankbic</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format AN..11</span></div> <div class="wfptf"> <p>Recipient BIC</p> </div> </td> </tr> <tr title=""> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span> clearing_bankcity</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format AN..50</span></div> <div class="wfptf"> <p>Recipient city or bank</p> </div> </td> </tr> <tr title=""> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span> clearing_bankname</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format AN..50</span></div> <div class="wfptf"> <p>Recipient bank name</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">Response Parameter (Approved) - direct debit</h5> <table class="ac-isParent"> <tbody> <tr title="mandate_identification"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>mandate_identification<br> <div class="reqUOO reqUn"></div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..35)</span></div> <div><span class="dmLkmF lVyis">Permitted Symbols [A-Z,a-z,0-9,+,-,.,(,)]</span></div> <div class="wfptf"> <p>A SEPA mandate can be created if a payment is initiated (amount > 0). Can be used to enforce a merchant specific mandate identification. The mandate_identification has to be unique.</p> <div class="alertbox"> <p>PPS (PAYONE Payment Service): This parameter must not be used! For PPS the PAYONE platform defines the mandate_identification</p> </div> <div class="tryoutbox">If the mandate_identification is not set PAYONE will create an unique mandate identification <br>(pattern: PO-nnnnnnnnnn).</div> </div> </td> </tr> <tr title="mandate_dateofsignature"> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span>mandate_dateofsignature</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format N..10</span></div> <div class="wfptf"> <p>Date when mandate has been created</p> <p>(format YYYYMMDD)</p> </div> </td> </tr> <tr title="creditor_identifier"> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span>creditor_identifier</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format AN..35</span></div> <div class="wfptf"> <p>Used CID for debit payment</p> </div> </td> </tr> <tr title="creditor_name"> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span>creditor_name</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format AN..35</span></div> <div class="wfptf"> <p>As recorded in PAYONE Platform.</p> </div> </td> </tr> <tr title="creditor_stree"> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span> creditor_street</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format AN..35</span></div> <div class="wfptf"> <p>As recorded in PAYONE Platform.</p> </div> </td> </tr> <tr title="creditor_zip"> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span>creditor_zip</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format AN..10</span></div> <div class="wfptf"> <p>As recorded in PAYONE Platform.</p> </div> </td> </tr> <tr title="creditor_city"> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span>creditor_city</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format AN..50</span></div> <div class="wfptf"> <p>As recorded in PAYONE Platform.</p> </div> </td> </tr> <tr title="creditor_country"> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span>creditor_country</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Country (ISO 3166)</span></div> </td> </tr> <tr title="creditor_email"> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span>creditor_email</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format AN..254</span></div> <div class="wfptf"> <p>As recorded in PAYONE Platform.</p> </div> </td> </tr> </tbody> </table> </div> <div class="responsesDIV"><button class="notiBtn has-text-danger-dark has-background-danger-light" aria-expanded="false"> <svg class="svg-Up svg2" version="1.1" viewbox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true" style="fill: currentColor; color: #cc0f35;"> <polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon> </svg><span>400 </span><span class="sc-jcwpoC DVwyR"></span></button> <h5 class="h5Param">Response Parameter (Pending) - currently only supported for KLV/KLS</h5> <table class="ac-isParent"> <tbody> <tr title="400-txid"> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span><span class="property-name">txid</span></td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(9..12)</span></div> <div class="wfptf"> <p>The txid specifies the payment process within the PAYONE platform</p> </div> </td> </tr> <tr title="400-userid"> <td class="ac-isParentTD pTDa" title="hostedCheckoutSpecificInput"><span class="sLborder"></span><button aria-label="expand properties"><span class="property-name">userid</span></button></td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(6..12)</span></div> <div class="wfptf"> <p>PAYONE User ID, defined by PAYONE</p> </div> </td> </tr> </tbody> </table> <div class="responsesDIV"><button class="notiBtn has-text-primary-dark has-background-success-light" aria-expanded="false"> <svg class="svg-Up svg2" version="1.1" viewbox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true" style="fill: currentColor; color: #00947e;"> <polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon> </svg><span>200 </span><span class="sc-jcwpoC DVwyR"></span></button> <h5 class="h5Param">Parameter (REDIRECT) (3-D Secure/online transfer/e-wallet)</h5> <table class="ac-isParent"> <tbody> <tr> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span><span class="property-name">txid</span></td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(9..12)</span></div> <div class="wfptf"> <p>The txid specifies the payment process within the PAYONE platform</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="hostedCheckoutSpecificInput"><span class="sLborder"></span><button aria-label="expand properties"><span class="property-name">userid</span></button></td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(6..12)</span></div> <div class="wfptf"> <p>PAYONE User ID, defined by PAYONE</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title=""><span class="sLborder"></span>redirecturl</td> <td class="pTDb"> <div> <div><span class="dmLkmF lVyis">Format CHAR(2..2000)</span></div> <div> <div class="wfptf"> <p>Redirect URL → zMerchant system has to redirect customer to this URL to complete payment</p> </div> </div> </div> </td> </tr> </tbody> </table> </div> </div> <div class="responsesDIV"><button class="notiBtn has-text-danger-dark has-background-danger-light" aria-expanded="false"> <svg class="svg-Up svg2" version="1.1" viewbox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true" style="fill: currentColor; color: #cc0f35;"> <polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon> </svg><span>400 </span><span class="sc-jcwpoC DVwyR"></span></button> <h5 class="h5Param">Response Parameter (Error)</h5> <table class="ac-isParent"> <tbody> <tr> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span> <button aria-label="expand properties"><span class="property-name">errorcode</span></button></td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(1..6)</span></div> <div class="wfptf"> <p>In case of error the PAYONE Platform returns an error code for your internal usage.</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="hostedCheckoutSpecificInput"><span class="sLborder"></span> <button aria-label="expand properties"><span class="property-name">errormessage</span></button></td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..1024)</span></div> <div class="wfptf"> <p>In case of error the PAYONE Platform returns an error message for your internal usage.</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="redirectPaymentMethodSpecificInput"><span class="sLborder"></span> <button aria-label="expand properties"><span class="property-name">customermessage</span></button></td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..1024)</span></div> <div class="wfptf"> <p>The customermessage is returned to your system in order to be displayed to the customer.</p> <p>(Language selection is based on the end customer's language, parameter "language")</p> </div> </td> </tr> </tbody> </table> </div> </div> <div class="column is-one-third code-samples-wrap"> <div class="payone-code-lane"><button class="csw-iONbtn mb-2"> <span type="post" class="SpanVerbHttp http-verb http-post"></span> <span class="SpanVerb">/post-gateway/ HTTP/1.1</span> </button></div> <div class="payloadbox codebox"> <pre class="has-text-white p-3 payone-code-background payone-w-100">Host: api.pay1.de<br>Content-Type: application/x-www-form-urlencoded</pre> </div> <div class="payone-codeseperator"></div> <div class="divcopybtn payone-w-100"><button type="button" class="payone-copy-text button payone-is-tiny btn-primary"> <span class="icon-text"> <span class="payone-is-tiny"> <i class="fas fa-regular fa-copy"></i> </span> <span>Copy</span> </span> </button></div> <div class="payloadbox codebox"> <pre class="has-text-white p-3 payone-code-background payone-w-100">Payload <br> <br>aid=52078<br>amount=3499<br>cardholder=max testerei<br>city=Dresden<br>clearingtype=cc<br>country=DE<br>currency=EUR<br>customer_is_present=yes<br>de[1]=Hauptartikel mit Eigenschaften XL<br>de[2]=Hauptartikel mit Kennzeichnung <br>de[3]=Standard Versand<br>email=test@payone.com<br>encoding=UTF-8<br>errorurl=https://yourdomain.dev/failure/appendSession/<br>firstname=Maximillian<br>gender=m<br>id[1]=SW10007.3<br>id[2]=SW10006<br>id[3]=ship9<br>ip=172.19.0.34<br>it[1]=goods<br>it[2]=goods<br>it[3]=shipment<br>key=17031f73e2c6f9755788bddfff04169b<br>language=de<br>lastname=Testerei<br>mid=14648<br>mode=test<br>no[1]=1<br>no[2]=1<br>no[3]=1<br>param=session-1|n2ikm4l9ifpds5p1efv6dede76|f8222c6f3c6999ce98f5198078522be4<br>portalid=2037267<br>pr[1]=1999<br>pr[2]=1500<br>pr[3]=0<br>pseudocardpan=9410010000167640853<br>recurrence=oneclick<br>reference=1234000243<br>request=preauthorization<br>salutation=Herr<br>shipping_city=Dresden<br>shipping_country=DE<br>shipping_firstname=Maximillian<br>shipping_lastname=Testerei<br>shipping_street=Wegeweg 25<br>shipping_zip=01099<br>street=Wegeweg 25<br>successurl=https://yourdomain.dev/success/swPaymentToken/WQXEBlwaY9jx9lZFQyxocKc5Cj86rsU3/appendSession/<br>telephonenumber=01752345678<br>va[1]=1900<br>va[2]=1900<br>va[3]=0<br>zip=01099 </pre> </div> <div class="payone-codeseperator"></div> <div class="divcopybtn payone-w-100"><button type="button" class="payone-copy-text button payone-is-tiny btn-primary"> <span class="icon-text"> <span class="payone-is-tiny"> <i class="fas fa-regular fa-copy"></i> </span> <span>Copy</span> </span> </button></div> <div class="payloadbox codebox"> <pre class="has-text-white p-3 payone-code-background payone-w-100">RESPONSE <br>status=APPROVED<br>txid=987654321 <br>userid=123456789 </pre> </div> </div> </div> </div> <div class="payone-white-content-section"> <h4 class="h4Header" id="Introduction">Sequence Diagrams</h4> <h5 class="h5Param">Redirect with preauthorization</h5> <p><a href="https://docs.payone.com/bl-content/uploads/pages/6198041e689a9f86b7d793a737cebf63/Redirectwithpreauthorization.png" target="_blank" rel="noopener"><img src="https://docs.payone.com/bl-content/uploads/pages/6198041e689a9f86b7d793a737cebf63/Redirectwithpreauthorization.png" alt="" width="700"></a></p> </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/integration/channel-server-api/server-api-preauthorization"; 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>