平台扣模式# 商家不需要关注整个周期扣的生命周期,也不需要对接芝麻 GO 额外的接口,只需要关注每个生命节点的消息通知,根据消息类型触发相应的业务。 关键消息通知# 1.
签约成功通知: zhima.credit.pe.zmgo.sign.notify 。收到该通知并且 type=CYCLE_WITHHOLD 代表周期扣签约成功,该通知下会携带首期扣款信息。此时商家需要记录 userId + agreementId+bizType + withholdPlanNo 的关键初始化状态,可查看 开通成功通知 。 2.
扣款成功通知:zhima.credit.pe.zmgo.settle.notify。收到该通知并且withhold_biz_type=ZMGO_CYCLE_WITHHOLD_DEDUCT 代表周期扣扣款消息通知,并且 trans_status=Y 代表周期扣扣款成功,该通知会携带本期扣款信息以及下期扣款信息, 此时需要根据本期扣款单号变更上一期的扣款信息,并记录下一期的扣款信息,且发送本期权益,可查看 代扣结果通知 。 3.
协议变更通知:zhima.credit.pe.zmgo.agreement.changed。收到该通知需要判断 agreement_status,状态Y 代表签约成功,P 代表用户退出处于结算中,N 代表协议到达终态,商家根据各自业务处理不同状态下的业务,可查看 协议变更通知 。 4.
结算成功通知:zhima.credit.pe.zmgo.settle.notify。收到该通知并且withhold_biz_type=ZMGO_MEMBERSHIP_FEE 代表结算消息通知,并且 trans_status=Y 代表结算成功,此时协议到达终态,可查看 芝麻 GO 结算 。 交互概览# 商户扣模式# 商家自行关注控制整个周期扣的生命周期,在规定时间内发起扣款、发起结算、发起退出即可。 关键消息通知# 1.
签约成功通知: zhima.credit.pe.zmgo.sign.notify 。收到该通知并且type=CYCLE_WITHHOLD 代表周期扣签约成功,该通知下会携带首期扣款信息,此时商家需要记录 userId + agreementId+bizType + withholdPlanNo 的关键初始化状态。收到该通知在 planned_trigger_time~time_out_time 范围内发起扣款申请,可查看 开通成功通知 。 2.
扣款成功通知:zhima.credit.pe.zmgo.settle.notify。收到该通知并且withhold_biz_type=ZMGO_CYCLE_WITHHOLD_DEDUCT 代表周期扣扣款消息通知,并且 trans_status=Y代表周期扣扣款成功,该通知会携带本期扣款信息以及下期扣款信息, 此时需要根据本期扣款单号变更上一期的扣款信息,并记录下一期的扣款信息,且发送本期权益。到了下一期的计划扣款时间:planned_trigger_time 即可发起扣款申请,可查看 代扣结果通知 。 3.
协议变更通知:zhima.credit.pe.zmgo.agreement.changed。收到该通知需要判断 agreement_status,状态Y 代表签约成功,P 代表用户退出处于结算中,N 代表协议到达终态,商家根据各自业务处理不同状态下的业务,商户扣的模式下如果 agreement_status=p,代表用户退出,此时需要根据 withhold_plan_no 发起结算 申请,可查看 协议变更通知 。 4.
结算成功通知:zhima.credit.pe.zmgo.settle.notify。收到该通知并且withhold_biz_type=ZMGO_MEMBERSHIP_FEE 代表结算消息通知,并且 trans_status=Y 代表结算成功,此时代表终结了周期扣协议,代表生命周期走到终态,可查看 芝麻 GO 结算 。 关键接口调用# 1.
发起扣款 API:zhima.credit.pe.zmgo.settle.apply。必须在planned_trigger_time~time_out_time 范围内,发起扣款申请,实时返回的成功,仅代表扣款申请成功,并不代表扣款成功,需要等到上方扣款成功通知才是真正扣款成功,商家可自行发放权益,可查看 发起结算 。 2.
优惠查询 API:zhima.merchant.zmgo.cumulate.query。发起结算的申请的时候需要填入: total_real_pay_amount、total_discount_amount、total_task_count。如果商家不想存,可以通过该 API 进行查询再回填,可查看 API 列表 。 3.
退出协议 API:zhima.credit.pe.zmgo.agreement.unsign。用户在商家端退出,调用该 API 即可进行退出处理,返回成功仅代表用户处于退出中,只有等到结算成功通知才代表用户真正结算成功退出,可查看 关闭芝麻 GO 。 交互概览# 修改于 2023-11-23 03:26:43