This application manages the devices in PAX PayDroid-based terminals. The peripherals/devices include the printer, the card reader, the contactless card reader, etc.If you are developing an app that runs inside the PAX POS, Neptune Service must be installed on the terminal before you call the NeptuneLiteApi.
Once Neptune Service is installed, you can use the NeptuneLiteApi to access the GPS, speaker, cameras, and other peripherals.The NeptuneLiteApi provides the APIs of the NeptuneService. This currently contains only the Device Adapter Layer module (DAL).The DAL provides uniform APIs for device operations, abstracting the differences between terminal models.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Paybyrd","colors":{"primary":"#6319F0","light":"#A4ADFF","dark":"#6319F0"},"logo":{"light":"https://mintcdn.com/paybyrd/X3OHHz6EJVWhNTO3/images/logo-light-full.png?fit=max\u0026auto=format\u0026n=X3OHHz6EJVWhNTO3\u0026q=85\u0026s=35a8f83493759c89b1ee80db71265676","dark":"https://mintcdn.com/paybyrd/X3OHHz6EJVWhNTO3/images/logo-dark-full.png?fit=max\u0026auto=format\u0026n=X3OHHz6EJVWhNTO3\u0026q=85\u0026s=7d1a41429a1708ce79ff23f45f296959"},"favicon":"https://mintcdn.com/paybyrd/GOPy9l9hDJ70VNa1/images/Avatar-Square.png?fit=max\u0026auto=format\u0026n=GOPy9l9hDJ70VNa1\u0026q=85\u0026s=78f2ae4b46f5e013c30d747f9889aa80","background":{"color":{"light":"#f2f2f2","dark":"#2e2e2e"}},"navbar":{"links":[{"href":"https://www.paybyrd.com/","label":"Paybyrd"},{"href":"https://status.paybyrd.com/","label":"Status"}],"primary":{"type":"button","label":"Get started with Paybyrd","href":"https://backoffice.paybyrd.com/"}},"footer":{"socials":{"website":"https://www.paybyrd.com/"},"links":[{"header":"Mobile","items":[{"label":"Get the dashboard app","href":"/get-started/start-building"}]}]},"fonts":{"family":"DM Sans","weight":400,"source":"https://fonts.gstatic.com/s/dmsans/v17/rP2Yp2ywxg089UriI5-g7M8btVsD8Ck0q7u0-K6z8GXhnU0.woff2","format":"woff2"},"icons":{"library":"lucide"},"integrations":{"ga4":{"measurementId":"G-7PQTSPLP9K"}},"contextual":{"options":["copy","view","vscode","chatgpt","claude","mcp","add-mcp"],"display":"toc"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paybyrd","hasAudioNarration":false,"actualSubdomain":"paybyrd","customDomains":["docs.paybyrd.com"],"gitSource":{"type":"github","owner":"paybyrd","repo":"paybyrd-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfac3b1ec88bdf5ff40127","collectionId":"99135064-27cc-4e8f-a205-a81518acd153","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfac3b1ec88bdf5ff40127"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adfac3b1ec88bdf5ff40127","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":30},{"language":"default","tag":"Payments API","count":26},{"language":"default","tag":"Payments","count":23},{"language":"default","tag":"Integrations","count":14},{"language":"default","tag":"Accept Payments","count":13},{"language":"default","tag":"Get started","count":8},{"language":"default","tag":"Manage Payments","count":8},{"language":"default","tag":"Transactions","count":8},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Point of Sale","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"integrations/point-of-sale/pax-peripherals-kit","slug":"/integrations/point-of-sale/pax-peripherals-kit","pageMetadata":{"title":"PAX peripherals Kit","description":null,"href":"/integrations/point-of-sale/pax-peripherals-kit"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`To develop an app that communicates with PAX terminal peripherals (such as the printer or camera), use the Neptune Service and PAX’s NeptuneLiteAPI.`}),`\n`,_jsx(Heading,{level:`2`,id:`neptune-service`,children:`Neptune Service`}),`\n`,_jsx(_components.p,{children:`This application manages the devices in PAX PayDroid-based terminals. The peripherals/devices include the printer, the card reader, the contactless card reader, etc.`}),`\n`,_jsx(_components.p,{children:`If you are developing an app that runs inside the PAX POS, Neptune Service must be installed on the terminal before you call the NeptuneLiteApi.`}),`\n`,_jsx(Heading,{level:`2`,id:`neptune-lite-api`,children:`Neptune Lite API`}),`\n`,_jsx(_components.p,{children:`Once Neptune Service is installed, you can use the NeptuneLiteApi to access the GPS, speaker, cameras, and other peripherals.`}),`\n`,_jsx(_components.p,{children:`The NeptuneLiteApi provides the APIs of the NeptuneService. This currently contains only the Device Adapter Layer module (DAL).`}),`\n`,_jsx(_components.p,{children:`The DAL provides uniform APIs for device operations, abstracting the differences between terminal models.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"PAX peripherals Kit","description":null,"href":"/integrations/point-of-sale/pax-peripherals-kit"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Neptune Service","slug":"neptune-service","depth":2,"children":[]},{"title":"Neptune Lite API","slug":"neptune-lite-api","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"paybyrd","siteName":"Paybyrd","title":"PAX peripherals Kit - Paybyrd","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T19:38:43.682Z","originalFileLocation":"integrations/point-of-sale/pax-peripherals-kit.md"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Paybyrd\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"PAX peripherals Kit - Paybyrd\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paybyrd\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paybyrd.com/integrations/point-of-sale/pax-peripherals-kit\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paybyrd.mintlify.app/_mintlify/api/og/v2?division=Point+of+Sale\u0026amp;title=PAX+peripherals+Kit\u0026amp;theme=482e40cfd6999bc2608c5e34\u0026amp;signature=06c439410afa5d0e91bd83534e25f3707ed3bd33fb6957a668330a4a453d2a89\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"PAX peripherals Kit - Paybyrd\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paybyrd.mintlify.app/_mintlify/api/og/v2?division=Point+of+Sale\u0026amp;title=PAX+peripherals+Kit\u0026amp;theme=482e40cfd6999bc2608c5e34\u0026amp;signature=06c439410afa5d0e91bd83534e25f3707ed3bd33fb6957a668330a4a453d2a89\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paybyrd\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6319F0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paybyrd.com/integrations/point-of-sale/pax-peripherals-kit\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/integrations/point-of-sale/pax-peripherals-kit.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paybyrd.com/#organization\",\"name\":\"Paybyrd\",\"url\":\"https://docs.paybyrd.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paybyrd/X3OHHz6EJVWhNTO3/images/logo-light-full.png?fit=max\u0026auto=format\u0026n=X3OHHz6EJVWhNTO3\u0026q=85\u0026s=35a8f83493759c89b1ee80db71265676\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paybyrd.com#website\",\"name\":\"Paybyrd\",\"url\":\"https://docs.paybyrd.com\",\"publisher\":{\"@id\":\"https://docs.paybyrd.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paybyrd.com/integrations/point-of-sale/pax-peripherals-kit#webpage\",\"url\":\"https://docs.paybyrd.com/integrations/point-of-sale/pax-peripherals-kit\",\"name\":\"PAX peripherals Kit\",\"dateModified\":\"2026-10-26T19:38:43.682Z\",\"isPartOf\":{\"@id\":\"https://docs.paybyrd.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paybyrd.com/integrations/point-of-sale/pax-peripherals-kit#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paybyrd.com/integrations/point-of-sale/pax-peripherals-kit#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Point of Sale\",\"item\":\"https://docs.paybyrd.com/integrations/point-of-sale/tap-to-pay\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"PAX peripherals Kit\",\"item\":\"https://docs.paybyrd.com/integrations/point-of-sale/pax-peripherals-kit\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.paybyrd.com/integrations/point-of-sale/pax-peripherals-kit#article\",\"headline\":\"PAX peripherals Kit\",\"name\":\"PAX peripherals Kit\",\"url\":\"https://docs.paybyrd.com/integrations/point-of-sale/pax-peripherals-kit\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paybyrd.com/integrations/point-of-sale/pax-peripherals-kit#webpage\"},\"dateModified\":\"2026-10-26T19:38:43.682Z\",\"publisher\":{\"@id\":\"https://docs.paybyrd.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paybyrd.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Paybyrd\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Paybyrd","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":"/introduction"}]},{"tab":"Payments","pages":[{"title":"Payments","href":"/accept-payments/how-it-works"}]},{"tab":"Integrations","groups":[{"group":"Embed Paybyrd","pages":[{"title":"Checkout","href":"/embed/checkout"},{"title":"Migration guide","href":"/embed/checkout-migration-guide"},{"title":"Checkout parameter reference","href":"/embed/checkout-parameter-reference"},{"title":"Card Collect","href":"/embed/card-collect"},{"title":"Pay by Link","href":"/embed/pay-by-link"}]},{"group":"E-commerce","pages":[{"title":"WooCommerce","href":"/integrations/ecommerce-plugins/woocommerce"},{"title":"Adobe Commerce (Magento)","href":"/integrations/ecommerce-plugins/adobe-commerce-magento"},{"title":"nopCommerce","href":"/integrations/ecommerce-plugins/nopcommerce"}]},{"group":"Point of Sale","pages":[{"title":"Tap to Pay","href":"/integrations/point-of-sale/tap-to-pay"},{"title":"Payment Terminals","href":"/integrations/point-of-sale/payment-terminals"},{"title":"Payment SDK (Android)","href":"/integrations/point-of-sale/payment-sdk-android"},{"title":"Remote transaction","href":"/integrations/point-of-sale/remote-transaction"},{"title":"POS Application Manual","description":null,"href":"/integrations/point-of-sale/pos-application-manual"},{"title":"PAX peripherals Kit","href":"/integrations/point-of-sale/pax-peripherals-kit"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/api-intro"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"PAX peripherals Kit - Paybyrd","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}
