商家芝麻GO累计数据回传接口

外部商家接入芝麻GO场景下，回传用户行为履约数据给芝麻。

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/zhima/merchant/zmgo/cumulate/sync' \ --header 'Content-Type: application/json' \ --data-raw '{ "amount_type_sync_data": { "discount_amount": "8.75", "discount_desc": "消费满减优惠001", "has_alipay_trade": false, "task_amount": "3.57", "task_desc": "完成一次任务001", "trade_no": "2020081722001435461000061785" }, "discount_type_sync_data": { "discount_amount": "8.75", "discount_desc": "消费满减优惠001" }, "times_type_sync_data": { "discount_amount": "8.75", "discount_desc": "消费满减优惠001", "task_amount": "3.57", "task_desc": "完成一次任务001", "task_times": 1 }, "agreement_id": "20195108518085620000", "biz_action": "POSITIVE", "data_type": "TASK", "open_id": "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5", "out_biz_no": "2020081211223006150094012926289", "provider_pid": "2088621805983504", "refer_out_biz_no": "2020081211223006150094012926289", "sub_biz_action": "ADD", "user_id": "2088602002015001", "biz_time": {} }'

请求参数

Body 参数application/json

amount_type_sync_data

object (AmountTypeSyncData)

可选

discount_amount

string

可选

商户回传的优惠金额，如用户享受的红包金额，单位元

示例值:

8.75

discount_desc

string

可选

商户数据回传的优惠信息的名称。

示例值:

消费满减优惠001

has_alipay_trade

boolean

可选

是否为支付宝交易，默认false，表示是否要做支付宝交易关联。此时tradeNo必须传支付宝交易号。

示例值:

false

task_amount

string

可选

用户和商户发生交易的交易单金额，单位元。

示例值:

3.57

task_desc

string

任务描述

可选

示例值:

完成一次任务001

trade_no

string

可选

用户和商户发生金额类交易的交易单号。

示例值:

2020081722001435461000061785

discount_type_sync_data

object (DiscountTypeSyncData)

可选

discount_amount

string

可选

商户回传的优惠金额，如用户享受的红包金额，单位元

示例值:

8.75

discount_desc

string

可选

商户数据回传的优惠信息的名称。

示例值:

消费满减优惠001

times_type_sync_data

object (TimesTypeSyncData)

可选

discount_amount

string

可选

商户回传的优惠金额，如用户享受的红包金额，单位元

示例值:

8.75

discount_desc

string

可选

商户数据回传的优惠信息的名称。

示例值:

消费满减优惠001

task_amount

string

可选

用户和商户发生交易的交易单金额，单位元。

示例值:

3.57

task_desc

string

任务描述

可选

示例值:

完成一次任务001

task_times

integer

可选

当为次数型任务时必须传。

示例值:

agreement_id

string

可选

芝麻go协议号，唯一标识一个芝麻go协议。

示例值:

20195108518085620000

biz_action

string

可选

数据回传的动作类型。枚举如下： * POSITIVE：正向回传，即订单金额累加，优惠累加，任务次数累加。 * REVERSE：逆向回传，即订单金额退款，优惠退款，任务次数回退。

示例值:

POSITIVE

data_type

string

可选

回传数据类型，枚举： TASK - 进度型，影响进度 DISCOUNT - 优惠型

示例值:

TASK

open_id

string

可选

用户 id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。

示例值:

074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5

out_biz_no

string

可选

外部业务号，唯一标识一笔回传数据。

示例值:

2020081211223006150094012926289

provider_pid

string

可选

数据回传的商户 ID，即和用户发生业务来往的 PID 主体。商户账号在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。

示例值:

2088621805983504

refer_out_biz_no

string

可选

逆向对应的正向外部业务号。逆向场景为必传入参。也就是biz_action为REVERSE时为必传入参。逆向时需通过此字段明确对应的正向的外部业务号。

示例值:

2020081211223006150094012926289

sub_biz_action

string

可选

数据回传动作子类型，枚举值，为必传入参。 ADD - 新增数据 UPDATE - 修改数据备注：UPDATE只能更新金额信息。

示例值:

ADD

user_id

string

可选

用户 id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。

示例值:

2088602002015001

biz_time

string

可选

回传数据发生的实际时间，包括：订单交易时间，优惠核销时间，以及任务完成时间。为必传入参。如：用户在【2019-03-08 00:00:00】核销了一个红包，但是【2019-03-10 00:00:00】才进行数据回传，此时biz_time取值红包核销的时间，也就是【2019-03-08 00:00:00】。

示例值:

{}

示例

返回响应

🟢200common response

application/json

Body

agreement_id

string

可选

芝麻go协议号，唯一标识一个芝麻go协议。

示例值:

20195108518085620000

fail_reason

string

可选

数据回传失败原因描述

示例值:

协议已经失效

out_biz_no

string

可选

外部业务号，唯一标识一笔回传数据。

示例值:

2020081211223006150094012926289

🔴500请求失败