Kpay支付接口v2
0.00
★9次@
A:赛忞初雪
API列表V2
V2接口限制
v2接口均有請求限制，同一接口不允許頻繁請求，請控制同一個接口請求間隔大於800毫秒，否則會返回50004請求過於頻繁異常信息。請求頭信息中timestamp參數請儘量保持最新，POS機不接受POS當前時間前後兩分鐘的時間戳，否則會返回10001參數無效異常信息。
應用簽到
POST/v2/pos/sign
開發者使用該接口向KPOS進行簽到，獲取KPOS的工作密鑰。
請求頭信息
timestamp Long REQUIRED
當前時間戳，精確到毫秒。
nonceStr Long REQUIRED
32位隨機字符串，例：BlW41Z20zy801bcjBbBx7fQVYkHNoAm7
請求數據
appId String (1,32) REQUIRED
開發者應用ID
appSecret String (1,64) REQUIRED
開發者應用密鑰
actionCallbackUrl String (1,256)
Kisok模式下終端操作回調地址（Kiosk模式下必填）
響應數據
code Integer REQUIRED
應答碼
data Object
響應數據（當應答碼10000時可能返回）
platformPublicKey String (1,2048) REQUIRED
平台工作公鑰鑰
appPrivateKey String (1,2048) REQUIRED
應用工作私鑰
message String
錯誤信息（當應答碼非10000時返回）
請求示例
POST http://这个不回家/v2/pos/sign
Headers
{
"Content-Type":"application/json",
"timestamp":"1654652134298"
}
Copy to clipboardErrorCopied
Body
{
"appId":"20xxxxxxxxxxxxxx",
"appSecret":"3nexzW7klObmTW5dl5Z8weuBxxxxxxxxxxxxxxxxxx"
}
Copy to clipboardErrorCopied
響應信息
{
"code": 10000,
"data": {
"platformPublicKey": "eyJhbGciOiJSUzI1N******************************************************ZVnQ",
"appPrivateKey": "eyJhbGciOiJSUzI1N******************************************************ZVnQ"
}
}
Copy to clipboardErrorCopied
消費交易
POST/v2/pos/sales
開發者使用該接口向KPOS發起消費請求，喚起KPOS收銀界面。喚起收銀界面後需要客人進行刷卡或掃碼支付，KPOS交易默認超時時間為65秒，如在65秒後沒有收到異步通知，可以調用查詢接口進行查詢。
請求頭信息
appId String REQUIRED
應用ID，例：202xxxxxxxxxx。
signature String REQUIRED
簽名字符串。
timestamp Long REQUIRED
當前時間戳，精確到毫秒。
nonceStr String REQUIRED
32位隨機字符串，例：BlW41Z20zy801bcjBbBx7fQVYkHNoAm7
請求數據
outTradeNo String (1,32) REQUIRED
商戶訂單號
memberCode String (1,32)
會員編號
description String (1,128)
商品描述
payAmount String (12) REQUIRED
支付金額，格式000000000100，單位：最小貨幣單位
tipsAmount String (12) REQUIRED
小費金額，格式000000000100，單位：最小貨幣單位
paymentType Long
支付類型（1：卡類，2：二維碼正掃，3：二維碼反掃，4: 八達通，5: 八達通二維碼正掃，6：Payme正掃，7：Payme反掃）
payCurrency String (1,4) REQUIRED
支付貨幣代碼，當前僅支持344（HKD）
callbackUrl String (1,256)
支付回調鏈接，有上送該字段則KPOS會在支付成功後回調該鏈接通知支付信息
qrCodeContent String (1,256)
支付渠道二維碼串碼 (Kiosk模式下發起反掃交易時必填)
includeReceipt Boolean
是否返回KPay小票數據（includeReceipt為true時返回小票數據，且KPay POS不打印本次交易小票）
remark String (1,256)
商戶自定義信息（此字段會在其商戶日結、月結結算報表中出現）
discountAmount String (12)
優惠金額，格式000000000100，單位：最小貨幣單位（僅KPayPOS設備前台應用可使用）
discountDescription String (1,128)
優惠說明（僅KPayPOS設備前台應用可使用）
frontCamera Boolean
使用前置攝像頭（當支付類型為二維碼反掃,frontCamera為true則自動使用前置攝像頭）
響應數據
code Integer REQUIRED
應答碼
data Object
響應數據（當應答碼10000時可能返回）
message String
錯誤信息（當應答碼非10000時返回）
請求示例
POST http://这个不回家/v2/pos/sales
Headers
{
"Content-Type":"application/json",
"timestamp":"1654652134298",
"appId":"202xxxxxxxxxx",
"nonceStr":"BlW41Z20zy801bcjBbBx7fQVYkHNoAm7",
"signature":"hXKbWYyHH/H05Rjd6TC0x7LzJg4v2aw7Kg/Kjv5oMz0jjh2qG4SHWwTymQ4jmCCjmzqyC3gEM3ARXBicbdlp1TWrPJgg51w9uc4SIRwnQhHh0FackKXFBjsMFDnJEl+VzLPueyFAy50jeaS1lUIZu7r2cD/TDUKiyucDKaZ4fwNmgsHUDmchqka8dT5JnqlCLs0lEQEkxmLzxvnay+eLAmiM8hzbq4NoHgCoAriCbqPcseUUJmUBMdLt+/lJa+qL8f2yFJRFpO69u3KFd8bt7/SqPZEwZaKroB2trqm9PotaGvLMOjvVvHnyQ8acdY0owBaae7l6LDZIUQHvhaHzMQ=="
}
Copy to clipboardErrorCopied
Body
{
"outTradeNo":"20xxxxxxxxxxxx1",
"payAmount":"000000000100",
"tipsAmount":"000000000000",
"payCurrency": "344",
"callbackUrl": "http://10.0.0.115:8080/callback"
}
Copy to clipboardErrorCopied
響應信息
{
"code": 10000,
"data": {}
}
Copy to clipboardErrorCopied
撤銷交易
POST/v2/pos/sales/cancel
開發者使用該接口向KPOS發起消費撤銷請求，喚起KPOS進入撤銷流程。
請求頭信息
appId String REQUIRED
應用ID，例：202xxxxxxxxxx。
signature String REQUIRED
簽名字符串。
timestamp Long REQUIRED
當前時間戳，精確到毫秒。
nonceStr String REQUIRED
32位隨機字符串，例：BlW41Z20zy801bcjBbBx7fQVYkHNoAm7
請求數據
outTradeNo String (1,32) REQUIRED
商戶訂單號
originOutTradeNo String (1,32) REQUIRED
原交易商戶訂單號
callbackUrl String (1,256)
撤銷回調鏈接，有上送該字段則KPOS會在撤銷成功後回調該鏈接通知交易信息
includeReceipt Boolean
是否返回KPay小票數據（includeReceipt為true時返回小票數據，且KPay POS不打印本次交易小票）
managerPassword String
管理員密碼，撤銷交易允許傳遞管理員密碼以此跳過終端中的管理員密碼校驗流程（傳遞的管理員密碼需要使用簽到返回的平台工作密鑰platformPublicKey進行RSA加密）
響應數據
code Integer REQUIRED
應答碼
data Object
響應數據（當應答碼10000時可能返回）
message String
錯誤信息（當應答碼非10000時返回）
請求示例
POST http://这个不回家/v2/pos/sales/cancel
Headers
{
"Content-Type":"application/json",
"timestamp":"1654652134298",
"appId":"202xxxxxxxxxx",
"nonceStr":"BlW41Z20zy801bcjBbBx7fQVYkHNoAm7",
"signature":"hXKbWYyHH/H05Rjd6TC0x7LzJg4v2aw7Kg/Kjv5oMz0jjh2qG4SHWwTymQ4jmCCjmzqyC3gEM3ARXBicbdlp1TWrPJgg51w9uc4SIRwnQhHh0FackKXFBjsMFDnJEl+VzLPueyFAy50jeaS1lUIZu7r2cD/TDUKiyucDKaZ4fwNmgsHUDmchqka8dT5JnqlCLs0lEQEkxmLzxvnay+eLAmiM8hzbq4NoHgCoAriCbqPcseUUJmUBMdLt+/lJa+qL8f2yFJRFpO69u3KFd8bt7/SqPZEwZaKroB2trqm9PotaGvLMOjvVvHnyQ8acdY0owBaae7l6LDZIUQHvhaHzMQ=="
}
Copy to clipboardErrorCopied
Body
{
"outTradeNo":"20xxxxxxxxxxxxx2",
"originOutTradeNo":"20xxxxxxxxxxxxx1",
"callbackUrl": "http://10.0.0.115:8080/callback"
}
Copy to clipboardErrorCopied
響應信息
{
"code": 10000,
"data": {}
}
Copy to clipboardErrorCopied
管理員密碼加密
const publicKey = forge.pki.publicKeyFromPem(pubKey);
const encryptedText = forge.util.encode64(
publicKey.encrypt(data, 'RSAES-PKCS1-V1_5', {
md: forge.md.sha1.create(),
mgf: forge.mgf.mgf1.create(forge.md.sha1.create())
}),);
Copy to clipboardErrorCopied
關閉交易
POST/v2/pos/sales/close
開發者使用該接口向KPOS發起消費關閉請求，喚起KPOS取消當前交易。
請求頭信息
appId String REQUIRED
應用ID，例：202xxxxxxxxxx。
signature String REQUIRED
簽名字符串。
timestamp Long REQUIRED
當前時間戳，精確到毫秒。
nonceStr String REQUIRED
32位隨機字符串，例：BlW41Z20zy801bcjBbBx7fQVYkHNoAm7
請求數據
outTradeNo String (1,32) REQUIRED
商戶訂單號
響應數據
code Integer REQUIRED
應答碼
data Object
響應數據（當應答碼10000時可能返回）
message String
錯誤信息（當應答碼非10000時返回）
請求示例
POST http://这个不回家/v2/pos/sales/close
Headers
{
"Content-Type":"application/json",
"timestamp":"1654652134298",
"appId":"202xxxxxxxxxx",
"nonceStr":"BlW41Z20zy801bcjBbBx7fQVYkHNoAm7",
"signature":"hXKbWYyHH/H05Rjd6TC0x7LzJg4v2aw7Kg/Kjv5oMz0jjh2qG4SHWwTymQ4jmCCjmzqyC3gEM3ARXBicbdlp1TWrPJgg51w9uc4SIRwnQhHh0FackKXFBjsMFDnJEl+VzLPueyFAy50jeaS1lUIZu7r2cD/TDUKiyucDKaZ4fwNmgsHUDmchqka8dT5JnqlCLs0lEQEkxmLzxvnay+eLAmiM8hzbq4NoHgCoAriCbqPcseUUJmUBMdLt+/lJa+qL8f2yFJRFpO69u3KFd8bt7/SqPZEwZaKroB2trqm9PotaGvLMOjvVvHnyQ8acdY0owBaae7l6LDZIUQHvhaHzMQ=="
}
Copy to clipboardErrorCopied
Body
{
"outTradeNo":"20xxxxxxxxxxxxx2"
}
Copy to clipboardErrorCopied
響應信息
{
"code": 10000,
"data": {}
}
Copy to clipboardErrorCopied
查詢交易
GET/v2/pos/query
開發者使用該接口向KPOS發起消費查詢請求，查詢交易信息。
請求頭信息
appId String REQUIRED
應用ID，例：202xxxxxxxxxx。
signature String REQUIRED
簽名字符串。
timestamp Long REQUIRED
當前時間戳，精確到毫秒。
nonceStr String REQUIRED
32位隨機字符串，例：BlW41Z20zy801bcjBbBx7fQVYkHNoAm7
請求數據
outTradeNo String (1,32) REQUIRED
商戶訂單號
remote Boolean
是否查詢雲端數據（僅限二維碼類交易，且支付結果為 超时、待處理、處理失敗 的交易）
includeReceipt Boolean
是否返回KPay小票數據
響應數據
code Integer REQUIRED
應答碼
data Object
響應數據（當應答碼10000時可能返回）
outTradeNO String (1,32) REQUIRED
商戶訂單號
transactionNo String (1,32) REQUIRED
KPay商戶訂單號（二維碼類交易返回）
refNo String (1,32) REQUIRED
KPay商戶交易參考號（卡類交易返回）
description String (1,128)
商品描述
payAmount String (12) REQUIRED
⽀付⾦額，格式000000000100，單位：最小貨幣單位
tipsAmount String (12)
小費金額，格式000000000100，單位：最小貨幣單位
payCurrency String (1,4) REQUIRED
支付貨幣代碼，當前僅支持344（HKD）
memberCode String (1,32)
會員編號
reason String (1,128)
交易失敗原因
payMethod Long REQUIRED
支付方式（1：Visa，2：Mastercard，3：中國銀聯，4：微信，5：支付寶，6：American Express，7：Diners Club，8：JCB，9：銀聯雲閃付，11：八達通，12：Payme）
transactionType Long REQUIRED
交易類型（1：消費，2：退貨，3：冲正，4：預授權，5：預授權完成，6：消費撤銷，7：小費調整，8：小費撤銷，9：預授權撤銷，10：預授權完成撤銷）
payResult Integer REQUIRED
支付結果（-1：超时，1：待處理，2：處理成功，3：處理失敗，4：已退貨，5：已撤銷，6：交易取消）
needSignature Boolean
小票是否需要簽名
remark String (1,256)
商戶自定義信息
discountAmount String (12)
優惠金額，格式000000000100，單位：最小貨幣單位
discountDescription String (1,128)
優惠說明
orderAmount String (12)
訂單金額(payAmount+tipsAmount+discountAmount)，格式000000000100，單位：最小貨幣單位
kpayOutTradeNo String (20)
KPay商戶訂單號
以下為KPay小票數據，僅 includeReceipt 為true時返回
kpayMerchantNo String REQUIRED
KPay商戶號（15位）
kpayMerchantNameZH String (1,36) REQUIRED
KPay商戶門店中文名
kpayMerchantNameEN String (1,100) REQUIRED
KPay商戶門店英文名
kpayMerchantAddress String (1,100) REQUIRED
KPay商戶門店地址
cardNo String (1,19)
銀行卡號（已脫敏）
cardInputCode String (1)
卡數據獲取方式（S:刷卡，I:插卡，C:拍卡，F:芯片降級交易，M:手動輸入）
batchNo String (6)
KPay批次號
traceNo String (6)
KPay流水號
orgTraceNo String (6)
KPay原交易流水號
orgTransactionNo String (1,32)
KPay原商戶訂單號（二維碼類交易返回）
kpayMemberNo String (1,32)
KPay會員編號
authCode String (1,16)
授權碼 (銀行卡類交易返回)
paymentId String (1,32)
支付機構交易號（二維碼類交易返回）
commitTime Long
交易提交時間（時間戳）
aid String (1,32)
卡應用ID (卡類EMV交易時返回)
aidLabel String (1,32)
卡應用名稱 (卡類EMV交易時返回)
pinVerified String (1,32)
是否脫機PIN驗證通過（當cardInputCode為 I 時，此字段才有效）
oemRefNo String (1,32)
八達通交易參考號（僅八達通交易時返回）
balance String (1,16)
八達通卡餘額（僅八達通卡交易且有餘額時返回）
tc String (1,32)
卡交易應用密文（TC）（僅卡類EMV交易時返回）
appVersion String (1,16)
KPay POS 版本號
terminalType String (1,16)
設備型號
receiptNoSignatureZH String
交易小票免簽名提示語（繁中）
receiptNoSignatureEN String
交易小票免簽名提示語（英文）
receiptSignatureZH String
交易小票簽名提示語（繁中）
receiptSignatureEN String
交易小票簽名提示語（英文）
receiptSignatureConfirmZH String
交易小票入賬確認提示語（繁中）
receiptSignatureConfirmEN String
交易小票入賬確認提示語（英文）
receiptDisclaimersZH String
交易小票免責提示語（英文）
receiptDisclaimersEN String
交易小票免責提示語（英文）
message String
錯誤信息（當應答碼非10000時返回）
請求示例
GET http://这个不回家/v2/pos/query?outTradeNo=20xxxxxxxxxxxxx2
Headers
{
"timestamp":"1654652134298",
"appId":"202xxxxxxxxxx",
"nonceStr":"BlW41Z20zy801bcjBbBx7fQVYkHNoAm7",
"signature":"hXKbWYyHH/H05Rjd6TC0x7LzJg4v2aw7Kg/Kjv5oMz0jjh2qG4SHWwTymQ4jmCCjmzqyC3gEM3ARXBicbdlp1TWrPJgg51w9uc4SIRwnQhHh0FackKXFBjsMFDnJEl+VzLPueyFAy50jeaS1lUIZu7r2cD/TDUKiyucDKaZ4fwNmgsHUDmchqka8dT5JnqlCLs0lEQEkxmLzxvnay+eLAmiM8hzbq4NoHgCoAriCbqPcseUUJmUBMdLt+/lJa+qL8f2yFJRFpO69u3KFd8bt7/SqPZEwZaKroB2trqm9PotaGvLMOjvVvHnyQ8acdY0owBaae7l6LDZIUQHvhaHzMQ=="
}
Copy to clipboardErrorCopied
響應信息
{
"code": 10000,
"data": {
"outTradeNO": "20xxxxxxxxxxxxx2",
"transactionNo": "20xxxxxxxxxxxxxxxx",
"description": "",
"memberCode":"",
"reason":"",
"payAmount": "000000000100",
"tipsAmount": "000000000000",
"payCurrency": "344",
"payMethod": 1,
"transactionType": 6,
"payResult": 2
}
}
Copy to clipboardErrorCopied
交易回調
POSTcallbackUrl
開發者消費請求填寫了callbackUrl參數，則可以在KPOS支付、撤銷成功後收到異步通知，開發者需要處理完業務後響應KPOS指定數據。如沒有成功響應KPOS，KPOS會按照一定規則進行重試，重試次數達到3次後，不再通知。需要獲取交易結果，可以調用查詢接口進行查詢。
請求頭信息
signature String REQUIRED
簽名字符串。
timestamp Long REQUIRED
當前時間戳，精確到毫秒。
nonceStr String REQUIRED
32位隨機字符串，例：BlW41Z20zy801bcjBbBx7fQVYkHNoAm7
請求數據
outTradeNO String (1,32) REQUIRED
商戶訂單號
transactionNo String (1,32) REQUIRED
KPay商戶訂單號（二維碼類交易返回）
refNo String (1,32) REQUIRED
KPay商戶交易參考號（卡類交易返回）
description String (1,128)
商品描述
payAmount String (12) REQUIRED
⽀付⾦額，格式000000000100，單位：最小貨幣單位
tipsAmount String (12) REQUIRED
小費金額，格式000000000100，單位：最小貨幣單位
payCurrency String (1,4) REQUIRED
支付貨幣代碼，當前僅支持344（HKD）
memberCode String (1,32)
會員編號
reason String (1,128)
交易失敗原因
payMethod Long REQUIRED
支付方式（1：Visa，2：Mastercard，3：中國銀聯，4：微信，5：支付寶，6：American Express，7：Diners Club，8：JCB，9：銀聯雲閃付，11：八達通，12：Payme）
transactionType Long REQUIRED
交易類型（1：消費，2：退貨，3：冲正，4：預授權，5：預授權完成，6：消費撤銷，7：小費調整，8：小費撤銷，9：預授權撤銷，10：預授權完成撤銷）
payResult Integer REQUIRED
支付結果（-1：超时，1：待處理，2：處理成功，3：處理失敗，4：已退貨，5：已撤銷，6：交易取消）
needSignature Boolean
小票是否需要簽名
remark String (1,256)
商戶自定義信息
discountAmount String (12)
優惠金額，格式000000000100，單位：最小貨幣單位
discountDescription String (1,128)
優惠說明
orderAmount String (12)
訂單金額(payAmount+tipsAmount+discountAmount)，格式000000000100，單位：最小貨幣單位
kpayOutTradeNo String (20)
KPay商戶訂單號
以下為KPay小票數據，僅 includeReceipt 為true時返回
kpayMerchantNo String REQUIRED
KPay商戶號（15位）
kpayMerchantNameZH String (1,36) REQUIRED
KPay商戶門店中文名
kpayMerchantNameEN String (1,100) REQUIRED
KPay商戶門店英文名
kpayMerchantAddress String (1,100) REQUIRED
KPay商戶門店地址
cardNo String (1,19)
銀行卡號（已脫敏）
cardInputCode String (1)
卡數據獲取方式（S:刷卡，I:插卡，C:拍卡，F:芯片降級交易，M:手動輸入）
batchNo String (6)
KPay批次號
traceNo String (6)
KPay流水號
orgTraceNo String (6)
KPay原交易流水號
orgTransactionNo String (1,32)
KPay原商戶訂單號（二維碼類交易返回）
kpayMemberNo String (1,32)
KPay會員編號
authCode String (1,16)
授權碼 (銀行卡類交易返回)
paymentId String (1,32)
支付機構交易號（二維碼類交易返回）
commitTime Long
交易提交時間（時間戳）
aid String (1,32)
卡應用ID (卡類EMV交易時返回)
aidLabel String (1,32)
卡應用名稱 (卡類EMV交易時返回)
pinVerified String (1,32)
是否脫機PIN驗證通過（當cardInputCode為 I 時，此字段才有效）
oemRefNo String (1,32)
八達通交易參考號（僅八達通交易時返回）
balance String (1,16)
八達通卡餘額（僅八達通卡交易且有餘額時返回）
tc String (1,32)
卡交易應用密文（TC）（僅卡類EMV交易時返回）
appVersion String (1,16)
KPay POS 版本號
terminalType String (1,16)
設備型號
receiptNoSignatureZH String
交易小票免簽名提示語（繁中）
receiptNoSignatureEN String
交易小票免簽名提示語（英文）
receiptSignatureZH String
交易小票簽名提示語（繁中）
receiptSignatureEN String
交易小票簽名提示語（英文）
receiptSignatureConfirmZH String
交易小票入賬確認提示語（繁中）
receiptSignatureConfirmEN String
交易小票入賬確認提示語（英文）
receiptDisclaimersZH String
交易小票免責提示語（英文）
receiptDisclaimersEN String
交易小票免責提示語（英文）
響應數據
code Integer REQUIRED
應答碼
請求示例
POST http://10.0.0.xxx:xxxx/callbackUrl
Headers
{
"Content-Type":"application/json",
"timestamp":"1654652134298",
"nonceStr":"BlW41Z20zy801bcjBbBx7fQVYkHNoAm7",
"signature":"hXKbWYyHH/H05Rjd6TC0x7LzJg4v2aw7Kg/Kjv5oMz0jjh2qG4SHWwTymQ4jmCCjmzqyC3gEM3ARXBicbdlp1TWrPJgg51w9uc4SIRwnQhHh0FackKXFBjsMFDnJEl+VzLPueyFAy50jeaS1lUIZu7r2cD/TDUKiyucDKaZ4fwNmgsHUDmchqka8dT5JnqlCLs0lEQEkxmLzxvnay+eLAmiM8hzbq4NoHgCoAriCbqPcseUUJmUBMdLt+/lJa+qL8f2yFJRFpO69u3KFd8bt7/SqPZEwZaKroB2trqm9PotaGvLMOjvVvHnyQ8acdY0owBaae7l6LDZIUQHvhaHzMQ=="
}
Copy to clipboardErrorCopied
Body
{
"outTradeNO": "20xxxxxxxxxxxxx2",
"transactionNo": "20xxxxxxxxxxxxxxxx",
"description": "",
"memberCode":"",
"reason":"",
"payAmount": "000000000100",
"tipsAmount": "000000000000",
"payCurrency": "344",
"payMethod": 1,
"transactionType": 6,
"payResult": 2
}
Copy to clipboardErrorCopied
響應信息
{
"code": 10000
}
Copy to clipboardErrorCopied
打印自定義小票
POST/v2/pos/print
開發者通過此api發送打印指令，可實現打印自定義數據和樣式的小票。
請求頭信息
appId String REQUIRED
應用ID，例：202xxxxxxxxxx。
signature String REQUIRED
簽名字符串。
timestamp Long REQUIRED
當前時間戳，精確到毫秒。
nonceStr String REQUIRED
32位隨機字符串，例：BlW41Z20zy801bcjBbBx7fQVYkHNoAm7w
請求數據
printType enum REQUIRED
打印類型（TEXT：文字, LR_TEXT：同行左右文字, QR_CODE：二維碼, BAR_CODE：條形碼, IMAGE：圖片, FEED：換行）
textContent String (1,200)
打印文字內容（printType為TEXT時則必填）
leftTextContent String (1,100)
打印在同行左側的文字內容（printType為LR_TEXT時則必填）
rightTextContent String (1,100)
打印在同行右側的文字內容（printType為LR_TEXT時則必填）
textSize enum
打印文字的尺寸,取值範圍（S：小, M：中, L：大），默認為 M
qrcodeContent String (1,100)
打印二維碼內容,居中顯示（printType為QR_CODE時則必填）
qrcodeSize Integer
二維碼尺寸,取值範圍（100~380），默認取值：280
barcodeContent String (1,20)
打印條形碼內容，僅允許純數字，居中顯示（printType為BAR_CODE時則必填）
barcodeHeight Integer
條形碼高度，取值範圍（80~200），默認取值：100
image String
打印Base64圖片內容（printType為IMAGE時則必填）
alignment enum
對齊方式,僅printType為TEXT時有效，取值範圍（LEFT：居左,RIGHT：居右,CENTER：居中）,默認居左
feedLine Integer
出紙行數，取值範圍（1~50）
響應數據
code Integer REQUIRED
應答碼
請求示例
POST http://10.0.0.xxx:xxxx/v2/pos/print
Headers
{
"Content-Type":"application/json",
"timestamp":"1654652134298",
"appId":"202xxxxxxxxxx",
"nonceStr":"BlW41Z20zy801bcjBbBx7fQVYkHNoAm7",
"signature":"hXKbWYyHH/H05Rjd6TC0x7LzJg4v2aw7Kg/Kjv5oMz0jjh2qG4SHWwTymQ4jmCCjmzqyC3gEM3ARXBicbdlp1TWrPJgg51w9uc4SIRwnQhHh0FackKXFBjsMFDnJEl+VzLPueyFAy50jeaS1lUIZu7r2cD/TDUKiyucDKaZ4fwNmgsHUDmchqka8dT5JnqlCLs0lEQEkxmLzxvnay+eLAmiM8hzbq4NoHgCoAriCbqPcseUUJmUBMdLt+/lJa+qL8f2yFJRFpO69u3KFd8bt7/SqPZEwZaKroB2trqm9PotaGvLMOjvVvHnyQ8acdY0owBaae7l6LDZIUQHvhaHzMQ=="
}
Copy to clipboardErrorCopied
Body
{
"steps": [
{
"printType": "IMAGE",
"image": "圖片的Base64字符串"
},
{
"printType": "TEXT",
"alignment": "CENTER",
"textContent": "KPay",
"textSize": "L"
},
{
"printType": "LR_TEXT",
"leftTextContent": "顧客存根",
"rightTextContent": "請妥善保存",
"textSize": "M"
},
{
"printType": "QR_CODE",
"qrcodeContent": "abcdefg",
"qrcodeSize": 280
},
{
"printType": "BAR_CODE",
"barcodeContent": "12345678",
"barcodeHeight": 100
},
{
"printType": "FEED",
"feedLine": 5
}
]
}
Copy to clipboardErrorCopied
響應信息
{
"code": 10000 ,
"message":"Success"
}
硬件app
