花呗分期

更新时间:2024-07-12 15:00:19

刷卡(条码)支付

  • URL:/pay/fenqi/barcodepay
  • Method:POST
参数名称 类型 长度 必填 说明
pay_ver String 3 Y 版本号,当前版本110
pay_type String 3 Y 请求类型,020
支付宝
service_id String 3 Y 接口类型,当前类型010
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
terminal_trace String 32 Y 终端流水号,填写商户系统的订单号
terminal_time String 14 Y 终端交易时间,yyyyMMddHHmmss,全局统一时间格式
auth_no String 128 Y 授权码,客户的付款码
total_fee String 12 Y 金额,单位分
order_body String 128 N 订单描述
attach String 128 N 附加数据,原样返回
goods_detail String 2048 N 订单包含的商品列表信息,Json格式。
goods_tag String 32 N 订单优惠标记,代金券或立减优惠功能的参数(字段值:cs和bld)
fenqi_num String 2 Y 花呗分期数,支持 3,6,12
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换

以上为请求参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码:01
成功 ,02
失败,响应码仅代表通信状态,不代表业务结果
return_msg String 128 Y 返回信息提示,“支付成功”,“支付中”,“请求受限”等
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换
result_code String 2 N 业务结果:01
成功 02
失败 ,03
支付中,99
该条码暂不支持支付类型自动匹配
pay_type String 3 N 请求类型,020
支付宝
merchant_name String 40 N 商户名称
merchant_no String 15 N 商户号
terminal_id String 8 N 终端号
terminal_trace String 32 N 终端流水号,商户系统的订单号,扫呗系统原样返回
terminal_time String 14 N 终端交易时间,yyyyMMddHHmmss,全局统一时间格式
total_fee String 12 N 金额,单位分
end_time String 14 N 支付完成时间,yyyyMMddHHmmss,全局统一时间格式
out_trade_no String 32 N 利楚唯一订单号
channel_trade_no String 32 N 通道订单号,支付宝订单号等,返回时不参与签名
channel_order_no String 64 N 银行渠道订单号,支付时显示在支付成功页面的条码,可用作扫码查询和扫码退款时匹配
user_id String 32 N 付款方用户id,“支付宝账户”,返回时不参与签名
attach String 128 N 附加数据,原样返回
receipt_fee String 12 N 实收金额

扫码支付(预支付)

  • URL:/pay/fenqi/prepay
  • Method:POST
参数名称 类型 长度 必填 说明
pay_ver String 3 Y 版本号,当前版本110
pay_type String 3 Y 请求类型,020
支付宝
service_id String 3 Y 接口类型,当前类型011
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
terminal_trace String 32 Y 终端流水号,填写商户系统的订单号
terminal_time String 14 Y 终端交易时间,yyyyMMddHHmmss,全局统一时间格式
total_fee String 12 Y 金额,单位分
order_body String 128 N 订单描述
notify_url String 256 N 外部系统通知地址
attach String 128 N 附加数据,原样返回
goods_detail String 2048 N 订单包含的商品列表信息,Json格式。
goods_tag String 32 N 订单优惠标记,代金券或立减优惠功能的参数(字段值:cs和bld)
fenqi_num String 2 Y 花呗分期数,支持 3,6,12
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换

以上为请求参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码:01
成功 ,02
失败,响应码仅代表通信状态,不代表业务结果
return_msg String 128 Y 返回信息提示,“预支付请求成功”,“预支付请求失败”等
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换
result_code String 2 N 业务结果:01
成功 ,02
失败
pay_type String 3 N 请求类型,020
支付宝
merchant_name String 40 N 商户名称
merchant_no String 15 N 商户号
terminal_id String 8 N 终端号
terminal_trace String 32 N 终端流水号,商户系统的订单号,扫呗系统原样返回
terminal_time String 14 N 终端交易时间,yyyyMMddHHmmss,全局统一时间格式
total_fee String 12 N 金额,单位分
out_trade_no String 32 N 利楚唯一订单号
qr_code String 128 N 二维码码串

公众号预支付(统一下单)

  • URL:/pay/fenqi/jspay
  • Method:POST
参数名称 类型 长度 必填 说明
pay_ver String 3 Y 版本号,当前版本110
pay_type String 3 Y 请求类型,020
支付宝
service_id String 3 Y 接口类型,当前类型012
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
terminal_trace String 32 Y 终端流水号,填写商户系统的订单号
terminal_time String 14 Y 终端交易时间,yyyyMMddHHmmss,全局统一时间格式
total_fee String 12 Y 金额,单位分
open_id String 128 N 用户标识(支付宝userid)
order_body String 128 N 订单描述
notify_url String 256 N 外部系统通知地址
attach String 128 N 附加数据,原样返回
goods_detail String 2048 N 订单包含的商品列表信息,Json格式。
goods_tag String 32 N 订单优惠标记,代金券或立减优惠功能的参数(字段值:cs和bld)
fenqi_num String 2 Y 花呗分期数,支持 3,6,12
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换

以上为请求参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码:01
成功 ,02
失败,响应码仅代表通信状态,不代表业务结果
return_msg String 128 Y 返回信息提示,“预支付请求成功”,“预支付请求失败”等
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换
result_code String 2 N 业务结果:01
成功 ,02
失败
pay_type String 3 N 请求类型,020
支付宝
merchant_name String 40 N 商户名称
merchant_no String 15 N 商户号
terminal_id String 8 N 终端号
terminal_trace String 32 N 终端流水号,商户系统的订单号,扫呗系统原样返回
terminal_time String 14 N 终端交易时间,yyyyMMddHHmmss,全局统一时间格式
total_fee String 12 N 金额,单位分
out_trade_no String 32 N 利楚唯一订单号
参数名称 类型 长度 必填 说明
ali_trade_no String 32 N 支付宝JSAPI支付返回字段用于调起支付宝JSAPI

小程序支付接口

  • URL:/pay/fenqi/minipay
  • Method:POST
参数名称 类型 长度 必填 说明
pay_ver String 3 Y 版本号,当前版本110
pay_type String 3 Y 请求类型,020
支付宝
service_id String 3 Y 接口类型,当前类型015
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
terminal_trace String 32 Y 终端流水号,填写商户系统的订单号
terminal_time String 14 Y 终端交易时间,yyyyMMddHHmmss,全局统一时间格式
total_fee String 12 Y 金额,单位分
open_id String 128 N 用户标识(支付宝user_id)
goods_tag String 32 N 订单优惠标记,代金券或立减优惠功能的参数(字段值:cs和bld)
order_body String 128 N 订单描述
notify_url String 256 N 外部系统通知地址
attach String 128 N 附加数据,原样返回
fenqi_num String 2 Y 花呗分期数,支持 3,6,12
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换

以上为请求参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码:01
成功 ,02
失败,响应码仅代表通信状态,不代表业务结果
return_msg String 128 Y 返回信息提示,“预支付请求成功”,“预支付请求失败”等
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换
result_code String 2 N 业务结果:01
成功 ,02
失败
pay_type String 3 N 请求类型,020
支付宝
merchant_name String 40 N 商户名称
merchant_no String 15 N 商户号
terminal_id String 8 N 终端号
terminal_trace String 32 N 终端流水号,商户系统的订单号,扫呗系统原样返回
terminal_time String 14 N 终端交易时间,yyyyMMddHHmmss,全局统一时间格式
total_fee String 12 N 金额,单位分
out_trade_no String 32 N 利楚唯一订单号
参数名称 类型 长度 必填 说明
ali_trade_no String 32 N 支付宝小程序支付返回字段用于调起支付宝小程序

订单操作接口

支付查询

  • URL:/pay/fenqi/query
  • Method:POST
参数名称 类型 长度 必填 说明
pay_ver String 3 Y 版本号,当前版本110
pay_type String 3 Y 请求类型,020
支付宝,000
自动识别类型
service_id String 3 Y 接口类型,当前类型020
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
terminal_trace String 32 Y 终端查询流水号,填写商户系统的查询流水号
terminal_time String 14 Y 终端查询时间,yyyyMMddHHmmss,全局统一时间格式
pay_trace String 32 N 当前支付终端流水号,与pay_time同时传递
pay_time String 14 N 当前支付终端交易时间,yyyyMMddHHmmss,全局统一时间格式,与pay_trace同时传递
out_trade_no String 64 Y 订单号,查询凭据,可填利楚订单号、支付宝订单号任意一个
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换

以上为请求参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码:01
成功 ,02
失败,响应码仅代表通信状态,不代表业务结果
return_msg String 128 Y 返回信息提示,“支付成功”,“支付中”,“请求受限”等
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换
result_code String 2 N 业务结果:01
成功 ,02
失败 ,03
支付中。支付失败
退款成功
状态均返回02
,具体状态和原因会在return_msg
中给出解释
pay_type String 3 N 请求类型,020
支付宝
merchant_name String 40 N 商户名称
merchant_no String 15 N 商户号
terminal_id String 8 N 终端号
terminal_trace String 32 N 终端流水号,商户系统的查询流水号,扫呗系统原样返回
terminal_time String 14 N 终端交易时间,yyyyMMddHHmmss,全局统一时间格式
total_fee String 12 N 金额,单位分
end_time String 14 N 支付完成时间,yyyyMMddHHmmss,全局统一时间格式
out_trade_no String 32 N 利楚唯一订单号
参数名称 类型 长度 必填 说明
trade_state String 10 N 交易订单状态,SUCCESS
支付成功,REFUND
转入退款,NOTPAY
未支付,CLOSED
已关闭,USERPAYING
用户支付中,REVOKED
已撤销,NOPAY
未支付或支付超时,PAYERROR
支付失败
channel_trade_no String 32 N 通道订单号,支付宝订单号等,返回时不参与签名
channel_order_no String 64 N 银行渠道订单号,支付时显示在支付成功页面的条码,可用作扫码查询和扫码退款时匹配
user_id String 32 N 付款方用户id,“支付宝账户”,返回时不参与签名
attach String 128 N 附加数据,原样返回,返回时不参与签名
receipt_fee String 12 N 实收金额
pay_trace String 32 N 当前支付终端流水号
pay_time String 14 N 当前支付终端交易时间,yyyyMMddHHmmss,全局统一时间格式

以上字段返回不参加签名

注意:

  • 查询支付结果时参数存在两种情况:1.out_trade_no为空的时候,查询的时候out_trade_no还是需要作为参数(对应的值是"")传进去,此时pay_trace(对应支付请求中的terminal_trace参数值)和pay_time(对应支付请求中的terminal_time参数值)也要作为请求参数传进去;2.out_trade_no不为空的时候,直接按照正常操作进行;
  • 查询最多15次,每次间隔5s
  • 此接口用来查原订单,不支持查退款订单

退款申请

  • URL:/pay/fenqi/refund
  • Method:POST
参数名称 类型 长度 必填 说明
pay_ver String 3 Y 版本号,当前版本110
pay_type String 3 Y 请求类型,020
支付宝,000
自动识别类型
service_id String 3 Y 接口类型,当前类型030
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
terminal_trace String 32 Y 终端退款流水号,填写商户系统的退款流水号
terminal_time String 14 Y 终端退款时间,yyyyMMddHHmmss,全局统一时间格式
refund_fee String 12 Y 退款金额,单位分
out_trade_no String 64 Y 订单号,查询凭据,利楚订单号、支付宝订单号任意一个
pay_trace String 32 N 当前支付终端流水号,与pay_time同时传递
pay_time String 14 N 当前支付终端交易时间,yyyyMMddHHmmss,全局统一时间格式,与pay_trace同时传递
auth_code String 6 N 短信或邮箱验证码
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换

以上为请求参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码:01
成功 ,02
失败,响应码仅代表通信状态,不代表业务结果
return_msg String 128 Y 返回信息提示,“退款成功”、“订单不存在”等
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换
result_code String 2 N 业务结果:01
成功 ,02
失败
pay_type String 3 N 请求类型,020
支付宝
merchant_name String 40 N 商户名称
merchant_no String 15 N 商户号
terminal_id String 8 N 终端号
terminal_trace String 32 N 终端流水号,商户系统的退款流水号,扫呗系统原样返回
terminal_time String 14 N 终端退款时间,yyyyMMddHHmmss,全局统一时间格式
refund_fee String 12 N 退款金额,单位分
end_time String 14 N 退款完成时间,yyyyMMddHHmmss,全局统一时间格式
out_trade_no String 32 N 利楚唯一订单号
out_refund_no String 32 N 利楚唯一退款单号

注意:

  • 需要商户当前账户内有大于退款金额的余额,否则会造成余额不足,退款失败;
  • 限支付30天内退款,超过30天,不能进行退款操作(具体退款限制时间由通道决定)。

交易通知

  • Method:POST
参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码:01
成功 ,02
失败,响应码仅代表通信状态,不代表业务结果
return_msg String 128 Y 返回信息提示,“签名失败”,“参数格式校验错误"等
result_code String 2 Y 业务结果:01
成功 ,02
失败
pay_type String 3 Y 请求类型,020
支付宝
user_id String 32 Y 付款方用户id,“支付宝账户”
merchant_name String 40 Y 商户名称
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
terminal_trace String 32 Y 终端流水号,此处传商户发起预支付或公众号支付时所传入的交易流水号
terminal_time String 14 Y 终端交易时间,yyyyMMddHHmmss,全局统一时间格式(01时参与拼接)
pay_trace String 32 N 当前支付终端流水号,与pay_time同时传递,返回时不参与签名
pay_time String 14 N 当前支付终端交易时间,yyyyMMddHHmmss,全局统一时间格式,与pay_trace同时传递
total_fee String 12 Y 金额,单位分
end_time String 14 Y 支付完成时间,yyyyMMddHHmmss,全局统一时间格式
out_trade_no String 32 Y 利楚唯一订单号
channel_trade_no String 32 Y 通道订单号,支付宝订单号等
attach String 128 Y 附加数据,原样返回
receipt_fee String 12 N 实收金额
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换

以上为请求参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码:01
成功 ,02
失败
return_msg String 128 Y 返回信息提示,“签名失败”,“参数格式校验错误"等

以上为响应参数

撤销交易(只针对刷卡支付)

  • URL:/pay/fenqi/cancel
  • Method:POST
参数名称 类型 长度 必填 说明
pay_ver String 3 Y 版本号,当前版本110
pay_type String 3 Y 请求类型,020
支付宝000
自动识别类型
service_id String 3 Y 接口类型,当前类型040
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
terminal_trace String 32 Y 终端流水号(socket协议:长度为6位,Http协议:长度为32位)
terminal_time String 14 Y 终端交易时间,yyyyMMddHHmmss,全局统一时间格式
out_trade_no String 32 N 利楚唯一订单号,优先使用订单号out_trade_no发起撤销,在out_trade_no获取异常的情况,可使用当前支付请求的终端交易流水号pay_trace和终端交易时间pay_time发起撤销
pay_trace String 32 N 当前支付终端流水号,与pay_time同时传递
pay_time String 14 N 当前支付终端交易时间,yyyyMMddHHmmss,全局统一时间格式,与pay_trace同时传递
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换

以上为请求参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码:01
成功 ,02
失败,响应码仅代表通信状态,不代表业务结果
return_msg String 128 Y 返回信息提示,“退款成功”、“订单不存在”等
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换
result_code String 2 N "业务结果,“01”成功,表示撤销成功,此笔订单不能再发起支付;若已支付完成,则会发起退款;“02”失败,表示撤销接口异常,根据recall判断是否可再次发起撤销操作;"
pay_type String 3 N 请求类型,020
支付宝
merchant_no String 15 N 商户号
terminal_id String 8 N 终端号
terminal_trace String 32 N 终端流水号(socket协议:长度为6位,Http协议:长度为32位)
terminal_time String 14 N 终端撤销时间,yyyyMMddHHmmss,全局统一时间格式
recall String 1 N 是否重新发起撤销
merchant_name String 40 N 商户名称

关闭订单

  • URL:/pay/fenqi/close
  • Method:POST
参数名称 类型 长度 必填 说明
pay_ver String 3 Y 版本号,当前版本110
pay_type String 3 Y 请求类型,020
支付宝,000
自动识别类型
service_id String 3 Y 接口类型,当前类型041
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
terminal_trace String 32 Y 终端流水号(socket协议:长度为6位,Http协议:长度为32位)
terminal_time String 14 Y 终端交易时间,yyyyMMddHHmmss,全局统一时间格式
out_trade_no String 32 N 利楚唯一订单号,优先使用订单号out_trade_no发起撤销,在out_trade_no获取异常的情况,可使用当前支付请求的终端交易流水号pay_trace和终端交易时间pay_time发起撤销
pay_trace String 32 N 当前支付终端流水号,与pay_time同时传递
pay_time String 14 N 当前支付终端交易时间,yyyyMMddHHmmss,全局统一时间格式,与pay_trace同时传递
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换

以上为请求参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码:01
成功 ,02
失败,响应码仅代表通信状态,不代表业务结果
return_msg String 128 Y 返回信息提示,“关单成功”、“订单不存在”等
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换
result_code String 2 N "业务结果,01
成功,表示关单成功,此笔订单不能再发起支付;
pay_type String 3 N 请求类型,020
支付宝
merchant_no String 15 N 商户号
terminal_id String 8 N 终端号
terminal_trace String 32 N 终端流水号(socket协议:长度为6位,Http协议:长度为32位)
terminal_time String 14 N 终端撤销时间,yyyyMMddHHmmss,全局统一时间格式

注意:

  • 此接口也支持支付宝,但仅限扫了二维码但没有输密码的情况下
  • 刷卡支付不能进行关单操作

退款订单查询

  • Method:POST
  • URL:/pay/fenqi/queryrefund
参数名称 类型 长度 必填 说明
pay_ver String 3 Y 版本号,当前版本110
pay_type String 3 Y 请求类型,020
支付宝,000
自动识别类型
service_id String 3 Y 接口类型,当前类型031
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
terminal_trace String 32 Y 当前终端退款查询流水号,填写商户系统的退款查询流水号
terminal_time String 14 Y 当前终端退款查询时间,yyyyMMddHHmmss,全局统一时间格式
out_refund_no String 32 Y 利楚唯一退款订单号
pay_trace String 32 N 退款终端流水号,与pay_time同时传递
pay_time String 14 N 退款终端交易时间,yyyyMMddHHmmss,全局统一时间格式,与pay_trace同时传递
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换

以上为请求参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码:01成功 ,02失败,响应码仅代表通信状态,不代表业务结果
return_msg String 128 Y 返回信息, 返回错误原因
key_sign String 32 Y 签名检验串,拼装所有非空参数+令牌(令牌名称为access_token),32位md5加密转换
result_code String 2 N 业务结果:01成功 ,02失败
pay_type String 3 N 请求类型,020 支付宝
merchant_name String 40 N 商户名称
merchant_no String 15 N 商户号
terminal_id String 8 N 终端号
terminal_trace String 32 N 当前终端退款查询流水号,扫呗系统原样返回
terminal_time String 14 N 当前终端退款查询时间,扫呗系统原样返回
refund_fee String 12 N 退款金额,单位分
end_time String 14 N 退款完成时间,yyyyMMddHHmmss,全局统一时间格式
out_refund_no String 32 N 利楚唯一退款订单号
out_trade_no String 32 N 利楚唯一原支付订单号
trade_state String 10 N 退款订单状态,SUCCESS退款成功,FAIL退款失败,REFUNDING退款中,NOREFUND退款超时等
channel_trade_no String 32 N 通道订单号,支付宝订单号等,返回时不参与签名
channel_order_no String 64 N 银行渠道订单号,退款时显示在退款成功页面的条码,可用作扫码退款查询
user_id String 32 N 退款方用户id,“支付宝账户”,返回时不参与签名
attach String 128 N 附加数据,原样返回,返回时不参与签名
pay_trace String 32 N 退款终端流水号
pay_time String 14 N 退款终端交易时间

分期费率查询

  • URL:/pay/fenqi/queryrate
  • Method:POST

注意:请求参数为空

以下为返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码:01
成功 ,02
失败,响应码仅代表通信状态,不代表业务结果
return_msg String 128 Y 返回信息提示
result_code String 2 N 业务结果:01
成功 ,02
失败
rate_list_json String 64 Y 分期费率JSON数组串

以下为rate_list_json

参数名称 类型 长度 必填 说明
periods String 2 Y 期数,3,6,12
rate String 11 Y 分期费率,千分比

© 利楚商服 2020 All rights reserved.