tt.createSignOrder
基础库 1.45.0 开始支持本方法,这是一个异步方法。
调用该 API 后,会生成相关签约单,用于后续唤起签约页面(调用tt.sign) 。
| 前提条件 | 使用前请确认按照周期代扣接入指南操作开通周期代扣能力 |
| 业务背景 | 无 |
| 使用限制 | 最低支持版本上注明行业 SDK ,表示仅在行业 SDK 上才支持,需要在代码中配置行业 SDK 的权限:行业 SDK 的权限配置。当完成行业 SDK 的权限配置后,可通过 tt.canIUse('createSignOrder') 判断该 API 是否可用。 |
| 注意事项 | 无 |
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.createSignOrder(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| businessType | number | 是 | 预授权模式,枚举值 2 - 周期代扣 | 1.45.0 | |
| data | string | 是 | 由开发者服务端返回,详细字段信息参考 data说明部分 | 1.45.0 | |
| byteAuthorization | string | 是 | 签名信息,由开发者服务端返回,生成方式见下文 | 1.45.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.45.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.45.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 1.45.0 |
data 参数说明
属性名 | 类型 | 必填 | 说明 |
outAuthOrderNo | string | 是 | 开发者侧签约单的单号,长度<=64byte |
serviceId | string | 是 | 签约模板配置成功后平台分配模板ID,具体流程可参考周期代扣签约模板配置 |
openId | string | 是 | 用户 openId,用户在小程序登录后获取到code(临时登录凭证),通过在服务端调用 登录凭证校验接口获取openId信息 |
expireSeconds | int64 | 否 | 签约或签约支付超时时间,单位[秒],不传默认5分钟,最少30秒,不能超过48小时。 建议开发者不要将超时时间设置太短 |
notifyUrl | string | 否 | 签约结果回调地址,https开头,长度<=512byte |
firstDeductionDate | string | 否 | 首次扣款日期,格式YYYY-MM-DD,纯签约场景需要传入,用于c端展示 |
authPayOrder | object | 否 | 扣款信息,如果传入该字段则会走签约支付流程,否则走纯签约流程,详细字段可参考authPayOrder说明部分 |
onBehalfUid | string | 否 | 代签约用户uid,该uid必须由ASCII字母、数字、下划线组成,长度<=64个字符,通常该字段应填入开发者自己系统的uid, |
uniqueId | string | 否 | 开发者指定签约唯一键,用户防止重复签约。
|
signWay | int32 | 否 | 签约渠道: 2 - 支付宝
3 - 抖音支付 |
authPayOrder 说明
属性名 | 类型 | 必填 | 说明 |
outPayOrderNo | string | 是 | 开发者侧代扣单的单号,长度<=64byte |
merchantUid | string | 是 | 开发者自定义收款商户号,限定在在小程序绑定的商户号内 |
initialAmount | int64 | 否 | 首期代扣金额,单位[分],不传则使用模板上的扣款金额,签约模板支持前N(N<=6)期优惠,该字段优先级高于模板的配置的第一期优惠价格,举例:如果当前参数传入扣款金额为10元,而实际模板中配置的第一期优惠价格为20元,那么第一期的实际扣款金额是10元 |
notifyUrl | string | 否 | 支付结果回调地址,https开头,长度<=512byte |
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "createSignOrder:ok" | 1.45.0 |
| authOrderId | string | 平台侧签约单的单号,长度<=64 byte | 1.45.0 |
| payOrderId | string | 平台侧代扣单的单号,长度<=64 byte,只有签约并支付场景才会返回 | 1.45.0 |
