跳到主要内容
版本:Next

SaaS CNP交易接口文档

1. 简介

提供Server To Server cnp交易接口 给服务商(下述描述机构均为服务商) 调用。

注:涉及金额字段,单位均为元

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

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

2.cnp接口

2.1 预下单

介绍:用于预先创建订单,后拉起收银台发起支付

接口地址: /saas/cnp

Header 参数

字段名类型是否必传字段名称说明
interfaceVersionString版本号默认值:1.0.0
languageString语言语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceNameString接口名称填写:preOrder
businessTypeString业务类型填写:cnp
orgNoString机构编号
orgCertIdString机构密钥证书序列号
signatureString机构签名
signMethodString机构签名方法 取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名类型是否必传字段名称说明
merchant
字段名类型是否必传字段名称说明
productNoString产品编号参考 附录-枚举字典 1. 产品编码; cnp场景目前固定 C202
merchantNoString商户号
Object商户信息对象
order
字段名类型是否必传字段名称说明
externalOrderNoString商户订单号业务方订单号/外部订单号
currencyString订单币种参考 附录-枚举字典 12. 币种
amountString订单交易金额
emailString付款人电子邮箱
webSiteString所属网站下单来源网站
languageString网站语言参考 附录-枚举字典 16. 语言 例:zh ,注意:不能使用zh_CN
orderTitleString订单标题
orderDetailsString订单描述如"饼干一包,水果一袋"
externalAdditionalDataString订单附加数据jsonStr 格式
goodsDetails
字段名类型是否必传字段名称说明
skuString商品编号
productNameString商品名称
priceNumber商品单价
quantityNumber商品购买数量
productImageString商品图片URL
productUrlString商品链接URL
Array商品信息列表
shippingAddress
字段名类型是否必传字段名称说明
shippingFirstNameString名字
shippingLastNameString姓氏
shippingAddress1String地址1
shippingAddress2String地址2
shippingCityString城市
shippingStateString州/省
shippingCountryString国家代码参考 附录-枚举字典 15. 国别列表,两位代码
shippingZipCodeString邮编
shippingPhoneString电话
Object收货地址对象
billingAddress
字段名类型是否必传字段名称说明
billingFirstNameString名字
billingLastNameString姓氏
billingAddress1String地址1使用dm/3ds则必填。为避免交易失败,中文地址建议翻译为英文地址
billingAddress2String地址2
billingCityString城市
billingStateString州/省
billingCountryString国家代码参考 附录-枚举字典 15. 国别列表, 两位代码
billingZipCodeString邮编
billingPhoneString电话
Object账单地址对象
Object订单信息对象
Curl请求示例
curl --location --request POST 'https://${PAYMENT_DOMAIN}/saas/cnp' \
--header 'businesstype: cnp' \
--header 'interfacename: preOrder' \
--header 'interfaceversion: 1.0.0' \
--header 'language: zh_CN' \
--header 'signature: C55VGlDUx3HZsyhP3RI1HeQdVlMICUWVYXF6BqKReHVoc27h76iNKijukuR/heWocSpevat+thQJKt25XwKUuRU+6JW7UOILd29261sTssBgRIvHlIYN4RMG4s5PxTQu2ftNz+0um8+V0BoFI/Q8/vYUtlZPMVaJ4+qZLskj5NevkIBQz7dkP2xCobQAdCSvhJAXGmfiWD6FujEbB+ICdidmkoCHlqMqpCxVOPjPP/GTscJYJi3lZ7KGD22zVX6s7/u6ggOq2pW888rLudal5osmNz0ISflLyF980KzYFvVs/hEzwOeMFiSmv5iDMXcwNvDtDCW1hDvxfmrMyq6QSg==' \
--header 'signmethod: RSA-SHA256' \
--header 'orgcertid: CFA36DA2E064916D6C5DE607EC6DCF1B2A58AD13' \
--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_20250908071916833_38",
"requestTime":"2025-09-08T07:19:16.833+08:00",
"nonceStr":"rbqEJuEb7UhZIxK1u8VHnk7I2fk1zLvT",
"data":{
"merchant":{
"merchantNo":"********",
"productNo" : "C202"
},
"order":{
"externalOrderNo":"EXT_ORDER_20250908151916",
"amount":"10",
"tipAmount":"0",
"currency":"USD",
"language":"zh",
"email":"gw816@163.com",
"webSite":"www.baidu.com",
"orderTitle":"订单title",
"orderDetails":"一袋饼干",
"externalAdditionalData":"{}",
"goodsDetails":[{
"sku":"123456",
"productName":"测试产品名",
"price":500,
"quantity":2,
"productImage":"",
"productUrl":""
}],
"shippingAddress":{
"shippingFirstName": "Peter 三",
"shippingLastName": "zh张",
"shippingAddress1": "广东省广州市测试 测试 测试测试 测试 测试*",
"shippingAddress2": "广东省广州市测试 Another",
"shippingCity": "New York",
"shippingState": "NY",
"shippingCountry": "CN",
"shippingZipCode": "10001",
"shippingPhone": "1231230080"
},
"billingAddress":{
"billingFirstName": "John",
"billingLastName": "Doe",
"billingAddress1": "456 Oak St",
"billingAddress2": null,
"billingCity": "Los Angeles",
"billingState": "CA",
"billingCountry": "CN",
"billingZipCode": "90001",
"billingPhone": "987-654-3210"
}
}
}
}'

响应参数

字段名类型是否必返字段名称说明
order
字段名类型是否必返字段名称说明
productNoString产品编号参考 附录-枚举字典 1. 产品编码
merchantNoString商户号
externalOrderNoString商户订单号调用方唯一
orderNoString平台订单号
currencyString订单币种
amountString订单交易金额
orderStatusString订单状态参考 附录-枚举字典 订单状态
orderTimeString下单时间ISO8601 格式 例如 2025-09-08T15:19:16.346+00:00
orderZoneIdString商户所在地时区商户时区/下单时区,例如 Asia/Hong_Kong
languageString网站语言
emailString付款人电子邮件
webSiteString所属网站
orderTitleString订单标题
orderDetailsString订单描述
externalAdditionalDataString订单附加数据
Object订单信息对象

响应Headers数据示例:

signature: idCYp8R2h4TPiLLN+E+K3F9uKwScaJjlAUwxut8PwEh4EfHn526IPZuw1MITfEmsQA06sNYrr5hI7dsaBJrBWLV8UFWKfuSkg2aPn94THa3TD/NZt5r7NxGYVAT2IGmw2q+h+z5hFQSBRENsz1r1GIhtQogaH2klN5m5XQNgJlHuGoMNpbCY8MRtDhVjmILrXHb1SrqsMQKW74r4EbjwXi6ZTV4c/OnYIXemg6us8v3kw9h4pKKWPsZh+jP9Y7Xk51SUFxOemxMayrW1xoDuOzZt0W5jCaX07KDrn4CKkFx0IPCnxjiv5vfavONN3/kbt0BYzqLMnFzWTVgIoCWN0w==
orgCertId: ****************************************
signMethod: RSA-SHA256
响应Body数据示例
{
"requestId": null,
"requestTime": null,
"responseTime": "2025-09-08T07:19:16.363+00:00",
"respCode": 200,
"respMsg": "success",
"busCode": null,
"busMsg": null,
"busSubCode": null,
"busSubMsg": null,
"data": {
"order": {
"externalOrderNo": "EXT_ORDER_20250908151916",
"orderNo": "10820250908000014101",
"amount": "10",
"currency": "USD",
"orderStatus": "01",
"orderTime": "2025-09-08T15:19:16.346+00:00",
"externalAdditionalData": "{}",
"merchantNo": "4344000047",
"productNo": "C202",
"orderZoneId": "Asia/Hong_Kong",
"orderTitle": "订单title",
"language": "zh",
"email": "gw816@163.com",
"webSite": "www.baidu.com"
}
}
}

2.2 修改订单

介绍:订单修改只能修改商品信息,收货地址信息,账单地址信息

接口地址: /saas/cnp

Header 参数

字段名类型是否必传字段名称说明
interfaceVersionString版本号默认值:1.0.0
languageString语言语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceNameString接口名称填写:updateOrderInfo
businessTypeString业务类型填写:cnp
orgNoString机构编号
orgCertIdString机构密钥证书序列号
signatureString机构签名
signMethodString机构签名方法 取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名类型是否必传字段名称说明
merchant
字段名类型是否必传字段名称说明
merchantNoString商户编号
Object商户信息对象
order
字段名类型是否必传字段名称说明
externalOrderNoString商户订单号与orderNo二选一
orderNoString平台订单号二者都传时 orderNo优先于externalOrderNo
goodsDetails
字段名类型是否必传字段名称说明
skuString商品编号
productNameString商品名称
priceNumber商品单价
quantityNumber商品购买数量
productImageString商品图片URL
productUrlString商品链接URL
Array商品信息列表
shippingAddress
字段名类型是否必传字段名称说明
shippingFirstNameString名字
shippingLastNameString姓氏
shippingAddress1String地址1
shippingAddress2String地址2
shippingCityString城市
shippingStateString州/省
shippingCountryString国家代码
shippingZipCodeString邮编
shippingPhoneString电话
Object收货地址对象
billingAddress
字段名类型是否必传字段名称说明
billingFirstNameString名字
billingLastNameString姓氏
billingAddress1String地址1使用dm/3ds则必填。为避免交易失败,中文地址建议翻译为英文地址
billingAddress2String地址2
billingCityString城市
billingStateString州/省
billingCountryString国家代码
billingZipCodeString邮编
billingPhoneString电话
Object账单地址对象
Object订单信息对象
Curl请求示例
curl --location --request POST 'https://${PAYMENT_DOMAIN}/saas/cnp' \
--header 'businesstype: cnp' \
--header 'interfacename: updateOrderInfo' \
--header 'language: zh_CN' \
--header 'interfaceversion: 1.0.0' \
--header 'signature: RuDTdEf/fwXaLk50u+WytuLPRXB1FiF1oBau+NXo/Df49+ZmXiLJWuU6RU8c/II7+m5NLYAZi2OPbiBNkR3fPXzla6C049sfa04f62lVdkb3I4SC+PjiRxMN3wnkD9aI6xY2EOT7IhwbBOhKtUCi25/4nmK2yIE8ftUbor2GVZSsb+Try4uhDw0u1dG/sK/YPvuoKwFnOWQQFr6BV3A/knvqs7aksQge7IA5huFRkI8KPDSADtGoDRGut5GqPywjj4Q2BpwfCyh/fdNRlxB+S1Sbaie6tVTTRrNZMlRII89l9HSz+CAQE0hwO4A5tsvVLXkunDcuZ0UShQO75Mlz1Q==' \
--header 'signmethod: RSA-SHA256' \
--header 'orgcertid: CFA36DA2E064916D6C5DE607EC6DCF1B2A58AD13' \
--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_20250908074336198_f9",
"requestTime":"2025-09-08T07:43:36.198+08:00",
"nonceStr":"48cMgLw4pRLic9mnFgevS8oqv7sDohkO",
"data":{
"merchant":{
"merchantNo":"********"
},
"order":{
"externalOrderNo":"EXT_ORDER_20250827180716",
"orderNo": "10820250908000014101",
"goodsDetails":[{
"sku":"123456",
"productName":"测试产品名11213123",
"price":500,
"quantity":2,
"productImage":"",
"productUrl":""
}],
"shippingAddress":{
"shippingFirstName": "Peter 三1123",
"shippingLastName": "zh张",
"shippingAddress1": "广东省广州市测试 测试 测试测试 测试 测试*",
"shippingAddress2": "广东省广州市测试 Another",
"shippingCity": "New York",
"shippingState": "NY",
"shippingCountry": "US",
"shippingZipCode": "10001",
"shippingPhone": "1231230080"
},
"billingAddress":{
"billingFirstName": "John123123",
"billingLastName": "Doe",
"billingAddress1": "456 Oak St",
"billingAddress2": null,
"billingCity": "Los Angeles",
"billingState": "CA",
"billingCountry": "US",
"billingZipCode": "90001",
"billingPhone": "987-654-3210"
}
}
}
}'

响应参数

字段名类型是否必返字段名称说明
order
字段名类型是否必返字段名称说明
merchantNoString商户编号
orderNoString平台订单号
externalOrderNoString商户订单号
orderStatusString订单状态
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-09-08T07:02:16.596+00:00",
"respCode": 200,
"respMsg": "success",
"busCode": null,
"busMsg": null,
"busSubCode": null,
"busSubMsg": null,
"data": {
"order": {
"externalOrderNo": "EXT_ORDER_20250908150138",
"orderNo": "10820250908000014097",
"orderStatus": "01",
"merchantNo": "********"
}
}
}

2.3 拉起支付收银台

介绍:拉起支付收银台

接口地址: /saas/cnp

Header 参数

字段名类型是否必传字段名称说明
interfaceVersionString版本号默认值:1.0.0
languageString语言语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceNameString接口名称填写:pullPayment
businessTypeString业务类型填写:cnp
orgNoString机构编号
orgCertIdString机构密钥证书序列号
signatureString机构签名
signMethodString机构签名方法 取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名类型是否必传字段名称说明
merchant
字段名类型是否必传字段名称说明
merchantNoString商户号
productNoString产品编号参考 附录-枚举字典 1. 产品编码
Object商户信息对象
order
字段名类型是否必传字段名称说明
externalOrderNoString商户订单号与 orderNo 二选一
orderNoString平台订单号二者都传时 orderNo优先于externalOrderNo
Object订单信息对象
transaction
字段名类型是否必传字段名称说明
merchantSerialNoString商户交易流水号
externalAdditionalDataString交易附加数据
returnUrlString收银台重定向地址支付成功后,支付网关跳回商户的地址
notifyUrlString支付结果通知地址支付成功后,后台通知商户支付结果的地址。如使用cnp系统的3ds功能,需上送以通知交易结果。
Object交易信息对象
Curl请求示例
curl --location --request POST 'https://${PAYMENT_DOMAIN}/saas/cnp' \
--header 'businesstype: cnp' \
--header 'interfacename: pullPayment' \
--header 'interfaceversion: 1.0.0' \
--header 'language: zh_CN' \
--header 'signature: IyYBGmF4U9TCTiQmuja1pkIsjyJkLgF2W4Rvb1U3oSC0xABFlNalEstq7yYOqCujCPjrB5XbMTbY01OaOBTtsypX+8IhqDtbBpDwWU8l38Pe5bUR46xL3Bm1T+OyX+EjEhvSNFsL7NBtHmLEG3iUdTgjM3iNPYRCehQV7pTb+f+mO5yrmpX/i+6v8EBhT5olE3i9bOCOIy3n6S0j26MSYPgpoA/0LioVkCjjVo2J+BCY51CxyMpKNjAQ7HXNbW1rDJcswlfwjfaXZE1W66wVPgc/88ohRfQ9FvhEtPZkBD/LvNQ3v7WLZQktkylIikSA4TDomCS7qqm8T/JW3ioEVQ==' \
--header 'signmethod: RSA-SHA256' \
--header 'orgcertid: CFA36DA2E064916D6C5DE607EC6DCF1B2A58AD13' \
--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":{
"merchant":{
"merchantNo":"*********"
},
"order":{
"externalOrderNo":"EXT_ORDER_20250908150138",
"orderNo": "10820250908000014097"

},
"transaction":{
"merchantSerialNo":"4416409948944886",
"returnUrl":"https://www.baidu.com/",
"notifyUrl":"https://example.com/notify"
}

}
}'

响应参数

字段名类型是否必返字段名称说明
transaction
字段名类型是否必返字段名称说明
merchantNoString商户号
productNoString产品编号
externalOrderNoString商户订单号
orderNoString平台订单号
merchantSerialNoString商户交易流水号
transactionNoString平台交易流水号系统生成
transactionTimeString交易发起时间
statusString交易状态参考 附录-枚举字典 11. 交易状态
cashUrlString收银台地址
externalAdditionalDataString交易附加数据
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-09-08T07:03:34.833+00:00",
"respCode": 200,
"respMsg": "success",
"busCode": null,
"busMsg": null,
"busSubCode": null,
"busSubMsg": null,
"data": {
"transaction": {
"merchantNo": "4344000047",
"productNo": "C202",
"merchantSerialNo": "4416409948944886",
"amount": 10.00,
"transactionNo": "TKF6406BAB8900000914193615962112",
"orderNo": "10820250908000014097",
"externalOrderNo": "EXT_ORDER_20250908150138",
"currency": "USD",
"status": "11",
"transactionTime": "2025-09-08T07:03:33.362+00:00",
"cashUrl": "https://payment-cnp-test.cogolinks.com/cnp/cashier?amount=10.00&orderNo=10820250908000014097&orgNo=S20250325000001&merchantNameEn=Resto+test+merchants&merchantNameCn=Resto%E5%AF%B9%E6%8E%A5%E6%B5%8B%E8%AF%95%E5%95%86%E6%88%B7&transactionNo=TKF6406BAB8900000914193615962112&merchantNo=4344000047&token=ZXlKaGJHY2lPaUpJVXpJMU5pSXNJblI1Y0NJNklrcFhWQ0o5LmV5SnZjbWRPYnlJNklsTXlNREkxTURNeU5UQXdNREF3TVNJc0luUnlZVzV6WVdOMGFXOXVUbThpT2lKVVMwWTJOREEyUWtGQ09Ea3dNREF3TURreE5ERTVNell4TlRrMk1qRXhNaUlzSW0xbGNtTm9ZVzUwVG04aU9pSTBNelEwTURBd01EUTNJbjAuMmNNWEFlbjFYZFlCbS1WcTV1bF9VYVNDWkxLOXRMNjBySVYtLUwxak5hUQ%253D%253D"
}
}
}

2.4 订单查询

介绍:查询订单及其关联交易

接口地址: /saas/cnp

Header 参数

字段名类型是否必传字段名称说明
interfaceVersionString版本号默认值:1.0.0
languageString语言语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceNameString接口名称填写:queryOrder
businessTypeString业务类型填写:cnp
orgNoString机构编号
orgCertIdString机构密钥证书序列号
signatureString机构签名
signMethodString机构签名方法取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名类型是否必传字段名称说明
merchant
字段名类型是否必传字段名称说明
merchantNoString商户号
Object商户信息对象
order
字段名类型是否必传字段名称说明
externalOrderNoString商户订单号与orderNo 二选一
orderNoString平台订单号二者都传时 orderNo优先于externalOrderNo
Object订单信息对象
Curl请求示例
curl --location --request POST 'https:///${PAYMENT_DOMAIN}/saas/cnp' \
--header 'businesstype: cnp' \
--header 'interfacename: queryOrder' \
--header 'interfaceversion: 1.0.0' \
--header 'language: zh_CN' \
--header 'signature: GsRVAfmJo8WhlcFMxgG/Gcwq7hiGg8GpuCXV4SIzhTDO+3+X0b/5Y5sGUs29OT0E4NzAkMmcUVQwaEhKsTPLyBhFm8F29tYlqKlycLJBXWUVDnVeOBbQSBszXwC9xItwfdJ9/pH6SIVIqkTcQjZIuxzkQQ/Ka6zV3LaRxUtK7s6899PMOMgJqwp1oNzVMftfN6wAzx0cAlIeJStjnKBTMEuPsFLV2g29n7w/TcEiwqCISr/CHSuD7WIbUtZf5ti8a6hO/B7xB45PL1GVVoZ72Co9j6HXnJmQMBkiEs6C02zlJZeTH5HXhKHp1f26QKnMB1MVSzBNj9YJ55Khi+gujQ==' \
--header 'signmethod: RSA-SHA256' \
--header 'orgcertid: CFA36DA2E064916D6C5DE607EC6DCF1B2A58AD13' \
--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_20250908070525953_3e",
"requestTime":"2025-09-08T07:05:25.953+08:00",
"nonceStr":"lZJEDUYuYx32Paue1yKnVwvbs4Yzb3QV",
"data":{
"merchant":{
"merchantNo":"********"
},
"order":{
"externalOrderNo":"EXT_ORDER_20250828102026",
"orderNo":"10820250908000014097"
}
}
}'

响应参数

字段名类型是否必返字段名称说明
order
字段名类型是否必返字段名称说明
productNoString产品编号
merchantNoString商户号
externalOrderNoString商户订单号业务方订单号
orderNoStringplatform订单号
currencyString订单币种
amountString订单交易金额
refundedAmountnumber订单退款金额
orderStatusString订单状态参考 附录-枚举字典 订单状态
orderTimeString下单时间
orderSourceString订单来源01:设备下单(无人售货柜、充电桩),02:云下单(Saas厂商)
paymentTypeString付款类型参考 附录-枚举字典 6. 支付类型
orderZoneIdString交易所在地时区商户时区/下单时区,例如 Asia/Hong_Kong
languageString网站语言
emailString电子邮件
webSiteString所属网站
orderTitleString订单标题
orderDetailsString订单描述
externalAdditionalDataString外部附加数据
goodsDetails
字段名类型是否必返字段名称说明
skuString商品编号
productNameString商品名称
priceNumber商品单价单位:元
quantityNumber商品数量
productImageString商品图片URL
productUrlString商品链接URL
Array商品信息列表
shippingAddress
字段名类型是否必返字段名称说明
shippingFirstNameString名字
shippingLastNameString姓氏
shippingAddress1String地址1
shippingAddress2String地址2
shippingCityString城市
shippingStateString州/省
shippingCountryString国家
shippingZipCodeString邮编
shippingPhoneString电话
Object收货地址信息
billingAddress
字段名类型是否必返字段名称说明
billingFirstNameString名字
billingLastNameString姓氏
billingAddress1String地址1
billingAddress2String地址2
billingCityString城市
billingStateString州/省
billingCountryString国家
billingZipCodeString邮编
billingPhoneString电话
Object账单地址信息
Object订单信息对象
transaction
字段名类型是否必返字段名称说明
transactionNoStringplatform交易流水号
merchantSerialNoString商户交易流水号
transactionTypeString交易类型参考 附录-枚举字典 3. 交易类型
currencyString交易币种
amountNumber交易金额
transactionTimeString交易发起时间
completionTimeString交易完成时间
statusString交易状态参考 附录-枚举字典 11. 交易状态
originalTransactionNoString原平台交易流水号
Array交易信息列表一个订单可能存在多笔交易记录

响应Headers数据示例:

signature: phdKQ6eySKqloGtOvu9vOO4coQUzdimMKLl9BH433Gh0VlLWiF98c6jAY50EHvD+4vjIk/31sTKzK74EHrbc/Xr9AslJ8KgLu+bx4oZKqAla8dE+wzCdkwXR9nq5EffUY6u/bxIYCjK93NMsHOFxrWrTYgMaolWYOCYWxRBNHAK2TnxUHg0hSNybiRwvv5Ouw8y+RFn0f2OO5eQoyJzRzaza13jUmWr5K3qQzgRQUYH5iiolwAHNAf11aoGkgiHdkEfQ5dPfH0en/TGOEh8PKqMsdz4SoNS4/JcC/j5KLniKiFQucyYVxdD0iB+pnFZygx3rtgltZoBdk9zfXZ3nhA==
orgCertId: ****************************************
signMethod: RSA-SHA256
响应Body数据示例
{
"requestId": null,
"requestTime": null,
"responseTime": "2025-09-08T07:05:25.662+00:00",
"respCode": 200,
"respMsg": "success",
"busCode": null,
"busMsg": null,
"busSubCode": null,
"busSubMsg": null,
"data": {
"order": {
"externalOrderNo": "EXT_ORDER_20250908150138",
"orderNo": "10820250908000014097",
"amount": "10.00",
"currency": "USD",
"orderTime": "2025-09-08T15:01:39.000+00:00",
"email": "gw816@163.com",
"goodsDetails": [
{
"sku": "123456",
"productName": "测试产品名11213123",
"price": 500,
"quantity": 2,
"productImage": "",
"productUrl": ""
}
],
"shippingAddress": {
"shippingFirstName": "Peter 三1123",
"shippingLastName": "zh张",
"shippingAddress1": "广东省广州市测试 测试 测试测试 测试 测试*",
"shippingAddress2": "广东省广州市测试 Another",
"shippingCity": "New York",
"shippingState": "NY",
"shippingCountry": "US",
"shippingZipCode": "10001",
"shippingPhone": "1231230080"
},
"billingAddress": {
"billingFirstName": "John123123",
"billingLastName": "Doe",
"billingAddress1": "456 Oak St",
"billingAddress2": null,
"billingCity": "Los Angeles",
"billingState": "CA",
"billingCountry": "US",
"billingZipCode": "90001",
"billingPhone": "987-654-3210"
},
"externalAdditionalData": "{}",
"merchantNo": "4344000047",
"productNo": "C202",
"orderZoneId": "Asia/Hong_Kong",
"paymentType": "01",
"orderSource": "02",
"refundedAmount": 0.00,
"orderStatus": "01",
"language": "zh",
"webSite": "www.baidu.com"
},
"transaction": [
{
"transactionNo": "TKF6406BAB8900000914193615962112",
"amount": 10.00,
"currency": "USD",
"transactionType": "01",
"status": "21",
"transactionTime": "2025-09-08T07:03:33.000+00:00",
"completionTime": "2025-09-08T07:05:08.000+00:00",
"merchantSerialNo": "4416409948944886"
}
]
}
}

2.5 交易查询

介绍:交易查询

接口地址: /saas/cnp

Header 参数

字段名类型是否必传字段名称说明
interfaceVersionString版本号默认值:1.0.0
languageString语言语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceNameString接口名称填写:queryTransaction
businessTypeString业务类型填写:cnp
orgNoString机构编号
orgCertIdString机构密钥证书序列号
signatureString机构签名
signMethodString机构签名方法取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名类型是否必传字段名称说明
merchant
字段名类型是否必传字段名称说明
merchantNoString商户号
Object商户信息对象
order
字段名类型是否必传字段名称说明
externalOrderNoString商户订单号
orderNoString平台订单号
Object订单信息对象
transaction
字段名类型是否必传字段名称说明
transactionNoString平台交易流水号
merchantSerialNoString商户交易流水号
Object交易信息对象
Curl请求示例
curl --location --request POST 'https:/${PAYMENT_DOMAIN}/saas/cnp' \
--header 'businesstype: cnp' \
--header 'interfacename: queryTransaction' \
--header 'interfaceversion: 1.0.0' \
--header 'language: zh_CN' \
--header 'signature: exJt04QK0IzkWQVZTSaO3rfIGj8QbWyxzdTioaAIG+hvZ3CJnbxmkOqhSof8JUF9KWvoH04SpJxX5I/FzBjBQdkaPacjsudizNI1vcEmCyu8uO9fP7YxnXlMpW8tlGIdoi5M9RvigilE6JONqlB9Ft8UgDLCvFBOEBYZleaPTqB93IsJBOzeAv/pyGJ6Ky+QiCw1nirvYKTXVEqAaqL7JLV+1e8o3ho+UCmS3WokzDtDxsAgN+zqaeBiosD8jzEJfXyN7El44t2fVo3aqnhehtUniUvfPTCtz5eOoZyiwliQ4KslcFwe6xIdY4LX4mfVqW/ehXzbw0LiK/sKWR6USw==' \
--header 'signmethod: RSA-SHA256' \
--header 'orgcertid: CFA36DA2E064916D6C5DE607EC6DCF1B2A58AD13' \
--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_20250908093146773_7d",
"requestTime":"2025-09-08T09:31:46.773+08:00",
"nonceStr":"PvFswQU8mleg9jJ842LAN3RUlF6eVf2i",
"data": {
"merchant": {
"merchantNo": "4344000047"
},
"order": {
"externalOrderNo": "EXT_ORDER_20250825141641",
"orderNo": "10820250828000013314"
},
"transaction":{
"transactionNo": "TKF6406BAB8900000914193615962112",
"merchantSerialNo":null
}

}
}'

响应参数

字段名类型是否必传字段名称说明
transaction
字段名类型是否必传字段名称说明
merchantNoString商户号
orderNoString平台订单号
externalOrderNoString商户订单号
merchantSerialNoString商户交易流水号
transactionNoString平台交易流水号
fundAgreementNoString资金入账协议编号
statusString交易状态参考 附录-枚举字典 11. 交易状态
transactionTypeString交易类型参考 附录-枚举字典 3. 交易类型
paymentWayString支付方式参考 附录-枚举字典 5. 支付方式
paymentTypeString付款类型参考 附录-枚举字典 6. 支付类型
paymentSubtypeString支付子类型参考 附录-枚举字典 7. 支付子类型
cardHolerMaskString持卡人持卡人掩码
cardNoMaskString卡号卡号掩码
cardTypeString卡类型
cardFlagString卡标志
cardBrandString卡组织
transactionTimeString交易发起时间
completionTimeString交易完成时间
transactionZoneIdString交易时区
currencyString交易币种
amountNumber交易金额
refundAmountNumber交易退款金额
localCurrencyString本地交易币种
localTranAmountNumber本地交易金额
localPayeeFeeNumber本地收款方服务费(扣)
localPayeeRefundFeeNumber本地收款方服务费(返)
marginAmountNumber保证金金额
pendingSettlementAmountNumber结算资金
localRefundAmountNumber本地交易退款金额
localPayeeRefundTotalFeeNumber本地收款方服务费(扣)退款金额
externalAdditionalDataString外部附加数据
originalTransactionNoString原平台交易流水号若为退款/撤销,指向原始交易号
Object交易信息对象

响应Headers数据示例:

signature: phdKQ6eySKqloGtOvu9vOO4coQUzdimMKLl9BH433Gh0VlLWiF98c6jAY50EHvD+4vjIk/31sTKzK74EHrbc/Xr9AslJ8KgLu+bx4oZKqAla8dE+wzCdkwXR9nq5EffUY6u/bxIYCjK93NMsHOFxrWrTYgMaolWYOCYWxRBNHAK2TnxUHg0hSNybiRwvv5Ouw8y+RFn0f2OO5eQoyJzRzaza13jUmWr5K3qQzgRQUYH5iiolwAHNAf11aoGkgiHdkEfQ5dPfH0en/TGOEh8PKqMsdz4SoNS4/JcC/j5KLniKiFQucyYVxdD0iB+pnFZygx3rtgltZoBdk9zfXZ3nhA==
orgCertId: ****************************************
signMethod: RSA-SHA256
响应Body数据示例
{
"requestId": null,
"requestTime": null,
"responseTime": "2025-09-08T11:17:54.522+00:00",
"respCode": 200,
"respMsg": "success",
"busCode": null,
"busMsg": null,
"busSubCode": null,
"busSubMsg": null,
"data": {
"order": null,
"transaction": {
"transactionNo": "TK71E220C4AC00000914500127899648",
"orderNo": "10820250908000014135",
"externalOrderNo": "EXT_ORDER_20250908190506",
"amount": 10.00,
"refundAmount": 0.00,
"currency": "USD",
"transactionType": "01",
"paymentWay": "02",
"status": "00",
"transactionTime": "2025-09-08T11:05:27.000+00:00",
"transactionZoneId": "Asia/Hong_Kong",
"completionTime": "2025-09-08T11:06:05.000+00:00",
"paymentType": "01",
"paymentSubtype": "04",
"cardBrand": "01",
"merchantSerialNo": "4416409948944886",
"merchantNo": "4344000047",
"cardNoMask": "401200****1112",
"cardHolerMask": "Pe**er",
"localCurrency": "HKD",
"localTranAmount": 77.70,
"localRefundAmount": 0.00,
"marginAmount": 0.00,
"pendingSettlementAmount": 0.00
}
}
}

2.6 关闭订单

介绍:只有未发生交易时才可以调用关单

接口地址: /saas/cnp

Header 参数

字段名类型是否必传字段名称说明
interfaceVersionString版本号默认值:1.0.0
languageString语言语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceNameString接口名称填写:close
businessTypeString业务类型填写:cnp
orgNoString机构编号
orgCertIdString机构密钥证书序列号
signatureString机构签名
signMethodString机构签名方法取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名类型是否必传字段名称说明
merchant
字段名类型是否必传字段名称说明
merchantNoString商户号
Object商户信息对象
order
字段名类型是否必传字段名称说明
externalOrderNoString商户订单号与orderNo二选一
orderNoString平台订单号二者都传时 orderNo优先于externalOrderNo
Object订单信息对象
Curl请求示例
curl --location --request POST 'https://${PAYMENT_DOMAIN}/saas/cnp' \
--header 'businesstype: cnp' \
--header 'interfacename: close' \
--header 'interfaceversion: 1.0.0' \
--header 'language: zh_CN' \
--header 'signature: f0AjyyZkUvUDtHs28UnQ6RovLNC0anzty6TMOqU6v3wBdyJNejAcy+u0pfTxL3WmtIx0OwtduLpxIrxtHIFgON0pMI1UpNOaskDZJIfi7e8C2O3s24hKxA7OKKWtgz2cHwMgrGtrHeCaJxFRxqrxLewtHfML8B+HYRYKltyAfoOLvpP1xpNXgctwhxGDhRSyC5GgJAiIIckVehoiIrlj3KZCqnFatG2E9LfKxWpL8E0cCVi2pzbb66rXsS+C/cCd8EAQioUt4MzTwPlivenpe8rdVw+NJjY8CR2FeJzckF5SKIyXkEjAGC0dM2TR/3TI/MOJ0fHEBPW+d1CzpHpkVA==' \
--header 'signmethod: RSA-SHA256' \
--header 'orgcertid: CFA36DA2E064916D6C5DE607EC6DCF1B2A58AD13' \
--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_20250908112410235_02",
"requestTime":"2025-09-08T11:24:10.235+08:00",
"nonceStr":"cJm5v6IMUeXJwFd7r9y6UYfLhn7uQJVB",
"data":{
"merchant":{
"merchantNo":"********"
},
"order":{
"externalOrderNo":"EXT_ORDER_20250826162403",
"orderNo": "10820250908000014136"
}
}
}'

响应参数

字段名类型是否必传字段名称说明
order
字段名类型是否必传字段名称说明
merchantNoString商户编号
orderNoString平台订单号
externalOrderNoString商户订单号
orderStatusString订单状态参考 附录-枚举字典 订单状态
Object订单信息

响应Headers数据示例:

signature: phdKQ6eySKqloGtOvu9vOO4coQUzdimMKLl9BH433Gh0VlLWiF98c6jAY50EHvD+4vjIk/31sTKzK74EHrbc/Xr9AslJ8KgLu+bx4oZKqAla8dE+wzCdkwXR9nq5EffUY6u/bxIYCjK93NMsHOFxrWrTYgMaolWYOCYWxRBNHAK2TnxUHg0hSNybiRwvv5Ouw8y+RFn0f2OO5eQoyJzRzaza13jUmWr5K3qQzgRQUYH5iiolwAHNAf11aoGkgiHdkEfQ5dPfH0en/TGOEh8PKqMsdz4SoNS4/JcC/j5KLniKiFQucyYVxdD0iB+pnFZygx3rtgltZoBdk9zfXZ3nhA==
orgCertId: ****************************************
signMethod: RSA-SHA256
响应Body数据示例
{
"requestId": null,
"requestTime": null,
"responseTime": "2025-09-08T11:24:14.174+00:00",
"respCode": 200,
"respMsg": "success",
"busCode": null,
"busMsg": null,
"busSubCode": null,
"busSubMsg": null,
"data": {
"order": {
"externalOrderNo": "EXT_ORDER_20250908192334",
"orderNo": "10820250908000014136",
"orderStatus": "06",
"merchantNo": "4344000047"
}
}
}

2.7 退款

介绍:退款

接口地址: /saas/cnp

Header 参数

字段名类型是否必传字段名称说明
interfaceVersionString版本号默认值:1.0.0
languageString语言语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceNameString接口名称填写:refund
businessTypeString业务类型填写:cnp
orgNoString机构编号
orgCertIdString机构密钥证书序列号
signatureString机构签名
signMethodString机构签名方法 取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名类型是否必传字段名称说明
merchant
字段名类型是否必传字段名称说明
merchantNoString商户号
Object商户信息对象
transaction
字段名类型是否必传字段名称说明
transactionNoString原平台交易流水号原交易单号
merchantSerialNoString商户交易流水号商户退款交易流水号
amountNumber交易金额退款金额 同原交易币种
notifyUrlString异步通知地址退款结果通知地址
externalAdditionalDataString外部附加信息
Object交易信息对象
Curl请求示例

curl --location --request POST 'https://${PAYMENT_DOMAIN}/saas/cnp' \
--header 'businesstype: cnp' \
--header 'interfacename: refund' \
--header 'interfaceversion: 1.0.0' \
--header 'language: zh_CN' \
--header 'signature: b/K1jJDzsCrKggZHxK2iJt6CdCrRjOxCPRlqfP+eLL58FG31/NWY+TbmCamD8YrJ+RipFQ8NttAL3mn8CK/s+uWUI0MpyCNmvA9KVUgOw+LGW7lcwztWSD2rDG2mD/lUx9++4NGIUP5eYk6Rd7Pojgn+2NWShR8bbLXQ2GuaZhhJv0UuUPEXTqKTOIKCLlML+x9t2xaGKRbuyzw7vhLtoT3GVu1XO1cbmAm69uyCshaVXuOQyl1W3Td7+VTPgoN880/1f+4WR1TKFU68OCyjwprM8cyrDU9fwlAjbTgdUAV+ApmzB6EHWjBJvjvKUJjvqkDq1ldeE7yDWJN1DQy/fg==' \
--header 'signmethod: RSA-SHA256' \
--header 'orgcertid: CFA36DA2E064916D6C5DE607EC6DCF1B2A58AD13' \
--header 'orgno: S20250325000001' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Host: 129.226.223.13' \
--header 'Connection: keep-alive' \
--data-raw '{
"requestId":"S20250325000001_20250909110755073_96",
"requestTime":"2025-09-09T11:07:55.073+08:00",
"nonceStr":"Twj5TX8Gy3tr5BgXw0ueLoZfnriRvAHi",
"data":{
"merchant": {
"merchantNo": "********"
},
"transaction": {
"transactionNo": "TK5970A4B16B00000914620757721088",
"merchantSerialNo": "MERCHANT_SERIAL_20250901155945",
"amount": 2.00,
"notifyUrl": "https://example.com/notify"
}
}
}'

响应参数

字段名类型是否必传字段名称说明
transaction
字段名类型是否必传字段名称说明
merchantNostring商户号
originalTransactionNostring原平台交易流水号关联的原交易单号
merchantSerialNostring商户交易流水号
transactionNostring平台交易流水号
externalOrderNoString商户订单号
orderNostring平台订单号
currencystring交易币种原始交易币种
amountnumber交易金额
localCurrencyString本地币种
localTranAmountNumber本地交易金额
localPayeeFeeNumber本地收款方服务费(扣)
localPayeeRefundFeeNumber本地收款方服务费(返)
statusstring交易状态参考 附录-枚举字典 11. 交易状态
transactionTimestring交易发起时间
completionTimestring交易完成时间
transactionTypestring交易类型参考 附录-枚举字典 3. 交易类型
paymentWaystring支付方式参考 附录-枚举字典 5. 支付方式
transactionZoneIdstring交易时区时区 ID(如 Asia/Hong_Kong)
fundAgreementNoString资金入账协议编号
externalAdditionalDatastring外部附加数据
object交易信息对象

响应Headers数据示例:

signature: phdKQ6eySKqloGtOvu9vOO4coQUzdimMKLl9BH433Gh0VlLWiF98c6jAY50EHvD+4vjIk/31sTKzK74EHrbc/Xr9AslJ8KgLu+bx4oZKqAla8dE+wzCdkwXR9nq5EffUY6u/bxIYCjK93NMsHOFxrWrTYgMaolWYOCYWxRBNHAK2TnxUHg0hSNybiRwvv5Ouw8y+RFn0f2OO5eQoyJzRzaza13jUmWr5K3qQzgRQUYH5iiolwAHNAf11aoGkgiHdkEfQ5dPfH0en/TGOEh8PKqMsdz4SoNS4/JcC/j5KLniKiFQucyYVxdD0iB+pnFZygx3rtgltZoBdk9zfXZ3nhA==
orgCertId: ****************************************
signMethod: RSA-SHA256
响应Body数据示例
{
"requestId": null,
"requestTime": null,
"responseTime": "2025-09-01T08:00:24.140+00:00",
"respCode": 200,
"respMsg": "success",
"busCode": null,
"busMsg": null,
"busSubCode": null,
"busSubMsg": null,
"data": {
"transaction": {
"merchantNo": "1344000007",
"merchantSerialNo": "MERCHANT_SERIAL_20250901155945",
"amount": 1.00,
"transactionNo": "TK7BC28F9A2300000912037006704640",
"originalTransactionNo": "TK756A7B381E00000912023013048320",
"orderNo": "10820250901000003606",
"refundAmount": 0.00,
"tipAmount": 0.00,
"refundTipAmount": 0.00,
"currency": "SGD",
"localTranAmount": 6.05,
"localRefundAmount": 0.00,
"localTipAmount": 0.00,
"localRefundTipAmount": 0.00,
"localCurrency": "HKD",
"transactionType": "08",
"paymentWay": "02",
"status": "00",
"responseCode": "200",
"transactionTime": "2025-09-01T08:00:22.000+00:00",
"transactionZoneUTCTime": "2025-09-01T16:00:22.000+08:00",
"transactionZoneId": "Asia/Hong_Kong",
"timeZoneFlag": 0,
"completionTime": "2025-09-01T08:00:24.000+00:00",
"cardNoDigest": "b20d173ea33f6410da288ce12bfabb0aff83a88ab6a3e5937c7ae7e367076e8a"
}
}
}

2.8 下单并支付

介绍:用于下单并支付,改场景下收银台页面和功能由商户提供

接口地址: /saas/cnp

Header 参数

字段名类型是否必传字段名称说明
interfaceVersionString版本号默认值:1.0.0
languageString语言语言(zh_CN,zh_TW,en_US)默认取值:zh_CN
interfaceNameString接口名称填写:orderAndSale
businessTypeString业务类型填写:cnp
orgNoString机构编号
orgCertIdString机构密钥证书序列号
signatureString机构签名
signMethodString机构签名方法 取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256

请求参数

字段名类型是否必传字段名称说明
merchant
字段名类型是否必传字段名称说明
productNoString产品编号参考 附录-枚举字典 1. 产品编码 ; cnp场景目前固定 C202
merchantNoString商户号
Object商户信息对象
order
字段名类型是否必传字段名称说明
externalOrderNoString商户订单号业务方订单号/外部订单号
currencyString订单币种参考 附录-枚举字典 12. 币种
amountString订单交易金额
emailString付款人电子邮箱
webSiteString所属网站下单来源网站
languageString网站语言参考 附录-枚举字典 16. 语言 例:zh ,注意:不能使用zh_CN
orderTitleString订单标题
orderDetailsString订单描述如“饼干一包,水果一袋”
externalAdditionalDataString订单附加数据jsonStr 格式
goodsDetails
字段名类型是否必传字段名称说明
skuString商品编号
productNameString商品名称
priceNumber商品单价
quantityNumber商品购买数量
productImageString商品图片URL
productUrlString商品链接URL
Array商品信息列表
shippingAddress
字段名类型是否必传字段名称说明
shippingFirstNameString名字
shippingLastNameString姓氏
shippingAddress1String地址1
shippingAddress2String地址2
shippingCityString城市
shippingStateString州/省
shippingCountryString国家代码参考 附录-枚举字典 15. 国别列表,两位代码
shippingZipCodeString邮编
shippingPhoneString电话
Object收货地址对象
billingAddress
字段名类型是否必传字段名称说明
billingFirstNameString名字
billingLastNameString姓氏
billingAddress1String地址1使用dm/3ds则必填。为避免交易失败,中文地址建议翻译为英文地址
billingAddress2String地址2
billingCityString城市
billingStateString州/省
billingCountryString国家代码参考 附录-枚举字典 15. 国别列表 两位代码
billingZipCodeString邮编
billingPhoneString电话
Object账单地址对象
Object订单信息对象
transaction
字段名类型是否必传字段名称说明
merchantSerialNoString商户交易流水号
amountString交易金额
paymentSubTypeString支付子类型参考 附录-枚举字典 7. 支付子类型
returnUrlString返回地址支付完成后跳转地址
notifyUrlString异步通知地址
cnpPayEnvironment
字段名类型是否必传字段名称说明
userAgentString持卡人浏览器UserAgent例:360Browser
ipAddressString持卡人 IP地址
panIsPasteString卡号是否粘贴0:否;1:是
timeZoneNumber持卡人时区偏移量 例:8
acceptLanguageString持卡人浏览器请求语言例:zh_CN
domainString支付网站域名
screenWidthNumber持卡人屏幕宽度px
screenHeightNumber卡人屏幕高度px
Object支付环境信息CNP 支付安全相关参数
cnpPayInfoVo
字段名类型是否必传字段名称说明
cardHolderString持卡人姓名
acctNoString卡号
expiryMonthString卡片到期月份MM
expiryYearString卡片到期年份YYYY
acctCvvStringCVV 安全码卡背面三位
tavvString3DS 交易认证值token化卡号场景时,使用tavv 代替 acctCvv
Object支付卡信息
Object交易信息对象
Curl请求示例
curl --location --request POST 'https://${PAYMENT_DOMAIN}/saas/cnp' \
--header 'businesstype: cnp' \
--header 'interfacename: orderAndSale' \
--header 'interfaceversion: 1.0.0' \
--header 'language: zh_CN' \
--header 'signature: CHIeX4tJsmeZQEyVJkAOSfIq3oQQa4Qdr/9hS6Sy5ldSzP6EOPJXQl3qKf1XqAsW1BnqP1DAXpxoGYZosP38TvMZT53NK08rqs6w3jmL1gZ50yrEwVa6WWPrOZgwhIAcIli3IjjRLyi2lfnsfAwl4iL2/9GFRHPxd3upgM1JAL/2FwcCTUWmES99vqGe5drRP8q9iDh9hMjSSFkh834crn46S7qLZNhAE+cRh1dcKC48KbxpAhEL0gaUYrNLVeWynroIQkg6b0gk+JBjL8H9TmxzlToggPG+Mhqlvf7iZvysxtLHrZWamo4mIu3LPwKplaCp6kiDoLji0ve451x7CQ==' \
--header 'signmethod: RSA-SHA256' \
--header 'orgcertid: CFA36DA2E064916D6C5DE607EC6DCF1B2A58AD13' \
--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_20250922092658036_8e",
"requestTime":"2025-09-22T09:26:58.036+08:00",
"nonceStr":"loPzrVKdURVrSnIhP4tSEXOkNCI8UjeK",
"data":{
"merchant":{
"merchantNo":"********",
"productNo" : "C202"
},
"order":{
"externalOrderNo":"EXT_ORDER_20250922172658",
"amount":"10",
"currency":"USD",
"language":"zh",
"email":"gw816@163.com",
"webSite":"www.baidu.com",
"orderTitle":"订单title",
"orderDetails":"一袋饼干",
"externalAdditionalData":"{}",
"goodsDetails":[{
"sku":"123456",
"productName":"测试产品名",
"price":500,
"quantity":2,
"productImage":"",
"productUrl":""
}],
"shippingAddress":{
"shippingFirstName": "Peter 三",
"shippingLastName": "zh张",
"shippingAddress1": "广东省广州市测试 测试 测试测试 测试 测试*",
"shippingAddress2": "广东省广州市测试 Another",
"shippingCity": "New York",
"shippingState": "NY",
"shippingCountry": "CN",
"shippingZipCode": "10001",
"shippingPhone": "1231230080"
},
"billingAddress":{
"billingFirstName": "John",
"billingLastName": "Doe",
"billingAddress1": "456 Oak St",
"billingAddress2": null,
"billingCity": "Los Angeles",
"billingState": "CA",
"billingCountry": "CN",
"billingZipCode": "90001",
"billingPhone": "987-654-3210"
}
},
"transaction":{
"merchantSerialNo":"test0009",
"returnUrl":"https://www.baidu.com/",
"notifyUrl":"https://webhook.site/1acb9fc2-11ae-4db8-bbbc-6858f35e87ec",
"amount":"10",
"paymentSubType":"04",
"cnpPayEnvironment":{
"userAgent":"360Brower",
"ipAddress":"127.0.0.1",
"panIsPaste":"0",
"timeZone":8,
"acceptLanguage":"zh_CN",
"domain":"https://payment-cnp-test.cogolinks.com",
"screenWidth":1029,
"screenHeight":1646
},
"cnpPayInfoVo":{
"cardHolder":"Peter",
"acctNo":"4012001037141112",
"expiryMonth":"12",
"expiryYear":"2027",
"acctCvv":"212",
"tavv":""
}
}
}

}'

响应参数

字段名类型是否必返字段名称说明
transaction
字段名类型是否必返字段名称说明
merchantNoString商户号
productNoString产品编号
externalOrderNoString商户订单号
orderNoString平台订单号
merchantSerialNoString商户交易流水号
transactionNoString平台交易流水号系统生成
transactionTimeString交易发起时间
statusString交易状态参考 附录-枚举字典 11. 交易状态
cashUrlString收银台地址
externalAdditionalDataString交易附加数据
Object交易信息对象

响应Headers数据示例:

signature: idCYp8R2h4TPiLLN+E+K3F9uKwScaJjlAUwxut8PwEh4EfHn526IPZuw1MITfEmsQA06sNYrr5hI7dsaBJrBWLV8UFWKfuSkg2aPn94THa3TD/NZt5r7NxGYVAT2IGmw2q+h+z5hFQSBRENsz1r1GIhtQogaH2klN5m5XQNgJlHuGoMNpbCY8MRtDhVjmILrXHb1SrqsMQKW74r4EbjwXi6ZTV4c/OnYIXemg6us8v3kw9h4pKKWPsZh+jP9Y7Xk51SUFxOemxMayrW1xoDuOzZt0W5jCaX07KDrn4CKkFx0IPCnxjiv5vfavONN3/kbt0BYzqLMnFzWTVgIoCWN0w==
orgCertId: ****************************************
signMethod: RSA-SHA256
响应Body数据示例
{
"requestId": null,
"requestTime": null,
"responseTime": "2025-09-22T09:26:55.913+00:00",
"respCode": 200,
"respMsg": "success",
"busCode": null,
"busMsg": null,
"busSubCode": null,
"busSubMsg": null,
"data": {
"transaction": {
"merchantNo": "********",
"merchantSerialNo": "test0009",
"amount": 10.00,
"transactionNo": "TK73975781C600000896906672095232",
"orderNo": "10820250922000015181",
"externalOrderNo": "EXT_ORDER_20250922172658",
"currency": "USD",
"status": "21",
"checkPayUrl": "https://test.allinpayhk.com/pay-web-h5/cnp_pay/directCashier?accessCode=85200309&mchtId=852999999528599&accessOrderId=TK73975781C600000896906672095232&language=cn"
}
}
}

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
}
}
}
}'