版本：1.1.1

SaaS 聚合收银台接口文档

1. 简介

聚合收银台接口是面向各类商户提供的统一支付接入标准化接口，提供一站式多渠道收单能力; 也支持聚合码支付；简化接入流程，提升支付体验;助力商户轻松实现高效、稳定的收款服务。

2.聚合收银台接口

2.1 创建收银台

介绍：用于预先创建收银台,后拉起收银台发起支付，接口返回聚合收银台访问链接及订单核心信息，商户前端可跳转至该链接拉起收银台页面，引导用户完成支付操作,支持嵌入式收银台和托管式收银台。

接口地址: /saas/checkOut

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

请求参数

字段名

类型

是否必传

字段名称

说明

merchant

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

Object

是

商户信息对象

checkout

字段名	类型	是否必传	字段名称	说明
orderNo	String	是	订单编号	收银台关联的订单唯一编号
timeExpire	Integer	是	有效时间	单位：秒，收银台有效时长,最长一天
ip	String	是	发起收银台的用户IP	发起收银台请求的用户设备IP地址
currency	String	是	货币类型	订单交易币种
amount	String	是	收款金额	收银台收款金额
redirectUrl	String	否	完成支付的重定向页面	支付完成后跳转的商户页面地址
notifyUrl	String	否	交易结果通知地址	交易完成后，系统向该地址发送交易结果通知
paymentType	String	否	支付方式编码	参考附录-枚举字典 17 收银台支付类型

Object

是

收银台配置对象

order

字段名

类型

是否必传

字段名称

说明

externalOrderNo

String

否

外部订单号

业务方传入的外部订单唯一标识

orderNo

String

否

订单编号

系统内订单唯一标识

amount

String

否

订单金额

订单总金额（字符串格式）

tipAmount

String

否

小费金额

订单附加小费金额

currency

String

否

订单币种

订单交易币种

externalAdditionalData

String

否

订单附加数据

JSON字符串格式，存储商户自定义附加信息

language

String

否

订单语言

订单展示语言

String

否

付款人电子邮箱

付款人联系邮箱

webSite

String

否

所属网站

订单下单来源的商户网站域名

orderTitle

String

否

订单标题

订单简短描述标题

orderDetails

String

否

订单描述

订单详细说明

goodsDetails

字段名	类型	是否必传	字段名称	说明
sku	String	否	商品SKU编号	商品唯一标识
productName	String	否	商品名称	商品展示名称
price	String	否	商品单价	单个商品价格
quantity	Number	否	商品购买数量	商品购买件数
productImage	String	否	商品图片URL	商品展示图片地址
productUrl	String	否	商品链接URL	商品详情页地址

Array

否

商品信息列表

订单包含的商品明细列表

shippingAddress

字段名	类型	是否必传	字段名称	说明
shippingFirstName	String	否	收货人名（名）	收货人名字
shippingLastName	String	否	收货人名（姓）	收货人姓氏
shippingAddress1	String	否	收货地址1	收货人详细地址第一行
shippingAddress2	String	否	收货地址2	收货人详细地址第二行
shippingCity	String	否	收货城市	收货人所在城市
shippingState	String	否	收货州/省	收货人所在州/省
shippingCountry	String	否	收货国家代码	收货地址所属国家两位字母代码
shippingZipCode	String	否	收货邮编	收货人地址邮编
shippingPhone	String	否	收货电话	收货人联系电话

Object

否

收货地址对象

订单收货地址信息

billingAddress

字段名	类型	是否必传	字段名称	说明
billingFirstName	String	否	账单人名（名）	账单人名字
billingLastName	String	否	账单人名（姓）	账单人姓氏
billingAddress1	String	否	账单地址1	账单人详细地址第一行
billingAddress2	String	否	账单地址2	账单人详细地址第二行
billingCity	String	否	账单城市	账单人所在城市
billingState	String	否	账单州/省	账单人所在州/省
billingCountry	String	否	账单国家代码	账单地址所属国家两位字母代码
billingZipCode	String	否	账单邮编	账单地址邮编
billingPhone	String	否	账单电话	账单人联系电话

Object

否

账单地址对象

订单账单地址信息

Object

否

订单信息对象

Curl请求示例

curl --request POST \
  --url http://${PAYMENT_DOMAIN}/saas/checkOut \
  --header 'Connection: keep-alive' \
  --header 'accept: application/json, text/plain, */*' \
  --header 'accept-encoding: gzip, deflate, br, zstd' \
  --header 'accept-language: zh-CN,zh;q=0.9,en;q=0.8,id;q=0.7' \
  --header 'appversion: 1.0.0' \
  --header 'authcertid: 1' \
  --header 'businesstype: checkOut' \
  --header 'content-type: application/json' \
  --header 'interfacename: create' \
  --header 'interfaceversion: 1.0.0' \
  --header 'merchantno: 1344000124' \
  --header 'orgcertid: CFA36DA2E064916D6C5DE607EC6DCF1B2A58AD13' \
  --header 'orgno: S20250325000001' \
  --header 'origin: https://payment-cnp-test.cogolinks.com' \
  --header 'referer: https://payment-cnp-test.cogolinks.com/mall' \
  --header 'signature: fDGgXFlUZ7Y5m0DWBxmhGOBCxdMrzhwN0W6YiRaAM0VuntuW17/qg+sfMU2O0BHtSVuXMl3DkIE4U1BHLAQPM9Ef9AIYcdsDVGjrGxRAMsZN7EC0GNCD6mEmcbANgg+SRz062ZCdMVWulLCMxBkUgBKGhf9pQ83dbcujuNGfeRAEIcmLGsi/dy3YySVGQjzZUfK/lmnmcb31/JiDnb3v9osy5eurKfWus9Qxl2OqRuEsUA4qxdDtYP8ATorPfpEVOk3h5BIVzSy0QpuWU8YYxNuY3+1YO8lwARdgZ4KlRRTSYofTt6mEFNBfTx0yTlj144Liq2w5EhxzUB+g+LAnlQ==' \
  --header 'signmethod: RSA-SHA256' \
  --header 'systemtype: h5_Android' \
  --data '{
    "requestId": "8225227574797250",
    "requestTime": "2026-01-08 10:02:43",
    "nonceStr": "00199327683190163602",
    "data": {
        "merchant": {
            "merchantNo": "1344000124"
        },
        "checkout": {
            "orderNo": "1767837763635",
            "timeExpire": 900,
            "ip": "1.202.216.194",
            "currency": "HKD",
            "amount": 5,
            "redirectUrl": "https://www.cogolinks.com",
            "notifyUrl": "https://www.cogolinks.com/notify",
            "paymentType": ""
        },
        "order": {
            "language": "zh",
            "externalOrderNo": "1767837763635",
            "amount": "5",
            "currency": "HKD",
            "email": "fang_yp@suixingpay.com",
            "externalAdditionalData": "mall-checkout",
            "orderTitle": "商城结算",
            "orderDetails": "商城示例下单",
            "tipAmount": "0",
            "webSite": "https://www.cogolinks.com",
            "goodsDetails": [
                {
                    "sku": "GFT-301",
                    "productName": "挂耳礼盒·旅拍系列",
                    "price": 5,
                    "quantity": 1,
                    "productImage": "https://www.baidu.com/",
                    "productUrl": "https://www.baidu.com/"
                }
            ],
            "billingAddress": {
                "billingFirstName": "Fang",
                "billingLastName": "Yangping",
                "billingAddress1": "12-15 F, Building 16",
                "billingCity": "No.30 Shixing Street",
                "billingState": "Beijing",
                "billingCountry": "CN",
                "billingZipCode": "100144",
                "billingPhone": "18168896116"
            },
            "shippingAddress": {
                "shippingFirstName": "Fang",
                "shippingLastName": "Yangping",
                "shippingAddress1": "12-15 F, Building 16",
                "shippingAddress2": "No.30 Shixing Street",
                "shippingCity": "Beijing",
                "shippingState": "Beijing",
                "shippingCountry": "CN",
                "shippingZipCode": "100144",
                "shippingPhone": "18168896116"
            }
        }
    }
}'

响应参数

字段名

类型

是否必返

字段名称

说明

checkOut

字段名	类型	是否必返	字段名称	说明
merchantNo	String	是	商户号	商户唯一标识
uid	String	是	全局唯一标识	接口返回的收银台请求全局唯一标识
url	String	是	收银台链接	聚合收银台的访问地址（前端跳转至该地址完成支付）
orderNo	String	是	订单编号	收银台关联的订单唯一编号
redirectUrl	String	否	重定向地址	支付完成后跳转的商户页面地址
notifyUrl	String	否	交易结果通知地址	交易完成后，系统向该地址发送交易结果通知
timeExpire	Integer	是	有效时间（秒）	收银台有效时长，单位：秒
validTime	TimeStamp	否	有效时间	收银台失效的时间
amount	String	是	收款金额	收银台收款金额
currency	String	是	币种	交易币种（参考附录-枚举字典币种，示例值：HKD）
status	String	是	收银台状态	收银台当前状态
paymentType	String	是	支付方式	支付方式编码

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": "2026-01-08T02:02:45.380+00:00",
  "respCode": 200,
  "respMsg": "success",
  "busCode": null,
  "busMsg": null,
  "busSubCode": null,
  "busSubMsg": null,
  "data": {
    "merchantNo": "1344000124",
    "uid": "0583e1d93b7441a5a2015243b8449120",
    "url": "https://payment-cnp-test.cogolinks.com/checkout?uid=0583e1d93b7441a5a2015243b8449120",
    "orderNo": "1767837763635",
    "redirectUrl": "https://www.cogolinks.com",
    "notifyUrl": "https://www.cogolinks.com/notify",
    "timeExpire": 900,
    "validTime": 1767838665,
    "amount": 5,
    "currency": "HKD",
    "status": "00",
    "paymentType": "",
    "platformOrderNo": null,
    "transactionNo": null,
    "ip": "1.202.216.194",
    "closeType": null,
    "selectedPaymentType": null
  }
}

2.2 收银台状态

介绍：获取收银台相关状态

接口地址: /saas/checkOut

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

请求参数

字段名

类型

是否必传

字段名称

说明

data

字段名	类型	是否必传	字段名称	说明
uid	String	是	收银台uid

Object

是

请求数据对象

Curl请求示例

curl --location --request POST 'http://${PAYMENT_DOMAIN}/saas/checkOut' \
--header 'xba-authcode: eyJhbGciOiJIUzI1NiJ9.eyJqdGkiO*********************MzE1NyIsImlhdCI6MTc1ODUxMDUyOCwiZXhwIjozNTE3MDIxMDU3fQ.XwPgDGMOuhpB9uv0A7cz776YJ1g4f2RKKAwO2NsIzQg' \
--header 'orgcertid: CFA36DA2E064916D6C5DE607EC6DCF1B2A58AD13' \
--header 'interfaceversion: 1.0.0' \
--header 'signmethod: RSA-SHA256' \
--header 'interfacename: 1' \
--header 'signature: 1' \
--header 'authsignature: 1' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Host: 127.0.0.1:8080' \
--header 'Connection: keep-alive' \
--data-raw '{
    "requestId": "15456456465465",
    "requestTime": "2026-05-12 17:55:59",
    "nonceStr": "85465168748945615445456465461245",
    "data": {
        "uid" : "e819dc64d03a41c1b8f5d406325f6664"
    }
}'

响应参数

字段名类型是否必返字段名称说明

checkOut

字段名	类型	是否必返	字段名称	说明
merchantNo	String	是	商户号	商户唯一标识
uid	String	是	收银台唯一标识	收银台生成的全局唯一ID
url	String	是	收银台访问链接	前端跳转至该地址完成支付
orderNo	String	是	订单编号	收银台关联的订单唯一编号
redirectUrl	String	否	支付完成重定向地址	支付完成后跳转的商户页面地址
notifyUrl	String	否	交易结果通知地址	交易完成后，系统向该地址发送交易结果通知
timeExpire	Number	否	收银台有效时长（秒）	收银台有效时间，单位：秒
validTime	Number	否	收银台失效时间	收银台失效的时间戳
amount	String	是	收银台收款金额	收银台订单收款金额
currency	String	是	币种	交易币种
status	String	是	收银台状态	00:下单成功, 01:支付成功, 02:已关闭
paymentType	String	是	支付类型	参考附录-枚举字典 17 收银台支付类型
platformOrderNo	String	是	平台订单号	平台生成的订单号
transactionNo	String	是	支付流水号	支付交易流水号

Object

是

收银台信息对象

聚合收银台核心返回信息

order

字段名	类型	是否必返	字段名称	说明
orderStatus	String	是	订单状态	参见附录2.2
externalOrderNo	String	是	外部订单号	商家订单号
orderNo	String	是	平台订单号	平台生成的订单号
orderDetails	String	是	订单详情	订单详细信息描述
amount	String	是	金额	订单金额
authorizeAmount	BigDecimal	否	授权金额	预授权金额
addAmount	BigDecimal	否	追加金额	追加授权金额
currency	String	是	币种	交易币种
orderTime	String	是	下单时间	订单创建时间戳
email	String	否	持卡人邮箱	持卡人联系邮箱
goodsDetails	Array	否	商品详情	商品详细信息列表
shippingAddress	Object	否	送货地址	商品送货地址信息
billingAddress	Object	否	账单地址	账单地址信息
externalAdditionalData	String	否	外部附加数据	JSON格式的附加数据，例：`{"key1":"value1","key2":"value2"}`

Object

是

支付订单信息对象

支付订单详细信息

transaction

字段名	类型	是否必返	字段名称	说明
transactionNo	String	是	交易流水号	用于唯一标识每一笔交易
originalTransactionNo	String	否	原始交易流水号	原始交易流水号
orderNo	String	是	订单号	平台订单号
externalOrderNo	String	是	外部订单号	商家订单号
amount	BigDecimal	是	交易金额	交易实际金额
authorizeAmount	BigDecimal	否	授权金额	预授权金额
addAmount	BigDecimal	否	追加金额	追加授权金额
refundAmount	BigDecimal	否	退款金额	已退款金额
payerFee	BigDecimal	否	付款方费用	付款方支付的手续费
payerRefundFee	BigDecimal	否	付款方退款费用	付款方退款时的手续费
payeeFee	BigDecimal	否	收款方费用	收款方支付的手续费
payeeRefundFee	BigDecimal	否	收款方退款费用	收款方退款时的手续费
tipAmount	BigDecimal	否	小费金额	小费金额
currency	String	是	币种	交易币种
transactionType	String	是	交易类型	01:消费, 02:消费撤销, 03:预授权, 04:授权追加, 05:授权撤销, 06:授权完成, 07:授权完成撤销, 08:退款, 09:冲正
paymentWay	String	否	支付方式	支付方式描述
authCode	String	否	授权码	交易授权码
status	String	是	交易状态	00:成功, 01:失败, 02:未知, 11:待发送, 12:已发送
responseCode	String	否	主码	交易响应主码
responseMessage	String	否	主码说明	交易响应主码说明
subCode	String	否	子码	交易响应子码
subMessage	String	否	子码说明	交易响应子码说明
transactionTime	String	是	交易时间	交易发生时间戳
transactionZoneUTCTime	String	否	交易时区UTC时间	交易时区UTC时间
transactionZoneId	String	否	交易时区id	时区ID，例：Asia/Shanghai
timeZoneFlag	Number	否	时区标识	0:标准时间, 1:夏令时
completionTime	String	否	交易完成时间	交易完成时间戳
refundFlag	String	否	退款标识	00:未处理, 01:部分退款, 02:全部退款
revokeFlag	String	否	撤销标识	00:未处理, 01:已撤销
authCompleteFlag	String	否	完成标识	00:未处理, 01:已完成
paymentType	String	是	支付类型	支付类型编码
paymentSubtype	String	否	支付子类型	支付子类型编码
cardType	String	否	卡类型	银行卡类型
cardFlag	String	否	卡标识	银行卡标识
cardBrand	String	否	卡组织	银行卡组织
merchantSerialNo	String	否	商户业务流水号	商户业务流水号
taskId	Number	否	任务ID	任务标识ID
cardNoDigest	String	否	卡号密文摘要	卡号摘要信息
externalAdditionalData	String	否	外部附加数据	JSON格式的附加数据
returnUrl	String	否	支付完成后跳转url	支付完成后跳转的URL
purseOrderNo	String	否	钱包类交易支付单号	钱包类交易支付单号
channelTransactionNo	String	否	渠道流水号	渠道侧交易流水号
cardNoMask	String	否	卡号掩码	卡号掩码

Object

是

支付单信息对象

支付交易详细信息

reversalTransaction object 否反交易记录(退款/撤销) 字段同transaction

响应Headers数据示例：

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

响应Body数据示例

{
  "requestId": null,
  "requestTime": null,
  "responseTime": "2026-01-20T14:33:13.102+08:00",
  "respCode": 200,
  "respMsg": "success",
  "busCode": null,
  "busMsg": null,
  "busSubCode": null,
  "busSubMsg": null,
  "data": {
    "checkOut": {
      "merchantNo": "1344000124",
      "uid": "2a963346f36242709464328eb4750c5b",
      "url": "https://payment-cnp-test.cogolinks.com/checkout?uid=2a963346f36242709464328eb4750c5b",
      "orderNo": "1768890071973",
      "redirectUrl": "https://www.cogolinks.com",
      "notifyUrl": "https://www.cogolinks.com/notify",
      "timeExpire": 900,
      "validTime": 1768890975,
      "amount": 0.3,
      "currency": "HKD",
      "status": "03",
      "paymentType": null,
      "platformOrderNo": "10820260120000034913",
      "transactionNo": "TK7C06AE422000001125899153866752",
      "ip": "1.202.216.194",
      "closeType": null,
      "selectedPaymentType": null,
      "reversalTransactionNo": [
        "TK0E87B1F80500001108307506053120"
      ]
    },
    "order": {
      "externalOrderNo": "1768890071973",
      "orderNo": "10820260120000034913",
      "orderDetails": "null",
      "amount": "0.30",
      "authorizeAmount": 0,
      "addAmount": 0,
      "currency": "HKD",
      "orderTime": "2026-01-20T22:22:02.354+08:00",
      "email": null,
      "goodsDetails": null,
      "shippingAddress": null,
      "billingAddress": null,
      "externalAdditionalData": null,
      "orderStatus": "04"
    },
    "transaction": {
      "transactionNo": "TK7C06AE422000001125899153866752",
      "orderNo": "10820260120000034913",
      "externalOrderNo": "1768890071973",
      "amount": 0.3,
      "refundAmount": 0.1,
      "payerFee": 0.02,
      "payerRefundFee": 0,
      "payeeFee": 0.02,
      "payeeRefundFee": 0,
      "tipAmount": 0,
      "currency": "HKD",
      "transactionType": "01",
      "paymentWay": "03",
      "status": "00",
      "responseCode": "200",
      "responseMessage": "交易成功",
      "subCode": "0000",
      "transactionTime": "2026-01-20T14:22:02.363+08:00",
      "transactionZoneId": "Asia/Hong_Kong",
      "timeZoneFlag": 0,
      "completionTime": "2026-01-20T14:22:11.542+08:00",
      "refundFlag": "02",
      "revokeFlag": "00",
      "authCompleteFlag": "00",
      "paymentType": "07",
      "paymentSubtype": "08",
      "cardFlag": "05",
      "merchantSerialNo": "5304776098522041",
      "purseOrderNo": "2026012022001333321443308095",
      "channelTransactionNo": "2026012011388440"
    },
    "reversalTransaction": [
      {
        "transactionNo": "TK0E87B1F80500001108307506053120",
        "originalTransactionNo": "TK7C06AE422000001125899153866752",
        "orderNo": "10820260120000034913",
        "amount": 0.1,
        "refundAmount": 0,
        "payerFee": 0,
        "payerRefundFee": 0,
        "payeeFee": 0,
        "payeeRefundFee": 0,
        "tipAmount": 0,
        "currency": "HKD",
        "transactionType": "08",
        "paymentWay": "03",
        "status": "00",
        "responseCode": "200",
        "responseMessage": "交易成功",
        "subCode": "0000",
        "transactionTime": "2026-01-20T14:22:35.214+08:00",
        "transactionZoneId": "Asia/Hong_Kong",
        "timeZoneFlag": 0,
        "completionTime": "2026-01-20T14:31:23.742+08:00",
        "refundFlag": "00",
        "revokeFlag": "00",
        "authCompleteFlag": "00",
        "paymentType": "07",
        "paymentSubtype": "08",
        "cardFlag": "05",
        "merchantSerialNo": "9f70a4cd79aa40ca8a4fdaeeaf6a1b7c",
        "channelTransactionNo": "2026012011388444"
      }
    ]
  }
}

2.3 关闭收银台

介绍：关闭收银台

接口地址: /saas/checkOut

字段名	类型	是否必传	字段名称	说明
interfaceVersion	String	是	版本号	默认值：1.0.0
language	String	否	语言	语言（zh_CN，zh_TW，en_US）默认取值：zh_CN
interfaceName	String	是	接口名称	填写：`close`
businessType	String	是	业务类型	填写：`checkOut`
signature	String	是	签名	由签名算法生成的字符串
signMethod	String	是	签名算法	RSA-SHA256
orgCertId	String	是	证书id	签名证书id
orgNo	String	是	机构编号	机构编号，由平台分配的唯一标识

请求参数

字段名

类型

是否必传

字段名称

说明

data

字段名	类型	是否必传	字段名称	说明
uid	String	是	收银台uid

Object

是

请求数据对象

Curl请求示例

curl --location --request POST 'https://${PAYMENT_DOMAIN}/saas/checkOut' \
--header 'businesstype: checkOut' \
--header 'interfacename: close' \
--header 'interfaceversion: 1.0.0' \
--header 'language: zh_CN' \
--header 'signature: IyYBGmF4U9TCT*********************stq7yYOqCujCPjrB5XbMTbY01OaOBTtsypX+8IhqDtbBpDwWU8l38Pe5bUR46xL3Bm1T+OyX+EjEhvSNFsL7NBtHmLEG3iUdTgjM3iNPYRCehQV7pTb+f+mO5yrmpX/i+6v8EBhT5olE3i9bOCOIy3n6S0j26MSYPgpoA/0LioVkCjjVo2J+BCY51CxyMpKNjAQ7HXNbW1rDJcswlfwjfaXZE1W66wVPgc/88ohRfQ9FvhEtPZkBD/LvNQ3v7WLZQktkylIikSA4TDomCS7qqm8T/JW3ioEVQ==' \
--header 'signmethod: RSA-SHA256' \
--header 'orgcertid: CFA36D*********************A58AD13' \
--header 'orgno: S20250325000001' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Connection: keep-alive' \
--data-raw '{
    "requestId":"S20250325000001_20250908070333042_25",
    "requestTime":"2025-09-08T07:03:33.042+08:00",
    "nonceStr":"HyuTIa6VT0PfcVGLaKf1LGO8DHz58hUA",
    "data":{
        "uid": "*********"
    }
}'

响应参数

字段名	类型	是否必返	字段名称
requestId	String	否	请求ID
requestTime	Integer	否	请求时间
responseTime	Integer	是	响应时间
respCode	String	是	响应码
respMsg	String	是	响应描述
busCode	String	否	业务主应答码
busMsg	String	否	平台交易流水号
busSubCode	String	是	业务子应答码
busSubMsg	String	是	业务子应答信息
data	String	是	相应数据

响应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-09-08T07:03:34.833+00:00",
  "respCode": 200,
  "respMsg": "success",
  "busCode": null,
  "busMsg": null,
  "busSubCode": null,
  "busSubMsg": null,
  "data": null
}

2.4 收银台退款

介绍：收银台退款

接口地址: /saas/checkOut

字段名	类型	是否必传	字段名称	说明
interfaceVersion	String	是	版本号	默认值：1.0.0
language	String	否	语言	语言（zh_CN，zh_TW，en_US）默认取值：zh_CN
interfaceName	String	是	接口名称	填写：`refund`
businessType	String	是	业务类型	填写：`checkOut`
signature	String	是	签名	由签名算法生成的字符串
signMethod	String	是	签名算法	RSA-SHA256
orgCertId	String	是	证书id	签名证书id
orgNo	String	是	机构编号	机构编号，由平台分配的唯一标识

请求参数

字段名

类型

是否必传

字段名称

说明

data

字段名	类型	是否必传	字段名称	说明
uid	String	是	收银台uid
amount	String	是	退款金额

Object

是

请求数据对象

Curl请求示例

curl --location --request POST 'https://${PAYMENT_DOMAIN}/saas/checkOut' \
--header 'businesstype: checkOut' \
--header 'interfacename: refund' \
--header 'interfaceversion: 1.0.0' \
--header 'language: zh_CN' \
--header 'signature: IyYBGmF4U9TCT*********************stq7yYOqCujCPjrB5XbMTbY01OaOBTtsypX+8IhqDtbBpDwWU8l38Pe5bUR46xL3Bm1T+OyX+EjEhvSNFsL7NBtHmLEG3iUdTgjM3iNPYRCehQV7pTb+f+mO5yrmpX/i+6v8EBhT5olE3i9bOCOIy3n6S0j26MSYPgpoA/0LioVkCjjVo2J+BCY51CxyMpKNjAQ7HXNbW1rDJcswlfwjfaXZE1W66wVPgc/88ohRfQ9FvhEtPZkBD/LvNQ3v7WLZQktkylIikSA4TDomCS7qqm8T/JW3ioEVQ==' \
--header 'signmethod: RSA-SHA256' \
--header 'orgcertid: CFA36D*********************A58AD13' \
--header 'orgno: S20250325000001' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Connection: keep-alive' \
--data-raw '{
    "data": {
        "uid":"2a963346f36242709464328eb4750c5b",
        "amount":0.1
    },
    "nonceStr": "15155c05-f0c7-4c05-b0c7-f0c7b0c7f0c7",
    "requestId": "452155c05-f0c7-4c05-b0c7-f0c7b0c7f0c7",
    "requestTime": "2026-01-19T07:27:23.917Z"
}'

响应参数

字段名类型是否必返字段名称说明

checkOut

字段名	类型	是否必返	字段名称	说明
merchantNo	String	是	商户号	商户唯一标识
uid	String	是	收银台唯一标识	收银台生成的全局唯一ID
url	String	是	收银台访问链接	前端跳转至该地址完成支付
orderNo	String	是	订单编号	收银台关联的订单唯一编号
redirectUrl	String	否	支付完成重定向地址	支付完成后跳转的商户页面地址
notifyUrl	String	否	交易结果通知地址	交易完成后，系统向该地址发送交易结果通知
timeExpire	Number	否	收银台有效时长（秒）	收银台有效时间，单位：秒
validTime	Number	否	收银台失效时间	收银台失效的时间戳
amount	String	是	收银台收款金额	收银台订单收款金额
currency	String	是	币种	交易币种
status	String	是	收银台状态	00:下单成功, 01:支付成功, 02:已关闭
paymentType	String	是	支付类型	参考附录-枚举字典 17 收银台支付类型
platformOrderNo	String	是	平台订单号	平台生成的订单号
transactionNo	String	是	支付流水号	支付交易流水号

Object

是

收银台信息对象

聚合收银台核心返回信息

order

字段名	类型	是否必返	字段名称	说明
orderStatus	String	是	订单状态	参见附录2.2
externalOrderNo	String	是	外部订单号	商家订单号
orderNo	String	是	平台订单号	平台生成的订单号
orderDetails	String	是	订单详情	订单详细信息描述
amount	String	是	金额	订单金额
authorizeAmount	BigDecimal	否	授权金额	预授权金额
addAmount	BigDecimal	否	追加金额	追加授权金额
currency	String	是	币种	交易币种
orderTime	String	是	下单时间	订单创建时间戳
email	String	否	持卡人邮箱	持卡人联系邮箱
goodsDetails	Array	否	商品详情	商品详细信息列表
shippingAddress	Object	否	送货地址	商品送货地址信息
billingAddress	Object	否	账单地址	账单地址信息
externalAdditionalData	String	否	外部附加数据	JSON格式的附加数据，例：`{"key1":"value1","key2":"value2"}`

Object

是

支付订单信息对象

支付订单详细信息

transaction

字段名	类型	是否必返	字段名称	说明
transactionNo	String	是	交易流水号	用于唯一标识每一笔交易
originalTransactionNo	String	否	原始交易流水号	原始交易流水号
orderNo	String	是	订单号	平台订单号
externalOrderNo	String	是	外部订单号	商家订单号
amount	BigDecimal	是	交易金额	交易实际金额
authorizeAmount	BigDecimal	否	授权金额	预授权金额
addAmount	BigDecimal	否	追加金额	追加授权金额
refundAmount	BigDecimal	否	退款金额	已退款金额
payerFee	BigDecimal	否	付款方费用	付款方支付的手续费
payerRefundFee	BigDecimal	否	付款方退款费用	付款方退款时的手续费
payeeFee	BigDecimal	否	收款方费用	收款方支付的手续费
payeeRefundFee	BigDecimal	否	收款方退款费用	收款方退款时的手续费
tipAmount	BigDecimal	否	小费金额	小费金额
currency	String	是	币种	交易币种
transactionType	String	是	交易类型	01:消费, 02:消费撤销, 03:预授权, 04:授权追加, 05:授权撤销, 06:授权完成, 07:授权完成撤销, 08:退款, 09:冲正
paymentWay	String	否	支付方式	支付方式描述
authCode	String	否	授权码	交易授权码
status	String	是	交易状态	00:成功, 01:失败, 02:未知, 11:待发送, 12:已发送
responseCode	String	否	主码	交易响应主码
responseMessage	String	否	主码说明	交易响应主码说明
subCode	String	否	子码	交易响应子码
subMessage	String	否	子码说明	交易响应子码说明
transactionTime	String	是	交易时间	交易发生时间戳
transactionZoneUTCTime	String	否	交易时区UTC时间	交易时区UTC时间
transactionZoneId	String	否	交易时区id	时区ID，例：Asia/Shanghai
timeZoneFlag	Number	否	时区标识	0:标准时间, 1:夏令时
completionTime	String	否	交易完成时间	交易完成时间戳
refundFlag	String	否	退款标识	00:未处理, 01:部分退款, 02:全部退款
revokeFlag	String	否	撤销标识	00:未处理, 01:已撤销
authCompleteFlag	String	否	完成标识	00:未处理, 01:已完成
paymentType	String	是	支付类型	支付类型编码
paymentSubtype	String	否	支付子类型	支付子类型编码
cardType	String	否	卡类型	银行卡类型
cardFlag	String	否	卡标识	银行卡标识
cardBrand	String	否	卡组织	银行卡组织
merchantSerialNo	String	否	商户业务流水号	商户业务流水号
taskId	Number	否	任务ID	任务标识ID
cardNoDigest	String	否	卡号密文摘要	卡号摘要信息
externalAdditionalData	String	否	外部附加数据	JSON格式的附加数据
returnUrl	String	否	支付完成后跳转url	支付完成后跳转的URL
purseOrderNo	String	否	钱包类交易支付单号	钱包类交易支付单号
channelTransactionNo	String	否	渠道流水号	渠道侧交易流水号
cardNoMask	String	否	卡号掩码	卡号掩码

Object

是

支付单信息对象

支付交易详细信息

reversalTransaction object 否反交易记录(退款/撤销) 字段同transaction

响应Headers数据示例：

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

响应Body数据示例

{
  "requestId": null,
  "requestTime": null,
  "responseTime": "2026-01-20T14:33:13.102+08:00",
  "respCode": 200,
  "respMsg": "success",
  "busCode": null,
  "busMsg": null,
  "busSubCode": null,
  "busSubMsg": null,
  "data": {
    "checkOut": {
      "merchantNo": "1344000124",
      "uid": "2a963346f36242709464328eb4750c5b",
      "url": "https://payment-cnp-test.cogolinks.com/checkout?uid=2a963346f36242709464328eb4750c5b",
      "orderNo": "1768890071973",
      "redirectUrl": "https://www.cogolinks.com",
      "notifyUrl": "https://www.cogolinks.com/notify",
      "timeExpire": 900,
      "validTime": 1768890975,
      "amount": 0.3,
      "currency": "HKD",
      "status": "03",
      "paymentType": null,
      "platformOrderNo": "10820260120000034913",
      "transactionNo": "TK7C06AE422000001125899153866752",
      "ip": "1.202.216.194",
      "closeType": null,
      "selectedPaymentType": null,
      "reversalTransactionNo": [
        "TK0E87B1F80500001108307506053120"
      ]
    },
    "order": {
      "externalOrderNo": "1768890071973",
      "orderNo": "10820260120000034913",
      "orderDetails": "null",
      "amount": "0.30",
      "authorizeAmount": 0,
      "addAmount": 0,
      "currency": "HKD",
      "orderTime": "2026-01-20T22:22:02.354+08:00",
      "email": null,
      "goodsDetails": null,
      "shippingAddress": null,
      "billingAddress": null,
      "externalAdditionalData": null,
      "orderStatus": "04"
    },
    "transaction": {
      "transactionNo": "TK7C06AE422000001125899153866752",
      "orderNo": "10820260120000034913",
      "externalOrderNo": "1768890071973",
      "amount": 0.3,
      "refundAmount": 0.1,
      "payerFee": 0.02,
      "payerRefundFee": 0,
      "payeeFee": 0.02,
      "payeeRefundFee": 0,
      "tipAmount": 0,
      "currency": "HKD",
      "transactionType": "01",
      "paymentWay": "03",
      "status": "00",
      "responseCode": "200",
      "responseMessage": "交易成功",
      "subCode": "0000",
      "transactionTime": "2026-01-20T14:22:02.363+08:00",
      "transactionZoneId": "Asia/Hong_Kong",
      "timeZoneFlag": 0,
      "completionTime": "2026-01-20T14:22:11.542+08:00",
      "refundFlag": "02",
      "revokeFlag": "00",
      "authCompleteFlag": "00",
      "paymentType": "07",
      "paymentSubtype": "08",
      "cardFlag": "05",
      "merchantSerialNo": "5304776098522041",
      "purseOrderNo": "2026012022001333321443308095",
      "channelTransactionNo": "2026012011388440"
    },
    "reversalTransaction": [
      {
        "transactionNo": "TK0E87B1F80500001108307506053120",
        "originalTransactionNo": "TK7C06AE422000001125899153866752",
        "orderNo": "10820260120000034913",
        "amount": 0.1,
        "refundAmount": 0,
        "payerFee": 0,
        "payerRefundFee": 0,
        "payeeFee": 0,
        "payeeRefundFee": 0,
        "tipAmount": 0,
        "currency": "HKD",
        "transactionType": "08",
        "paymentWay": "03",
        "status": "00",
        "responseCode": "200",
        "responseMessage": "交易成功",
        "subCode": "0000",
        "transactionTime": "2026-01-20T14:22:35.214+08:00",
        "transactionZoneId": "Asia/Hong_Kong",
        "timeZoneFlag": 0,
        "completionTime": "2026-01-20T14:31:23.742+08:00",
        "refundFlag": "00",
        "revokeFlag": "00",
        "authCompleteFlag": "00",
        "paymentType": "07",
        "paymentSubtype": "08",
        "cardFlag": "05",
        "merchantSerialNo": "9f70a4cd79aa40ca8a4fdaeeaf6a1b7c",
        "channelTransactionNo": "2026012011388444"
      }
    ]
  }
}

3.交易通知

3.1交易回调业务方

介绍：相关交易逻辑完成后给业务方推送最终交易结果通知。

通知参数

参考收银台状态查询响应结果

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": "2026-02-06T07:07:49.584+00:00",
    "respCode": 200,
    "respMsg": "success",
    "busCode": null,
    "busMsg": null,
    "busSubCode": null,
    "busSubMsg": null,
    "data": {
        "order": {
            "externalOrderNo": "2019669270895788570",
            "orderNo": "10820260206000044885",
            "orderDetails": "尖沙咀店",
            "amount": "67.00",
            "authorizeAmount": null,
            "addAmount": null,
            "currency": null,
            "orderTime": "2026-02-06T15:07:32.610+00:00",
            "email": null,
            "goodsDetails": null,
            "shippingAddress": null,
            "billingAddress": null,
            "externalAdditionalData": "{\"corporationId\":440021082,\"shopId\":400412410,\"paymentId\":2019669270895788570}",
            "orderStatus": null
        },
        "transaction": {
            "transactionNo": "TKF935A1770500001125888174817280",
            "orderNo": "10820260206000044885",
            "externalOrderNo": "2019669270895788570",
            "amount": 67,
            "refundAmount": 0,
            "currency": "HKD",
            "transactionType": "01",
            "paymentWay": "02",
            "status": "00",
            "transactionTime": "2026-02-06T07:07:32.958+00:00",
            "transactionZoneId": "Asia/Hong_Kong",
            "completionTime": "2026-02-06T07:07:48.225+00:00",
            "paymentType": "02",
            "paymentSubtype": "05",
            "cardFlag": "01",
            "cardBrand": "02",
            "merchantSerialNo": "048d2d00207d49258892626605429c11",
            "returnUrl": "https://f5cr35nvpnut.m.sea.restosuite.ai/payStatus?tableId=2010584954987540489&shopId=400412410&bizType=1100&routeName=createOrder&type=1&orderId=2019669270807646394&transId=2019669270866366468",
            "cardNoMask": "543121****4860",
            "merchantNo": "1344000031",
            "cardHolerMask": "n**e",
            "localCurrency": "HKD",
            "localTranAmount": 67,
            "localPayeeFee": 2.5,
            "localPayeeRefundFee": 0,
            "localPayeeRefundTotalFee": 0,
            "localRefundAmount": 0,
            "marginAmount": 0,
            "pendingSettlementAmount": 0
        }
    }
}
}'

SaaS 聚合收银台接口文档

1. 简介

2.聚合收银台接口

2.1 创建收银台

Header 参数

请求参数

响应参数

2.2 收银台状态

Header 参数

请求参数

响应参数

2.3 关闭收银台

Header 参数

请求参数

响应参数

2.4 收银台退款

Header 参数

请求参数

响应参数

3.交易通知

3.1交易回调业务方

通知参数

1. 简介​

2.聚合收银台接口​

2.1 创建收银台​

Header 参数​

请求参数​

响应参数​

2.2 收银台状态​

Header 参数​

请求参数​

响应参数​

2.3 关闭收银台​

Header 参数​

请求参数​

响应参数​

2.4 收银台退款​

Header 参数​

请求参数​

响应参数​

3.交易通知​

3.1交易回调业务方​

通知参数​

1. 简介

2.聚合收银台接口

2.1 创建收银台

Header 参数

请求参数

响应参数

2.2 收银台状态

Header 参数

请求参数

响应参数

2.3 关闭收银台

Header 参数

请求参数

响应参数

2.4 收银台退款

Header 参数

请求参数

响应参数

3.交易通知

3.1交易回调业务方

通知参数