Skip to main content

【资产类】卡包指定资产移除

基本信息

接口名称:移除指定卡券(通知三方)状  态:已完成
接口路径:POST /paas/micro/voucherwallet/removeCardVoucherWallet更新时间:2022-09-28 17:45:52
Mock地址:https://apimock.e-buychina.com/mock/77/paas/micro/voucherwallet/removeCardVoucherWallet

请求参数

Headers:

参数名称参数值是否必填
Content-Typeapplication/json

Body:

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
appIdstring请求AppId最大长度:50
最小长度:1
Mock:@natural
actionstring交易类型最大长度:50
最小长度:1
Mock:removeCardVoucherWallet
timestampnumber请求时间戳Mock:@timestamp
signTypestring签名类型最大长度:20
最小长度:1
Mock:sha256
signstring签名值最大长度:500
最小长度:1
Mock:@natural
langstring语言最大长度:50
最小长度:1
Mock:zh_CN
contentobject请求报文
  memberIdstring(条件必填)租户会员ID(上送JWT令牌时选填)最大长度:32
最小长度:1
Mock:@string
  thirdOpenIdstring(条件必填)三方用户唯一标识(外部会员ID,与租户会员ID不能同时为空)最大长度:32
最小长度:1
Mock:@string
  voucherCodeListarray卡券号集合(明文交易卡号或券码号)

返回数据

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
successboolean交易成功与否Mock:@boolean
actionstring交易类型最大长度:50
最小长度:1
Mock:removeCardVoucherWallet
timestampnumber返回时间戳Mock:@timestamp
errorCodestring错误码最大长度:50
Mock:@word
errorMessagestring错误描述最大长度:50
Mock:@csentence
signTypestring签名类型最大长度:20
Mock:sha256
signstring签名值最大长度:500
Mock:@natural
contentobject返回报文
  updateCountinteger移除成功数量

备注

适用业务场景:
* 1) 部分卡券资产移除操作(不含转赠场景),移除后用户卡券不可见
* 2) 支持渠道方三方卡包的移除通知,控制易百已对接渠道的三方卡包状态(如微信、支付宝渠道卡包)
* 3) 租户会员注销场景(原手机号失效),相关资产作逻辑删除(需上送所有卡券列表)

为了保证接口安全性,本接口使用JWT令牌处理进行请求校验,合法JWT令牌方可调用此接口
校验依据为租户会员ID
令牌换取接口详见:https://book.e-buy.com/books/e-buy-paas-api/page/jwt

请求报文示例:

{
    "uuid": "20211224-kecwygdsipokqstbqtbwmqlpxijewfbf",
    "appId": "ebuytes100100100",
    "action": "removeCardVoucherWallet",
    "timestamp": 1640331603,
    "signType": "sha256",
    "sign": "1289147634148182",
    "content": {
        "memberId": "3af2d2e1060d399c5ec5592fbfa87828",
        "voucherCodeList": [ "caziqra3", "dbajqrb4", "ecbkqrc5"``]
    },
    "lang": "zh_CN"
}

响应报文示例:

{
    "uuid": "20211224-kecwygdsipokqstbqtbwmqlpxijewfbf",
    "action": "removeCardVoucherWallet",
    "content": {
        "updatedCount":1
    },
    "success": true,
    "errorCode": "",
    "errorMessage": "",
    "timestamp": 1640332092481,
    "signType": "sha256",
    "sign": "f94ddcbf0ab5bc28ad0fb018a4365b7164c9dbfb46de458e704813d7757b4bd7"
}

注意:为保证签名的一致性,返回报文中的content字段将以string形式的进行返回,例如:

{
	"content": {
		"userId": 1,
		"userName": "Trump"
	}
}

将返回为:

{
	"content": "{\"userId\":1,\"userName\":\"Trump\"}"
}

变更历史

变更日期变更内容
2022-09-28
2022-05-18
2022-05-13
2022-05-13
2022-05-13
2022-05-11
2022-05-11
2021-09-03
2021-09-02
2020-08-19
2020-08-19
2020-08-19
2020-08-19
api-id=18587