客户套餐卡退卡

接口地址

/marketing/card/bill/autoAddPackageCardRefundBill

入参

字段说明

名称	类型	必填	示例	描述
serialNumber	String	是	"EJ27311048335"	退卡流水号，用于问题追溯，长度为10~32个字符。注意：流水号要保证在整个卡的业务域内唯一，包括套餐卡开卡、套餐卡退卡、储值卡开卡等。
idEntity	Number	是	11715748705813418008	套餐卡实体 ID
idCustomer	Number	否	10545360219000304622	持卡客户 ID，用于安全校验。若当前套餐卡真实持有人与该字段不一致，则退卡失败。强烈建议传递该参数。
refundMoney	Number	是	200.00	退款金额。最大可退款金额：卡实体剩余实额 realAmount
paymentName	String	是	"微信支付"	退款方式名称。取自"财务参数设置-收款方式"，需要该收款方式开启，否则会报错。
idEmployee	Number	否	10545360219000304622	退卡员工 ID
idOwnOrg	Number	是	10545360219000304622	退卡门店 ID
remark	String	否	"协商退卡"	退卡备注，最大长度 200

JSON示例

{
    "paramValues": [
        {
            "serialNumber": "EJ27311048335",
            "idEntity": 11715748705813418008,
            "refundMoney": 200.00,
            "paymentName": "微信支付",
            "idEmployee": 10545360219000304622,
            "idOwnOrg": 10545360219000304622,
            "remark": "协商退卡",
        }
    ]
}

出参

字段说明

名称	类型	示例	描述
idCardBill	Number	10545360219000304622	退卡单唯一标识。 退卡结算属于比较耗时的操作，底层是异步处理的，存在极端情况下结算失败的可能。这种情况下，虽然接口返回了 退卡单标识 idCardBill，但可能退卡结算并未成功。 所以建议接入方在执行最终的给车主退款操作前，调用“卡实体明细查询”接口，check 卡实体状态是否为退卡状态，即 usable = 5。

JSON示例

{
    "code": 200,
    "message": "OK",
    "data": {
        "idCardBill": 11935963830410043452
    }
}