版本：Next

SaaS POS交易接口文档

1. 简介

提供线下支付终端 API 接口服务给上游渠道调用。上游渠道上位机在支付终端发起消费、预授权请求成功后，可直接通过商户号等信息在云端发起后续交易行为，譬如：订单信息查询、退款，会得到响应的支付支付结果

注：涉及金额字段，单位均为元

请求地址，请求头信息参看文档: saas公共请求及响应参数-3. 请求公共参数信息

响应头信息参看文档: saas公共请求及响应参数-4. 响应公共参数信息

2.查询

2.1 支付订单查询

介绍：通过商户号以及外部订单号或平台订单号（二选一）来查询订单详情，返回订单对象和支付单对象信息，包括订单金额、授权金额、币种、订单时间、支付金额、小费金额、退款金额、支付状态等。

接口地址: /saas/query

字段名	类型	是否必传	字段名称	说明
interfaceVersion	String	是	版本号	默认值:1.0.0
language	String	否	语言	语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceName	String	是	接口名称	填写:`order`
businessType	String	是	业务类型	填写:`query`
orgNo	String	是	机构编号
orgCertId	String	是	机构密钥证书序列号
signature	String	是	机构签名
signMethod	String	是	机构签名方法	取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名

类型

是否必传

字段名称

说明

merchant

字段名	类型	是否必传	字段名称	说明
merchantNo	String	是	商户号

Object

是

商户对象信息

order

字段名	类型	是否必传	字段名称	说明
externalOrderNo	String	选填	外部订单号	外部订单号和平台订单号二选一
orderNo	String	选填	平台订单号	外部订单号和平台订单号二选一

Object

是

订单对象信息

Curl请求示例

curl --location '${PAYMENT_DOMAIN}/saas/query' \
--header 'businessType: query' \
--header 'interfaceName: order' \
--header 'interfaceVersion: 1.0.0' \
--header 'language: zh_CN' \
--header 'orgNo: S**************' \
--header 'orgCertId: ****************************************' \
--header 'signature: A18VnjMNpXcsW41XDAlkzCXT16V+tNTVdD5/Kp/BHwgJnSHCN6rzaBh9hfm8xQFNNdp0ueb79plOaVzibF5ZLbx7Vy/qYr5iRNq1DZCyHB9XjBRGabLbKfZ/3kRvOrcgRFKy2ZRcAqJVw2J5DryqYTBlYzJZKpq8BbpWzepd/AqsjLSVHGyUJgaDeGeUM1lX52ovJRvSDEt6sTjZt56mOB5Zi+kI3KwawivRe2rdenDDC5LLyJde8+91XCC+hXn+wjXq8eMQJ6n4Wdkyh9Da5j0uwjvTxB6GHAXmWn49dFdSPVOWxjlz33gc2xi7w/oQbecpRrF98Xf52H95QIBwfQ==' \
--header 'signMethod: RSA-SHA256' \
--header 'Content-Type: application/json' \
--data '{
  "requestId": "S**************_20250721071251671_06",
  "requestTime": "2025-07-21T07:12:51.671+08:00",
  "nonceStr": "VTCG6QAxj3YzWwzvuYxIRRNODmk7nTfh",
  "data": {
    "merchant": {
      "merchantNo": "**********"
    },
    "order": {
      "externalOrderNo": "2025071411280103",
      "orderNo": "10820250714000010952"
    }
  }
}'

响应参数

字段名

类型

是否必传

字段名称

说明

order

字段名	类型	是否必传	字段名称	说明
externalOrderNo	String	是	外部订单号
orderNo	String	是	平台订单号
amount	decimal	是	金额
authorizeAmount	decimal	否	授权金额
addAmount	decimal	否	授权追加金额
currency	String	是	币种
orderDetails	String	是	订单详情
orderTime	Timestamp	是	订单时间
externalAdditionalData	String	否	外部附加数据	返回业务方自定义订单参数原值，JSON格式
payeeFee	decimal	否	收款方费用
payeeRefundFee	decimal	否	收款方退款费用

Object

是

订单对象

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	是	支付流水号
originalTransactionNo	String	否	原支付流水号
orderNo	String	是	订单号
amount	decimal	是	支付金额
tipAmount	decimal	否	小费金额
refundAmount	decimal	否	退款金额
currency	String	是	币种
status	String	是	支付单状态	参考附录-枚举字典 11 交易状态
transactionType	String	是	交易类型	参考附录-枚举字典 3 交易类型
paymentWay	String	是	支付方式	参考附录-枚举字典 5 支付方式
paymentType	String	是	支付类型	参考附录-枚举字典 6 支付类型
paymentSubtype	String	是	支付子类型	参考附录-枚举字典 7 支付子类型
cardType	String	否	卡类型	参考附录-枚举字典 8 付款卡类型
cardFlag	String	否	卡标识	参考附录-枚举字典 9 卡标识
cardBrand	String	否	卡组织	参考附录-枚举字典 10 卡组织
cardNoDigest	String	否	卡号密文摘要	根据机构敏感信息配置条件返回，配置允许返回该字段存在值
payerFee	decimal	否	付款方费用	交易手续费明确才返回
payerRefundFee	decimal	否	付款方退款费用	交易手续费明确才返回
payeeFee	decimal	否	收款方费用	交易手续费明确才返回
payeeRefundFee	decimal	否	收款方退款费用	交易手续费明确才返回
authCode	String	否	授权码
refundFlag	String	否	退款标识	00.未处理，01.部分退款，02.全部退款
revokeFlag	String	否	撤销标识	00.未处理，01.已撤销
authCompleteFlag	String	否	完成标识	00.未处理，01.已完成
responseCode	String	否	主码
responseMessage	String	否	主码说明
subCode	String	否	子码
subMessage	String	否	子码说明
completionTime	timestamp	否	交易完成时间
transactionTime	timestamp	是	交易时间
transactionZoneUTCTime	timestamp	是	交易时区时间
transactionZoneId	String	是	时区	交易时区例：Asia/Shanghai
timeZoneFlag	Integer	是	时区标识	时区标识：0.标准时间，1.夏令时

Object

是

支付单对象

响应Headers数据示例：

signature: bka/ln9zgHTen4jblFP84UJPs2a/paEFbeV/+1cMoW8B5pGegHSGc4dZIxh4bD1oOV0W0lwqCnhSPzbvN9Xb2XGSAREK4WsSk4QrV5axK7Eh6gVtK7TOibtM3KnoA77B6iww3R1uuEclWgrvXcwVqDJpNQbm10sJU6OSHY5Q3UlTRr1t+f5+T1lKHjg0w9VY9VBK61Mwzhc+qrySLVD/WnxVVIO95SfA7wkvhRM8L1i/4OWAonSWo0Xmt/l4ALCHPKr0H/splrvPj1tfq6S3ibg8+PhSIt+B5Mtdb6tlx80BdlXD+Wx2swZ5B70kk83dF/KQvsGT6g10PiGCAN6fSw==
orgCertId: ****************************************
signMethod: RSA-SHA256

响应Body数据示例

{
  "requestId": null,
  "requestTime": null,
  "responseTime": "2025-07-21T07:36:30.331+00:00",
  "respCode": 200,
  "respMsg": "success",
  "busCode": null,
  "busMsg": null,
  "busSubCode": null,
  "busSubMsg": null,
  "data": {
    "order": {
      "externalOrderNo": null,
      "orderNo": "10820250714000010952",
      "orderDetails": null,
      "amount": "0.02",
      "authorizeAmount": 0.00,
      "addAmount": 0.00,
      "currency": "HKD",
      "orderTime": "2025-07-14T11:20:07.000+00:00",
      "goodsDetails": null,
      "shippingAddress": null,
      "billingAddress": null,
      "externalAdditionalData": null
    },
    "transaction": [
      {
        "transactionNo": "TK6CE8B0450700000843566441054208",
        "originalTransactionNo": null,
        "orderNo": "10820250714000010952",
        "externalOrderNo": null,
        "amount": 0.02,
        "authorizeAmount": null,
        "addAmount": null,
        "refundAmount": 0.00,
        "payerFee": 0.00,
        "payerRefundFee": 0.00,
        "payeeFee": 0.00,
        "payeeRefundFee": 0.00,
        "tipAmount": 0.00,
        "currency": "HKD",
        "transactionType": "01",
        "paymentWay": "01",
        "authCode": "389096",
        "status": "00",
        "responseCode": "200",
        "responseMessage": null,
        "subCode": null,
        "subMessage": null,
        "transactionTime": "2025-07-14T03:20:07.000+00:00",
        "transactionZoneUTCTime": "2025-07-14T11:20:07.000+08:00",
        "transactionZoneId": "Asia/Hong_Kong",
        "timeZoneFlag": 0,
        "completionTime": "2025-07-14T03:20:09.000+00:00",
        "refundFlag": "00",
        "revokeFlag": "00",
        "authCompleteFlag": "00",
        "paymentType": "01",
        "paymentSubtype": "03",
        "cardType": null,
        "cardFlag": "03",
        "cardBrand": "02",
        "merchantSerialNo": null,
        "taskId": null,
        "cardNoDigest": "7b20fbb6b29c9a01436f19f8187f78af3c1f3dbf51162e604adcb9a6342ac9d7",
        "externalAdditionalData": null
      }
    ]
  }
}

2.2线上支付交易查询

介绍：依据商户号以及交易流水号或商户交易流水号（二选一）查询支付单信息。

接口地址: /saas/query

字段名	类型	是否必传	字段名称	说明
interfaceVersion	String	是	版本号	默认值:1.0.0
language	String	否	语言	语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceName	String	是	接口名称	填写:`transaction`
businessType	String	是	业务类型	填写:`query`
orgNo	String	是	机构编号
orgCertId	String	是	机构密钥证书序列号
signature	String	是	机构签名
signMethod	String	是	机构签名方法	取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名

类型

是否必传

字段名称

说明

merchant

字段名	类型	是否必传	字段名称	说明
merchantNo	String	是	商户号

Object

是

商户对象信息

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	选填	交易流水号	与商户交易流水号二选一
merchantSerialNo	String	选填	商户交易流水号	与交易流水号二选一

Object

是

支付单对象信息

Curl请求示例

 curl --location '${PAYMENT_DOMAIN}/saas/query' \
--header 'businessType: query' \
--header 'interfaceName: transaction' \
--header 'interfaceVersion: 1.0.0' \
--header 'language: zh_CN' \
--header 'orgNo: S**************' \
--header 'orgCertId: ****************************************' \
--header 'signature: A+/KPdwH1w1YDFBSGWiRn5qTSspRwfCxQQkFpAo7dPwWxAZcYAYXaaVvagUSkN4AlMclD/Nu3mEMCB4sRi9XH8jaghoKFmIPZ1RKu9J45C0NoMHp6g82MWLUCeT6YJhr6NsRaxfWnTDsk2il6yBBm8jufQxXd/g2v9u0DWd2r+dkOYjTIH6sbWGx+DK8SPhGas5cFG5xvcBno4JbWR82BHBxbCPDf7WpGRjWj81EDlJH8UWgSdJ0FpgR+iDl4h0AI4liCUJav2b5a3b1c1mdbnxh3NC2CVzbvuTrgYUD6Xo2H2EX5wb5GQD5EDznrNwpxayeZ74vHp7n22yeU7LHCQ==' \
--header 'signMethod: RSA-SHA256' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "S**************_20250721081638385_d6",
    "requestTime": "2025-07-21T08:16:38.386+08:00",
    "nonceStr": "1aHZhBUqnrijiUb7rDukP0UaT7qdV6nZ",
    "data": {
        "merchant": {
            "merchantNo": "**********"
        },
        "transaction": {
            "transactionNo": "TK6CE8B0450700000843566441054208",
            "merchantSerialNo": ""
        }
    }
}'

响应参数

介绍：响应线上支付支付单查询对象的详细数据，如支付流水号、原支付流水号、订单号、支付金额等。

字段名

类型

是否必传

字段名称

说明

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	是	支付流水号
originalTransactionNo	String	否	原支付流水号
orderNo	String	是	订单号
amount	decimal	是	支付金额	单位：元
addAmount	decimal	否	预授权追加金额	单位：元
authorizeAmount	decimal	否	预授权金额	单位：元
tipAmount	decimal	否	小费金额	单位：元
refundAmount	decimal	否	退款金额	单位：元
currency	String	是	币种
status	String	是	支付单状态	参考附录-枚举字典 11 交易状态
transactionType	String	是	交易类型	参考附录-枚举字典 3 交易类型
paymentWay	String	是	支付方式	参考附录-枚举字典 5 支付方式
paymentType	String	是	支付类型	参考附录-枚举字典 6 支付类型
paymentSubtype	String	是	支付子类型	参考附录-枚举字典 7 支付子类型
cardType	String	否	卡类型	参考附录-枚举字典 8 付款卡类型
cardFlag	String	否	卡标识	参考附录-枚举字典 9 卡标识
cardBrand	String	否	卡组织	参考附录-枚举字典 10 卡组织
cardNoDigest	String	否	卡号密文摘要	根据机构敏感信息配置条件返回，配置允许返回该字段存在值
payerFee	decimal	否	付款方费用	交易手续费明确才返回
payerRefundFee	decimal	否	付款方退款费用	交易手续费明确才返回
payeeFee	decimal	否	收款方费用	交易手续费明确才返回
payeeRefundFee	decimal	否	收款方退款费用	交易手续费明确才返回
authCode	String	否	授权码
refundFlag	String	否	退款标识	00.未处理，01.部分退款，02.全部退款
revokeFlag	String	否	撤销标识	00.未处理，01.已撤销
authCompleteFlag	String	否	完成标识	00.未处理，01.已完成
externalAdditionalData	String	否	外部附加数据	返回业务方自定义交易参数原值，JSON格式
responseCode	String	否	主码
responseMessage	String	否	主码说明
subCode	String	否	子码
subMessage	String	否	子码说明
completionTime	timestamp	否	交易完成时间
transactionTime	timestamp	是	交易时间
transactionZoneUTCTime	timestamp	是	交易时区时间
transactionZoneId	String	是	时区	交易时区例：Asia/Shanghai
localPayeeFee	decimal	是	服务费	收款方服务费(扣)（本地币种）
localPayeeRefundFee	decimal	是	服务费	收款方服务费(返)（本地币种）
localPayeeRefundTotalFee	decimal	是	服务费	收款方服务费(扣)退款金额（本地币种）

Object

是

支付单对象

响应Headers数据示例：

signature: rlMROtdEuS2zIh/eCMfT98kCgJ4gooB1Cf99SgXaaYS84uEdd+HWOzDYiBjuk5A3hDc3JuGuRSKToq4rovhEHo8h2BnaK5MmtLmhBpuDDyoLWsRuvsvq3Yc5BCipay9I9jB9Zh1MfqmrwXSjIhM5tCuwlsc3cLYgPvQyKX1dnf/f0sU1QxKGSZamDCqnIj8JvdWXaDKjyUi6StfUiL/5ggae04RMLdwfoIeTqUzhTQrCoSwISUVq43s3GSL+t45LpyojyzNitll8ygoIehgzxS37ab81pIpopm5ymhhRoUe2/srIJ0RhdAjbXBGtx0y3v68u1U4LqnVEo0lrC/uOqA==
orgCertId: ****************************************
signMethod: RSA-SHA256

响应Body数据示例

{
    "requestId": null,
    "requestTime": null,
    "responseTime": "2025-07-21T08:16:46.780+00:00",
    "respCode": 200,
    "respMsg": "success",
    "busCode": null,
    "busMsg": null,
    "busSubCode": null,
    "busSubMsg": null,
    "data": {
        "order": null,
        "transaction": {
            "transactionNo": "TK6CE8B0450700000843566441054208",
            "originalTransactionNo": null,
            "orderNo": "10820250714000010952",
            "externalOrderNo": null,
            "amount": 0.02,
            "authorizeAmount": null,
            "addAmount": null,
            "refundAmount": 0.00,
            "payerFee": 0.00,
            "payerRefundFee": 0.00,
            "payeeFee": 0.00,
            "payeeRefundFee": 0.00,
            "tipAmount": 0.00,
            "currency": "HKD",
            "transactionType": "01",
            "paymentWay": "01",
            "authCode": "389096",
            "status": "00",
            "responseCode": "200",
            "responseMessage": null,
            "subCode": null,
            "subMessage": null,
            "transactionTime": "2025-07-14T03:20:07.000+00:00",
            "transactionZoneUTCTime": "2025-07-14T11:20:07.000+08:00",
            "transactionZoneId": "Asia/Hong_Kong",
            "timeZoneFlag": 0,
            "completionTime": "2025-07-14T03:20:09.000+00:00",
            "refundFlag": "00",
            "revokeFlag": "00",
            "authCompleteFlag": "00",
            "paymentType": "01",
            "paymentSubtype": "03",
            "cardType": null,
            "cardFlag": "03",
            "cardBrand": "02",
            "merchantSerialNo": null,
            "taskId": null,
            "cardNoDigest": "7b20fbb6b29c9a01436f19f8187f78af3c1f3dbf51162e604adcb9a6342ac9d7",
            "externalAdditionalData": null
        }
    }
}

3.POS终端 API 接口

3.1 pos预下单

介绍：创建 POS 订单，参数包括商户对象信息、订单对象信息（外部订单号、订单金额、小费金额、币种、订单详情），返回订单对象信息，含平台订单号、订单状态等。

接口地址: /saas/pos

字段名	类型	是否必传	字段名称	说明
interfaceVersion	String	是	版本号	默认值:1.0.0
language	String	否	语言	语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceName	String	是	接口名称	填写:`preOrder`
businessType	String	是	业务类型	填写:`pos`
orgNo	String	是	机构编号
orgCertId	String	是	机构密钥证书序列号
signature	String	是	机构签名
signMethod	String	是	机构签名方法	取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名

类型

是否必传

字段名称

说明

merchant

字段名	类型	是否必传	字段名称	说明
merchantNo	String	是	商户号
productNo	String	否	产品编号	参考附录-枚举字典 1 产品编码

Object

是

商户对象信息

order

字段名	类型	是否必传	字段名称	说明
externalOrderNo	String	是	外部订单号（商家订单号）
amount	String	是	订单金额
tipAmount	String	否	小费金额
currency	String	是	币种	参考附录-枚举字典 12 币种
orderDetails	String	是	订单详情
externalAdditionalData	String	否	外部附加数据	传入业务方自定义订单参数

Object

是

订单对象信息

Curl请求示例

curl --location '${PAYMENT_DOMAIN}/saas/pos' \
--header 'businessType: pos' \
--header 'interfaceName: preOrder' \
--header 'interfaceVersion: 1.0.0' \
--header 'language: zh_CN' \
--header 'orgNo: S**************' \
--header 'orgCertId: ****************************************' \
--header 'signature: g6Y16R11teWTFMP7PiJzhyNn8n4XhHc/esK+u21TMQgnen3Jc15WTlUfiV9XdThi/2j8EWQwK63yB5R7YbBYoQrNL0FHVhnw2kahbqv+7Oy5fSRbEuv9onzXyNuHjSuzZZurvHWkvhEhj0c4DYeR3mzHHz32wSLCNJ0j+MbtxvAnUm2IJn863UrPazFtfKcW5+rP+OPt5GF5nCpqXWamwL0i0xF0A7dTKjp1H7HhgR/APdt/0NZu5niQMnHyVk8amWkoVFQ25ty/Hg0jJpgAsYGeiIzE0YlB9XVPXafxMYjgbFVi0++fHRrwIb2F7arNPcjaU8SgASjbMbw+uYO3UA==' \
--header 'signMethod: RSA-SHA256' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "S**************_20250721084506658_9f",
    "requestTime": "2025-07-21T08:45:06.658+08:00",
    "nonceStr": "06cDtGdwlsIIfk15zC8SUqatRaZw82fe",
    "data": {
        "merchant": {
            "merchantNo": "**********",
            "productNo": "C101"
        },
        "order": {
            "externalOrderNo": "EXT_ORDER_20250721164506",
            "amount": "800.00",
            "tipAmount": "20.00",
            "currency": "HKD",
            "orderDetails": "商品A x1,商品B x2,商品C x1"
        }
    }
}'

响应参数

介绍：响应pos预下单，订单对象信息，平台订单号，订单金额，预授权金额，小费金额，订单状态信息：

字段名

类型

是否必传

字段名称

说明

order

字段名	类型	是否必传	字段名称	说明
orderNo	String	是	平台订单号
externalOrderNo	String	否	外部订单号	商家订单号
amount	String	是	订单金额	单位：元
tipAmount	String	否	小费金额	单位：元
authorizeAmount	decimal	否	授权金额	单位：元
currency	String	是	币种	参考附录-枚举字典 12 币种
orderTime	timestamp	是	下单时间
orderStatus	String	是	订单状态	参考附录-枚举字典 2 订单状态
externalAdditionalData	String	否	外部附加数据	传入业务方自定义交易参数，JSON格式

Object

是

订单对象信息

响应Headers数据示例：

signature: L4WrntCSrkOnrI+zqeIVfm/bVcwYh/AoBHemdxM4kubCDW4VDc4vS5D0mrCuucNZUSpfUHxzXh1nZeBY+W2UO3dam097rgSctVfDRrZ088ohz4Xac0WjE1sSvR3Kdnb4UEIudX5nQcQDi1ADqJsIHdzJ+SVHvMC2clkNuvrDGlUBN/JRLSITa8wSnAKCyjtDYznDzXsDtStw7lTcBNcaSG25lCbomZ8NqX8pWfC1yEmQY5Ob49C9zSGlj1aE++3frSt7PLtv0UJzvwkXY4cMufwdgm9q3T6RM3lMabXXbFLKlEqRNCrx8hXGSNYBLvtNQIAy17uDcBUWtG7glYmAlA==
orgCertId: ****************************************
signMethod: RSA-SHA256

响应Body数据示例

{
    "requestId": null,
    "requestTime": null,
    "responseTime": "2025-07-21T08:43:19.002+00:00",
    "respCode": 200,
    "respMsg": "success",
    "busCode": null,
    "busMsg": null,
    "busSubCode": null,
    "busSubMsg": null,
    "data": {
        "order": {
            "externalOrderNo": "EXT_ORDER_20250721164309",
            "orderNo": "10820250721000011181",
            "amount": "800.00",
            "tipAmount": "20.00",
            "currency": "HKD",
            "orderStatus": "01"
        }
    }
}

3.2 pos预授权完成

介绍：预授权交易确认后进行的完成确认，预授权订单主要是确认预授权完成的订单金额，进行完成确认。

接口地址: /saas/pos

字段名	类型	是否必传	字段名称	说明
interfaceVersion	String	是	版本号	默认值:1.0.0
language	String	否	语言	语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceName	String	是	接口名称	填写:`auth/capture`
businessType	String	是	业务类型	填写:`pos`
orgNo	String	是	机构编号
orgCertId	String	是	机构密钥证书序列号
signature	String	是	机构签名
signMethod	String	是	机构签名方法	取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名

类型

是否必传

字段名称

说明

merchant

字段名	类型	是否必传	字段名称	说明
merchantNo	String	是	商户号

Object

是

商户对象信息

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	是	原交易流水号
merchantSerialNo	String	是	商户流水号
amount	String	是	金额	单位：元
tipAmount	String	否	小费金额	单位：元
externalAdditionalData	String	否	外部附加数据	传入业务方自定义交易参数，JSON格式

Object

是

订单对象信息

Curl请求示例

curl --location '${PAYMENT_DOMAIN}/saas/pos' \
--header 'businessType: pos' \
--header 'interfaceName: auth/capture' \
--header 'interfaceVersion: 1.0.0' \
--header 'language: zh_CN' \
--header 'orgNo: S**************' \
--header 'orgCertId: ****************************************' \
--header 'signature: T8KDHqYf8cbK4FtwdD1I0DaQaVACIOCBPvy5kIcSlUhMZRG6fXVBhzz47DIjPOP9NLOKo1i7EsnKcXDaL4pmI3yyTYRMYuPalUp4DH6Pyypvyli4mVHDjw7zZE2lcPOYJO8DG1werdUcrQJ93inLzaeqI2mgAAdjBC+J5Wxva/pooQStuWxm4YRfcYdsTWTfT2Cl+bL3c0yMHwkCKi+Xe0eD7De2SNigxX+9oBzojAoJB0UhpjB3GF4Zy7qQP3kMuCOfZJU5i5XAMcVBBOl27ADxcIU2EAwLliKEpzQw3SbgrUULZTO8Mlh/oQcJLx3WN/uvwYMOFQ1yjY8u16KNtg==' \
--header 'signMethod: RSA-SHA256' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "S**************_20250722042604854_8d",
    "requestTime": "2025-07-22T04:26:04.854+08:00",
    "nonceStr": "dwq6VXHzTqcqa2wzla779rDCebnzAJTB",
    "data": {
        "merchant": {
            "merchantNo": "**********"
        },
        "transaction": {
            "transactionNo": "TKB7C32E377400000843840740835328",
            "merchantSerialNo": "MERCHANT_SERIAL_20250722122604",
            "amount": "10",
            "tipAmount": "0.00"
        }
    }
}'

响应参数

字段名

类型

是否必传

字段名称

说明

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	是	支付流水号
originalTransactionNo	String	否	原支付流水号
merchantSerialNo	String	否	商户流水号
amount	decimal	是	支付金额	单位：元
tipAmount	decimal	否	小费金额	单位：元
currency	String	是	币种	参考附录-枚举字典 12 币种
status	String	是	支付单状态	参考附录-枚举字典 11 交易状态
orderNo	String	是	平台订单号
externalOrderNo	String	否	外部订单号
refundAmount	decimal	否	退款金额	单位：元
transactionType	String	是	交易类型	参考附录-枚举字典 3 交易类型
paymentWay	String	是	支付方式	参考附录-枚举字典 5 支付方式
cardNoDigest	String	否	卡号密文摘要	根据机构敏感信息配置条件返回，配置允许返回该字段存在值
authCode	String	否	授权码
responseCode	String	否	主码
responseMessage	String	否	主码说明
subCode	String	否	子码
subMessage	String	否	子码说明
completionTime	timestamp	否	交易完成时间
transactionTime	timestamp	是	交易时间
transactionZoneUTCTime	timestamp	是	交易时区时间
transactionZoneId	String	是	时区	交易时区例：Asia/Shanghai
timeZoneFlag	Integer	是	时区标识	时区标识：0.标准时间，1.夏令时
externalAdditionalData	String	否	外部附加数据	返回业务方自定义交易参数原值，JSON格式

Object

是

支付单对象

响应Headers数据示例：

signature: idCYp8R2h4TPiLLN+E+K3F9uKwScaJjlAUwxut8PwEh4EfHn526IPZuw1MITfEmsQA06sNYrr5hI7dsaBJrBWLV8UFWKfuSkg2aPn94THa3TD/NZt5r7NxGYVAT2IGmw2q+h+z5hFQSBRENsz1r1GIhtQogaH2klN5m5XQNgJlHuGoMNpbCY8MRtDhVjmILrXHb1SrqsMQKW74r4EbjwXi6ZTV4c/OnYIXemg6us8v3kw9h4pKKWPsZh+jP9Y7Xk51SUFxOemxMayrW1xoDuOzZt0W5jCaX07KDrn4CKkFx0IPCnxjiv5vfavONN3/kbt0BYzqLMnFzWTVgIoCWN0w==
orgCertId: ****************************************
signMethod: RSA-SHA256

响应Body数据示例

{
    "requestId": null,
    "requestTime": null,
    "responseTime": "2025-07-22T04:27:17.961+00:00",
    "respCode": 200,
    "respMsg": "success",
    "busCode": null,
    "busMsg": null,
    "busSubCode": null,
    "busSubMsg": null,
    "data": {
        "transaction": {
            "merchantNo": "**********",
            "terminalSerialNo": "SI********",
            "merchantSerialNo": "MERCHANT_SERIAL_20250722122604",
            "amount": 10.00,
            "transactionNo": "TKD8A489C4F400000843961915965440",
            "originalTransactionNo": "TKB7C32E377400000843840740835328",
            "orderNo": "10820250722000011204",
            "refundAmount": 0.00,
            "tipAmount": 0.00,
            "currency": "HKD",
            "transactionType": "06",
            "paymentWay": "01",
            "authCode": "288927",
            "status": "00",
            "responseCode": "200",
            "transactionTime": "2025-07-22T04:27:14.000+00:00",
            "transactionZoneUTCTime": "2025-07-22T12:27:14.000+08:00",
            "transactionZoneId": "Asia/Hong_Kong",
            "timeZoneFlag": 0,
            "completionTime": "2025-07-22T04:27:18.000+00:00",
            "cardBrand": "01"
        }
    }
}

3.3 pos预授权撤销

介绍：POS设备订单预授权撤销操作，需要输入商户对象信息，商户号，订单对象信息，原交易流水号，商户流水号

接口地址: /saas/pos

字段名	类型	是否必传	字段名称	说明
interfaceVersion	String	是	版本号	默认值:1.0.0
language	String	否	语言	语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceName	String	是	接口名称	填写:`auth/revoke`
businessType	String	是	业务类型	填写:`pos`
orgNo	String	是	机构编号
orgCertId	String	是	机构密钥证书序列号
signature	String	是	机构签名
signMethod	String	是	机构签名方法	取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名

类型

是否必传

字段名称

说明

merchant

字段名	类型	是否必传	字段名称	说明
merchantNo	String	是	商户号

Object

是

商户对象信息

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	是	原交易流水号
merchantSerialNo	String	是	商户流水号
externalAdditionalData	String	否	外部附加数据	传入业务方自定义交易参数，JSON格式

Object

是

订单对象信息

Curl请求示例

curl --location '${PAYMENT_DOMAIN}/saas/pos' \
--header 'businessType: pos' \
--header 'interfaceName: auth/revoke' \
--header 'interfaceVersion: 1.0.0' \
--header 'language: zh_CN' \
--header 'orgNo: S**************' \
--header 'orgCertId: ****************************************' \
--header 'signature: DB07yd0mkHAyDG+m6d51Y6ju0TPuvvvJqHFahJ3U3uRE0qYfG7Q4BarFMUk9iBdzALurXPR66hUulixLjpoKAbuABnDKTPPP1okyE0tr+y3Xak8AuLQ0blGJJeSxN1+vhq8pCnU601OgVYDs/s2UDceSki1cVKBE/9gwVDQ6GFh2Cu1t3uj1xEZLiriWj3Ps2wxsw7vHiVmrN7dIH33YnOn4Xn79j4jYk5869JUbpm2uPRCg1bHU4+4Yk1EUDtI4TDmzNWP5RBahcKN0X4yTRY/bvT0kD4NwVijqB/xi7EdMzGRNaR7/FpbBeI7kXscpIXxjxbUaPOpL5qQctbMBGg==' \
--header 'signMethod: RSA-SHA256' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "S**************_20250722043718741_a9",
    "requestTime": "2025-07-22T04:37:18.741+08:00",
    "nonceStr": "qK761D4PPNrXfPKy3wrMPV20x86yVzTh",
    "data": {
        "merchant": {
            "merchantNo": "**********"
        },
        "transaction": {
            "transactionNo": "TK7AE428D09800000843971106439168",
            "merchantSerialNo": "MERCHANT_SERIAL_20250722123718"
        }
    }
}'

响应参数

介绍：响应预授权撤销情况是否成功，显示撤销金额和撤销情况

字段名

类型

是否必传

字段名称

说明

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	是	支付流水号
originalTransactionNo	String	否	原支付流水号
merchantSerialNo	String	否	商户流水号
amount	decimal	是	支付金额	单位：元
tipAmount	decimal	否	小费金额	单位：元
currency	String	是	币种
status	String	是	支付单状态	参考附录-枚举字典 11 交易状态
orderNo	String	是	订单号
externalOrderNo	String	否	外部订单号
refundAmount	decimal	否	退款金额	单位：元
transactionType	String	是	交易类型	参考附录-枚举字典 3 交易类型
paymentWay	String	是	支付方式	参考附录-枚举字典 5 支付方式
cardNoDigest	String	否	卡号密文摘要	根据机构敏感信息配置条件返回，配置允许返回该字段存在值
authCode	String	否	授权码
responseCode	String	否	主码
responseMessage	String	否	主码说明
subCode	String	否	子码
subMessage	String	否	子码说明
completionTime	timestamp	否	交易完成时间
transactionTime	timestamp	是	交易时间
transactionZoneUTCTime	timestamp	是	交易时区时间
transactionZoneId	String	是	时区	交易时区例：Asia/Shanghai
timeZoneFlag	Integer	是	时区标识	时区标识：0.标准时间，1.夏令时
externalAdditionalData	String	否	外部附加数据	返回业务方自定义交易参数原值，JSON格式

Object

是

支付单对象

响应Headers数据示例：

signature: Oil2Qv4rKWTwlDwVA39b4mGqRX8kBY3kWtJhUHQnrGvDR48Q8h/0VuQYkp+tz0q28XPKftUG8XUf4lkcGRkEfTn/E2P6pV7HeVvmLzMkpp2na8NnViflTWZCf9jF0xZI6cLXCdd8cJZZKhJkxbGp6l6V3cxU6Dl/pCSVNM2Ys9q618516Ynd4mGI4KPW/pmsLJiGuWFT8M8LwEZEM4ZkM+EofXDWVCoNjhMiIZeCdN0V49plKJfkmJYKM5n3IAZ1BwMiivM6FQygF5/MtgZ5MlEq+qFTw/13EVYC9X2PuwRi/BKyItHQanCP4LuCzM9Pnl/4KLJ3HG2Z675qjqreIA==
orgCertId: ****************************************
signMethod: RSA-SHA256

响应Body数据示例

{
    "requestId": null,
    "requestTime": null,
    "responseTime": "2025-07-22T04:37:47.920+00:00",
    "respCode": 200,
    "respMsg": "success",
    "busCode": null,
    "busMsg": null,
    "busSubCode": null,
    "busSubMsg": null,
    "data": {
        "transaction": {
            "merchantNo": "**********",
            "terminalSerialNo": "SI********",
            "merchantSerialNo": "MERCHANT_SERIAL_20250722123718",
            "amount": 20.00,
            "transactionNo": "TKCB0FB454BF00000843972268752896",
            "originalTransactionNo": "TK7AE428D09800000843971106439168",
            "orderNo": "10820250722000011206",
            "refundAmount": 0.00,
            "tipAmount": 0.00,
            "currency": "HKD",
            "transactionType": "05",
            "paymentWay": "01",
            "authCode": "409703",
            "status": "00",
            "responseCode": "200",
            "transactionTime": "2025-07-22T04:37:46.000+00:00",
            "transactionZoneUTCTime": "2025-07-22T12:37:46.000+08:00",
            "transactionZoneId": "Asia/Hong_Kong",
            "timeZoneFlag": 0,
            "completionTime": "2025-07-22T04:37:48.000+00:00",
            "cardBrand": "01"
        }
    }
}

3.4 pos预授权完成撤销

介绍：进行订单交易被预授权确认完成后，还需要进行预授权撤销就需要进行预授权完成撤销请求，主要用于预授权完成后使用

接口地址: /saas/pos

字段名	类型	是否必传	字段名称	说明
interfaceVersion	String	是	版本号	默认值:1.0.0
language	String	否	语言	语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceName	String	是	接口名称	填写:`auth/capture/revoke`
businessType	String	是	业务类型	填写:`pos`
orgNo	String	是	机构编号
orgCertId	String	是	机构密钥证书序列号
signature	String	是	机构签名
signMethod	String	是	机构签名方法	取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名

类型

是否必传

字段名称

说明

merchant

字段名	类型	是否必传	字段名称	说明
merchantNo	String	是	商户号

Object

是

商户对象信息

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	是	原交易流水号
merchantSerialNo	String	是	商户流水号
externalAdditionalData	String	否	外部附加数据	传入业务方自定义交易参数，JSON格式

Object

是

订单对象信息

Curl请求示例

curl --location '${PAYMENT_DOMAIN}/saas/pos' \
--header 'businessType: pos' \
--header 'interfaceName: auth/capture/revoke' \
--header 'interfaceVersion: 1.0.0' \
--header 'language: zh_CN' \
--header 'orgNo: S**************' \
--header 'orgCertId: ****************************************' \
--header 'signature: hVYTG+hu6WCg9Sa1FWJmfBv2zw7IbEPCxQ45skg89ZdapGZejOy6RWg4F1etTgUuiBV0D8lIxTd+OEkRxJZChW5D0+QylBxQynr1aki+wANCz/C6AfssqKSRK57K6A8wb751/BN89kkGx+hwg0Ia/ALtGH2JXn/gM6vx/lNbb0p0OuaiWAja1G/gharQnFsNGuVTw7IPZ2eftJP1OLffmA8BTq68N+640Kxbd95eArj8SPtwq/ODNrxdqtUQYR3smiJZJ4+KbitSRMtbFv8VKdM4vxgyo+Wt7pVSN2MekUdZqeGCuYhMqdysTD0nlMMaxRqYKcc5NmYwMhWGQ8pLmg==' \
--header 'signMethod: RSA-SHA256' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "S**************_20250722043410948_05",
    "requestTime": "2025-07-22T04:34:10.948+08:00",
    "nonceStr": "Hf2GRMa1KfrOZi91la8pJ351iub0skbv",
    "data": {
        "merchant": {
            "merchantNo": "**********"
        },
        "transaction": {
            "transactionNo": "TKD8A489C4F400000843961915965440",
            "merchantSerialNo": "MERCHANT_SERIAL_20250722123410"
        }
    }
}'

响应参数

字段名

类型

是否必传

字段名称

说明

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	是	支付流水号
originalTransactionNo	String	否	原支付流水号
merchantSerialNo	String	否	商户流水号
amount	decimal	是	支付金额	单位：元
tipAmount	decimal	否	小费金额	单位：元
currency	String	是	币种
status	String	是	支付单状态	参考附录-枚举字典 11 交易状态
orderNo	String	是	订单号
externalOrderNo	String	否	外部订单号
refundAmount	decimal	否	退款金额	单位：元
transactionType	String	是	交易类型	参考附录-枚举字典 3 交易类型
paymentWay	String	是	支付方式	参考附录-枚举字典 5 支付方式
authCode	String	否	授权码
responseCode	String	否	主码
responseMessage	String	否	主码说明
subCode	String	否	子码
subMessage	String	否	子码说明
completionTime	timestamp	否	交易完成时间
transactionTime	timestamp	是	交易时间
transactionZoneUTCTime	timestamp	是	交易时区时间
transactionZoneId	String	是	时区	交易时区例：Asia/Shanghai
timeZoneFlag	Integer	是	时区标识	时区标识：0.标准时间，1.夏令时
externalAdditionalData	String	否	外部附加数据	返回业务方自定义交易参数原值，JSON格式

Object

是

支付单对象

响应Headers数据示例：

signature: DoT8AzRpkN8p7YvPiEWybWdWI7T/jDCc5demxlorQc0eJl9i2IY40xszDLUBPkuTSjTKSeuZrdFFAoITQIS3Z3+ULKK8ed2h/5vruuqFqMsj9/u9dGaK9y9BIpc4+ey2bVd6eksk+oM+kfjWCB1bmYKbaF5moD62k6uDLSd8k5NeSQvSmqh9903m8UrcUfpxrn0pHR3ectDgqMDqjkmM8IaiU3zNE6G7xaYIb+J9SosMG1AkNk8kA5uTtlvIban7anIe0uFT3H5JcWHWsBEsAHHNOCJIKTcvlDxpQMp4SrBSuxhYiEKEvt07sugkQ/+doDaZV4ST0QksntiNvDZ/HQ==
orgCertId: ****************************************
signMethod: RSA-SHA256

响应Body数据示例

{
    "requestId": null,
    "requestTime": null,
    "responseTime": "2025-07-22T04:34:29.441+00:00",
    "respCode": 200,
    "respMsg": "success",
    "busCode": null,
    "busMsg": null,
    "busSubCode": null,
    "busSubMsg": null,
    "data": {
        "transaction": {
            "merchantNo": "**********",
            "terminalSerialNo": "SI********",
            "merchantSerialNo": "MERCHANT_SERIAL_20250722123410",
            "amount": 10.00,
            "transactionNo": "TK228856D63100000843969007550464",
            "originalTransactionNo": "TKB7C32E377400000843840740835328",
            "orderNo": "10820250722000011204",
            "refundAmount": 0.00,
            "tipAmount": 0.00,
            "currency": "HKD",
            "transactionType": "07",
            "paymentWay": "01",
            "authCode": "288927",
            "status": "00",
            "responseCode": "200",
            "transactionTime": "2025-07-22T04:34:27.000+00:00",
            "transactionZoneUTCTime": "2025-07-22T12:34:27.000+08:00",
            "transactionZoneId": "Asia/Hong_Kong",
            "timeZoneFlag": 0,
            "completionTime": "2025-07-22T04:34:29.000+00:00",
            "cardBrand": "01"
        }
    }
}

3.5 pos交易消费撤销

介绍：用于POS交易消费的撤销

接口地址: /saas/pos

字段名	类型	是否必传	字段名称	说明
interfaceVersion	String	是	版本号	默认值:1.0.0
language	String	否	语言	语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceName	String	是	接口名称	填写:`sale/revoke`
businessType	String	是	业务类型	填写:`pos`
orgNo	String	是	机构编号
orgCertId	String	是	机构密钥证书序列号
signature	String	是	机构签名
signMethod	String	是	机构签名方法	取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名

类型

是否必传

字段名称

说明

merchant

字段名	类型	是否必传	字段名称	说明
merchantNo	String	是	商户号

Object

是

商户对象信息

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	是	原交易流水号
merchantSerialNo	String	是	商户流水号
externalAdditionalData	String	否	外部附加数据	传入业务方自定义交易参数，JSON格式

Object

是

订单对象信息

Curl请求示例

curl --location '${PAYMENT_DOMAIN}/saas/pos' \
--header 'businessType: pos' \
--header 'interfaceName: sale/revoke' \
--header 'interfaceVersion: 1.0.0' \
--header 'language: zh_CN' \
--header 'orgNo: S**************' \
--header 'orgCertId: ****************************************' \
--header 'signature: Cag3B1EezGfsZspMPbqikttaIwyUSyk/N7BqKXXP+yvBSKux5qYjEDy7KmbmTKOj0bDotAZ3wnzzbPABrSphrEIEqxfviK2nzD+t87fGnPFQhvRXQ6JQEIx4T6SRUlJj/pvdnoSgG35qfo8l2LRqrFWresAdrwSIAnZm81qn1FZ9Zxsv+VIKATM4mBXaqmd9wvSwOaq/idN6aneeYWmN6TrT0Bt3FRbipVD+dhTiL7g6uQue8dJmhasGMFuVpv/kWpiw4j6CPc3e2BFljp6fn+RkqTgn4BntzNbjAFXqX4cOsW7VN9ydClPRPJMtZw7Ph1g95FbBq/OB1O2ykksV2A==' \
--header 'signMethod: RSA-SHA256' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "S**************_20250722044901042_fb",
    "requestTime": "2025-07-22T04:49:01.042+08:00",
    "nonceStr": "AC0QGqGDPGe3sQ5aJEmPMmphDfISrsPr",
    "data": {
        "merchant": {
            "merchantNo": "**********"
        },
        "transaction": {
            "transactionNo": "TK8B899F411F00000843981861158912",
            "merchantSerialNo": "MERCHANT_SERIAL_20250722124901"
        }
    }
}'

响应参数

字段名

类型

是否必传

字段名称

说明

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	是	支付流水号
originalTransactionNo	String	否	原支付流水号
merchantSerialNo	String	否	商户流水号
amount	decimal	是	支付金额	单位：元
tipAmount	decimal	否	小费金额	单位：元
currency	String	是	币种
status	String	是	支付单状态	参考附录-枚举字典 11 交易状态
orderNo	String	是	订单号
externalOrderNo	String	否	外部订单号
refundAmount	decimal	否	退款金额	单位：元
transactionType	String	是	交易类型	参考附录-枚举字典 3 交易类型
paymentWay	String	是	支付方式	参考附录-枚举字典 5 支付方式
cardNoDigest	String	否	卡号密文摘要	根据机构敏感信息配置条件返回，配置允许返回该字段存在值
authCode	String	否	授权码
responseCode	String	否	主码
responseMessage	String	否	主码说明
subCode	String	否	子码
subMessage	String	否	子码说明
completionTime	timestamp	否	交易完成时间
transactionTime	timestamp	是	交易时间
transactionZoneUTCTime	timestamp	是	交易时区时间
transactionZoneId	String	是	时区	交易时区例：Asia/Shanghai
timeZoneFlag	Integer	是	时区标识	时区标识：0.标准时间，1.夏令时
externalAdditionalData	String	否	外部附加数据	返回业务方自定义交易参数原值，JSON格式

Object

是

支付单对象

响应Headers数据示例：

signature: kJ2EKLCxMFL+5rbrcubFZbJCmMnAFh2EVo5auGxdP1qE4DlkzJG5k0dlB3F+6C4iZky5rpCYDTrxGCaYvw4NY1eFOl/qmzF40pox/pPxNzf40wIqUrFyHrS+sxixPHvmMeWBfN7sghNO25UMHJSDvZo86PAFxIvnzeTVHu3Gc5llhjZkhWTvsfhk8syrGhUSVP7DkJpUWsniGWVYs1AxVK4MLSCl+ZNNL+cg0J8Lz3vwiHB2UA1HXTG9lbi//TodUoqBTLH5kt7zgiP2cPau49lJhZm5dupeFuYJt+fBHT2IKF2N0bbGaHHgYY/mFE94/gdp+tuW8lzeGgMSC1i6hA==
orgCertId: ****************************************
signMethod: RSA-SHA256

响应Body数据示例

{
    "requestId": null,
    "requestTime": null,
    "responseTime": "2025-07-22T04:49:17.336+00:00",
    "respCode": 200,
    "respMsg": "success",
    "busCode": null,
    "busMsg": null,
    "busSubCode": null,
    "busSubMsg": null,
    "data": {
        "transaction": {
            "merchantNo": "**********",
            "terminalSerialNo": "SI********",
            "merchantSerialNo": "MERCHANT_SERIAL_20250722124901",
            "amount": 20.00,
            "transactionNo": "TK05280F33D100000843983577563136",
            "originalTransactionNo": "TK8B899F411F00000843981861158912",
            "orderNo": "10820250722000011210",
            "refundAmount": 0.00,
            "tipAmount": 0.00,
            "currency": "HKD",
            "transactionType": "02",
            "paymentWay": "01",
            "status": "00",
            "responseCode": "200",
            "transactionTime": "2025-07-22T04:49:16.000+00:00",
            "transactionZoneUTCTime": "2025-07-22T12:49:16.000+08:00",
            "transactionZoneId": "Asia/Hong_Kong",
            "timeZoneFlag": 0,
            "completionTime": "2025-07-22T04:49:17.000+00:00",
            "cardBrand": "01"
        }
    }
}

3.6 pos退款

介绍：用于pos交易退款

接口地址: /saas/pos

字段名	类型	是否必传	字段名称	说明
interfaceVersion	String	是	版本号	默认值:1.0.0
language	String	否	语言	语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceName	String	是	接口名称	填写:`refund`
businessType	String	是	业务类型	填写:`pos`
orgNo	String	是	机构编号
orgCertId	String	是	机构密钥证书序列号
signature	String	是	机构签名
signMethod	String	是	机构签名方法	取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名

类型

是否必传

字段名称

说明

merchant

字段名	类型	是否必传	字段名称	说明
merchantNo	String	是	商户号

Object

是

商户对象信息

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	是	原交易流水号
merchantSerialNo	String	是	商户流水号
amount	String	是	金额	单位：元
tipAmount	String	否	小费金额	单位：元
externalAdditionalData	String	否	外部附加数据	传入业务方自定义交易参数，JSON格式

Object

是

订单对象信息

Curl请求示例

curl --location '${PAYMENT_DOMAIN}/saas/pos' \
--header 'businessType: pos' \
--header 'interfaceName: refund' \
--header 'interfaceVersion: 1.0.0' \
--header 'language: zh_CN' \
--header 'orgNo: S**************' \
--header 'orgCertId: ****************************************' \
--header 'signature: WYFGBpvVS9XabLuXNZjL60FCku80N3+dvZi08WNb7vowLgQbZeYCVdih0Zgu96vu5+C4Xr6Ycr2eNyBhUhGIlSjXR7/qJvjRpcm0o8+cPwvD+i+MGktbtCFiN131k2FHs0+wkdrdZDD6VG1aYkZlVtnzzWkPRIDDdgbD5wrctM4gs/Pqb4LjfDDNf9VmdciEDAxXFGOAsyZAC8nkH/DckVtAWnWC9gzhfS3KGAX/xVyitisFozScb7Hdbewh4Rv8IBiIiHIk5GGPbxnFjkgzKf3TpOJMgL1845Tx3geBw0T5NuJSs2Et/NW0Y+Pp1FkaiWR5xTRRp3QcP2FNWyPpsQ==' \
--header 'signMethod: RSA-SHA256' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "S**************_20250722045241825_fc",
    "requestTime": "2025-07-22T04:52:41.825+08:00",
    "nonceStr": "aEJ6mdknJnDSQLeu0iyDyueMI7upoiUB",
    "data": {
        "merchant": {
            "merchantNo": "**********"
        },
        "transaction": {
            "transactionNo": "TKE18DD7B12000000843982354104320",
            "merchantSerialNo": "MERCHANT_SERIAL_20250722125241",
            "amount": "10.00",
            "tipAmount": "0.00"
        }
    }
}'

响应参数

字段名

类型

是否必传

字段名称

说明

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	是	支付流水号
originalTransactionNo	String	否	原支付流水号
merchantSerialNo	String	否	商户流水号
amount	decimal	是	支付金额	单位：元
tipAmount	decimal	否	小费金额	单位：元
currency	String	是	币种	参考附录-枚举字典 12 币种
status	String	是	支付单状态	参考附录-枚举字典 11 交易状态
orderNo	String	是	平台订单号
externalOrderNo	String	否	外部订单号
refundAmount	decimal	否	退款金额	单位：元
transactionType	String	是	交易类型	参考附录-枚举字典 3 交易类型
paymentWay	String	是	支付方式	参考附录-枚举字典 5 支付方式
cardNoDigest	String	否	卡号密文摘要	根据机构敏感信息配置条件返回，配置允许返回该字段存在值
authCode	String	否	授权码
responseCode	String	否	主码
responseMessage	String	否	主码说明
subCode	String	否	子码
subMessage	String	否	子码说明
completionTime	timestamp	否	交易完成时间
transactionTime	timestamp	是	交易时间
transactionZoneUTCTime	timestamp	是	交易时区时间
transactionZoneId	String	是	时区	交易时区例：Asia/Shanghai
timeZoneFlag	Integer	是	时区标识	时区标识：0.标准时间，1.夏令时
externalAdditionalData	String	否	外部附加数据	返回业务方自定义交易参数原值，JSON格式

Object

是

支付单对象

响应Headers数据示例：

signature: kNG/8hcqaVIzeqhufxpI7P1phMaDyipFmi7hjp1E/dRI/YxxJuE67t7YfLcD+Nvour2UyexsvtGCefAXuVZgQnHDGCr7XHmJDzkuxe1YD6KI6O8ILgF3FOqawZKBUkCQGl/XwYscuTWeJVh4PD0oRf3LDiAmaNG/V2t+r5a308/usJOzK45Zf/dHfxylXKCindvQ7OAVSmvSElB0o7s0gh5DsYLzy1ZOI9BdVlIWHOGUiJYZlmV+8hF5zhGrOplGZTCDedIhQQO+g/whqpZv0icmTWcfHyyF9S6mOaPV87V+xCVR1e0JBdix7F8Arn0I8wmveYW0EPDLakhh/M9kAQ==
orgCertId: ****************************************
signMethod: RSA-SHA256

响应Body数据示例

{
    "requestId": null,
    "requestTime": null,
    "responseTime": "2025-07-22T04:52:56.139+00:00",
    "respCode": 200,
    "respMsg": "success",
    "busCode": null,
    "busMsg": null,
    "busSubCode": null,
    "busSubMsg": null,
    "data": {
        "transaction": {
            "merchantNo": "**********",
            "terminalSerialNo": "SI********",
            "merchantSerialNo": "MERCHANT_SERIAL_20250722125241",
            "amount": 10.00,
            "transactionNo": "TK0262FCA3DB00000843987140689920",
            "originalTransactionNo": "TKE18DD7B12000000843982354104320",
            "orderNo": "10820250722000011211",
            "refundAmount": 0.00,
            "tipAmount": 0.00,
            "currency": "HKD",
            "transactionType": "08",
            "paymentWay": "01",
            "status": "00",
            "responseCode": "200",
            "transactionTime": "2025-07-22T04:52:54.000+00:00",
            "transactionZoneUTCTime": "2025-07-22T12:52:54.000+08:00",
            "transactionZoneId": "Asia/Hong_Kong",
            "timeZoneFlag": 0,
            "completionTime": "2025-07-22T04:52:56.000+00:00",
            "cardBrand": "01"
        }
    }
}

3.7 pos小费撤销

介绍：用于pos机消费进行的小费交易的撤销。

接口地址: /saas/pos

字段名	类型	是否必传	字段名称	说明
interfaceVersion	String	是	版本号	默认值:1.0.0
language	String	否	语言	语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceName	String	是	接口名称	填写:`tip/revoke`
businessType	String	是	业务类型	填写:`pos`
orgNo	String	是	机构编号
orgCertId	String	是	机构密钥证书序列号
signature	String	是	机构签名
signMethod	String	是	机构签名方法	取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名

类型

是否必传

字段名称

说明

merchant

字段名	类型	是否必传	字段名称	说明
merchantNo	String	是	商户号

Object

是

商户对象信息

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	是	原交易流水号
merchantSerialNo	String	是	商户流水号
externalAdditionalData	String	否	外部附加数据	传入业务方自定义交易参数，JSON格式

Object

是

订单对象信息

Curl请求示例

curl --location '${PAYMENT_DOMAIN}/saas/pos' \
--header 'businessType: pos' \
--header 'interfaceName: tip/revoke' \
--header 'interfaceVersion: 1.0.0' \
--header 'language: zh_CN' \
--header 'orgNo: S**************' \
--header 'orgCertId: ****************************************' \
--header 'signature: Bq5IgE3OCNuESPDELic2Rp5ko50Z1V3iYwdFQZEICt9WBVDMSP9VJMtCH/VVdUD3n/L+Bkid++2QlKRa3GxBDgEuPM71sGOlnopiPlpu9z9mN7/y1Cw3CxwWO0SnJFHEqNfoSOoH+MxrPyTtLtXuGOeUJ7EHyBLKUvQoL9SSknjqLrqP/MSoEqmo8a5EiBD+LiSFkEOxs1HWncFUBSVT+5b5tYOvTEf3wccgDbbI2Mc/ahiHq+x/3UQZTypvdrpMnU6FoL+7vH9MKP+j34daq6v82oh47ebycBOwsoLv+LvccRnWlm/JGIp/s6p9fsaI3rcbCnr2ZzswBOlkJrItUg==' \
--header 'signMethod: RSA-SHA256' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "S**************_20250722045857490_ca",
    "requestTime": "2025-07-22T04:58:57.490+08:00",
    "nonceStr": "YL0PdhJdmh4Z814fLxjZCAzSlLhvmz6b",
    "data": {
        "merchant": {
            "merchantNo": "**********"
        },
        "transaction": {
            "transactionNo": "TK2EFEB08DDD00000628919306223616",
            "merchantSerialNo": "MERCHANT_SERIAL_20250722125857"
        }
    }
}'

响应参数

字段名

类型

是否必传

字段名称

说明

transaction

字段名	类型	是否必传	字段名称	说明
transactionNo	String	是	支付流水号
originalTransactionNo	String	否	原支付流水号
merchantSerialNo	String	否	商户流水号
amount	decimal	是	支付金额	单位：元
tipAmount	decimal	否	小费金额	单位：元
currency	String	是	币种	参考附录-枚举字典 12 币种
status	String	是	支付单状态	参考附录-枚举字典 11 交易状态
orderNo	String	是	平台订单号
externalOrderNo	String	否	外部订单号
refundAmount	decimal	否	退款金额	单位：元
transactionType	String	是	交易类型	参考附录-枚举字典 3 交易类型
paymentWay	String	是	支付方式	参考附录-枚举字典 5 支付方式
cardNoDigest	String	否	卡号密文摘要	根据机构敏感信息配置条件返回，配置允许返回该字段存在值
authCode	String	否	授权码
responseCode	String	否	主码
responseMessage	String	否	主码说明
subCode	String	否	子码
subMessage	String	否	子码说明
completionTime	timestamp	否	交易完成时间
transactionTime	timestamp	是	交易时间
transactionZoneUTCTime	timestamp	是	交易时区时间
transactionZoneId	String	是	时区	交易时区例：Asia/Shanghai
timeZoneFlag	Integer	是	时区标识	时区标识：0.标准时间，1.夏令时
externalAdditionalData	String	否	外部附加数据	返回业务方自定义交易参数原值，JSON格式

Object

是

支付单对象

响应Headers数据示例：

signature: Job/Ou6Ni6UQUJD1av4AQCSQ2mEA1Jfahk0v+lGIMoeg07GuaSF1bTUZ/1fpZfowDo8M4AD2tPFwlsg3d6VbCnNrBpz4IXUq7p5y58QDMvLBXD050tXQH7ABEx9+4Wp/s5ueSXssFQXRa4vR0U5mBFHb+w5SIMpL9PFtO6e7psjO5oZFsE2hziPolvR0IQDbHNEzfEl6zXGqHOSYFXXCrN7s/IEiNSeI5twD9vCTZRoHJ0u/EylA2uDAEfDhIcMeQu6j1VZeRFK+fidQifBaLt5TH40kj4ZpOCOF1PXT+RK280oXJOlr80HkjJcTAXglvqy4pZG/zQc0mAlGbKr5Vg==
orgCertId: ****************************************
signMethod: RSA-SHA256

响应Body数据示例

{
	"requestId": null,
	"requestTime": null,
	"responseTime": "2025-07-22T04:52:56.139+00:00",
	"respCode": 200,
	"respMsg": "success",
	"busCode": null,
	"busMsg": null,
	"busSubCode": null,
	"busSubMsg": null,
	"data": {
		"transaction": {
			"amount": 20.0,
			"authCode": "236158",
			"completionTime": 1742449238000,
			"currency": "HKD",
			"merchantSerialNo": "revoke_tC94C5686500000628644470194176",
			"orderNo": "10820250320000005158",
			"originalTransactionNo": "TK2EFEB08DDD00000628919306223616",
			"paymentWay": "01",
			"refundAmount": 0.0,
			"responseCode": "200",
			"status": "00",
			"timeZoneFlag": 0,
			"tipAmount": 0.0,
			"transactionNo": "TK949BA8D16900000628920027693056",
			"transactionTime": 1742449238000,
			"transactionType": "11",
			"transactionZoneId": "Asia/Hong_Kong",
			"transactionZoneUTCTime": 1742420438000
		}
	}
}

4.交易通知

4.1 交易回调业务方

介绍：交易完成后给业务方发送结果通知。

需要接入机构提供回调地址

需要提供ip白名单

回调地址: ${SERVICE_NOTIFY_URL}

请求参数

字段名

类型

是否必传

字段名称

说明

transaction

字段名	类型	是否必传	字段名称	说明
merchantNo	String	是	商户编号
terminalSerialNo	String	是	终端序列号
merchantSerialNo	String	是	商户交易流水号
amount	decimal	是	支付金额	单位：元
transactionNo	String	否	交易流水号
originalTransactionNo	String	否	原交易流水号
currency	String	否	币种	参考附录-枚举字典 12 币种
status	String	否	交易状态	参考附录-枚举字典 11 交易状态
orderNo	String	否	订单号
externalOrderNo	String	否	外部订单号
refundAmount	decimal	否	退款金额	单位：元
transactionType	String	否	交易类型	参考附录-枚举字典 3 交易类型
paymentWay	String	否	支付方式	参考附录-枚举字典 5 支付方式
cardNoDigest	String	否	卡号密文摘要	根据机构敏感信息配置条件返回，配置允许返回该字段存在值
authCode	String	否	授权码
responseCode	String	否	主码
responseMessage	String	否	主码说明
subCode	String	否	子码
subMessage	String	否	子码说明
completionTime	timestamp	否	交易完成时间
transactionTime	timestamp	否	交易时间
transactionZoneUTCTime	timestamp	否	交易时区时间
transactionZoneId	String	否	时区	交易时区例：Asia/Shanghai
timeZoneFlag	Integer	否	时区标识	时区标识：0.标准时间，1.夏令时
externalAdditionalData	String	否	外部附加数据	返回业务方自定义交易参数原值，JSON格式

Object

是

交易对象

Curl请求示例

curl --location '${SERVICE_NOTIFY_URL}' \
--header 'Content-Type: application/json' \
--header 'orgNo: S**************' \
--header 'orgCertId: ****************************************' \
--header 'signMethod: RSA-SHA256' \
--header 'signature: gmEnbXHetb0a+iwz2xJwgYXKHHwYd9Yy8fumDlzOevruscS6yawHjgxZGDhW24+hrJDIS2vwDF879dUOk/YL3kGvoUHXe52UM0y/81+JJ9PD2Ic0C8agBOmSXEiG9ROfOjRDmfxz/zYOHhWGBuN7VtNlKxUxopw8l57MR1ouSLt+g3XEEqpNTqMhB3njTZ5CXZ/XZj95dfZUkkXtXdC1mPOtSkE55gNxTSECcfKDT78gmBMcJEgBpZHoaStEt+KEe6TZ7avmBpP43pccKALWDDkjmiCdXqDxl9a3HOpWj5bx9RALg6GuCDheNBBy/D0CRsQeBEljmBKmHTr1/IVbkQ==' \
--data '{
    "requestId": null,
    "requestTime": null,
    "responseTime": "2025-07-18T10:44:18.866+00:00",
    "respCode": 200,
    "respMsg": "success",
    "busCode": null,
    "busMsg": null,
    "busSubCode": null,
    "busSubMsg": null,
    "data": {
        "transaction": {
            "merchantNo": "**********",
            "terminalSerialNo": "SI********",
            "merchantSerialNo": "2025071818435461",
            "amount": 6.00,
            "transactionNo": "TK523BE28B8300000808914719686656",
            "originalTransactionNo": "TK9B637B1A5D00000808914329124864",
            "orderNo": "10820250718000011158",
            "refundAmount": 0.00,
            "tipAmount": 0.00,
            "currency": "HKD",
            "transactionType": "06",
            "paymentWay": "01",
            "authCode": "657666",
            "status": "00",
            "responseCode": "200",
            "transactionTime": "2025-07-18T10:44:17.000+00:00",
            "transactionZoneId": "Asia/Hong_Kong",
            "timeZoneFlag": 0,
            "completionTime": "2025-07-18T10:44:19.000+00:00",
            "cardNoDigest": "fdaec090552b92671fe93ad58ae46de41e33e3d7c211bf88f43e82bac4d05676",
            "cardBrand": "01"
        }
    }
}'

5.管理类接口

5.1 终端操作状态处理

介绍：更改或查询设备当前支付可受理状态。

接口地址: /saas/query

字段名	类型	是否必传	字段名称	说明
interfaceVersion	String	是	版本号	默认值:1.0.0
language	String	否	语言	语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceName	String	是	接口名称	填写:`paymentStatus`
businessType	String	是	业务类型	填写:`query`
orgNo	String	是	机构编号
orgCertId	String	是	机构密钥证书序列号
signature	String	是	机构签名
signMethod	String	是	机构签名方法	取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名

类型

是否必传

字段名称

说明

merchant

字段名	类型	是否必传	字段名称	说明
merchantNo	String	是	商户号

Object

是

商户对象信息

terminal

字段名	类型	是否必传	字段名称	说明
sn	String	是	终端序列号
paymentStatus	String	选填	终端支付操作状态	00 未操作（可受理新支付订单），01 操作中（不可受理新支付订单，更改时可传对应值

Object

是

终端信息

Curl请求示例

curl --location '${PAYMENT_DOMAIN}/saas/query' \
--header 'businessType: query' \
--header 'interfaceName: paymentStatus' \
--header 'interfaceVersion: 1.0.0' \
--header 'language: zh_CN' \
--header 'orgNo: S**************' \
--header 'orgCertId: ****************************************' \
--header 'signature: KbTF+Rs5YagWBne8abUaU3EpRB1DCvnySUah/wRqFAFguf7+nA5DAMm9mG9/bsrVTZnLyBwCREFsqGIAPnK4FhB6WVsm0182Ge4C6HvdGD10kp+InylWbIZXxU6Q/6QxOJmrd8xc5LOlvhhlHksx1F/twFT0VHqvoPHHlyVBfOdmi6rh/GjbWy62twyA4EwPEJhjog/2tMm2YZNjuYIRF/01dLvPwizgyWKMxAYKTKDTIeoIeeD1qZ9a4qx3+RBjWN6jl1ZniFQ3kOqaJbear7MCgHzgiA/qoD94FC4Eb8MZ6NAsh+U6dI8sPGT1RKwbA6DiHaMsFkFyrfRu0K1URQ==' \
--header 'signMethod: RSA-SHA256' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "S**************_20250723043936092_8f",
    "requestTime": "2025-07-23T04:39:36.092+08:00",
    "nonceStr": "QLAOcvJj0ojzOWg5YQLGjfJtF43ncsz2",
    "data": {
        "merchant": {
            "merchantNo": "**********"
        },
        "terminal": {
            "sn": "SI********",
            "paymentStatus": "00"
        }
    }
}'

响应参数

字段名

类型

是否必传

字段名称

说明

merchant

字段名	类型	是否必传	字段名称	说明
merchantNo	String	是	商户号

Object

是

交易对象

terminal

字段名	类型	是否必传	字段名称	说明
sn	String	是	终端序列号
paymentStatus	String	是	终端支付操作状态	00 未操作（可受理新支付订单），01 操作中（不可受理新支付订单

Object

是

终端信息

响应Headers数据示例：

signature: qpmtmNE9I9kqBEmPl4a2XwWCE23pJ9l9E9w8sqtm8fPRMIZLihg9UoF7CP+qX99P15F9pZM9diN545v8LzoT1OGr6EL1zciOQJu0361tED+B7PQi9sEXkBrn70sqvFgolYzi5gcxNC9j6usjg2s2KwWMJIjIjJNnZ/YNTfxXMf8T9C+66osQKF9XdEtn5GBwvc2JzLy6Fb34Heo4/TpHAFxATtsOpRJCz2/aqtSjf2SUHYbWxBFtkKgj6BdQIKCX8Zl36DvSHHyASOc/ae5wMLPv9KVsB4ZRM5T40geaxVNQiS6lxLgKZ3LDKukx155W1gXd9kJwwlyXy48Ctg7fxQ==
orgCertId: ****************************************
signMethod: RSA-SHA256

响应Body数据示例

{
  "requestId": null,
  "requestTime": null,
  "responseTime": "2025-07-23T04:39:49.626+00:00",
  "respCode": 200,
  "respMsg": "success",
  "busCode": null,
  "busMsg": null,
  "busSubCode": null,
  "busSubMsg": null,
  "data": {
    "merchant": {
      "merchantNo": "**********",
      "zoneId": null,
      "channelCode": null,
      "channelMerchantNo": null,
      "productNo": null
    },
    "terminal": {
      "sn": "SI********",
      "paymentStatus": "00"
    }
  }
}

1. 简介​

2.查询​

2.1 支付订单查询​

Header 参数​

请求参数​

响应参数​

2.2线上支付 交易查询​

Header 参数​

请求参数​

响应参数​

3.POS终端 API 接口​

3.1 pos预下单​

Header 参数​

请求参数​

响应参数​

3.2 pos预授权完成​

Header 参数​

请求参数​

响应参数​

3.3 pos预授权撤销​

Header 参数​

请求参数​

响应参数​

3.4 pos预授权完成撤销​

Header 参数​

请求参数​

响应参数​

3.5 pos交易消费撤销​

Header 参数​

请求参数​

响应参数​

3.6 pos退款​

Header 参数​

请求参数​

响应参数​

3.7 pos小费撤销​

Header 参数​

请求参数​

响应参数​

4.交易通知​

4.1 交易回调业务方​

请求参数​

5.管理类接口​

5.1 终端操作状态处理​

Header 参数​

请求参数​

响应参数​

​

1. 简介

2.查询

2.1 支付订单查询

Header 参数

请求参数

响应参数

2.2线上支付交易查询

Header 参数

请求参数

响应参数

3.POS终端 API 接口

3.1 pos预下单

Header 参数

请求参数

响应参数

3.2 pos预授权完成

Header 参数

请求参数

响应参数

3.3 pos预授权撤销

Header 参数

请求参数

响应参数

3.4 pos预授权完成撤销

Header 参数

请求参数

响应参数

3.5 pos交易消费撤销

Header 参数

请求参数

响应参数

3.6 pos退款

Header 参数

请求参数

响应参数

3.7 pos小费撤销

Header 参数

请求参数

响应参数

4.交易通知

4.1 交易回调业务方

请求参数

5.管理类接口

5.1 终端操作状态处理

Header 参数

请求参数

响应参数