目录
获取签约字符串
唤起支付宝周期扣款签约页面
支付宝小程序唤起独立签约,需要通过alipay.user.agreement.page.sign接口获取签约字符串signStr,然后调用my.paySignCenter API在支付宝小程序内唤起周期扣款签约页面。
获取签约字符串
调用接口alipay.user.agreement.page.sign获取签约字符串,所需参数如下:
公共请求参数
参数 | 必填 | 描述 | 示例值 |
---|
app_id | 是 | 支付宝分配给开发者的应用ID | 2014072300007148 | method | 是 | 接口名称 | alipay.user.agreement.page.sign | format | 否 | 仅支持JSON | JSON | return_url | 否 | HTTP/HTTPS开头字符串 | https://m.alipay.com/Gk8NF23 | charset | 是 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 | sign_type | 是 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 | sign | 是 | 商户请求参数的签名串,详见签名 | 详见示例 | timestamp | 是 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 | version | 是 | 调用的接口版本,固定为:1.0 | 1.0 | notify_url | 否 | 支付宝服务器主动通知商户服务器里指定的页面http/https路径。 | http://api.test.alipay.net/atinterface/receive_notify.htm | app_auth_token | 否 | 详见应用授权概述 | | biz_content | 是 | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 | |
请求参数
参数 | 必填 | 描述 | 示例值 |
---|
product_code | 可选 | 销售产品码,商户签约的支付宝合同所对应的产品码。 周期扣款场景固定为 CYCLE_PAY_AUTH。 | CYCLE_PAY_AUTH | personal_product_code | 必选 | 个人签约产品码,商户和支付宝签约时确定,商户可咨询技术支持。 周期扣款个人签约产品码固定为 CYCLE_PAY_AUTH_P | CYCLE_PAY_AUTH_P | sign_scene | 可选 | 协议签约场景,商户可根据?代扣产品常见场景值?选择符合自身的行业场景。 说明:当传入商户签约号 external_agreement_no 时,本参数必填,不能为默认值 DEFAULT|DEFAULT。 | INDUSTRY|CARRENTAL | external_agreement_no | 可选 | 商户签约号,代扣协议中标示用户的唯一签约号(确保在商户系统中唯一)。 格式规则:支持大写小写字母和数字,最长32位。 商户系统按需自定义传入,如果同一用户在同一产品码、同一签约场景下,签订了多份代扣协议,那么需要指定并传入该值。 | test | access_params | 必选 | 请按当前接入的方式进行填充,且输入值必须为文档中的参数取值范围。 扫码或者短信页面签约需要拼装http的请求地址访问中间页面,钱包h5页面签约可直接拼接scheme的请求地址 | | └channel | 必选 | 目前支持以下值: 1. ALIPAYAPP (钱包h5页面签约) 2. QRCODE(扫码签约) 3. QRCODEORSMS(扫码签约或者短信签约) | ALIPAYAPP | period_rule_params | 必选 | 周期管控规则参数period_rule_params,在签约周期扣款产品(如CYCLE_PAY_AUTH_P)时必传,在签约其他产品时无需传入。 周期扣款产品,会按照这里传入的参数提示用户,并对发起扣款的时间、金额、次数等做相应限制。 | | └period_type | 必选 | 周期类型period_type是周期扣款产品必填,枚举值为DAY和MONTH。 DAY即扣款周期按天计,MONTH代表扣款周期按自然月。 与另一参数period组合使用确定扣款周期,例如period_type为DAY,period=30,则扣款周期为30天;period_type为MONTH,period=3,则扣款周期为3个自然月。 自然月是指,不论这个月有多少天,周期都计算到月份中的同一日期。例如1月3日到2月3日为一个自然月,1月3日到4月3日为三个自然月。注意周期类型使用MONTH的时候,计划扣款时间execute_time不允许传28日之后的日期(可以传28日),以此避免有些月份可能不存在对应日期的情况。 | DAY | └period | 必选 | 周期数period是周期扣款产品必填。与另一参数period_type组合使用确定扣款周期,例如period_type为DAY,period=90,则扣款周期为90天。 | 7 | └execute_time | 必选 | 首次执行时间execute_time是周期扣款产品必填,即商户发起首次扣款的时间。精确到日,格式为yyyy-MM-dd 结合其他必填的扣款周期参数,会确定商户以后的扣款计划。发起扣款的时间需符合这里的扣款计划。 | 2019-01-23 | └single_amount | 必选 | 单次扣款最大金额single_amount是周期扣款产品必填,即每次发起扣款时限制的最大金额,单位为元。商户每次发起扣款都不允许大于此金额。 | 10.99 | └total_amount | 可选 | 总金额限制,单位为元。如果传入此参数,商户多次扣款的累计金额不允许超过此金额。 | 600 | └total_payments | 可选 | 总扣款次数。如果传入此参数,则商户成功扣款的次数不能超过此次数限制(扣款失败不计入)。 | 12 |
const signObj = {
app_id: '2014072300007148',
biz_content: '{"access_params":{"channel":"ALIPAYAPP"},"external_agreement_no":"2019_06_0910","personal_product_code":"CYCLE_PAY_AUTH_P","period_rule_params":{"period_type":"DAY","period":"30","execute_time":"2021-10-29","single_amount":"10","total_amount":"600","total_payments":"12"},"sign_scene":"INDUSTRY|DIGITAL_MEDIA"}',
charset: 'UTF-8',
method: 'alipay.user.agreement.page.sign',
sign_type: 'RSA2',
timestamp: '2021-10-29 17:18:02',
version: '1.0',
sign:'Y+Sx4WPF4tIzTnQ+FqYds+xLBfi9wflmD+GPs2LN0qSo6431moZqM3TCouc/tEjzh3/GUFc75yHNEXVBTQ0iL+nSM4PlNgP3yPCql12c38PmChAcfj0C/1+engUkqXtCtWs0lXVKXn2ze3aHLE+64dG87h8I1ngl/2LqSAD8mhH4RmWDIrxFcxNEzlT+GJp+7Ae+OpbT284iOuZ5l5DUya47K7LVI3+/t1sXsHPGAD1d1wDQ+NfcfE+jAAw2XQ1G/EcnNkZCHlplIU1tAFTKDMPKIlOHUV1F1LkqCcH3AK5w+C0RNLcDW8SbN4q79gRGDWXX7C6FjURAjn8Tw8/Zgw=='
};
let signStr = '';
for (let key in signObj) {
signStr += key + '=' + encodeURIComponent(signObj[key]) + '&';
}
signStr = signStr.substring(0, signStr.length - 1);
signStr = encodeURIComponent(signStr);
唤起支付宝周期扣款签约页面
调用my.paySignCenter API,使用上一步得到的signStr作为API的参数来唤起支付宝周期扣款签约页面。
my.paySignCenter({
signStr: signStr,
success: (res) => {
my.alert({
title: 'success', // alert 框的标题
content: JSON.stringify(res)
});
},
fail: (res) => {
my.alert({
title: 'fail', // alert 框的标题
content: JSON.stringify(res)
});
}
});
|