优惠详情
功能描述
收钱吧付款码支付接口、查询接口同步返回 和 回调接口(商户系统域名地址)通知,新增参数provider_response,以json方式展示,所有优惠信息都将通过该字段做展示,返回的内容与微信/支付宝保持一致;接口默认不返回,如果需要接口返回这些内容,请联系收钱吧技术支持同事开通。
微信/支付宝接口返回的数据格式不一致,详见以下内容。
微信支付优惠详情返回:
参数 | 参数名称 | 类型 | 必填 | 描述 | 范例 |
---|---|---|---|---|---|
provider_response | 优惠详情 | JSON | N | 格式为json,内容有两部分 goods_details为数组,内容为核销单品信息,voucher_details为数组,内容为核销券信息。 |
provider_response.goods_details:
参数 | 参数名称 | 类型 | 必填 | 描述 | 范例 |
---|---|---|---|---|---|
goods_id | 商品编码 | String(32) | Y | 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成 | 商品编码 |
goods_remark | 商品备注 | String(128) | N | goods_remark为备注字段,按照配置原样返回,字段内容在微信后台配置券时进行设置。 | 1001 |
discount_amount | 商品优惠金额 | int | Y | 单品的总优惠金额,单位为:分 | 100 |
quantity | 商品数量 | int | Y | 用户购买的数量 | 1 |
price | 商品价格 | int | Y | 商品单价,单位为:分。 | 528800 |
provider_response.voucher_details:
参数 | 参数名称 | 类型 | 必填 | 描述 | 范例 |
---|---|---|---|---|---|
promotion_id | 券ID | String(32) | Y | 券或者立减优惠id | 109519 |
name | 优惠名称 | String(64) | N | 优惠名称 | 单品惠-6 |
scope | 优惠范围 | String(32) | N | GLOBAL- 全场代金券 SINGLE- 单品优惠 |
SINGLE |
type | 优惠类型 | String(32) | N | COUPON- 代金券,需要走结算资金的充值型代金券,(境外商户券币种与支付币种一致) DISCOUNT- 优惠券,不走结算资金的免充值型优惠券,(境外商户券币种与标价币种一致) |
DISCOUNT |
amount | 优惠券面额 | int | Y | 用户享受优惠的金额,单位为:分 | 5 |
activity_id | 活动ID | String(32) | Y | 在微信商户后台配置的批次ID | 931386 |
wxpay_contribute | 微信出资 | String(32) | N | 特指由微信支付商户平台创建的优惠,出资金额等于本项优惠总金额,单位为分 | 0 |
merchant_contribute | 商户出资 | String(32) | N | 特指商户自己创建的优惠,出资金额等于本项优惠总金额,单位为分 | 0 |
other_contribute | 其他出资 | String(32) | N | 其他出资方出资金额,单位为分 | 5 |
goods_detail | 单品列表 | [] | 否 | 单品信息,使用Json格式 | 见下文 |
provider_response.voucher_details.goods_detail:
参数 | 参数名称 | 类型 | 必填 | 描述 | 范例 |
---|---|---|---|---|---|
goods_id | 商品编码 | String(32) | Y | 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成 | 商品编码 |
goods_remark | 商品备注 | String(128) | N | goods_remark为备注字段,按照配置原样返回,字段内容在微信后台配置券时进行设置。 | 1001 |
discount_amount | 商品优惠金额 | int | Y | 单品的总优惠金额,单位为:分 | 100 |
quantity | 商品数量 | int | Y | 用户购买的数量 | 1 |
price | 商品价格 | int | Y | 商品单价,单位为:分。 | 528800 |
示例:
{
"result_code": "200",
"error_code": "",
"error_message": "",
"biz_response": {
"result_code": "PAY_SUCCESS",
"error_code": "",
"error_message": "",
"data": {
"sn": "7895200324716",
"client_sn": "61945351348716",
"client_tsn": "6194535183908716",
"trade_no": "4200001135340759748745388",
"finish_time": "1627443180613",
"channel_finish_time": "1627443180000",
"status": "SUCCESS",
"order_status": "PAID",
"payway": "3",
"payway_name": "微信",
"sub_payway": "1",
"payer_uid": "",
"payer_login": "oGFfks0Phw0IVsCm35Yu2c",
"total_amount": "600",
"net_amount": "600",
"settlement_amount": "200",
"subject": "Pizza",
"operator": "kay",
"provider_response": { //优惠详情
"goods_details": [
{
"goods_id": "1541791611", //String(32) 商品编码
"quantity": 1, //int 商品数量
"price": 500, //int 商品价格
"discount_amount": 200 //int 商品优惠金额
},
{
"goods_id": "1541791611",
"quantity": 1,
"price": 500,
"discount_amount": 200
}
],
"voucher_details": [
{
"promotion_id": "25496109591", //String(32) 券ID
"name": "单品券", //String(64) 优惠名称
"scope": "SINGLE",//String(32) 优惠范围
"type": "DISCOUNT", //String(32)优惠类型
"amount": 400, //int 优惠券面额
"activity_id": "15757412", //String(32)活动ID 在微信商户后台配置的批次ID
"wxpay_contribute": 0, //String(32)微信出资
"merchant_contribute": 400,//String(32)商户出资
"other_contribute": 0, //String(32) 其他出资
"goods_detail": [
{
"goods_id": "1541791611",
"quantity": 1,
"price": 500,
"discount_amount": 200
},
{
"goods_id": "1541791611",
"quantity": 1,
"price": 500,
"discount_amount": 200
}
]
}
]
},
"payment_list": [
{
"type": "BANKCARD_CREDIT",
"amount_total": "200",
"amount": "200"
},
{
"type": "DISCOUNT_CHANNEL_MCH",
"amount_total": "400",
"amount": "400"
}
]
}
}
}
支付宝支付优惠详情返回:
参数 | 参数名称 | 类型 | 必填 | 描述 | 范例 |
---|---|---|---|---|---|
provider_response | 优惠详情 | JSON | N | 格式为json,内容有两部分 goods_details为数组,内容为核销单品信息,voucher_details为数组,内容为核销券信息。 |
provider_response.goods_details:
参数 | 参数名称 | 类型 | 必填 | 描述 | 范例 |
---|---|---|---|---|---|
goods_id | 商品编码 | String | STANDARD3325 | ||
goods_name | 商品名称 | String | 会飞的猫 | ||
discount_amount | 商品优惠金额 | String | 单品的总优惠金额 单位为:元(下列金额类字段均以元为单位) |
100.00 | |
voucher_id | 券ID | String | Y | 202107213498543 | |
goods_num | 商品数量 | String | 2.0 |
provider_response.voucher_details:
参数 | 参数名称 | 类型 | 必填 | 描述 | 范例 |
---|---|---|---|---|---|
id | 券ID | String(32) | Y | 券或者立减优惠id | 202107213498543 |
name | 券名称 | String(64) | Y | 优惠券名称 | XX商城特价优惠 |
type | 券类型 | String(32) | Y | 如: ALIPAY_FIX_VOUCHER - 全场代金券 ALIPAY_DISCOUNT_VOUCHER - 折扣券 ALIPAY_ITEM_VOUCHER - 单品优惠券 ALIPAY_CASH_VOUCHER - 现金抵价券 ALIPAY_BIZ_VOUCHER - 商家全场券 注:不排除将来新增其他类型的可能,商家接入时注意兼容性避免硬编码 |
ALIPAY_FIX_VOUCHER |
amount | 优惠券面额 | Price(8) | Y | 优惠券面额,它应该会等于商家出资加上其他出资方出资 | 10.00 |
merchant_contribute | 商家出资 | Price(8) | N | 商家出资(特指发起交易的商家出资金额) | 9.00 |
other_contribute | 其他出资方出资金额 | Price(8) | N | 其他出资方出资金额,可能是支付宝,可能是品牌商,或者其他方,也可能是他们的一起出资 | 1.00 |
memo | 优惠券备注信息 | String(256) | N | 优惠券备注信息 | 学生专用优惠 |
template_id | 券模板id | String(64) | N | 券模板id | 2021072156321 |
purchase_buyer_contribute | Price(8) | N | 如果使用的这张券是用户购买的,则该字段代表用户在购买这张券时用户实际付款的金额 | 2.01 | |
purchase_merchant_contribute | Price(8) | N | 如果使用的这张券是用户购买的,则该字段代表用户在购买这张券时商户优惠的金额 | 1.03 | |
purchase_ant_contribute | Price(8) | N | 如果使用的这张券是用户购买的,则该字段代表用户在购买这张券时平台优惠的金额 | 0.82 |
示例:
{
"result_code": "200",
"error_code": "",
"error_message": "",
"biz_response": {
"result_code": "PAY_SUCCESS",
"error_code": "",
"error_message": "",
"data": {
"sn": "7895200395517",
"client_sn": "5668456701153",
"client_tsn": "5636068456701153",
"trade_no": "20210728259781450760007",
"finish_time": "1627454819123",
"channel_finish_time": "1627454819000",
"status": "SUCCESS",
"order_status": "PAID",
"payway": "1",
"payway_name": "支付宝",
"sub_payway": "1",
"payer_uid": "208863459784",
"payer_login": "101***@qq.com",
"total_amount": "1000",
"net_amount": "1000",
"settlement_amount": "700",
"subject": "Pizza",
"operator": "kay",
"provider_response": {
"goods_details": [
{
"goods_id": "1541791611", // 商品编码
"goods_name": "电脑", //商品名称
"discount_amount": "3.00", //商品优惠金额
"voucher_id": "2021072800073002785908WGPICH", //券id
"goods_num": "2.0" //商品数量
}
],
"voucher_details": [
{
"amount": "3.00", //Price(8) 优惠券面额
"id": "2021072800073002785908WGPICH", //String(32) 券id
"merchant_contribute": "3.00", //Price(8)商家出资
"name": "3.00元代金券", //String(64)券名称
"other_contribute": "0.00",//Price(8)其他出资方出资金额
"template_id": "20210728000730010234006F2YOI", //String(64)券模板id
"type": "ALIPAY_COMMON_ITEM_VOUCHER" //String(32) 券类型
}
]
},
"payment_list": [
{
"type": "DISCOUNT_CHANNEL_MCH",
"amount_total": "300",
"amount": "300"
},
{
"type": "ALIPAY_HUABEI",
"amount_total": "700",
"amount": "700"
}
]
}
}
}