境内收单-收银台

接口描述

使用此接口发起收银台

基本信息

测试请求地址 https://cbtrxtest.helipay.com/cbtrx/pay/cashier/interface
请求地址 https://cbptrx.helipay.com/cbtrx/pay/cashier/interface
提交方式 采用POST方法提交,requestbody传值 Content-Type=[application/json;charset=UTF-8]
签名算法 UTF-8字符编码 SHA256签名 AES加密

请求参数

名称 参数 类型 必填 示例值 说明
商户编号 merchantNo String(10) Me10000001 合利宝-跨境系统分配的商户编号
商户订单号 orderNo String(64) p_20170302185347 商户系统内部订单号,同一商户号下订单号唯一
商户平台 用户ID memberNo String(18) 1234567 商户平台 用户ID
订单金额 orderAmount Number(10.2) 0.01 单位:元,订单金额最小为0.01
产品编码 productCode String(20) ONLINEB2C、ONLINEB2B、QUICKPAY、WXPAYSCAN、ALIPAYSCAN 1.网银、快捷、微信主扫、支付宝主扫,中商户已开通产品的任意一个 2.根据此字段收银台页面优先展示对应产品的tab
商品名称 goodsName String(50) 澳大利亚岩龙虾
应用名 appName String(50) 某宝
下单ip orderIp String(50) 1.1.1.1
有效期 period String(6) 1 默认为7
有效期单位 periodUnit String(10) HOUR YEAR/MONTH/DAY/HOUR/MINUTE/SECOND;默认为DAY
服务器回调地址 serverCallbackUrl String(300) http://www.456.com
页面回调地址 pageCallbackUrl String(300) http://www.123.com
微信报备号 wxReportId String(128) 2222223
支付宝报备号 aliReportId String(128) 2222223

响应参数

名称 参数 类型 必填 示例值 说明
产品编码 productCode String(20) ONLINEB2C、ONLINEB2B、QUICKPAY、WXPAYSCAN、ALIPAYSCAN 与请求产品编码一致
商户订单号 orderNo String(64) p_20170302185347
商户编号 merchantNo String(10) Me10000002 合利宝-跨境系统分配的商户编号
响应码 errorCode String(10) 0000 0000 代表请求成功
响应信息 errorMessage String(200) 响应信息 错误信息
响应时间 current String(20) 2021-04-01 12:00:00 格式yyyy-MM-dd HH:mm:ss
订单金额 orderAmount Number(10.2) 0.01 单位:元
重定向url redirectUrl String(20) http://127.0.0.1:8080/cbtrx/pay/cashier/domestic/online/index.html?payOrderNo=ff28cc446b439e2751f5d3b&merchantNo=ce430f67682a&cashierMenuType=3f5f452023 商户根据该url,进行重定向展现收银台页面

接口描述

使用订单号获取合利宝系统相关收银台订单信息。

基本信息

测试请求地址 https://cbtrxtest.helipay.com/cbtrx/rest/order/cashier/query
请求地址 https://cbptrx.helipay.com/cbtrx/rest/order/cashier/query
提交方式 采用POST方法提交,requestbody传值 Content-Type=[application/json;charset=UTF-8]
签名算法 UTF-8字符编码 SHA256签名 AES加密

请求参数

名称 参数 类型 必填 示例值 说明
产品编码 productCode String(20) ALIPAYSCAN/WXPAYSCAN/ONLINEB2B/ONLINEB2C/QUICKPAY 订单对应的实际业务对应的产品编码
商户订单号 orderNo String(64) p_20170302185347 原交易订单号
商户编号 merchantNo String(10) Me10000002 合利宝-跨境系统分配的商户编号

响应参数

名称 参数 类型 必填 示例值 说明
产品编码 productCode String(20) ONLINEB2C、ONLINEB2B、QUICKPAY、WXPAYSCAN、ALIPAYSCAN 1.网银、快捷、微信主扫、支付宝主扫,该订单实际支付的产品
商户订单号 orderNo String(64) p_20170302185347 原交易订单号
平台流水号 serialNumber String(32) 201702241400010002 合利宝-跨境系统生成的唯一交易流水号
商户编号 merchantNo String(10) Me10000002 合利宝-跨境系统分配的商户编号
响应码 errorCode String(10) 0000 0000 代表请求成功
响应信息 errorMessage String(200) 成功 响应信息 错误信息
响应时间 current String(20) 2021-04-01 12:00:00 格式yyyy-MM-dd HH:mm:ss
下单时间 createDate String(20) 2021-04-01 12:00:00 格式yyyy-MM-dd HH:mm:ss
完成时间 finishDate String(20) 2021-04-01 12:00:00 格式yyyy-MM-dd HH:mm:ss
订单状态 orderStatus String(20) SUCCESS/INIT 支付成功:SUCCESS,未支付:INIT
订单金额 orderAmount Number(10.2) 0.01 单位:元
支付银行 bankCode String(20) ICBC/CCB 银行编码,详细信息参见附录
绑卡id bindId String(40) 绑卡id

收银台-发起退款

接口描述

收银台订单使用此接口发起对原交易的退款请求

测试请求地址 https://cbtrxtest.helipay.com/cbtrx/rest/refund/cashier/refundApply
请求地址 https://cbptrx.helipay.com/cbtrx/rest/refund/cashier/refundApply
提交方式 采用POST方法提交,requestbody传值 Content-Type=[application/json;charset=UTF-8]
签名算法 UTF-8字符编码 SHA256签名 AES加密

请求参数

名称 参数 类型 必填 示例值 说明
产品编码 productCode String(20) 例:ONLINEB2C、ONLINEB2B、QUICKPAY等 用户实际支付的产品编码
原订单号 orderNo String(64) p_20170302185347 原交易订单号
商户编号 merchantNo String(10) Me10000002 合利宝-跨境系统分配的商户编号
退款请求订单号 refundOrderNo String(64) refund_p_20170302185347
退款金额 refundAmount Number(10.2) 0.01 单位:元
退款备注 refundDesc String(128) 备注 备注退款原因等信息
平台商户编号 platMerchantNo String(10) 如下说明 电商平台商户所属的平台商编号
服务器回调地址 refundNotifyAddress String(128) www.baidu.com 服务器回调地址

响应参数

名称 参数 类型 必填 示例值 说明
响应码 errorCode String(10) 0000 0000 代表请求成功
响应信息 errorMessage String(200) 成功 响应信息 错误信息
原订单产品编码 productCode String(20)
响应时间 current String(20) 2021-04-01 12:00:00 格式yyyy-MM-dd HH:mm:ss
原订单号 orderNo String(64) p_20170302185347
商户编号 merchantNo String(10) Me10000002 合利宝-跨境系统分配的商户编号
退款汇总: refundRecord
原订单请求号 sourceOrderNo String(64)
原订单序列号 sourceSerialNumber String(32)
原订单金额 sourceOrderAmount Number(10.2)
原订单手续费 sourceOrderFee Number(10.2)
原订单完成时间 sourceOrderCompleteDate String(20) 2021-04-01 12:00:00 格式yyyy-MM-dd HH:mm:ss
已退款金额 refundedAmount Number(10.2)
已退款手续费 refundedFee Number(10.2)
退款次数 refundCount int
最近退款时间 latestRefundDate String(20) 2021-04-01 12:00:00 格式yyyy-MM-dd HH:mm:ss
退款明细: detail
退款序列号 serialNumber String(64)
退款请求号 refundOrderNo String(64)
退款金额 refundAmount Number(10.2)
退款手续费 refundFee Number(10.2)
退款入账金额 refundInAccountAmout Number(10.2)
创建时间 createDate String(20) 2021-04-01 12:00:00 格式yyyy-MM-dd HH:mm:ss
退款完成时间 completeDate String(20) 2021-04-01 12:00:00 格式yyyy-MM-dd HH:mm:ss
退款状态 refundStatus String(20) INIT (初始化)、RECEIVE(接收)、DOING(处理中)、CLOSE(关闭)、SUCCESS(成功)、FAIL(失败)
退款描述 refundDesc String(128)

收银台退款查询

接口描述

收银台订单-使用此接口发起对退款请求的查询

测试请求地址 https://cbtrxtest.helipay.com/cbtrx/rest/refund/cashier/queryRefund
请求地址 https://cbptrx.helipay.com/cbtrx/rest/refund/cashier/queryRefund
提交方式 采用POST方法提交,requestbody传值 Content-Type=[application/json;charset=UTF-8]
签名算法 UTF-8字符编码 SHA256签名 AES加密

请求参数

名称 参数 类型 必填 示例值 说明
原订单产品编码 productCode String(20) 例:ONLINEB2C、ONLINEB2B、QUICKPAY等 用户实际支付的产品编码
退款订单号 orderNo String(64) p_20170302185347 原交易订单号
商户编号 merchantNo String(10) Me10000002 合利宝-跨境系统分配的商户编号
会员编号 subMerchantNo String(10) Me10000021 商户的会员,如原交易与会员无关,可不填
平台商户编号 platMerchantNo String(10) 如下说明 电商平台商户所属的平台商编号

响应参数

名称 参数 类型 必填 示例值 说明
响应码 errorCode String(10) 0000 0000 代表请求成功
响应信息 errorMessage String(200) 成功 响应信息 错误信息
原订单产品编码 productCode String(20) 实际支付的产品编码
响应时间 current String(20) 2021-04-01 12:00:00 格式yyyy-MM-dd HH:mm:ss
原订单号 orderNo String(64) p_20170302185347
商户编号 merchantNo String(10) Me10000002 合利宝-跨境系统分配的商户编号
退款汇总: refundRecord
原订单请求号 sourceOrderNo String(64)
原订单序列号 sourceSerialNumber String(32)
原订单金额 sourceOrderAmount Number(10.2)
原订单手续费 sourceOrderFee Number(10.2)
原订单完成时间 sourceOrderCompleteDate String(20) 2021-04-01 12:00:00 格式yyyy-MM-dd HH:mm:ss
已退款金额 refundedAmount Number(10.2)
已退款手续费 refundedFee Number(10.2)
退款次数 refundCount int
最近退款时间 latestRefundDate String(20) 2021-04-01 12:00:00 格式yyyy-MM-dd HH:mm:ss
退款明细: detail
退款序列号 serialNumber String(64)
退款请求号 refundOrderNo String(64)
退款金额 refundAmount Number(10.2)
退款手续费 refundFee Number(10.2)
退款入账金额 refundInAccountAmout Number(10.2)
创建时间 createDate String(20) 2021-04-01 12:00:00 格式yyyy-MM-dd HH:mm:ss
退款完成时间 completeDate String(20) 2021-04-01 12:00:00 格式yyyy-MM-dd HH:mm:ss
退款状态 refundStatus String(20) INIT (初始化)、RECEIVE(接收)、DOING(处理中)、CLOSE(关闭)、SUCCESS(成功)、FAIL(失败)
退款描述 refundDesc String(128)