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 - Createaccess </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-createaccess"/>  </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-createaccess">Server API - Createaccess</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>For processing a purchase transaction in connection with session management or with initiating a subscription.</p> <p>This request is only available with the version "Access".</p> </div> <h3>Important notes</h3> <div class="payone-white-content-section"> <p>For the time-based settlement of goods or subscriptions you must first create offers in your merchant area.<br>You have the option to submit values that overwrite the settings for the offer used (e.g. price, term, etc.). These optional submitted values will be used for all following periods of this contract. The original offer is not changed.</p> <p>If the time at which access is first granted is in the future or the initial term is free of charge, a reservation, which will later be cancelled automatically, is carried out. The amount for the reservation is one payment unit (e.g. 1 EUR). This procedure is simply used to verify the customer's payment data and to check the customer data using risk checks, provided that these are active. The first "real" booking will be effected at the start of the first period that requires a charge.<br>The periods (defined by “period_unit_trail”, “period_length_trail”, “period_unit_recurring”, “period_length_ recurring”) are limited to 60 months.</p> </div> <h3>Integration</h3> <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 - Createaccess</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: createaccess</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, 4-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">Format LIST</span></div> </td> </tr> <tr> <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"><span class="dmLkmF lVyis">Format CHAR(1..20)</span></span></div> <div><span class="dmLkmF lVyis"><span class="dmLkmF lVyis">Permitted Symbols<br>[0-9][a-z][A-Z], .,-,_,/<br> </span></span></div> <div class="wfptf"> <p>Merchant reference number for the payment process (case insensitive)</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>productid<br> <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(1..7) <br><br></span></div> <div class="wfptf"> <p>ID for the offer</p> </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> <p>This parameter is passed on to all follow-up bookings of the same contract</p> </div> </div> </td> </tr> <tr title="narrative_text"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>accessname<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..32)</span></div> <div> <div class="wfptf"> <p>Customer's user name</p> </div> </div> </td> </tr> <tr title="customer_is_present"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>accesscode<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..32)<br></span></div> <div class="wfptf"> <p>Customer's password</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>access_starttime<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis"><span class="dmLkmF lVyis">Format Unixtimestamp</span></span></div> <div class="wfptf"> <p>Access starting date as Unixtimestamp</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>access_expiretime<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis"><span class="dmLkmF lVyis">Format Unixtimestamp</span></span></div> <div class="wfptf"> <p>Can be either used with creating a new access (createaccess)<br>-> Set expiry date/time of the initial term as Unixtimestamp (e.g. date of first renewal)</p> <p>deprecated, should not be used. Please use “period_unit_trail”, “period_length_trail” instead.<br>do not use with “period_unit_trail”, “period_length_trail”<br>or used with updating an existing access (updateaccess)<br>-> Update expiry date/time of the current term as Unixtimestamp (e.g. overwrite date of next renewal)</p> <br><span class="dmLkmF lVyis"></span></div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>access_canceltime<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis"><span class="dmLkmF lVyis">Format Unixtimestamp</span></span></div> <div class="wfptf"> <p>Date of cancellation as Unixtimestamp in the future (after this date no further renewals will be carried out)</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>amount_trail<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis"><span class="dmLkmF lVyis">Format NUMERIC(1..8), max. value 999 999 99</span></span></div> <div class="wfptf"> <p>Total gross amount for initial term</p> <p>Must equal the sum (quantity x price) of all items for the initial term.</p> <p>Required when item is submitted.</p> <p>Amount can be "0" (e.g. for test period).</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>period_unit_trail<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis"><span class="dmLkmF lVyis">Format LIST</span></span></div> <div> <table class="payone-simpleTable" style="width: 68.7621%;"> <thead> <tr> <th class="payone-simpleTh" style="width: 21.5649%;">Value</th> <th class="payone-simpleTh" style="width: 78.4351%;">Comment</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd" style="width: 21.5649%;">Y</td> <td class="payone-simpleTd" style="width: 78.4351%;">Value “length” is in years</td> </tr> <tr> <td class="payone-simpleTd" style="width: 21.5649%;">M</td> <td class="payone-simpleTd" style="width: 78.4351%;">Value “length” is in months</td> </tr> <tr> <td class="payone-simpleTd" style="width: 21.5649%;">D</td> <td class="payone-simpleTd" style="width: 78.4351%;">Value “length” is in days</td> </tr> </tbody> </table> <p></p> </div> <div> <p>Time unit for initial term</p> <p>Do not use with “access_expiretime”.</p> <p>Do not exceed 5 years / 60 months.</p> <br><span class="dmLkmF lVyis"></span></div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>period_length_trail<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis"><span class="dmLkmF lVyis">Format NUMERIC(1..4)</span></span></div> <div><span class="dmLkmF lVyis"><span class="dmLkmF lVyis"> </span></span></div> <div class="wfptf"> <p>Duration of the initial term. Can only be used in combination with period_unit_trail.</p> <p>Required when period_unit_trail is submitted.</p> <p>Do not use with “access_expiretime”</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>amount_recurring<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis"><span class="dmLkmF lVyis">Format NUMERIC(1..8), max. value 999 999 99</span></span></div> <div class="wfptf"> <p>Total gross amount of all items of one period during the subsequent term</p> <p>Must equal the sum (quantity x price) of all items during the subsequent term.</p> <p>Required when item is submitted.</p> <p>Amount must not be "0".</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>period_unit_recurring<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis"><span class="dmLkmF lVyis">Format LIST </span></span></div> <div> <table class="payone-simpleTable" style="width: 69.8691%;"> <thead> <tr> <th class="payone-simpleTh" style="width: 22%;">Value</th> <th class="payone-simpleTh" style="width: 77%;">Comment</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd" style="width: 22%;">Y</td> <td class="payone-simpleTd" style="width: 77%;">Value “length” is in years</td> </tr> <tr> <td class="payone-simpleTd" style="width: 22%;">M</td> <td class="payone-simpleTd" style="width: 77%;">Value “length” is in months</td> </tr> <tr> <td class="payone-simpleTd" style="width: 22%;">D</td> <td class="payone-simpleTd" style="width: 77%;">Value “length” is in days</td> </tr> <tr> <td class="payone-simpleTd" style="width: 22%;">N</td> <td class="payone-simpleTd" style="width: 77%;">No subsequent term given</td> </tr> </tbody> </table> <p></p> </div> <div> <p>Time unit for subsequent term</p> <p>Do not exceed 5 years / 60 months.</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>period_length_recurring<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis"><span class="dmLkmF lVyis">Format NUMERIC(1..4)</span></span></div> <div class="wfptf"> <p>Duration of the subsequent term. Can only be used in combination with period_unit_recurring.</p> <p>Required when period_length_recurring is submitted.</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">Parameter (module billing)</h5> <table class="ac-isParent"> <tbody> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>vaccountname<br> <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..20)</span></div> <div><span class="dmLkmF lVyis">Permitted Symbols<br>[0-9, a-z, A-Z, .,-,_,/]<br> </span></div> <div class="wfptf"> <p>ID/name of the merchant's billing account</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>settle_period_length<br> <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(1..3)</span></div> <div class="wfptf"> <p>Length of the accounting period</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>settle_period_unit<br> <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div> <table class="payone-simpleTable" style="width: 70.2354%;"> <thead> <tr> <th class="payone-simpleTh" style="width: 23%;">Value</th> <th class="payone-simpleTh" style="width: 77%;">Comment</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd" style="width: 23%;">Y</td> <td class="payone-simpleTd" style="width: 77%;">Value “length” is in years</td> </tr> <tr> <td class="payone-simpleTd" style="width: 23%;">M</td> <td class="payone-simpleTd" style="width: 77%;">Value “length” is in months</td> </tr> <tr> <td class="payone-simpleTd" style="width: 23%;">D</td> <td class="payone-simpleTd" style="width: 77%;">Value “length” is in days</td> </tr> <tr> <td class="payone-simpleTd" style="width: 23%;">N</td> <td class="payone-simpleTd" style="width: 77%;">No subsequent term given</td> </tr> </tbody> </table> </div> <div class="wfptf"> <p>Time unit of the accounting period</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>settletime<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format Unixtimestamp</span></div> <div class="wfptf"> <p>Date for the next invoicing Unixtimestamp in the future.</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>payout_open_balance<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div> <table class="payone-simpleTable" style="width: 81.6887%;"> <thead> <tr> <th class="payone-simpleTh" style="width: 22.1099%;">Value</th> <th class="payone-simpleTh" style="width: 77.8901%;">Comment</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd" style="width: 22.1099%;">yes</td> <td class="payone-simpleTd" style="width: 77.8901%;">Amount will be credited immediately (default)</td> </tr> <tr> <td class="payone-simpleTd" style="width: 22.1099%;">no</td> <td class="payone-simpleTd" style="width: 77.8901%;">Credited amount will be offset with the subsequent transaction</td> </tr> </tbody> </table> </div> <div class="wfptf"> <p>Credits will be booked on the most recent payment process.</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">Parameter (module Invoicing)</h5> <table class="ac-isParent"> <tbody> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>invoice_deliverymode<br> <div class="reqUOO optUn">optional</div> </td> <td> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div class="wfptf"> <table class="payone-simpleTable"> <thead> <tr> <th class="payone-simpleTh" style="width: 34%;">Value</th> <th class="payone-simpleTh" style="width: 66%;">Comment</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd">M</td> <td class="payone-simpleTd">Postal Mail</td> </tr> <tr> <td class="payone-simpleTd">P</td> <td class="payone-simpleTd">PDF (via email)</td> </tr> <tr> <td class="payone-simpleTd">N</td> <td class="payone-simpleTd">no delivery</td> </tr> </tbody> </table> <p>Parameter defines how documents like invoice, credit notes and reminders should be sent to the customer.</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>invoiceappendix<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..255)</span><span class="dmLkmF lVyis"></span></div> <div class="wfptf"> <p>Dynamic text on the invoice</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>id_trail[n]<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">Array 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>Product number, order number, etc. of this item (initial term)</p> </div> </td> </tr> <tr title="pr[n]"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>pr_trail[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(8) max. 19 999 999 99</span></div> <div class="wfptf"> <p>Quantity of this item (initial term)</p> </div> </td> </tr> <tr title="no[n]"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>no_trail[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(5)<br>Array Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div class="wfptf"> <p>Quantity of this item (initial term)</p> </div> </td> </tr> <tr title="de[n]"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>de_trail[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..255)<br>Array Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div><span class="dmLkmF lVyis">Example</span></div> <div>de[1]=Product 1</div> <div>de[2]=Product 2</div> <div>de[3]=Product 3</div> <div>...</div> <div>de[100]=Product 100</div> <div class="wfptf"> <p>Description of this item (initial term)</p> </div> </td> </tr> <tr title="va[n]"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>va_trail[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(4)</span></div> <div><span class="dmLkmF lVyis">Array Array elements [n] starting with [1]; serially numbered; max [400]<br></span></div> <div><span class="dmLkmF lVyis"></span></div> <div class="wfptf"> <p>VAT rate (% or bp) (first term)</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>ti_trail[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..100)</span></div> <div><span class="dmLkmF lVyis">Array Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div><span class="dmLkmF lVyis"></span></div> <div class="wfptf"> <p>Title (initial term)</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>id_recurring[n]<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">Array 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>Product number, order number, etc. of this item (subsequent term)</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>no_recurring[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(5)</span></div> <div><span class="dmLkmF lVyis">Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted Symbols [0-9][a-z][A-Z], .,-,_,/</span></div> <div><span class="dmLkmF lVyis"></span></div> <div class="wfptf"> <p>Quantity of this item (subsequent term)</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>pr_recurring[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(8) max. 999 999 99</span></div> <div><span class="dmLkmF lVyis">Array Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div><span class="dmLkmF lVyis"></span></div> <div class="wfptf"> <p>Unit gross price of the item (subsequent term) in smallest unit.</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>de_recurring[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..255)</span></div> <div><span class="dmLkmF lVyis">Array Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div><span class="dmLkmF lVyis">Example</span></div> <div>de[1]=Product 1</div> <div>de[2]=Product 2</div> <div>de[3]=Product 3</div> <div>...</div> <div>de[100]=Product 100</div> <div class="wfptf"> <p>Description of this item (subsequent term)</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>va_recurring[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(4)</span></div> <div><span class="dmLkmF lVyis">Array Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div><span class="dmLkmF lVyis"></span></div> <div class="wfptf"> <p>VAT rate (% or bp) (subsequent term)</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>ti_recurring[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..100)</span></div> <div><span class="dmLkmF lVyis">Array Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div><span class="dmLkmF lVyis"></span></div> <div class="wfptf"> <p>Title (subsequent term)</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">PERSONAL DATA Parameters</h5> <table 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">"customerid" can be used to identify a customer record. <br>If "customerid" is used then stored customer data are loaded automatically.</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) <br>Samples </span></div> <div><span class="dmLkmF lVyis">Dr <br>Prof. <br>Dr.-Ing. </span></div> <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</p> <p>"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</p> <p>"company" or "lastname" or "firstname" plus "lastname"</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</p> <p>"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: 7th floor / c/o Maier</span></div> <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"></span>Format LIST<br><span class="dmLkmF lVyis">Permitted values ISO 3166 2-letter-codes<br>Samples: DE / GB / US</span></div> <div class="wfptf"> <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 class="wfptf"> <p>Permitted values: ISO 3166-2 States (regions) 2-letter-codes</p> <div> <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> <div class="wfptf"> <p>Specifies state / region of country for the customer. <br>"state" is required for these countries: US, CA, <strong>CN</strong>, 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: 20190101 / 19991231</span></div> <div class="wfptf"> <p>Date of birth of customer</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 class="wfptf"> <p>Permitted values ISO 639-1 (Language)2-letter-codes</p> <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="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">PARAMETER (debit payment)</h5> <table class="ac-isParent"> <tbody> <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"><br>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 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"><span>If the mandate_identification is not set PAYONE will create an unique mandate identification (pattern: PO-nnnnnnnnnn).</span></div> <p></p> <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">Parameter (credit card)</h5> <table class="ac-isParent"> <tbody> <tr title="cardpan"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>cardpan<br> <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div class="wfptf"> <p>Primary account number of credit card</p> </div> <div><span class="dmLkmF lVyis">Format NUMERIC(13..19)</span></div> <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> </td> </tr> <tr title="cardtype"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>cardtype<br> <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div class="wfptf"> <p>Primary account number of credit card</p> </div> <div><span class="dmLkmF lVyis">Format LIST</span></div> <div class="wfptf"> <p>Card type of credit card</p> <table class="payone-simpleTable" style="width: 93.8971%;"> <thead> <tr> <th class="payone-simpleTh" style="width: 17%;">Value</th> <th class="payone-simpleTh" style="width: 39%;">Comment</th> <th class="payone-simpleTh" style="width: 84%;">BIN-Range for automatic card type detection</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd" style="width: 17%;">V</td> <td class="payone-simpleTd" style="width: 39%;">Visa</td> <td class="payone-simpleTd" style="width: 84%;">4</td> </tr> <tr> <td class="payone-simpleTd" style="width: 17%;">M</td> <td class="payone-simpleTd" style="width: 39%;">MasterCard</td> <td class="payone-simpleTd" style="width: 84%;">51-55,2221-2720</td> </tr> <tr> <td class="payone-simpleTd" style="width: 17%;">A</td> <td class="payone-simpleTd" style="width: 39%;">American Express</td> <td class="payone-simpleTd" style="width: 84%;">34, 37</td> </tr> <tr> <td class="payone-simpleTd" style="width: 17%;">D</td> <td class="payone-simpleTd" style="width: 39%;">Diners / Discover</td> <td class="payone-simpleTd" style="width: 84%;"> <p>300-305,3095,36,38,39</p> <p>601, 64, 65</p> </td> </tr> <tr> <td class="payone-simpleTd" style="width: 17%;">J</td> <td class="payone-simpleTd" style="width: 39%;">JCB</td> <td class="payone-simpleTd" style="width: 84%;">3528-3589</td> </tr> <tr> <td class="payone-simpleTd" style="width: 17%;">O</td> <td class="payone-simpleTd" style="width: 39%;">Maestro International</td> <td class="payone-simpleTd" style="width: 84%;">50, 56-58,602, 61, 620, 627, 63, 67</td> </tr> <tr> <td class="payone-simpleTd" style="width: 17%;">P</td> <td class="payone-simpleTd" style="width: 39%;">China Union Pay</td> <td class="payone-simpleTd" style="width: 84%;">62212600-62299800,624-626, 6282-6288</td> </tr> <tr> <td class="payone-simpleTd" style="width: 17%;">U</td> <td class="payone-simpleTd" style="width: 39%;">UATP / Airplus</td> <td class="payone-simpleTd" style="width: 84%;">1220, 1920 -> coming soon; not available yet</td> </tr> <tr> <td class="payone-simpleTd" style="width: 17%;">G</td> <td class="payone-simpleTd" style="width: 39%;">girocard</td> <td class="payone-simpleTd" style="width: 84%;">68*</td> </tr> </tbody> </table> <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<br> <div class="reqUOO reqUn">required</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><br> <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="cardholder"> <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">Parameter (3-D Secure)</h5> <table class="ac-isParent"> <tbody> <tr title="xid"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>xid<br> <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..60)</span></div> <div class="wfptf"> <ul style="list-style: '- ' inside;"> <li>either "xid" (from previous 3dscheck)</li> <li>or "successurl", "errorurl", "backurl" must be given.</li> </ul> <p>3-D Secure transaction ID (if the request "3dscheck" was used previous transactions), i.e.:</p> <ul style="list-style: '- ' inside;"> <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="eci"> <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: yes / no</span></div> <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="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"><br>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"> <ul style="list-style: '- ' inside;"> <li>either "xid" (from previous 3dscheck)</li> <li>or "successurl", "errorurl", "backurl" must be given</li> <li>or default "successurl" and "backurl" for a portal are configured within PMI.</li> </ul> <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"><br>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"><br>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">Response Parameters</h5> <table class="ac-isParent"> <tbody> <tr title="status"> <td class="ac-isParentTD pTDa"><span class="sLborder"></span> status</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Permitted Values <br></span></div> <div><span class="dmLkmF lVyis">>APPROVED<br>PENDING<br>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>userid</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="userid"> <td class="ac-isParentTD pTDa" title="hostedCheckoutSpecificInput"><span class="sLborder"></span>accessid</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(3..12)</span></div> <div class="wfptf"> <p>Access ID, defined by PAYONE</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)</h5> <table class="ac-isParent"> <tbody> <tr title="400-txid"> <td class="ac-isParentTD pTDa" title="cardPaymentMethodSpecificInput"><span class="sLborder"></span>txid</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>userid</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="userid"> <td class="ac-isParentTD pTDa" title="hostedCheckoutSpecificInput"><span class="sLborder"></span>accessid</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(3..12)</span></div> <div class="wfptf"> <p>Access 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)</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>userid</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> errorcode</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> errormessage</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> customermessage</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=16442<br>amount_recurring=1599<br>amount_trail=1099<br>api_version=3.11<br>city=Kiel<br>clearingtype=elv<br>country=DE<br>email=jerret-jan.harms@payone.com<br>encoding=UTF-8<br>firstname=Paul<br>iban=DE85123456782599100003<br>invoiceappendix=Das ist eine Testrechnung ...<br>key=3adxxxxxxxxxxxxxxxxxxx1cb9e<br>language=de<br>lastname=Payer<br>mandate_identification=PO-TESTTEST<br>mid=14648<br>mode=test<br>param=c6d922426548b23ecb1346672a97b404<br>period_length_recurring=1<br>period_length_trail=1<br>period_unit_recurring=D<br>period_unit_trail=D<br>portalid=2035<br>productid=6548<br>reference=286419625962056<br>request=createaccess<br>street=Fraunhoferstr. 2 - 4<br>zip=24118</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><br>status=APPROVED<br>txid=1062831600<br>userid=717750373<br>accessid=4634635 </pre> </div> </div> </div> </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-createaccess"; 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>