通知相关


3. 10通知相关

通知具有自动重发机制,接口幂等需由对接方保证。

以下是通知重发机制:

5.1券核销通知

卡券(实体卡、满减券、金额券、计次券)核销时的数据通知

业务请求参数

method: allinpay.shopoint.couponService.checkNotify

字段名

参数类型

必填

最大长度

说明

取值

changeId

Integer

是

 

核销记录编号

 

couponId

Integer

是

 

券编号

 

couponNo

String

是

 

券号

 

orderId

Integer

否

 

核销内部订单号

 

templateId

Integer

是

 

券模板编号

 

consumeAmount

String

是

 

核销金额

单位为分

orderNo

String

否

 

交易单号

 

tranNo

String

否

 

交易流水号

 

tranDateTime

String

是

 

核销交易时间

格式: yyyyMMddHHmmss

unit

String

否

 

单位, 计次券使用

 

couponName

String

是

 

券名称

 

shopName

String

否

 

店铺名称

 

cardNo

String

否

 

会员卡号

 

publicOpenId

String

否

 

机构公众号OPENID

 

promotionId

Integer

否

 

活动ID

 

mobile

String

否

 

微信手机号

 

shopId

Integer

否

 

核券店铺ID

 

shopCode

String

否

 

店铺号

 

orgId

Integer

否

 

机构ID

 

orgName

String

否

 

机构名称

 

customerId

Integer

否

 

数字营销会员ID

 

createUserId

Integer

否

 

核销人登录账号

 

createUserSysno

Integer

否

 

核销人ID

 

createUserName

String

否

 

核销人姓名

 

outOrderId

String

否

 

核销外部订单号

 

financeList

 

List

否

 

财务科目列表

 

accountNo

String

是

 

财务科目号

 

accountTitle

String

是

 

财务科目名称

 

accountPriority

Integer

否

 

财务科目优先级

数字越小,优先级越高

 

String

是

 

科目值

5.2

 

5.2会员注册/修改通知

  会员注册或信息修改时的数据通知(无重试机制,仅通知一次)

业务请求参数

method: allinpay.shopoint.customerService.registerNotify(注册),

allinpay.shopoint.customerService.modifyNotify(修改)

字段名

参数类型

必填

最大长度

说明

取值

customerId

Integer

是

 

会员ID

 

mobile

String

是

 

手机号

 

cardNo

String

否

 

会员卡号

 

memberLevelId

Integer

是

 

会员等级

 

openid

String

否

 

微信openid

 

name

String

否

 

姓名

 

gender

String

否

 

性别

 

nickName

String

否

 

昵称

 

birthday

String

否

 

生日

 

carLicenseNo

String

否

 

车牌号

 

refereeSysno

Integer

否

 

推荐人ID

 

referee

String

否

 

推荐人

 

registerMethod

Integer

是

 

来源方式

1-顾客注册,2-POS注册,3数据导入,4-发会员卡,5-接口导入

registerFrom

String

是

 

注册来源

 

unionId

String

否

 

会员唯一ID

 

 

5.3订单支付通知

  订单支付成功后的数据通知

业务请求参数

method: allinpay.shopoint.orderService.notify

字段名

参数类型

必填

最大长度

说明

取值

reqTransCode

String

否

 

外部订单号

ISV订单号

 

orderCode

String

是

 

订单号

 

amount

Integer

是

 

订单原始金额

单位分

noDiscountAmount

Integer

是

 

不参与优惠抵扣金额

单位分

discountAmount

Integer

是

 

商户活动优惠金额

单位分

couponAmount

Integer

是

 

商户卡券抵扣金额

单位分

balanceAmount

Integer

是

 

钱包消费金额

单位分

scoreAmount

Integer

是

 

积分抵扣金额

单位分

subsidyAmount

Integer

是

 

银行活动优惠金额

单位分

giveAmount

Integer

是

 

赠送金额

单位分

paymentMethod

String

是

 

支付方式

银行卡、微信、支付宝、云闪付、现金、全抵扣

paymentAmount

Integer

是

 

支付金额

单位分

transType

Integer

是

 

交易类型

1-消费,2-撤销,3-退款,4-充值

transTime

String

是

 

交易时间

格式:yyyy-MM-dd HH:mm:ss

shopId

Integer

是

 

店铺ID

 

shopCode

String

否

 

店铺编号

 

shopName

String

是

 

店铺名称

 

customerId

Integer

否

 

顾客ID

 

trxId

String

否

 

收银宝支付流水号

 

openId

String

否

 

机构公众号openId

 

remark

String

否

 

备注

 

orderItemList

 

ArrayList

 

 

否

 

 

 

itemType

 

Integer

否

 

订单明细类别

1、实体商品;2、虚拟商品;3、充值

skuId

 

Integer

否

 

货品ID

 

salePrice

 

Integer

否

 

销售价

单位分

nums

 

Integer

否

 

购买数量

 

amount

 

Integer

否

 

总金额

单位分

score

 

Integer

否

 

积分价

积分数

shareId

 

Integer

否

 

分享ID

 

guideId

 

Integer

否

 

导购ID

 

refereeCustomerId

 

Integer

否

 

推荐会员ID

 

skuInfoList

ArrayList

 

否

 

 

 

 

templateId

Integer

否

 

券模板ID

 

 

templateName

String

否

 

券模板名称

 

 

num

Integer

否

 

张数

 

 

5.4券核销撤销通知

卡券(实体卡、满减券、金额券、计次券)撤销核销时的数据通知

业务请求参数

method: allinpay.shopoint.couponService.cancelNotify

字段名

参数类型

必填

最大长度

说明

取值

changeId

Integer

是

 

核销记录编号

 

couponId

Integer

是

 

券编号

 

couponNo

String

是

 

券号

 

templateId

Integer

是

 

券模板编号

 

refundAmount

String

是

 

撤销金额

单位为分

tranDateTime

String

是

 

撤销交易时间

格式: yyyyMMddHHmmss

unit

String

否

 

单位, 计次券使用

 

couponName

String

是

 

券名称

 

shopId

Integer

否

 

核券店铺ID

 

shopCode

String

否

 

店铺号

 

shopName

String

否

 

核销店铺名称

 

orderId

Integer

否

 

核销时内部订单号

 

cardNo

String

否

 

会员卡号

 

publicOpenId

String

否

 

机构公众号OPENID

 

mobile

String

否

 

手机号

 

orgId

Integer

否

 

机构ID

 

orgName

String

否

 

机构名称

 

customerId

Integer

否

 

数字营销会员ID

 

createUserId

Integer

否

 

核销人登录账号

 

createUserSysno

Integer

否

 

核销人ID

 

createUserName

String

否

 

核销人姓名

 

outOrderId

String

否

 

核销外部订单号

 

 

 

5.5跨机构订单支付通知

  当前对接方(通惠机构)的合作机构的订单支付成功时的数据通知

业务请求参数

method: allinpay.shopoint.orderService.partnerNotify

字段名

参数类型

必填

最大长度

说明

取值

orderCode

String

是

 

订单号

 

finishTime

String

是

 

订单完成时间

格式:yyyy-MM-dd HH:mm:ss

customerMobile

String

是

 

用户手机号

 

openId

String

否

 

微信openid

 

mchtCd

String

否

 

商户号

 

mchtName

String

是

 

商户名称

 

qrCodeBoardNo

String

否

 

码牌编号

 

amount

Integer

是

 

订单原始金额

单位分

useScore

Integer

是

 

使用积分数

 

paymentAmount

Integer

是

 

实际支付金额

单位分

paymentMethod

Integer

是

 

支付方式

0-微信,1-支付宝,2-手机QQ,3-银联,99-其他

tradeType

Integer

是

 

交易类型

1-消费,2-退款

 

5.6微信核销通知转发

  微信券核销通知(透传)转发(无重试机制,仅通知一次)

业务请求参数

method: allinpay.shopoint.couponService.wechatCheckNotify

参考https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_1_15.shtml中的核销券通知参数

5.7发券通知

  发券时的数据通知

业务请求参数

method: allinpay.shopoint.couponService.sendNotify

字段名

参数类型

必填

最大长度

说明

取值

customerId

Integer

否

 

领券人ID

 

promotionId

Integer

否

 

活动ID

 

promotionName

String

否

 

活动名称

 

guideUserId

Integer

否

 

导购编号

 

openId

String

否

 

领券人OpenId

 

mobile

String

否

 

领券人手机号

 

externalCode

String

否

 

领券人外部编号

 

num

Integer

否

 

发券数量

 

type

  Integer

   否

 

发券类型

1券发放 2券变更 3券核销

scene

  Integer

   否

 

发券场景

19顾客领通联券

27 顾客领系统用户发的通联券

20 顾客购买通联券

28 顾客积分购买通联券

24顾客领订单返的通联券

29 顾客领微信券

33 顾客使用积分购买微信券

1系统用户激活通联券

3系统用户激活微信券

8 系统用户冻结通联券

35系统用户核销通联券

couponList

 

ArrayList

 

否

 

 

 

couponNo

String

否

 

通联券券号

 

outOrderId

String

否

 

外部订单号

 

couponType

Integer

否

 

券类型

0金额券1代金券2计次券3满减券

initAmount

Integer

否

 

初始金额、次数

单位:分/次

templateId

Integer

否

 

通联券券模板ID

 

wechatCouponId

String

否

 

微信券券号

微信开放平台发券券号

wechatStockId

String

否

 

微信发券批次号

 

createTime

String

否

 

发券时间

格式:yyyy-MM-dd HH:mm:ss

 

5.8卡券充值通知

  卡券(实体卡、满减券、金额券、计次券)充值时的数据通知

业务请求参数

method: allinpay.shopoint.couponRecharge.notify

字段名

参数类型

必填

最大长度

说明

取值

auditId

Integer

是

 

充值审核ID

 

auditStatus

Integer

是

 

返回码,审核状态

1 已通过 2已拒绝

scope

Integer

否

 

充值类型

1 充值 2调账

rechargeDetailList

 

ArrayList

 

否

 

 

 

couponNo

String

是

 

实体卡卡号

 

couponType

Integer

否

 

券类型

0金额券2计次券

value

Integer

否

 

充值数量

计次券单位为次,金额券为分

oldBalance

Integer

否

 

充值前金额

计次券单位为次,金额券为分

balance

Integer

否

 

充值后金额

计次券单位为次,金额券为分

validityBeginDate

String

否

 

有效期起始日期

格式:yyyy-MM-dd HH:mm:ss

validityEndDate

String

否

 

validityEndDate

格式:yyyy-MM-dd HH:mm:ss

 

mobile

String

否

 

手机号

 

 

rechargeStatus

Integer

否

 

处理状态

1处理成功

2处理失败

3审核拒绝

 

failDesc

String

否

 

失败原因

 

 

createTime

String

是

 

充值时间

格式:yyyy-MM-dd HH:mm:ss

 

requestUserName

String

否

 

操作员

 

 

auditUserName

String

否

 

审批员

 

5.9支付宝核销通知转发

  支付宝券核销数据(透传)转发(无重试机制,仅通知一次)

业务请求参数

method: allinpay.shopoint.couponService.alipayCheckNotify

参考支付宝文档

 

5.10 卡券变动通知

所有卡券(实体卡、满减券、金额券、计次券)的发放、充值、调账、发放撤销、消费撤销等涉及账户变动、状态变动动作发生时的数据通知

业务请求参数

method: allinpay.shopoint.couponService.changeNotify

字段名

参数类型

必填

最大长度

说明

取值

orgId

Integer

是

8

机构号

 

cardNo

String

是

 

实体卡号

 

couponType

Integer

是

 

是否会员卡

5-会员卡

couponNo

String

是

20

券号

 

validityBeginDate

String

是

 

有效开始时间

格式:yyyy-MM-dd HH:mm:ss

validityEndDate

String

是

 

有效结束时间

格式:yyyy-MM-dd HH:mm:ss

balance

Integer

是

 

卡余额

单位为分

status

Integer

是

 

状态

0-正常

customerMobile

String

否

 

会员手机号

 

customerName

String

否

 

会员姓名

 

notifyId

String

是

64

通知唯一ID,重复通知不变

 

 

5.11 实体卡入库通知

实体卡入库时的数据通知

业务请求参数

method: allinpay.shopoint.cardService.storeNotify

字段名

参数类型

必填

最大长度

说明

取值

orgId

Integer

是

8

机构号

 

initAmount

Integer

是

 

面额

单位为分

inCount

Integer

是

 

数量

 

validityBeginDate

String

是

 

有效开始时间

格式:yyyy-MM-dd HH:mm:ss

validityEndDate

String

是

 

有效结束时间

格式:yyyy-MM-dd HH:mm:ss

beginNo

String

是

 

起始卡号

 

endNo

String

是

 

终止卡号

 

cardNoList

List<String>

是

 

卡号列表

 

notifyId

String

是

64

通知唯一ID,重复通知不变

 

couponType

Integer

是

 

是否会员卡

5-会员卡

 

5.12 ISV收银台前端跳转

该接口属于页面跳转。支付成功后,ISV收银台页面跳转回ISV调用方

跳转目的地址为:3.5.15 ISV收银台接口 中传入的returnUrl参数

业务请求参数

method: allinpay.shopoint.orderService.isvReturn

字段名

参数类型

必填

最大长度

说明

取值

reqTransCode

String

否

 

ISV订单号

 

amount

Integer

是  

 

订单原始金额

单位:分

5.13顾客注册/修改通知

  顾客注册或信息修改时的数据通知

业务请求参数

method: allinpay.shopoint.customerService.register (注册),

allinpay.shopoint.customerService.modify (修改)

字段名

参数类型

必填

最大长度

说明

取值

customerId

Integer

是

 

会员ID

 

mobile

String

否

 

手机号

 

cardNo

String

否

 

会员卡号

 

memberLevelId

Integer

否

 

会员等级

 

openid

String

否

 

微信openid

 

name

String

否

 

姓名

 

gender

String

否

 

性别

 

nickName

String

否

 

昵称

 

birthday

String

否

 

生日

 

carLicenseNo

String

否

 

车牌号

 

refereeSysno

Integer

否

 

推荐人ID

 

referee

String

否

 

推荐人

 

registerMethod

Integer

是

 

来源方式

1-顾客注册,2-POS注册,3数据导入,4-发会员卡,5-接口导入

registerFrom

String

是

 

注册来源

 

unionId

String

否

 

会员唯一ID

 

externalCode

String

否

 

外部顾客编号

 

5.14一键绑卡签约结果通知

  签约完成后向商户通知签约的信息。

业务请求参数

method: allinpay.shopoint.memberService.agreementApplyOnlineNotify

字段名

参数类型

必填

最大长度

说明

取值

reqOrderNo

String

是

64

申请流水号

 

trxStatus

String

是

4

签约状态

0000-签约成功,3开头错误码表示签约失败

errMsg

String

否

200

响应消息

 

requestId

String

否

10

签约协议ID

 

bankCode

String

否

16

银行代码

 

bankName

String

否

100

银行名称

 

accountNo

String

否

32

银行卡号

 

mobile

String

否

11

手机号

 

accountType

String

否

2

卡类型

00-借记卡,02-信用卡

idNo

String

否

18

证件号

 

5.15提现结果通知

  提现完成后向商户通知提现结果的信息。

业务请求参数

method: allinpay.shopoint.fundService.withdrawNotify

字段名

参数类型

必填

最大长度

说明

取值

orderId

String

否

 

订单号

 

accountUserId

Integer

是

 

账户Id

 

 

accountSetNo

Integer

是

 

账户集编号

100001,余额户

2000000,营销户

referenceType

Integer

是

 

账户来源

11,大B

13,店铺

49,外部分佣方

referenceId

Integer

否

 

账户来源Id

账户来源为大B时,机构Id

账户来源为店铺时,店铺Id

账户来源为外部分佣方时,null

externalCode

String

否

 

店铺编号或者外部分佣方编号

 

shopName

String

否

 

店铺名称

 

accountName

String

是

 

账户名称

 

withdrawTId

Integer

否

 

 

通联返回的提现交易流水号

withdrawAmount

BigDecimal

是

 

提现金额

实际到账金额

fee

BigDecimal

是

 

手续费

提现手续费

summary

String

否

 

摘要

大B为结算通时,长度为100;

大B为其他类型时,长度为50

withdrawStatus

Integer

是

 

提现状态

2,交易成功

3,提现失败

withdrawStatusDesc

String

是

 

提现状态描述

2,交易成功

3,提现失败原因

           
           
           
           
           
           
           
           
           
           
           
           
           
           

5.16资金管理小b开通通知

  小b开通审核通过后向商户通知小b信息。

业务请求参数

method: allinpay.shopoint.fundService.userAuditNotify

字段名

参数类型

必填

最大长度

说明

取值

accountUserId

Integer

是

 

账户Id

 

 

referenceType

Integer

是

 

账户来源

13,店铺

49,外部分佣方

referenceId

Integer

否

 

账户来源Id

账户来源为店铺时,店铺Id

账户来源为外部分佣方时,null

enabled

Boolean

是

 

账户启停状态

 

externalCode

String

否

 

店铺编号或者外部分佣方编号

 

shopName

String

否

 

店铺名称

 

accountType

Integer

是

 

账户类型

0,个人

1,企业

2,个体工商户

accountName

String

是

 

账户名称

 

withdrawType

Integer

是

 

提现方式

0,不提现

1,自动提现

2,手动提现

termType

Integer

是

 

结算类型

1,按自然日

2,按工作日

3,按自然月

termValue

Integer

是

 

结算类型的值

1,结算termValue个自然日之前的交易

2,结算termValue个工作日之前的交易

3,每月在termValue这天,结算前一个自然月及之前的交易

 

 


2025年11月19日 14:49 收藏文档