API 列表

支付宝为开发者接入花呗分期功能提供新旧两个版本的接口,请开发者在接入时明确接口版本。


新版接口

接口列表


支付场景

接口名称

手机网站支付

手机网站支付接口 2.0:alipay.trade.wap.pay

手机 APP 支付

app 支付接口 2.0:alipay.trade.app.pay

线下当面付

统一收单交易支付接口:alipay.trade.pay

统一收单交易创建接口:alipay.trade.create

统一收单线下交易预创建:alipay.trade.precreate

电脑网站支付

统一收单下单并支付页面接口:alipay.trade.page.pay 


花呗分期相关参数

标准收银台模式


支付宝标准收银台展示花呗分期渠道(仅支持用户承担手续费),无需额外签约花呗分期,且无需进行额外的花呗分期参数的透传开发工作,可以直接在支付宝标准收银台中展示出花呗分期渠道


单通道模式


商家可以根据需要,将花呗分期资金渠道前置或者与其他付款方式并列,实现花呗分期单通道模式该方式下,如果当前花呗分期渠道无法支付成功,则可以继续使用其他支付渠道进行付款。


开发者需要将花呗分期参数传入到 extend_params 中,格式如下:


"extend_params":{"hb_fq_num":"3","hb_fq_seller_percent":"100"}


  • hb_fq_num 代表花呗分期数,仅支持传入 3、6、12,其他期数暂不支持,传入会报错;
  • hb_fq_seller_percent 代表卖家承担收费比例,商家承担手续费传入 100,用户承担手续费传入 0,仅支持传入 100、0 两种,其他比例暂不支持,传入会报错。


前端效果请见应用案例-APP端分期应用案例-PC网站分期


旧版接口

旧版 PC 端支付接口列表


若您使用的是老版本的接口,请参考如下老版本接口花呗分期参数。

支付场景

接口

PC 端支付

即时到账交易接口:create_direct_pay_by_user


花呗分期相关参数

标准收银台模式


支付宝标准收银台展示花呗分期渠道(仅支持用户承担手续费),无需额外签约花呗分期,且无需进行额外的花呗分期参数的透传开发工作,可以直接在支付宝标准收银台中展示出花呗分期渠道


单通道模式


方式一

该方式下无需额外签约花呗分期协议,开发者在收单接口中传入可用渠道参数 enable_pay_channels=pcreditpayInstallment 即可。

注意:

该方式下,如果当前花呗分期渠道无法支付成功,则无法继续使用其他支付渠道进行付款。


方式二

要实现花呗分期单通道模式,将花呗分期资金渠道与与支付宝并列,开发者需要将花呗分期参数传入到 hb_fq_param 中,格式如下:


hb_fq_param=hb_fq_seller_percent^100|hb_fq_num^3


  • hb_fq_num:代表花呗分期数,仅支持传入3、6、12,其他期数暂不支持,传入会报错
  • hb_fq_seller_percent:商家承担手续费传入 100,用户承担手续费传入 0,仅支持传入 100、0 两种,其他比例暂不支持,传入会报错。

注意:

该方式下,如果当前花呗分期渠道无法支付成功,则可以继续使用其他支付渠道进行付款。


旧版手机端支付接口列表

支付场景

接口

手机网站支付

老版本手机网站支付接口:alipay.wap.create.direct.pay.by.user

手机 APP 支付

老版本移动支付接口:mobile.securitypay.pay

花呗分期相关参数

标准收银台


支付宝标准收银台展示花呗分期渠道(仅支持用户承担手续费),无需额外签约花呗分期,且无需进行额外的花呗分期参数的透传开发工作,可以直接在支付宝标准收银台中展示出花呗分期渠道


单通道模式


方式一

该方式下无需额外签约花呗分期协议,开发者在收单接口中传入可用渠道参数 enable_pay_channels=pcreditpayInstallment 即可。

注意:

该方式下,如果当前花呗分期渠道无法支付成功,则无法继续使用其他支付渠道进行付款。


方式二

要实现花呗分期单通道模式,将花呗分期资金渠道与与支付宝并列,开发者需要将花呗分期参数传入到 hb_fq_param 中,格式如下:


hb_fq_param={"hb_fq_num":"3","hb_fq_seller_percent":"100"}


  • hb_fq_num:代表花呗分期数,仅支持传入3、6、12,其他期数暂不支持,传入会报错
  • hb_fq_seller_percent:商家承担手续费传入100,用户承担手续费传入0,仅支持传入100、0两种,其他比例暂不支持,传入会报错。


注意

该方式下,如果当前花呗分期渠道无法支付成功,则可以继续使用其他支付渠道进行付款。

老wap支付接口 (alipay.wap.trade.create.direct) 不支持开通花呗分期支付渠道。



开发者可以点击进入开放平台在线接口调试工具进行 API 在线调试;选择左侧的 API 类别,找到并点击对应的 API 开始在线调试;您也可以在搜索框查找对应的接口。







onlineServer