数字营销
标准API开放接口规范
1.文档说明
2.接口规则
3.标准接口定义
会员营销
3.1.1会员账户信息查询
3.1.2会员充值
3.1.13第三方优惠试算
3.1.5会员注册
3.1.6统一登录注册
3.1.7会员商户优惠试算
3.1.10会员基本信息查询
3.1.16会员绑储值卡
3.1.17会员实名
3.1.18会员充值查询
3.1.21会员绑定实体卡(开卡)
3.1.22会员卡密码修改
3.1.23会员调账
3.1.24会员调账查询
3.1.25会员状态变更
3.1.26发送短信验证码
3.1.28会员消费查询
3.1.29会员消费撤销
3.1.30会员消费撤销查询
3.1.31会员无密码消费
3.1.32会员消费
3.1.34会员信息更新
3.1.35会员账户流水
3.1.37 获取用户基本信息(OAuth2)
3.1.38 获取基础营销授权链接
3.3.1 H5页面调用绑定微信和手机号(GET)
3.3.2 H5页面调用绑定微信和外部顾客编号(GET)
卡券营销
3.2.1卡/券查询
3.2.2发卡/券
3.2.4卡/券作废
3.2.5卡/券核券撤销
3.2.7发卡/券(套券)
3.2.8发卡/券查询
3.2.9作废优惠券发券
3.2.10储值卡充值
3.2.11储值卡充值查询
3.2.12实体储值卡激活(单张)
3.2.13可发卡/券列表查询(套)
3.2.14卡/券批量查询
3.2.15卡/券鉴权
3.2.16卡/券动态二维码生成
3.2.17卡/券转赠
3.2.18卡/券发放查询
3.2.19卡/券核销查询
3.2.20卡/券核销撤销查询
3.2.21卡/券模板详情查询
3.2.22 卡/券交易流水查询
3.2.23储值卡调账
3.2.24储值卡调账查询
3.2.25 卡/券交易流水分页查询
3.2.26 作废卡/券发放
3.2.27卡/券核销
3.2.33卡/券动账流水
3.2.35券号查询该顾客同券模板下的券号列表
3.2.36卡/券冻结
3.2.45卡券延期
外部平台券
3.2.28第三方核券准备接口
3.2.29第三方核券接口
3.2.30第三方核券流水查询接口
3.2.31第三方撤销核券接口
3.2.32第三方券码查询接口
3.2.34第三方门店验券历史接口
3.2.35券号查询该顾客同券模板下的券号列表
3.2.38美团到店综合预约数据
3.2.39美团到店综合消费数据
3.2.40美团到店综合团单消费详情数据
3.2.41美团到店综合门店流量数据
3.2.42美团餐饮门店套餐映射
3.2.43美团到店综合门店商品信息
3.2.44抖音商品线上数据
3.2.46抖音综合提现记录查询
3.2.47抖音综合账单详情查询
3.2.48抖音订单查询
3.2.49抖音账单详细查询
3.2.50抖音券状态批量查询
订单同步
3.5.1外部订单同步
3.5.2外部订单查询
3.5.3外部订单同步撤销
3.5.17外部订单核销
3.5.18外部订单查询
3.5.19外部订单撤销
订单支付
3.5.9订单查询
3.5.10订单退款
3.5.11退款订单查询
3.5.12统一扫码
3.5.13终端信息采集
3.5.14统一支付
3.5.15 ISV收银台
3.5.16生成订单
3.5.20终端信息查询
3.5.23分账确认
3.5.24分账确认结果查询
7.1终端信息字段说明
7.2 splitList字段说明
账户类
3.9.1 资金管理余额查询
3.9.3 资金管理提现
3.9.4 资金管理提现结果查询
3.9.5 资金管理账户批量导入
3.9.6 资金管理账户查询
通知相关
3.10通知相关
5.1券核销通知
5.2会员注册/修改通知
5.3订单支付通知
5.4券核销撤销通知
5.5跨机构订单支付通知
5.6微信核销通知转发
5.7发券通知
5.8卡券充值通知
5.9支付宝核销通知转发
5.10 卡券变动通知
5.11 实体卡入库通知
5.13顾客注册/修改通知
5.15提现结果通知
5.16资金管理小b开通通知
对账文件
6.1对账文件
6.2 分账对账流水文件下载
6.3 对账流水文件下载
机构管理类
3.8.1外部门店信息同步
3.8.2 创建/修改机构用户
3.8.3 查询机构用户信息
3.8.4 机构统计信息查询
附录
7.1终端信息字段说明
7.2 splitList字段说明
7.3 店铺经营类型枚举
7.6 支付方式说明
7.7 paytypeinfo-支付方式参数说明
7.9渠道交易类型(trxCode)
7.10交易返回码(trxStatus)
7.11扩展参数说明
4.1 公共返回码(code)
4.开发参考
4.1 SDK参考概述
4.2 Java SDK
4.3 Python SDK
4.4 PHP SDK
4.5 GO SDK
4.6 C# SDK
一码付开放接口规范
1.接口说明
2.接口规则
3.标准API
3.1统一扫码
3.2统一撤销
3.3统一退款
3.4统一查询
3.5交易结果通知
3.6订单生成
3.7终端信息采集报备
3.8统一支付
3.9资金管理余额查询
3.10资金管理提现
3.11资金管理提现结果查询
3.12资金管理转账
3.13资金管理转账结果查询
3.14终端信息查询
3.15订单关闭
3.16ISV收银台
3.17ISV前端跳转
3.18对账流水文件下载
3.19根据授权码(付款码)获取用户ID
3.20资金管理提现通知
3.21分账/收款确认
3.22分账/收款确认结果查询
3.23资金管理转账通知
3.24资金管理批量转账
3.25资金管理批量转账结果查询
3.26B2B订单支付收款
3.27B2B订单支付付款
3.31代付
3.32代付订单查询
3.33资金管理交易文件查询
3.34收支明细查询
3.35交易列表查询
4.附录
4.1 接口返回码retcode说明
4.2 交易返回码trxstatus说明
4.3 交易类型
4.4 支付渠道优惠信息填写规范(benefitdetail字段)
4.5 拓展参数说明(extendparams)
4.6 终端信息字段说明
4.7 asinfo字段说明
4.8 交易方式
4.9 splitlist字段说明
4.10支付方式
4.11paytypeinfo-支付方式参数说明
4.12民生/平安银行转账子账簿信息
5.13微信订单支付(小程序资金管控)接入说明
5.开发参考
5.1 SDK参考概述
5.2 Java SDK
5.3 C# SDK
5.4 PHP SDK
5.5 GO SDK
5.6 C SDK
5.6.1 安装指南
5.6.2 使用示例
通惠API开放接口规范
1. 文档说明
2. 接口规则
3.标准接口定义
3.1会员信息类
3.3页面调用类
3.4 银行活动类
3.7 互动营销类
3.8 机构管理类
4.公共返回码
5.通知相关
6.对账文件类
7.开发参考
8.接口权限申请表下载
9.常见问题合集
通联核心产品文档中心
-
+
3.2.2发卡/券
### 3.2.2 优惠券发券 产生优惠券。 **method:** allinpay.shopoint.couponService.couponSend **version:** 1.0 **业务请求参数** | 字段名 | 参数类型 | 必填 | 最大长度 | 说明 | 取值 | | --- | --- | --- | --- | --- | --- | | shopId | String | 否 | | 店铺ID | | | shopCode | String | 否 | | 店铺号 | 与shopId功能相同,shopId和shopCode同时输入则只取shopId,shopId和shopCode必输一项 | | operUserId | String | 是 | | 收银员id | 收银员登录名称 | | couponType | String | 是 | | 券类型 | 1-电子券<br>2-纸质券 | | num | String | 是 | | 发券数量 | 正整数 | | couponTemplateId | String | 是 | | 券模板Id | | | idType | String | 否 | | 接受券的会员账号类型 | 1-手机号<br>2-会员卡号<br>3-Openid<br>5-外部ID | | memberId | String | 否 | | 接受券的会员账号 | idType存在时必填 Openid不能被查询到时,将新建对应的用户 | | orderId | String | 是 | | 外部发券订单号 | | | sourceType | String | 否 | | 来源类型 | 1-手机号<br>2-Openid<br>3-导购ID<br>4-用户ID | | sourceValue | String | 否 | | 来源值 来源类型(sourceType)存在时必填 | | | remark | String | 否 | | 备注信息 | | | extendInfo | JSON | 否 | | 自定义扩展信息 | 如: extendInfo: {"buyerType":"个人","buyerIdNo":"51*****217","buyerContact":"189***25", } | | buyerMobile | String | 否 | | 购卡人手机号 | 多用途金额券或者实体卡为记名卡或者批次金额超过10000元时必填 需先调用会员实名接口 | **业务响应参数** | 字段名 | 参数类型 | 必填 | 最大长度 | 说明 | 取值 | | --- | --- | --- | --- | --- | --- | | code | Integer | 是 | | 返回码 | 0-表示成功<br>3-表示失败,具体失败原因参见msg字段<br>其他:参见4.1 公共返回码 | | msg | String | 是 | | 错误信息 | | | data.tranNo | String | 是 | | 流水号 | | | data.shopName | String | 是 | | 店铺名称 | | | data.tranDateTime | String | 是 | | 交易时间 | | | data.instruction | String | 否 | | 券使用须知 | | | data.list | ArrayList | | | 是 | 交易券明细 | | data.list[].templateId | Integer | 是 | | 模板ID | | | data.list[].couponName | String | 是 | | 券名称 | | | data.list[].couponNo | String | 否 | | 券号 | 发券对象,或纸质券时有效 | | data.list[].qrCodeContext | String | 否 | | 电子券二维码 | 无发券对象,且电子券时有效 | **请求示例** ```json {"shopId":"1","operUserId":"1","couponType":"1","num":"10","couponTemplateId":"307"} ``` **响应示例** ```json { "code": 0 , "data": { "tranNo":"50806050005080208145", "shopName": null , "tranDateTime": [ 2020 , 4 , 10 , 16 , 3 , 4 9 ], "list": [ { "templateId": 307 , "couponName":"专门测试ZHT", "couponNo": null , "qrCodeContext":"https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=gQF48DwAAAAAAAAAAS5odHRwOi8vd2VpeGluLnFxLmNvbS9xLzAyNDdIQUo1VEw5X1AxeFJTZ051Y0IAAgRlKJBeAwQQDgAA" } ] }, "sign":"VCpfqwnJGQvV5c3esmz5OpylgfIE6gGqtl3gS/Lrjz4dFt3icgeDA4yjZ9ZO+qJbGH85djwWp6EtTPPE/LRgI2TjWgiyuyR4FdJ7lM4ze/VwcAKxxWVj0OayjXLJblHxTtUNNjfzjH0ndnldQO7gigpvOfgMoampnbOq65SC+3o=" } ``` **部分响应失败枚举** | code | msg | | --- | --- | |1001|shopCode错误| |1001|shopId(或shopCode)未传递| |1001|operUserId未传递| |1001|couponType未传递| |1001|券类型错误| |1001|num未传递| |1001|couponTemplateId未传递或不是正整数| |1001|会员账户类型错误| |1001|memberId未传递| |1001|来源类型错误| |1001|来源值未传递| |1001|请先进行实名认证| |1001|金额大于等于一万需要实名| |2001|发券数量必须为整数| |2001|发券数量错误| |1001|operUserId未传递| |3101|店铺号错误| |3101|无效的couponTemplateId| |3101|操作员不存在| |3101|未能识别的(%s)顾客号(#%s)| |3102|非本机构券模板| |3102|非本机构店铺| |3103|非店铺(#%d)操作员(#%s)| |3103|店铺(#%d)不属于操作员(#%s)店铺组(#%d)| |3201|发券失败[%s]| |3202|外部订单号重复|
卜子超buzc
2026年3月13日 09:56
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Word文件
PDF文档
分享
链接
类型
密码
更新密码
有效期