接口地址:https://vsp.allinpay.com/apiweb/unitorder/alipayfqfee
测试地址:https://test.allinpaygd.com/apiweb/unitorder/alipayfqfee
使用场景:
商户自建收银台需要向持卡人展示支付宝分期(花呗分期、信用卡分期)优惠信息,可调用本接口查询用户在本商户下分期的优惠详情。
调用前提:
- 商户报备了支付宝分期(花呗分期、信用卡分期)优惠活动
- 本接口需额外申请接口权限
请求参数:
|
参数 |
参数名称 |
取值 |
可空 |
最大长度 |
备注 |
|
cusid |
商户号 |
平台分配的商户号 |
否 |
15 |
|
|
appid |
应用ID |
平台分配的APPID |
否 |
8 |
|
|
version |
版本号 |
接口版本号 |
可 |
2 |
默认填12 |
|
trxamt |
需要支付的金额 |
单位分 |
否 |
20 |
|
|
aliuserid |
支付宝userid |
|
否 |
32 |
|
|
randomstr |
随机字符串 |
随机生成的字符串 |
否 |
32 |
|
|
signtype |
签名方式 |
|
是 |
8 |
RSA/SM2 |
|
sign |
签名 |
|
否 |
32 |
详见安全规范 |
响应参数:
|
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
|
|
retcode |
返回码 |
SUCCESS/FAIL
|
否 |
8 |
此字段是通信标识,非交易结果,交易是否成功需要查看trxstatus来判断 |
|
|
retmsg |
返回码说明 |
|
是 |
100 |
|
|
|
|
以下信息只有当retcode为SUCCESS时有返回 |
|||||
|
cusid |
商户号 |
平台分配的商户号 |
否 |
15 |
|
|
|
appid |
应用ID |
平台分配的APPID |
否 |
8 |
|
|
|
cusfeespe |
商户贴息信息 |
Object[Cusfeespe]的json字符串 |
否 |
- |
|
|
|
alipreconsult |
支付宝单通道优惠信息 |
支付宝单通道优惠信息的json字符串 |
是 |
- |
|
|
|
sign |
签名 |
|
否 |
32 |
详见安全规范 |
|
商户贴息信息[cusfeespe]字段如下
|
参数 |
参数名称 |
取值 |
可空 |
最大长度 |
备注 |
|
txmod |
贴息方式 |
0-全场贴息 1-订单贴息 |
否 |
1 |
全场贴息:商户花呗分期交易都会贴息 订单贴息:交易下单时需指定该交易是否贴息。例如 fqnum=3,1。代表花呗分期3期,并且使用商户贴息 |
|
fq3 |
分期3是否贴息 |
1-贴息 0-不贴息 |
是 |
1 |
|
|
fq6 |
分期6是否贴息 |
1-贴息 0-不贴息 |
是 |
1 |
|
|
fq12 |
分期12是否贴息 |
1-贴息 0-不贴息 |
是 |
1 |
|
|
fq24 |
分期24是否贴息 |
1-贴息 0-不贴息 |
是 |
1 |
|
支付宝单通道优惠信息说明如下:
| 字段名称 | 类型 | 中文名称 | 语义 |
|---|---|---|---|
| channel_info_list |
List<ChannelInfo > |
渠道列表 |
1.⽤户可⽤渠道列表以及营销信息 2.当⽤户身份传参⽅案使⽤⽅案4时,需单独 解析⽅可得到此字段 |
| pre_consult_id | String | 咨询ID |
前置咨询流⽔ID 为保证单通道2.0场景下,收单维度知道这是⼀ 笔来⾃前置咨询且代表单通道2.0的交易,请将 该前置咨询流⽔ID传⼊交易扩展字段中具体位 置:business_params扩展字段中,key为 preConsultId: https://opendocs.alipay.com/pre-open/0cays5?pathHash=4a96c82f |
| biz_tag_list |
List<String> |
人群标签 |
⼈群标签列表,固定枚举值 FQ_AVAILABLE: 分期可⽤(可⽤同时展示 花呗分期和信⽤卡分期单通道;不可⽤花 呗分期和信⽤卡分期都不展示。) FQ_AVAILABLE_24: 花呗分期24期可⽤ (信⽤卡分期24期不需要⼈群标签,全量 ⽤户展示,⽬前信⽤卡分期24期⽀持13家 银⾏) FQ_AMOUNT_PROMOTE:随机专享提额 |
ChannelInfo渠道信息和营销信息:
| 字段名称 | 类型 | 中文名称 | 示例 | 语义 |
|---|---|---|---|---|
| name | String | 渠道名称 |
信⽤卡分期 |
渠道名称 |
|
channel_code |
String |
渠道编码 |
ALICREDITFQ G |
渠道编码 枚举: ALICREDITFQG:花呗分 期 ALICREDIT_CC_INSTAL :信⽤卡分期 |
|
channel_detail_params |
channelDetailParams |
资产描述 拓展参数 |
"govSubsidy":"Y" 或者"instSubsidy":"Y" |
该笔交易为国家贴息标签, 示意: "channel_detail_params": { "govSubsidy":"Y" }, 该笔交易为银⾏贴息标签 示意 "channel_detail_params": { "instSubsidy":"Y" }, 如信息为空则⽆任何标签展示 "channel_detail_params": {}, |
| installment_info_list |
List<InstallmentInfo> |
分期信息 |
|
分期信息 |
|
operation_list |
List<OperationInfo> |
渠道运营 信息 |
渠道运营信息 |
分期信息InstallmentInfo:
| 字段名称 | 字段类型 | 中文名称 | 示例 | 语义 |
|---|---|---|---|---|
| install_count | String | 期数 | 3 | 分期期数 |
| channel_order_info_list |
ChannelOrderInfo |
分期支持的订单列表 | — |
分期⽀持的订单 列表 |
| operation_list |
List<OperationInfo> |
子渠道运营信息 | — |
渠道运营信息 |
分期⽀持的订单列表ChannelOrderInfo:
| 字段名称 | 字段类型 | 中文名称 | 示例 | 语义 |
|---|---|---|---|---|
| out_biz_no | String | 支持的外部订单号 | 3 |
⽀持的外部订单号 |
营销表达OperationInfo:
| 字段名称 | 字段类型 | 中文名称 | 示例值 | 语义 |
|---|---|---|---|---|
| scene_code | String | 运营场景码 | merchantPreConsult_alicreditfqgChannelRecommend |
业务场景对应的运营位置标识 |
| view_type | String | 展示类型 | content |
营销对客表达的类型。⽬前主要是content,语义是⽂案展示 |
| view_data | ViewData | 营销表达数据 | — |
营销数据详情 |
ViewData:
| 字段名称 | 字段类型 | 中文名称 | 示例值 | 语义 |
|---|---|---|---|---|
| operation_tip | String | 运营文案描述 | 3期免息 |
表达⽴减的辅助提示 |
| operation_desc | String | 运营主体 | 花呗分期 |
表达运营主体信 |
| promo_type | String |
运营类型 |
feeRatioNonCashAsset |
运营类型:分期⼿续费折扣、⽀付⾦额优惠信息 枚举: 定额⾦额类优惠: fixedAmountCashAsset 随机⾦额类优惠: randomAmountCashAsset ⼿续费率折扣: feeRatioNonCashAsset |
| promo_price | String |
运营定价 |
0 |
⽴减优惠⾦额 ⽴减3元时,值为3 分期⼿续费折扣⽐例 ⼿续费3折时,值为3 免息时,值为0 |
| pay_operation_info | String |
运营信息 |
为保证前置咨询时曝光的权益能够在⽤户⽀付时被优先曝光、选中,请于唤起⽀付时回传前置营销单据信息。 具体位置: business_params扩展字段中,key为payOperationInfo: https://opendocs.alipay.com/pre-open/0cays5?pathHash=4a96c82f |