核销码生成

接口地址

/macan/voucher/code/create

入参

字段说明

名称	类型	必填	示例	描述
type	String	是	"card"	核销码类型：card-卡、coupon-券、order-订单
relatedId	Number	是	15446577379572653837	关联的卡、券或订单的 ID，这里必须是 F6 侧的 ID
relatedCustomerId	Number	否	10545360219000304622	关联资源的持有客户 ID，用于安全校验。若关联资源的真实持有人与该字段不一致，则核销码生成失败。强烈建议传递该参数。
expirationMinutes	Number	否	30	过期分钟数，范围 (0, 120]，缺省 30 分钟

JSON示例

{
    "paramValues": [
        {
            "type": "card",
            "relatedId": 15446577379572653837,
            "relatedCustomerId": 10545360219000304622,
            "expirationMinutes": 30
        }
    ]
}

出参

字段说明

名称	类型	示例	描述
code	Number	200	200-业务成功 400-业务异常 500-接口内部异常
data	GatewayResponse
message	String	"SUCCESS"	SUCCESS-正常返回 其他则是异常响应的错误提示

GatewayResponse

名称	类型	示例	描述
data	VoucherCodeCreateResponse�		核销码生成结果
message	String	"OK"	OK-业务接口请求成功

VoucherCodeCreateResponse�

名称	类型	示例	描述
qrCodeContent	String	"f6://voucherCode?code=9X8Z62GR&type=card"	核销二维码内容，对接方自行生成对应的二维码图片
expirationTime	String	"2024-06-11 13:10:47"	过期时间，格式 yyyy-MM-dd HH:mm:ss

JSON示例

{
    "code": 200,
    "data": {
        "data": {
            "qrCodeContent": "f6://voucherCode?code=9X8Z62GR&type=card",
            "expirationTime": "2024-06-11 13:10:47"
        },
        "message": "OK"
    },
    "message": "SUCCESS"
}