卡券管理类接口列表

批量激活卡券
批量取消激活卡券
按礼品卡号查询卡信息

批量激活卡券

接口用途

供门店激活一批卡或券

接口地址

https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/batchActivate

action

batchActivate

请求参数，中间件===>易百后台

字段	类型	是否必填	字段意义	备注
traceNo	String	是	收银机流水号	不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列
onlineTid	String	否	线上对接使用的统一终端号	对接前需提前和易百技术沟通
activateType	String	是	激活类型	1：券；2：预付卡
posOrderNo	String	是	pos订单号	pos订单号，由商家自定义需保证在商户端不重复
totalAmount	Price	是	交易总金额	单位：元
userRealAmount	Price	是	用户实付	单位：元
receiptAmount	Price	是	商户实收金额	单位：元
codeValidDays	Number	否	相对有效天数	码相对有效期天数和码有效开始结束时间段任选其一必填
codeValidStart	String	否	码有效开始时间
codeValidEnd	String	否	码有效结束时间
codeDetail	List<codeDetail>	是	待激活卡券列表
orderRemark	String	否	订单备注	订单备注信息，除基本信息，也用于部分透传字段场景使用

请求报文举例

{
    "traceNo": "TEST16876705239999000001",
    "onlineTid": "",
    "activateType": "1",
    "posOrderNo": "batchActivate1687670523",
    "totalAmount": "100",
    "userRealAmount": "100",
    "receiptAmount": "100",
    "codeValidDays": "100",
    "codeValidStart": "2023-06-18",
    "codeValidEnd": "2023-12-31",
    "codeDetail": [
        {
            "code": "10032812043865714308",
        }
    ]
}

返回参数，易百后台===>中件间

字段	类型	是否必填	字段意义	备注
traceNo	String	是	收银机流水号	不允许重复
orderNo	String	是	本次激活操作订单号
transDate	String	是	交易时间	格式为：yyyyMMddHHmmss
returnCode	String	是	返回码	00仅表示本次请求成功，并不代表所有码都激活成功
returnDesc	String	是	返回信息	交易结果描述或错误原因
codeDetail	List<codeDetail>	是	激活结果列表
orderRemark	String	否	订单备注	订单备注信息，除基本信息，也用于部分透传字段场景使用

返回报文举例

{
   	"returnCode": "00",
	"returnDesc": "交易成功",
    "codeDetail": [
        {
            "code": "10032812043865714308",
            "resultCode": "SUCCESS",
            "resultDesc": "交易成功",
            "ticketId": "1000030000057",
            "ticketName": "测试预付费",
            "useTimes": 1
        }
    ],
    "traceNo": "TEST16876705239999000001",
    "transDate": "20230625132210"
}

批量取消激活卡券

接口用途

供门店取消激活一批卡或券

接口地址

https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/batchUnActivate

action

batchUnActivate

请求参数，中间件===>易百后台

字段	类型	是否必填	字段意义	备注
traceNo	String	是	收银机流水号	不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列
onlineTid	String	否	线上对接使用的统一终端号	对接前需提前和易百技术沟通
codeDetail	List<codeDetail>	否	待取消激活卡券列表	券号列表
originalTraceNo	String	否	原激活交易收银机流水号	传入需要取消激活原交易收银机流水号Costa品牌必传
orderRemark	String	否	订单备注	订单备注信息，除基本信息，也用于部分透传字段场景使用，如品牌核销渠道等。

请求报文举例

{
    "traceNo": "TEST16876718849999000003",
    "onlineTid": "",
    "codeDetail": [
        {
            "code": "10032812043892009242"
        }
    ]
}

返回参数，易百后台===>中件间

字段	类型	是否必填	字段意义	备注
traceNo	String	是	收银机流水号	不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列
orderNo	String	是	本次作废操作订单号
transDate	String	是	交易时间	格式为：yyyyMMddHHmmss
returnCode	String	是	返回码	00仅表示本次请求成功，并不代表所有码都取消激活成功
returnDesc	String	是	返回信息	交易结果描述或错误原因
codeDetail	List<codeDetail>	是	取消激活结果列表
orderRemark	String	否	订单备注	订单备注信息，除基本信息，也用于部分透传字段场景使用，如品牌核销渠道等。

返回报文举例

{
	"returnCode": "00",
	"returnDesc": "交易成功",
    "codeDetail": [
        {
            "code": "10032812043892009242",
            "resultCode": "SUCCESS",
            "resultDesc": "交易成功",
            "ticketId": "1000030000057",
            "ticketName": "测试预付费",
            "useTimes": 1
        }
    ],
    "traceNo": "TEST16876718849999000003",
    "transDate": "20230625134444"
}

按礼品卡号查询卡信息

接口用途

供门店查询卡相关信息

接口地址

https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/getCardInfo

action

getCardInfo

请求参数，中间件===>易百后台

字段	类型	是否必填	字段意义	备注
traceNo	String	是	收银机流水号	不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列
onlineTid	String	否	线上对接使用的统一终端号	对接前需提前和易百技术沟通
cardNo	String	是	礼品卡卡号	卡号
orderRemark	String	否	订单备注	订单备注信息，除基本信息，也用于部分透传字段场景使用，如品牌核销渠道等。

请求报文举例

{
    "traceNo": "TEST16876718849999000003",
    "onlineTid": "",
    "cardNo": "9531761027959980000026"
}

返回参数，易百后台===>中件间

字段	类型	是否必填	字段意义	备注
traceNo	String	是	收银机流水号	不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列
orderNo	String	是	本次查询操作易百交易号
transDate	String	是	交易时间	格式为：yyyyMMddHHmmss
returnCode	String	是	返回码	00表示本次查询请求成功
returnDesc	String	是	返回信息	交易结果描述或错误原因
cardInfo	Object<cardInfo>	是	礼品卡信息	当returnCode为00时才返回
orderRemark	String	否	订单备注	订单备注信息，除基本信息，也用于部分透传字段场景使用，如品牌核销渠道等。

返回报文举例

{
	"returnCode": "00",
	"returnDesc": "交易成功",
	"cardInfo": {
		"cardNo": "",
		"cardStatus": "11",
		"effectStartTime": 1733021696000,
		"expireTime": 1735613696000,
		"bindSuccessTime": 0,
		"lastUseTime": 0,
		"cardId": "",
		"cardName": "",
		"cardFaceValue": 0,
		"cardNetValue": 0,
		"cardBalance": 150,
		"extraInfo": ""
	},
	"traceNo": "TEST16876718849999000003",
	"transDate": "20230625134444"
}