机器人次卡核销
1.机器人次卡核销接口(冻结)
1.1 交互时序图:
1.2 请求场景:
智能机器人使用次卡支付冻结
1.3 接口要求:
使用来伊份openapi加密协议进行加密请求
1.4 接口标准
1.4.1 基本信息
描述 | 值 |
---|---|
服务名称 | community-card-api |
URL | 测试环境:https://openapi.test.laiyifen.com/community-card-api/community/card/robot/freeze 生产环境:https://openapi.laiyifen.com/community-card-api/community/card/robot/freeze |
认证方式 | 令牌 |
请求方式 | HTTP(POST) |
1.4.2 请求头公共参数 (Header)
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
X-Co-Client | String | 是 | 客户端Id(来伊份提供) |
X-Co-Sign | String | 是 | 签名 |
X-Co-TimeStamp | String | 是 | 签名时间戳 |
1.4.3 入参 Body
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
mscCode | String | 是 | 客户端编码,例如:传 1Z330030 |
itemList | List | 是 | 商品行信息集合 |
shopCode | String | 是 | 门店编码,例如:1Z33 |
uniqueCode | String | 是 | 机器人唯一码 ,保证唯一 |
phone | String | 是 | 用户手机号 |
orderNo | String | 是 | 外部订单号 |
1.4.3.1 itemList(商品数据)
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
skuCode | String | 是 | 商品编码 |
skuQty | Integer | 是 | 商品数量 |
saleUnitCode | String | 是 | 商品销售单位 |
1.4.4 入参示例
{
"mscCode":"107U0030",
"phone":"13666666666",
"shopCode":"107U",
"uniqueCode":"db5c91d6-29d5-11ed-80f8-005056ae1a79",
"orderNo":"55588868343490604806445",
"itemList":[
{
"saleUnitCode":"BEI",
"skuCode":"CK001",
"skuQty":2
}
]
}
1.4.5 返回统一参数
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
code | String | 是 | 返回请求业务代码 |
msg | String | 是 | 返回信息描述 |
data | Json | 是 | 返回参数 |
1.4.6 返回参数Data
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
token | String | 是 | 调用核销/解冻接口时需要回传 |
itemList | List | 是 | 剩余待支付金额明细 |
1.4.7 返回参数itemList
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
skuCode | String | 是 | 商品编码 |
skuQty | Integer | 是 | 商品待支付数量 |
skuUnitCode | String | 是 | 单位 |
1.4.8 返回示例
{
"code":0,
"data":{
"token":"/HfMFHGYmR9fRTMDj8UooaSatk+EvLqY0ACohCvzLog=",
"itemList":[
{
"saleUnitCode":"BEI",
"skuCode":"CK001",
"skuQty":1
}
]
},
"msg":"success"
}
2.机器人次卡核销回调接口(解冻&核销)
2.1 交互时序图:
2.2 请求场景:
机器人调用次卡核销接口后,回调此接口进行次卡解冻或者核销
2.3 接口要求:
使用来伊份openapi加密协议进行加密请求
2.4 接口标准
2.4.1 基本信息
描述 | 值 |
---|---|
服务名称 | community-card-api |
URL | 测试环境:https://openapi.test.laiyifen.com/community-card-api/community/card/robot/callback 生产环境:https://openapi.laiyifen.com/community-card-api/community/card/robot/callback |
认证方式 | 令牌 |
请求方式 | HTTP(POST) |
2.4.2 请求头公共参数 (Header)
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
X-Co-Client | String | 是 | 客户端Id(来伊份提供) |
X-Co-Sign | String | 是 | 签名 |
X-Co-TimeStamp | String | 是 | 签名时间戳 |
2.4.3 入参 Body
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
token | String | 是 | 次卡核销接口返回的token |
orderNo | String | 是 | 外部订单号 |
resultCode | String | 是 | 外部订单支付状态 "0"-成功 ,"1"-失败 |
2.4.4 入参示例
{
"orderNo":"55588868343490604806445",
"resultCode":"0",
"token":"/HfMFHGYmR9fRTMDj8UooaSatk+EvLqY0ACohCvzLog="
}
2.4.5 返回统一参数
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
code | String | 是 | 返回请求业务代码 |
msg | String | 是 | 返回信息描述 |
data | Json | 是 | 返回参数 |
2.4.8 返回示例
{
"code":0,
"data":true,
"msg":"success"
}