CINXE.COM
WebSockets API - Connect
<!DOCTYPE html> <html> <head> <meta charset="utf-8"/> <meta name="viewport" content="width=device-width, initial-scale=1.0"/> <title>WebSockets API - Connect</title> <link rel="apple-touch-icon" sizes="76x76" href="/favicons/apple-touch-icon.png?v=dLJendOlMG"> <link rel="icon" type="image/png" sizes="32x32" href="/favicons/favicon-32x32.png?v=dLJendOlMG"> <link rel="icon" type="image/png" sizes="16x16" href="/favicons/favicon-16x16.png?v=dLJendOlMG"> <link rel="manifest" href="/favicons/site.webmanifest?v=dLJendOlMG"> <link rel="mask-icon" href="/favicons/safari-pinned-tab.svg?v=dLJendOlMG" color="#e60975"> <link rel="shortcut icon" href="/favicons/favicon.ico?v=dLJendOlMG"> <meta name="apple-mobile-web-app-title" content="Paymentsense - Connect"> <meta name="application-name" content="Paymentsense - Connect"> <meta name="msapplication-TileColor" content="#e60975"> <meta name="theme-color" content="#ffffff"> <link rel="stylesheet" href="/lib/bootstrap/dist/css/bootstrap.css" /> <link rel="stylesheet" href="/css/site.css?v=od0x-a5VJRY8lWP0uqeC7-jSkMaEc3-QdDKb4sqWCT4" /> <link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet"> <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.0/jquery.min.js"></script> </head> <body> <nav class="navbar navbar-fixed-top bg-white"> <div class="container-fluid"> <div class="navbar-header"> <a class="navbar-brand" href="/"> <img class="connect-docs-logo" src="/images/connect_docs_logo.png" alt="Paymentsense"/> </a> <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="/"> <img class="paymentsense-logo" src="/images/paymentsense-logo-dark.svg" alt="Paymentsense"/> </a> </div> <div id="navbar" class="navbar-collapse collapse navbar-hide bg-gray-fade"> <ul class="nav nav-pills nav-stacked menu-overview"> <li class="title"> <span class="collapse-button pull-right glyphicon glyphicon-chevron-down"></span> <div>Overview</div> </li> <li class="nav-stacked-item"> <a href="/">Introduction</a> </li> </ul> <ul class="nav nav-pills nav-stacked menu-rest-interface"> <li class="title"> <span class="collapse-button pull-right glyphicon glyphicon-chevron-down"></span> <div>REST Interface</div> </li> <li class="nav-stacked-item"> <a href="/rest/getting-started">Getting Started</a> </li> <li class="nav-stacked-item"> <a href="/rest/pac-transaction-flow">PAC Transaction Flow</a> </li> <li class="nav-stacked-item"> <a href="/rest/api">API</a> </li> <li class="nav-stacked-item"> <a href="/rest/error-messages">Built-in user messages</a> </li> <li class="nav-stacked-item"> <a href="/rest/changelog">Changelog</a> </li> </ul> <ul class="nav nav-pills nav-stacked menu-websockets-interface"> <li class="title"> <span class="collapse-button pull-right glyphicon glyphicon-chevron-down"></span> <div>WebSockets Interface</div> </li> <li class="nav-stacked-item"> <a href="/websockets/getting-started">Getting Started</a> </li> <li class="nav-stacked-item"> <a href="/websockets/pac-transaction-flow">PAC Transaction Flow</a> </li> <li class="nav-stacked-item"> <a href="/websockets/api">API</a> </li> <li class="nav-stacked-item"> <a href="/websockets/changelog">Changelog</a> </li> </ul> <ul class="nav nav-pills nav-stacked menu-next-steps"> <li class="title"> <span class="collapse-button pull-right glyphicon glyphicon-chevron-down"></span> <div>Next Steps</div> </li> <li class="nav-stacked-item"> <a href="/next-steps/integration-checklist">Integration Checklist</a> </li> <li class="nav-stacked-item"> <a href="/next-steps/qa-process">QA Process</a> </li> </ul> <ul class="nav nav-pills nav-stacked menu-help-support"> <li class="title"> <span class="collapse-button pull-right glyphicon glyphicon-chevron-down"></span> <div>Help & Support</div> </li> <li class="nav-stacked-item"> <a href="/pdq/test-cards">Test Cards</a> </li> <li class="nav-stacked-item"> <a href="/pdq/invoking-scenarios">Invoking Scenarios</a> </li> <li class="nav-stacked-item"> <a href="/faqs">FAQs</a> </li> </ul> <ul class="nav nav-pills nav-stacked menu-ingenico-guides"> <li class="title"> <span class="collapse-button pull-right glyphicon glyphicon-chevron-down"></span> <div>Ingenico PDQ Guides</div> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/ict-setup">iCT Setup</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/iwl-setup">iWL Setup</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/internet-connectivity">Checking Internet Connectivity</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/static-ip">Setting a Static IP Address</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/tms-call">Performing a TMS Call</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/pair-base">Pairing an iWL to a base</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/standalone-mode">Switching to Standalone Mode</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/supervisor-password">Changing the Supervisor Password</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/configuration-options">Configuration Options</a> </li> </ul> <ul class="nav nav-pills nav-stacked menu-connect-e"> <li class="title"> <span class="collapse-button pull-right glyphicon glyphicon-chevron-down"></span> <div>Connect-E</div> </li> <li class="nav-stacked-item"> <a href="/ConnectE/GettingStarted">Getting Started</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/PaymentsFlows">Payment Flows</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/BestPractice">Best Practices</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/Standard">Standard - One off Payment</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/RecurringPayment">Standard - Repeat Payment</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/WaitPreExecuteOneOffPayment">Wait Pre-execute - One off Payment</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/WaitPreExecuteRecurringPayment">Wait Pre-execute - Repeat Payment</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/SavePaymentMethodOneOffPayment">Save Payment Method - One off Payment</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/Checkout">Checkout</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/Wallet">Wallet</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/ApplePay">Apple Pay™</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/GooglePay">Google Pay™</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/Webhooks">Webhooks</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/RestApi">REST API</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/SettingUpTestAccount">Setup Test Account</a> </li> </ul> </div> </div> </nav> <div class="box bg-gray-fade"> <div class="flex-row header"> <div class="sidebar side-nav" role="navigation"> <ul class="nav nav-pills nav-stacked menu-overview"> <li class="title"> <span class="collapse-button pull-right glyphicon glyphicon-chevron-down"></span> <div>Overview</div> </li> <li class="nav-stacked-item"> <a href="/">Introduction</a> </li> </ul> <ul class="nav nav-pills nav-stacked menu-rest-interface"> <li class="title"> <span class="collapse-button pull-right glyphicon glyphicon-chevron-down"></span> <div>REST Interface</div> </li> <li class="nav-stacked-item"> <a href="/rest/getting-started">Getting Started</a> </li> <li class="nav-stacked-item"> <a href="/rest/pac-transaction-flow">PAC Transaction Flow</a> </li> <li class="nav-stacked-item"> <a href="/rest/api">API</a> </li> <li class="nav-stacked-item"> <a href="/rest/error-messages">Built-in user messages</a> </li> <li class="nav-stacked-item"> <a href="/rest/changelog">Changelog</a> </li> </ul> <ul class="nav nav-pills nav-stacked menu-websockets-interface"> <li class="title"> <span class="collapse-button pull-right glyphicon glyphicon-chevron-down"></span> <div>WebSockets Interface</div> </li> <li class="nav-stacked-item"> <a href="/websockets/getting-started">Getting Started</a> </li> <li class="nav-stacked-item"> <a href="/websockets/pac-transaction-flow">PAC Transaction Flow</a> </li> <li class="nav-stacked-item"> <a href="/websockets/api">API</a> </li> <li class="nav-stacked-item"> <a href="/websockets/changelog">Changelog</a> </li> </ul> <ul class="nav nav-pills nav-stacked menu-next-steps"> <li class="title"> <span class="collapse-button pull-right glyphicon glyphicon-chevron-down"></span> <div>Next Steps</div> </li> <li class="nav-stacked-item"> <a href="/next-steps/integration-checklist">Integration Checklist</a> </li> <li class="nav-stacked-item"> <a href="/next-steps/qa-process">QA Process</a> </li> </ul> <ul class="nav nav-pills nav-stacked menu-help-support"> <li class="title"> <span class="collapse-button pull-right glyphicon glyphicon-chevron-down"></span> <div>Help & Support</div> </li> <li class="nav-stacked-item"> <a href="/pdq/test-cards">Test Cards</a> </li> <li class="nav-stacked-item"> <a href="/pdq/invoking-scenarios">Invoking Scenarios</a> </li> <li class="nav-stacked-item"> <a href="/faqs">FAQs</a> </li> </ul> <ul class="nav nav-pills nav-stacked menu-ingenico-guides"> <li class="title"> <span class="collapse-button pull-right glyphicon glyphicon-chevron-down"></span> <div>Ingenico PDQ Guides</div> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/ict-setup">iCT Setup</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/iwl-setup">iWL Setup</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/internet-connectivity">Checking Internet Connectivity</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/static-ip">Setting a Static IP Address</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/tms-call">Performing a TMS Call</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/pair-base">Pairing an iWL to a base</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/standalone-mode">Switching to Standalone Mode</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/supervisor-password">Changing the Supervisor Password</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/software-version">Checking the Software Version</a> </li> <li class="nav-stacked-item"> <a href="/pdq/ingenico/configuration-options">Configuration Options</a> </li> </ul> <ul class="nav nav-pills nav-stacked menu-connect-e"> <li class="title"> <span class="collapse-button pull-right glyphicon glyphicon-chevron-down"></span> <div>Connect-E</div> </li> <li class="nav-stacked-item"> <a href="/ConnectE/GettingStarted">Getting Started</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/PaymentsFlows">Payment Flows</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/BestPractice">Best Practices</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/Standard">Standard - One off Payment</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/RecurringPayment">Standard - Repeat Payment</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/WaitPreExecuteOneOffPayment">Wait Pre-execute - One off Payment</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/WaitPreExecuteRecurringPayment">Wait Pre-execute - Repeat Payment</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/SavePaymentMethodOneOffPayment">Save Payment Method - One off Payment</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/Checkout">Checkout</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/Wallet">Wallet</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/ApplePay">Apple Pay™</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/GooglePay">Google Pay™</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/Webhooks">Webhooks</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/RestApi">REST API</a> </li> <li class="nav-stacked-item"> <a href="/ConnectE/SettingUpTestAccount">Setup Test Account</a> </li> </ul> </div> </div> <div class="flex-row content container-fluid main-content"> <div class="page-header"> <h1>WebSockets API <select onclick="" id="version-selector"><option value="v1">v1</option><option value="v0">v0</option></select></h1> <p>For versioning see <a href="/websockets/getting-started">"API Version Header"</a> and <a href="/websockets/changelog">changelog</a>.</p> </div> <div class="new-version-warning alert alert-warning" role="alert"> <h4 class="alert-heading">Warning!</h4> <p>Some features in this API version (e.g. cashback via the API) will not work without an updated terminal software. You can check the version on your PDQ by following the steps <a href="/pdq/ingenico/software-version">here</a>. If this is not x053 or greater (e.g. 9053 or 4054), please contact us.</p> </div> <p>Every message sent across the connection has been documented below using a JSON schema which defines the structure of the message. Each JSON Schema is also provided in its raw form so it can be used to validate any messages whilst developing your integration.</p> <div class="websocket-api separated-text-section"> <h2>Pay-At-Counter</h2> <div class="ws-message-extra-info" id="extrainfo_Pay-At-Counter"> <p>Loading Content ...</p> </div> <div class="ws-endpoint-group"> <h3 class="collapsible-section-header" data-toggle="collapse" data-target="#epos-to-connect-requests0"> <a>EPOS To Connect Requests</a> </h3> <ul id="epos-to-connect-requests0" class="ws-endpoint-list collapse"> <li class="ws-endpoint-item" id="CtSR_connectedTerminals"> <h3 class="collapsible-section-header" data-toggle="collapse" data-target="#connected-terminals0"> <a>Connected Terminals </a> </h3> <div id="connected-terminals0" class="ws-endpoint-data collapse"> <h3>Request Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_CtSR_connectedTerminals_Request"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/CtSR_connectedTerminals_Request.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_CtSR_connectedTerminals_Request"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example 1</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_connectedTerminals_Request_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 2</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_connectedTerminals_Request_Example_2"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> <h3>Response Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_CtSR_connectedTerminals_Response"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/CtSR_connectedTerminals_Response.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_CtSR_connectedTerminals_Response"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example 1</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_connectedTerminals_Response_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 2</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_connectedTerminals_Response_Example_2"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> </div> </li> <li class="ws-endpoint-item" id="CtSR_terminalDetails"> <h3 class="collapsible-section-header" data-toggle="collapse" data-target="#terminal-details0"> <a>Terminal Details </a> </h3> <div id="terminal-details0" class="ws-endpoint-data collapse"> <h3>Request Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_CtSR_terminalDetails_Request"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/CtSR_terminalDetails_Request.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_CtSR_terminalDetails_Request"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_terminalDetails_Request_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> <h3>Response Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_CtSR_terminalDetails_Response"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/CtSR_terminalDetails_Response.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_CtSR_terminalDetails_Response"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_terminalDetails_Response_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> </div> </li> <li class="ws-endpoint-item" id="CtSR_PerformTransaction"> <h3 class="collapsible-section-header" data-toggle="collapse" data-target="#perform-transaction0"> <a>Perform Transaction </a> </h3> <div id="perform-transaction0" class="ws-endpoint-data collapse"> <h3>Request Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_CtSR_PerformTransaction_Request"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/CtSR_PerformTransaction_Request.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_CtSR_PerformTransaction_Request"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example 1</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_PerformTransaction_Request_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 2</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_PerformTransaction_Request_Example_2"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> <h3>Response Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_CtSR_PerformTransaction_Response"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/CtSR_PerformTransaction_Response.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_CtSR_PerformTransaction_Response"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example 1</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_PerformTransaction_Response_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 2</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_PerformTransaction_Response_Example_2"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> </div> </li> <li class="ws-endpoint-item" id="CtSR_cancelTransaction"> <h3 class="collapsible-section-header" data-toggle="collapse" data-target="#cancel-transaction0"> <a>Cancel Transaction </a> </h3> <div id="cancel-transaction0" class="ws-endpoint-data collapse"> <h3>Request Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_CtSR_cancelTransaction_Request"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/CtSR_cancelTransaction_Request.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_CtSR_cancelTransaction_Request"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_cancelTransaction_Request_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> <h3>Response Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_CtSR_cancelTransaction_Response"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/CtSR_cancelTransaction_Response.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_CtSR_cancelTransaction_Response"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_cancelTransaction_Response_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> </div> </li> <li class="ws-endpoint-item" id="CtSR_duplicate"> <h3 class="collapsible-section-header" data-toggle="collapse" data-target="#duplicate0"> <a>Duplicate <span> (Ingenico Only)</span> </a> </h3> <div id="duplicate0" class="ws-endpoint-data collapse"> <h3>Request Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_CtSR_duplicate_Request"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/CtSR_duplicate_Request.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_CtSR_duplicate_Request"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_duplicate_Request_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> <h3>Response Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_CtSR_duplicate_Response"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/CtSR_duplicate_Response.json" target="_blank">link</a></p> </div> <h4>Example</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_duplicate_Response_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> </div> </li> <li class="ws-endpoint-item" id="CtSR_Report"> <h3 class="collapsible-section-header" data-toggle="collapse" data-target="#report0"> <a>Report <span> (Ingenico Only)</span> </a> </h3> <div id="report0" class="ws-endpoint-data collapse"> <h3>Request Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_CtSR_Report_Request"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/CtSR_Report_Request.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_CtSR_Report_Request"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example 1</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_Report_Request_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 2</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_Report_Request_Example_2"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> <h3>Response Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_CtSR_Report_Response"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/CtSR_Report_Response.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_CtSR_Report_Response"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example 1</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_Report_Response_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 2</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_CtSR_Report_Response_Example_2"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> </div> </li> </ul> <h3 class="collapsible-section-header" data-toggle="collapse" data-target="#connect-to-epos-requests1"> <a>Connect To EPOS Requests</a> </h3> <ul id="connect-to-epos-requests1" class="ws-endpoint-list collapse"> <li class="ws-endpoint-item" id="StCR_verifySignature"> <h3 class="collapsible-section-header" data-toggle="collapse" data-target="#verify-signature1"> <a>Verify Signature </a> </h3> <div id="verify-signature1" class="ws-endpoint-data collapse"> <h3>Request Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_StCR_verifySignature_Request"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/StCR_verifySignature_Request.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_StCR_verifySignature_Request"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_StCR_verifySignature_Request_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> <h3>Response Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_StCR_verifySignature_Response"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/StCR_verifySignature_Response.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_StCR_verifySignature_Response"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_StCR_verifySignature_Response_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> </div> </li> </ul> <h3 class="collapsible-section-header" data-toggle="collapse" data-target="#connect-to-epos-notifications2"> <a>Connect To EPOS Notifications</a> </h3> <ul id="connect-to-epos-notifications2" class="ws-endpoint-list collapse"> <li class="ws-endpoint-item" id="StCN_terminalNotification"> <h3 class="collapsible-section-header" data-toggle="collapse" data-target="#terminal-notification2"> <a>Terminal Notification </a> </h3> <div id="terminal-notification2" class="ws-endpoint-data collapse"> <h3>Notification Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_StCN_terminalNotification"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/StCN_terminalNotification.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_StCN_terminalNotification"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="col-xs-12 col-sm-12"> <article class="ws-message-example" id="example_StCN_terminalNotification_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> </div> </li> </ul> <h3 class="collapsible-section-header" data-toggle="collapse" data-target="#connect-to-epos-error3"> <a>Connect To EPOS Error</a> </h3> <ul id="connect-to-epos-error3" class="ws-endpoint-list collapse"> <li class="ws-endpoint-item" id="StCE_ErrorMessage"> <h3 class="collapsible-section-header" data-toggle="collapse" data-target="#error3"> <a>Error </a> </h3> <div id="error3" class="ws-endpoint-data collapse"> <h3>Error Message</h3> <div class="ws-endpoint-message"> <h4>JSON Schema</h4> <div class="ws-message-info"> <article class="ws-message-schema" id="schema_StCE_ErrorMessage"> <p>***Error: Content has failed to load.***</p> </article> <p>Raw JSON schema: <a href="/postmatic_html/schemas/StCE_ErrorMessage.json" target="_blank">link</a></p> </div> <h4>Additional Information</h4> <div class="ws-message-info"> <div class="ws-message-extra-info" id="extrainfo_StCE_ErrorMessage"> <p>***Error: Content has failed to load.***</p> </div> </div> <h4>Example 1</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Message To Connect</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_Request"> <p>***Error: Content has failed to load.***</p> </article> </div> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Error Message To EPoS</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 2</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Message To Connect</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_2_Request"> <p>***Error: Content has failed to load.***</p> </article> </div> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Error Message To EPoS</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_2"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 3</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Message To Connect</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_3_Request"> <p>***Error: Content has failed to load.***</p> </article> </div> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Error Message To EPoS</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_3"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 4</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Message To Connect</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_4_Request"> <p>***Error: Content has failed to load.***</p> </article> </div> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Error Message To EPoS</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_4"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 5</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Message To Connect</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_5_Request"> <p>***Error: Content has failed to load.***</p> </article> </div> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Error Message To EPoS</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_5"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 6</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Message To Connect</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_6_Request"> <p>***Error: Content has failed to load.***</p> </article> </div> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Error Message To EPoS</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_6"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 7</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Message To Connect</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_7_Request"> <p>***Error: Content has failed to load.***</p> </article> </div> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Error Message To EPoS</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_7"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 8</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Message To Connect</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_8_Request"> <p>***Error: Content has failed to load.***</p> </article> </div> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Error Message To EPoS</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_8"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 9</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Message To Connect</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_9_Request"> <p>***Error: Content has failed to load.***</p> </article> </div> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Error Message To EPoS</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_9"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> <h4>Example 10</h4> <div class="row ws-message-info ws-message-examples-container"> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Message To Connect</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_10_Request"> <p>***Error: Content has failed to load.***</p> </article> </div> <div class="ws-error-example col-xs-12 col-sm-6"> <h5>Error Message To EPoS</h5> <article class="ws-message-example" id="example_StCE_ErrorMessage_Example_10"> <p>***Error: Content has failed to load.***</p> </article> </div> </div> </div> </div> </li> </ul> </div> </div> <div class="separated-text-section"> <h2>Pay-At-Table</h2> <p>See our <a href="https://docs.dojo.tech/tables/">Tables API</a> documentation for more information.</p> </div> <div class="separated-text-section"> <p> All JSON schemas use <a href="http://json-schema.org/draft-04/schema#" target="_blank">http://json-schema.org/draft-04/schema#</a>. </p> <p> Documentation of JSON Schemas built using <a href="https://www.github.com/mattyod/matic/" target="_blank">Matic.js</a>. </p> <p> Messages over the WebSocket connection use JSON following the <a href="http://www.jsonrpc.org/specification" target="_blank">JSON-RPC2 Protocol</a>. </p> </div> <h2>Next Steps</h2> <p>Once you've completed the integration, use the <a href="/next-steps/integration-checklist">Checklist</a> to ensure that everything has been implemented as expected.</p> <script type="text/javascript" id="embedJSONSchemas"> function applyMaticJsToElement($element) { $element.find('.new-block').each(function () { //if ($(this).prev('.parent').text() != '"properties":') { if (!$(this).parent().parent().is('article')) { $(this).hide(); } else { $(this).prev('.parent').toggleClass('uncollapsed') } }); $element.find('.parent').each(function () { $(this).on('click', function () { $(this).next('.new-block').toggle(200); $(this).toggleClass('uncollapsed') }); }); }; function embedSchema(article) { $article = $(article); var articleId = $article.attr('id'); var filename = '/postmatic_html/' + articleId.replace(/^schema_/, '').replace(/---/g, '') + '.html'; // Any hyphens '---' in an endpoint ID are ignored by jquery AJAX code so html elements can point to the same resources. $.get(filename, function (data, status) { var idSelector = '#' + articleId; $pageArticle = $(idSelector); if (status == 'success') { var wrapper = '<div></div>'; var $wrappedData = $(wrapper).html(data); var article = $wrappedData.find('#schema'); $pageArticle.html(article.html()); applyMaticJsToElement($pageArticle); } else { article.html('<p>Error: Could not embed schema documentation.</p>'); } }); }; $(document).ready(function () { $('.ws-message-schema').each(function () { embedSchema($(this)); }); }); </script> <script type="text/javascript" id="embedExtraInfo"> function embedExtraInfo(div) { $div = $(div); var filename = '/websockets/extra_info.html'; var ajaxInput = filename + ' ' + '#' + $div.attr('id').replace(/^extrainfo_/, 'extrainfo_content_').replace(/---/g, ''); // Any hyphens '---' in an endpoint ID are ignored by jquery AJAX code so html elements can point to the same resources. div.load(ajaxInput); }; $(document).ready(function () { $('.ws-message-extra-info').each(function () { embedExtraInfo($(this)); }); }); </script> <script type="text/javascript" id="embedExamples"> function embedExample(article) { $article = $(article); var filename = '/js/Examples/' + $article.attr('id').replace(/^example_/, '').replace(/---/g, '') + '.json'; // Any hyphens '---' in an endpoint ID are ignored by jquery AJAX code so html elements can point to the same resources. $article.html('<div><pre></pre></div>'); $pre = $article.find('pre'); $pre.load(filename); }; $(document).ready(function () { $('.ws-message-example').each(function () { embedExample($(this)); }); }); </script> <script type="text/javascript" id="openCollapsableIfUrlAnchor"> $(document).ready(function () { if (location.hash && $(location.hash).length == 1 && $(location.hash).children('div.collapse').length == 1) { if ($(location.hash).parents('.collapse').length > 0) { $(location.hash).parents('.collapse').collapse('show'); } $(location.hash).children('div.collapse').collapse('show'); } }); </script> <script type="text/javascript"> $('#version-selector').change(function () { version = $("#version-selector").val(); url = '/js/swagger_' + version + '.json'; if (version === "v0") { window.location.replace("/websockets/api-v0") }; }); </script> </div> </div> <script src="/lib/jquery/dist/jquery.js"></script> <script src="/lib/bootstrap/dist/js/bootstrap.js"></script> <script src="/js/site.js?v=EJoUa2zJf1jD2gOSD-bFxcqjh7BTi3T8Syelg9L4Zs4"></script> <script> (function(i, s, o, g, r, a, m) { i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function() { (i[r].q = i[r].q || []).push(arguments) }, i[r].l = 1 * new Date(); a = s.createElement(o), m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m) })(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga'); ga('create', 'UA-102643555-1', 'auto'); ga('send', 'pageview'); </script> </body> </html>