{"_id":"@cardknox/js-sdk","_rev":"6-65eb3eaac229d7cde7ba0f65be54c52d","name":"@cardknox/js-sdk","dist-tags":{"latest":"1.1.221-0.2401"},"versions":{"1.1.221-0.2401":{"name":"@cardknox/js-sdk","version":"1.1.221-0.2401","author":{"email":"developersupport@cardknox.com"},"license":"","_id":"@cardknox/js-sdk@1.1.221-0.2401","maintainers":[{"name":"rezwan-ck","email":"rezwan@cardknox.com"},{"name":"mweisz-ck","email":"mweisz@cardknox.com"},{"name":"mstein-ck","email":"mstein@cardknox.com"},{"name":"ymwymw","email":"ymwymw@gmail.com"}],"homepage":"https://github.com/cardknox/cardknox-sdk-js#readme","bugs":{"url":"https://www.cardknox.com/contact/","email":"developersupport@cardknox.com"},"dist":{"shasum":"f65b6ef67f1438249d75615a8ff6e11d87191fe5","tarball":"https://registry.npmjs.org/@cardknox/js-sdk/-/js-sdk-1.1.221-0.2401.tgz","fileCount":4,"integrity":"sha512-W2xWdK7GG343ComwbiB66z97W598hTPMzk2qwwl34kRqGXXCoUMq2xvWfqC9tglMfWAP04oDY/N9SBlwajTjew==","signatures":[{"sig":"MEUCIQCfn2iA4P1fpytC5UsgFusMPQFWXj9HyKwhuVLDECzHqAIgBEkxNk68g/cbGxHF3eYmJ9uGTbkvsNaYAsDEWz8yPJE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":127566,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjYYsNACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoQEA//cFb36GBJPc6dPJSJhNX/Qn1fBH4EZ0Y8sEgkAj0MH04ceso1\r\nor8hi4YdqxLB/O49JNWwYjj9BLNv4kHCrjb76FDFelJdDufyuJZmkWxOCaJy\r\nk1TBoQCchxYzBQMovYKbKQYFuFWu/tL8nxBAWZUKDOqCAtiCooL5uFkqpIey\r\nYh5g6MVwfIzcxcQb80rolU3RYSvACd6BiBJjbZvkaNpEpoUHzs/swUW3p4Sm\r\nj41Ruz4GIEWspSGZzLyttADtycOQmN6Z1/zWqwMW9BO0WtYoxW1Gizsf9WiS\r\nPbwfRnKm82nFLnpRqH1ToyMlwze6mWa54j8MDICWVBOFg8G+RldCH5wSNtWP\r\nPA+C50Vak1irempJE7MFlIcG1/9HWue2NzJtXvysBbhxlR96oaTeZPkQ+FTN\r\naToqSLDhPMZ+z2+yfgY7UIM1063ZwvOJiGSN0ofAK7fOAGSixj5aZ7pv7Jv5\r\nmCtQHmNr4trWIGD5YTVYdulawwQq0OiuJ3rnMBp8JTOYIH2ANZwWWH/LaTog\r\nG0Wxy1/PhENoKEnNJwy+se9ZNOngQB2Ue8WWqpoVjcvggzAatIYJuL6ych5q\r\nCXeOf25/ZxaTAaj4LbW+f6suNDrmxYC9mZ4OqSAsBfoJN+jsgnSApYXHl71c\r\nn35jPwj81GYmoEqLgGPMSn454EgQfxQ9/So=\r\n=EydD\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/cardknox-sdk.min.js","gitHead":"e30ec1207d214cb40a38e46b2fda16f4af69c372","scripts":{"test":"echo \"TODO: create test\" && exit 0","build":"webpack --config webpack.prod.config.js","start":"start http://lh.cardknox.com:4000/sample.html && start light-server -s public -p 4000 -w \"public/**\" && npm run watch","watch":"webpack --config webpack.dev.config.js --watch","build-dev":"webpack --config webpack.dev.config.js"},"_npmUser":{"name":"mstein-ck","email":"mstein@cardknox.com"},"repository":{"url":"git+https://github.com/cardknox/cardknox-sdk-js.git","type":"git"},"_npmVersion":"8.5.5","coreVersion":"1.1","description":"A library for communicating with Cardknox supported terminals and the Cardknox Gateway","directories":{},"_nodeVersion":"16.15.0","dependencies":{"is-ip":"^3.1.0","validate":"^5.1.0","@babel/runtime":"^7.10.4"},"buildRevision":".2210.2401","_hasShrinkwrap":false,"releaseChannel":"stable","devDependencies":{"eslint":"^7.4.0","aws-sdk":"^2.1057.0","webpack":"^5.72.0","showdown":"^1.9.1","@babel/core":"^7.10.4","webpack-cli":"^4.9.2","babel-eslint":"^10.1.0","babel-loader":"^8.1.0","light-server":"^2.7.0","eslint-loader":"^4.0.2","@babel/preset-env":"^7.10.4","copy-webpack-plugin":"^6.0.3","clean-webpack-plugin":"^3.0.0","@babel/plugin-transform-runtime":"^7.10.4","@babel/plugin-syntax-class-properties":"^7.10.4","@babel/plugin-proposal-class-properties":"^7.10.4"},"_npmOperationalInternal":{"tmp":"tmp/js-sdk_1.1.221-0.2401_1667336973576_0.5198081196944369","host":"s3://npm-registry-packages"}}},"time":{"created":"2022-11-01T21:09:33.520Z","modified":"2025-09-30T20:23:52.545Z","1.1.221-0.2401":"2022-11-01T21:09:33.736Z"},"bugs":{"url":"https://www.cardknox.com/contact/","email":"developersupport@cardknox.com"},"author":{"email":"developersupport@cardknox.com"},"homepage":"https://github.com/cardknox/cardknox-sdk-js#readme","repository":{"url":"git+https://github.com/cardknox/cardknox-sdk-js.git","type":"git"},"description":"A library for communicating with Cardknox supported terminals and the Cardknox Gateway","maintainers":[{"email":"mweisz@cardknox.com","name":"mweisz-ck"},{"email":"rezwan@cardknox.com","name":"rezwan-ck"},{"email":"sergealt@hotmail.com","name":"sergealt"},{"email":"mstein@cardknox.com","name":"mstein-ck"},{"email":"jdick@solapayments.com","name":"solajdick"}],"readme":"# cardknox-sdk-js\r\n\r\n## SDK\r\n\r\n### HTTPS\r\n\r\nTo enable _https_ on the Pax device, please contact [support](mailto:support@cardkox.com).\r\n\r\nTo avoid the need for a self-signed certificate, Cardknox provides a SSL certificate pointing to the local IP address. The format for the host name is \\ i.e. for IP address 192.168.1.1 the host name would be _ip-192-168-1-1.mylocaldevice.com_. The SDK will automatically format the host name correctly when the protocol is _https_.\r\n\r\nA DNS entry must exist, mapping the host name to the IP address. The SDK will check that the entry exists if there are network errors.\r\n\r\nTo create a DNS entry, use the tool located [here](http://localdevice.us-west-2.elasticbeanstalk.com/). This can also be done via API.\r\n\r\n```\r\ncurl --request POST \\\r\n --url http://localdevice.us-west-2.elasticbeanstalk.com/api/dnsrecord/save \\\r\n --header 'Content-Type: multipart/form-data' \\\r\n --form ip=192.168.1.1\r\n```\r\n\r\n### Process\r\n\r\n##### Process a transaction\r\n\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
ArgsReturns
TypeTransactionRequestTransactionResponse
\r\n\r\n---\r\n\r\n### Get Signature\r\n\r\n##### Prompts for signature on the device\r\n\r\nThis returns a base64 encoded PNG *without the data header*.\r\n\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
ArgsReturns
TypeSettingsString
\r\n\r\n---\r\n\r\n### TransactionRequest\r\n\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
NameTypeDescriptionValid values
xSoftwareNameStringYour software name
xSoftwareVersionStringYour software version
xCommandStringTransaction typeEnum xCommand
xAmountNumberTransaction amount.Format: #.##
xTipNumberTip amount included in the transaction amount.Format: #.##
xInvoiceStringInvoice number
xCustom02StringCustom dataMax length of 4 (will be truncated)
xAllowDuplicateBooleanIf true, host will not check for duplicate
settingsSettingsTransaction settings, these should be the same for all transactions
\r\n\r\n\r\n---\r\n\r\n### Settings\r\n\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
NameTypeDescriptionValid values
deviceIpAddressStringIP address of your device. When the protocol is https the mylocaldevice.com domain name will be used. See HTTPS
deviceIpPortStringIP port of your device. Default is \"10009\"
deviceIpProtocolStringThe protocol to use to talk to the device. Defaults to the location protocol
\r\n\r\n---\r\n\r\n### xCommand\r\n\r\nList of supported transaction types.\r\n\r\nThese enums are available from the SDK.\r\n\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
NameCommand
CC_SALEcc:sale
CC_CREDITcc:credit
CC_AUTHONLYcc:authonly
CC_CAPTUREcc:capture
CC_POSTAUTHcc:postauth
CC_VOIDcc:void
CC_VOIDRELEASEcc:voidrelease
CC_VOIDREFUNDcc:voidrefund
CC_BALANCEcc:balance
EBTFS_SALEebtfs:sale
EBTFS_CREDITebtfs:credit
EBTFS_BALANCEebtfs:balance
EBTCB_SALEebtcb:sale
EBTCB_BALANCEebtcb:balance
GIFT_REDEEMgift:redeem
GIFT_ISSUEgift:issue
GIFT_BALANCEgift:balance
\r\n","readmeFilename":"README.md"}