PAYONE Documentation Platform | Server API

<!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 - Debit </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-debit"/>  </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 payone-breadcrumbs-nav" 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-debit">Server API - Debit</a></li> </ul> </nav> <div class="payone-breadcrumbs-toc"> <div class="navbar-item has-dropdown is-hoverable"> <a class="navbar-link payone-font-smaller"> Table Of Contents </a> <div class="navbar-dropdown payone-navbar-dropdown-toc is-right"> <a href="#introduction" class="navbar-item" style="padding-left: 1rem;"><i class="payone-icon-nano payone-blue-right"></i>  INTRODUCTION</a><a href="#overview" class="navbar-item" style="padding-left: 1rem;"><i class="payone-icon-nano payone-blue-right"></i>  OVERVIEW</a><a href="#integration" class="navbar-item" style="padding-left: 1rem;"><i class="payone-icon-nano payone-blue-right"></i>  INTEGRATION</a> </div> </div> </div> </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-authorization">Client API - Authorization</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-bankaccountcheck">Client API - Bankaccountcheck</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-authorization">Client API - Authorization</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-bankaccountcheck">Client API - Bankaccountcheck</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 id="introduction">Introduction</h3> <div class="payone-white-content-section"> <p>The "debit" request books an outstanding amount to the receivables account. This request can be used instead of the "refund" request. The request offers additional options that are not possible using "refund".</p> <p><strong>Settlement of balances</strong></p> <p>The PAYONE Platform can carry out a settlement of balances for you. If a transaction account has a negative balance it can be captured or paid out in case of a positive balance. The means of payment used for the settlement are always the funds that have been deposited during the process.</p> <p>If you set the parameter "settleaccount" to "no" using the "debit" request, a settlement is not carried out. Only a booking on the transaction account occurs. If you select the value "yes", however, the balance is automatically settled (captured or paid out) by the PAYONE Platform after the request has been carried out.</p> <p>Please notice that the submitted amount does not necessarily correspond with the open balance which is subsequently captured or paid out. This is always the case if the balance was not settled before issuing the request!</p> <p>If you only wish to settle the open balance without booking a new payment request enter zero as the amount and set the "settleaccount" value to "yes". This can be useful e.g. for a refund in the event of an overpayment by the customer or can be used for the repeated collection of an unpaid debit payment. Furthermore, the open balance can be collected using a different type of payment. For this purpose the corresponding payment data must be submitted. This process can e.g. be used for a subsequent collection of an invoice via direct debit or credit card.</p> </div> <h3 id="overview">Overview</h3> <div class="payone-white-content-section"> <table class="payone-simpleTable"> <tbody> <tr> <td class="payone-simpleTd" style="width: 14%;">Credit card</td> <td class="payone-simpleTd" style="width: 24%;">The amount is credited to the customer's card</td> <td class="payone-simpleTd" style="width: 62%; height: 25px;"></td> </tr> <tr> <td class="payone-simpleTd">Debit payment</td> <td class="payone-simpleTd">The customer is reimbursed with the corresponding amount</td> <td class="payone-simpleTd"> <p>For collecting money and debit: According to the new regulation on the transfer of funds (Geldtransferverordnung) address data (name, street, zip, city) is mandatory for cross border bank transfers (EEA / EWR), e.g.: CH, SM, MC, PM, JE, GG. This is mandatory from 2017-11-19.</p> <p>Please use request “updateuser” to update customers address data.</p> <p>This means that the whole address for bank transfers needs to be provided.</p> <p></p> </td> </tr> <tr> <td class="payone-simpleTd">Online transfer</td> <td class="payone-simpleTd"> <p>The customer is reimbursed with the corresponding amount</p> </td> <td class="payone-simpleTd"> <p>Please use request “updateuser” to update customers address data.</p> <p>This means that the whole address for bank transfers needs to be provided.</p> </td> </tr> <tr> <td class="payone-simpleTd">e-wallet</td> <td class="payone-simpleTd">The amount is credited to the customer's e-wallet account</td> <td class="payone-simpleTd"></td> </tr> <tr> <td class="payone-simpleTd">Prepayment</td> <td class="payone-simpleTd"> <p>The customer is reimbursed with the corresponding amount, see footnote Debit payment</p> </td> <td class="payone-simpleTd"> <p>For debit: According to the new regulation on the transfer of funds (Geldtransferverordnung) address data (name, street, zip, city) is mandatory for cross border bank transfers (EEA / EWR), e.g.: CH, SM, MC, PM, JE, GG. This is mandatory from 2017-11-19.</p> <p>Please use request “updateuser” to update customers address data.</p> <p>This means that the whole address for bank transfers needs to be provided.</p> </td> </tr> <tr> <td class="payone-simpleTd">Invoice</td> <td class="payone-simpleTd"> <p>The customer is reimbursed with the corresponding amount, see footnote Debit payment</p> </td> <td class="payone-simpleTd"> <p>For debit: According to the new regulation on the transfer of funds (Geldtransferverordnung) address data (name, street, zip, city) is mandatory for cross border bank transfers (EEA / EWR), e.g.: CH, SM, MC, PM, JE, GG. This is mandatory from 2017-11-19.</p> <p>Please use request “updateuser” to update customers address data.</p> <p>This means that the whole address for bank transfers needs to be provided.</p> </td> </tr> <tr> <td class="payone-simpleTd">Cash on delivery</td> <td class="payone-simpleTd"> <p>The customer is reimbursed with the corresponding amount, see footnote Debit payment</p> </td> <td class="payone-simpleTd"> <p>For debit: According to the new regulation on the transfer of funds (Geldtransferverordnung) address data (name, street, zip, city) is mandatory for cross border bank transfers (EEA / EWR), e.g.: CH, SM, MC, PM, JE, GG. This is mandatory from 2017-11-19.</p> <p>Please use request “updateuser” to update customers address data.</p> <p>This means that the whole address for bank transfers needs to be provided.</p> </td> </tr> </tbody> </table> </div> <h3 id="integration">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 - Debit</pre> <h5 class="h5Param">Account Parameters</h5> <table class="ac-isParent"> <tbody> <tr> <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: debit</span></div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="merchantId"><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> <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> <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> <td class="ac-isParentTD pTDa" title="merchantId"><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 class="ac-isParent"> <tbody> <tr> <td class="ac-isParentTD pTDa" title="merchantId"><span class="sLborder"></span>txid<br> <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis"><span class="dmLkmF lVyis">Format NUMERIC(9..12) <br></span></span></div> <div> <p></p> <p>The txid specifies the payment process within the PAYONE platform.</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="merchantId"><span class="sLborder"></span>sequencenumber<br> <div class="reqUOO reqUn">required</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format NUMERIC(1..3)</span></div> <div><span class="dmLkmF lVyis">Permitted values 0..127</span></div> <div class="wfptf"> <p>Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2</p> <p>Required for multi partial capture (starting with the 2nd capture)</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="merchantId"><span class="sLborder"></span>amount <div class="reqUOO reqUn">required</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> <td class="ac-isParentTD pTDa" title="merchantId"><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> <p>EUR</p> <p>USD</p> <p>GBP</p> <div class="wfptf"> <p>Amount of debit (in smallest currency unit! e.g. cent, max. 19 999 999 99). The amount must be less than or equal to the amount of the corresponding booking. Always provide a negative amount</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="merchantId"><span class="sLborder"></span>narrative_text <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> <td class="ac-isParentTD pTDa" title="merchantId"><span class="sLborder"></span>use_<wbr>customerdata <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: 20%;">Value</th> <th class="payone-simpleTh" style="width: 80%;">Comment</th> </tr> </thead> <tbody> <tr> <td class="payone-simpleTd">yes</td> <td class="payone-simpleTd">Uses current account details from debtor's master data (default)</td> </tr> <tr> <td class="payone-simpleTd">no</td> <td class="payone-simpleTd">Uses the last known account details in the payment process</td> </tr> </tbody> </table> </div> <div> <div class="wfptf"> <p>Use account details from debtor's master data</p> </div> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="merchantId"><span class="sLborder"></span><span class="dmLkmF">transaction_<wbr>param</span><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">Permitted Symbols [0-9][A-Z][a-z][.-_/]</span></div> <div class="wfptf"> <p>Optional parameter for merchant information (per payment request)</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">Parameters (invoice/prepayment/cash on delivery)</h5> <table class="ac-isParent"> <tbody> <tr> <td class="ac-isParentTD pTDa" title="merchantId"><span class="sLborder"></span>iban <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(10..34)</span></div> <div><span class="dmLkmF lVyis">Permitted Symbols [0-9][A-Z]</span></div> <div class="wfptf"> <p>IBAN to be used for payment or to be checked</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="merchantId"><span class="sLborder"></span>bic <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> <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> <td class="ac-isParentTD pTDa" title="merchantId"><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 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> <td class="ac-isParentTD pTDa" title="merchantId"><span class="sLborder"></span>bankaccount <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>Account number (BBAN)</p> <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> <td class="ac-isParentTD pTDa" title="merchantId"><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>Sort code (BBAN) (only in DE)</p> <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> </tbody> </table> <h5 class="h5Param">Parameter (Invoicing)</h5> <table class="ac-isParent"> <tbody> <tr> <td class="ac-isParentTD pTDa" title="merchantId"><span class="sLborder"></span>invoiceid<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..20)</span></div> <div class="wfptf"> <p>Merchant's invoice number</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="merchantId"><span class="sLborder"></span><span class="dmLkmF">invoice_<wbr>deliverymode</span><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: 30%;">Value</th> <th class="payone-simpleTh" style="width: 70%;">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> </div> <div class="wfptf"> <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" title="merchantId"><span class="sLborder"></span><span class="dmLkmF">invoice_<wbr>deliverydate</span><br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format DATE(8), YYYYMMDD</span></div> <div class="wfptf"> <p>Delivery date (YYYYMMDD)</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="merchantId"><span class="sLborder"></span>invoice_<wbr>deliveryenddate <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format DATE(8), YYYYMMDD</span></div> <div class="wfptf"> <p>Delivery end date (YYYYMMDD)</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="merchantId"><span class="sLborder"></span>invoiceappendix <div class="reqUOO optUn">optional</div> </td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format CHAR(1..255)</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>it[n] <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: 28.4884%;">it[n]</th> <th class="payone-simpleTh" style="width: 71.5116%;">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> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="merchantId" 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 Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div><span class="dmLkmF lVyis">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> <td class="ac-isParentTD pTDa" title="merchantId" 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>Unit gross price of the item in smallest unit! e.g. cent.</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" style="width: 24.9575%;"><span class="sLborder"></span>no[n] <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> <td class="ac-isParentTD pTDa" title="merchantId" 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>Description of this item. Will be printed on documents to customer.</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="merchantId" 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)</span></div> <div><span class="dmLkmF lVyis">Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div class="wfptf"> <p>VAT rate (% or bp)</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="merchantId" style="width: 24.9575%;"><span class="sLborder"></span>sd[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb" style="width: 74.8689%;"> <div><span class="dmLkmF lVyis">Format DATE(8), YYYYMMDD</span></div> <div><span class="dmLkmF lVyis">Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div class="wfptf"> <p>Delivery date (YYYYMMDD)</p> </div> </td> </tr> <tr> <td class="ac-isParentTD pTDa" title="merchantId" style="width: 24.9575%;"><span class="sLborder"></span>ed[n]<br> <div class="reqUOO optUn">optional</div> </td> <td class="pTDb" style="width: 74.8689%;"> <div><span class="dmLkmF lVyis">Format DATE(8), YYYYMMDD</span></div> <div><span class="dmLkmF lVyis">Array elements [n] starting with [1]; serially numbered; max [400]</span></div> <div class="wfptf"> <p>Delivery period end date (YYYYMMDD)</p> </div> </td> </tr> </tbody> </table> <h5 class="h5Param">Response Parameters</h5> <table class="ac-isParent"> <tbody> <tr> <td class="ac-isParentTD pTDa" title="merchantId"><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</span></div> <div><span class="dmLkmF lVyis">APPROVED</span></div> <div><span class="dmLkmF lVyis">PENDING</span></div> <div><span class="dmLkmF lVyis">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> <td class="ac-isParentTD pTDa"><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> </tbody> </table> <h5 class="h5Param">Response Parameter (approved) - credit card (if AVS has been ordered)</h5> <table class="ac-isParent"> <tbody> <tr> <td class="ac-isParentTD pTDa"><span class="sLborder"></span>protect_result_avs</td> <td class="pTDb"> <div><span class="dmLkmF lVyis">Format A..1</span></div> <div class="wfptf"> <p>AVS return value</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> <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> </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 (Error)</h5> <table class="ac-isParent"> <tbody> <tr> <td class="ac-isParentTD pTDa"><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"><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 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="icon 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>https://api.pay1.de/post-gateway/<br>add_paydata[cancellation_reason]=undeliverable<br>amount=-1500<br>currency=EUR<br>de[1]=Hauptartikel mit Kennzeichnung<br>de[2]=Standard Versand<br>encoding=UTF-8<br>id[1]=SW10006<br>id[2]=Standard Versand<br>it[1]=goods<br>it[2]=shipment<br>key=17031f73e2c6f9755788bddfff04169b<br>mid=14648<br>mode=test<br>no[1]=1<br>no[2]=1<br>portalid=2040559<br>pr[1]=1500<br>pr[2]=0<br>request=debit<br>sequencenumber=2<br>txid=921178115<br>va[1]=1900<br>va[2]=0</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="icon 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=921178115<br>workorderid=PP2ACD85MMXFG7JY<br>settleaccount=yes </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-debit"; var link = permalink+"#"+id; copyToClipboard(link); }); }); // doc ready </script> <script> /************************ Sticky navbar ************************/ // Declare the function first var myFunction; // When the user scrolls the page, assign myFunction window.onscroll = function() { if (typeof myFunction === "function") { myFunction(); } }; // Get the navbar var navbar = document.getElementById("subnavbar"); // Check if the navbar exists if (navbar) { // Get the offset position of the navbar var sticky = navbar.offsetTop; // Define the function myFunction = function() { if (window.scrollY >= sticky) { navbar.classList.add("sticky"); } else { navbar.classList.remove("sticky"); } }; } </script> <script src="https://docs.payone.com/bl-themes/payone-docs/php/api/api-template.js?version=3.15.0"></script>  </div> </div> <div class="site_footer" id="footcontainer"> <footer class="footer site-footer">  <div class="container">  <div class="footer-column"> <h3 class="h3Footer">PAYONE</h3> <ul> <li><a href="https://www.payone.com/DE-de/agb">Terms and Conditions</a></li> <li><a href="https://www.payone.com/DE-de/impressum">Legal Notice</a></li> <li><a href="/information/privacy-policy">Privacy Policy</a></li> <li><a href="https://www.payone.com/DE-de/ueber-uns/presse">Press</a></li> </ul> </div>  <div class="footer-column"> <h3 class="h3Footer">Service</h3> <ul> <li><a href="https://www.payone.com/DE-de/service/kundenportale">Customer Portals</a></li> <li><a href="https://www.payone.com/DE-de/ueber-uns/partner">Partner</a></li> <li><a href="https://github.com/PAYONE-GmbH">Github</a></li> <li><a href="https://www.payone.com/DE-de/service/downloads">Downloads</a></li> <li><a href="https://www.payone.com/DE-de/service/kontakt">Contact</a></li> <li><a href="https://www.payone.com/DE-de/service/feedback-beschwerde">Feedback</a></li> </ul> </div>  <div class="footer-column"> </div>  <div class="footer-column-social">  <div class="social-links" style="width: 100%;justify-content: space-evenly;"> <p> <a href="https://www.instagram.com/payone_gmbh/" style="padding: 5px;"> <i class="payone-icon-medium payone-black-instagram"></i></a> <a href="https://www.linkedin.com/company/payone_gmbh" style="padding: 5px;"> <i class="payone-icon-medium payone-black-linkedin"></i></a> <a href="https://www.facebook.com/PAYONEGmbH/"><i class="payone-icon-medium payone-black-facebook"></i></a> <a href="https://github.com/PAYONE-GmbH/" style="padding: 5px;"> <i class="payone-icon-medium payone-black-github"></i></a> <a href="https://www.youtube.com/channel/UCM7Eky84PKzkyTILI6xga-Q" style="padding: 5px;"> <i class="payone-icon-medium payone-black-youtube"></i></a> </p> </div> </div> <div class="footer-column-copyright">  <div class="footer-powered-copyright"> <p ><span style="font-size:13px;">© PAYONE GmbH, Powered by <a target="_blank" class="text-white" href="https://www.bludit.com">Bludit</a></span></p> </div> </div> <div class="footer-column-worldline">  <div class="logo-text"> <img src="//media3.payone.com/f/64176/4200x387/933f1413c4/payone_worldline_endorsement_dunkelgrau.png" alt="" style="max-width:200px;"> </div> </div> </div> </footer> </div> <button id="backToTopBtn" title="Go to page start"></button> </body> </html>

CINXE.COM

PAYONE Documentation Platform | Server API - Debit