使用场景:用于多阶段订单分期付款后履约确认
接口编号:alipay.open.mini.order.installment.create
请求参数(bizdata):
参数 | 参数名称 | 取值 | 可空 | 类型 | 备注 |
---|---|---|---|---|---|
out_installment_order_id |
外部分期 单号 |
【描述】分期单外部请求号 由商家自定义,64个字符以内 仅支持字母、数字、下划线且需保证在商户端不重复 其他请求参数不变时重复请求会幂等返回分期单号 |
否 | string[1,64] | |
type | 分期类型 |
【描述】分期类型 【枚举值】 租金: RENT 买断: BUYOUT 续租: RELET 代扣: WITHHOLD 运费: FREIGHT 保险费: INSURANCE 违约金: LATE_FEE 赔付金: INDEMNITY 追加扣款: ADDITION 【注意事项】 创建订单如果传入阶段付款计划 改类型不允许传入RELET 如果是租金类型请传入RENT 【示例值】WITHHOLD |
否 | string[0,32] | |
order_id |
交易组件 订单号 |
【描述】交易组件订单号 | 否 | string[1,34] |
order_id out_order_id 两者任选其一传入 必传 |
out_order_id |
外部商户 订单号 |
【描述】外部商户订单号 | 否 | string[1,32] | |
user_id | 买家ID | 【描述】2088开头的16位纯数字 | 否 | string[1,32] |
user_id open_id 两者任选其一传入 必传 |
open_id |
支付宝用 户唯一标 识 |
【描述】支付宝用户唯一标识 | string[1,128] | ||
installment_price | 分期金额 |
【描述】当分期类型为RENT 期数为1时,分期金额=首期金额 期数非1时,分期金额=每期金额 如果有尾期金额,最后一期分期金额=尾期金额 当分期类型为BUYOUT 分期金额=买断价 buyout_price 当分期类型为RELET 分期金额即续租金额 【必选条件】 当交易组件订单类型为STANDARD_RENT时必传 【示例值】10.00 |
是 | price(0.00,1000000] | |
installment_no_type |
分期号类 型 |
【描述】分期数类型 【枚举值】 期数: PERIOD 【必选条件】 当传入installment_no字段时,该字段必填 【示例值】PERIOD |
是 | string[1,10] | |
installment_no |
本次分期 号 |
【描述】当前分期数 【必选条件】 当分期单类型type=RENT或type=WITHHOLD时 该字段必填 【示例值】1 |
是 | string[1,34] | |
trade_no | 交易号 | 【描述】支付宝收单交易号 | 是 | string[1,100] | |
is_finish_performance |
分期是否 完结 |
【描述】分期是否已经完结 false:未完结 true:已完结 |
是 | boolean | |
pay_channel |
分期单支付 渠道 |
【描述】用户分期扣款的支付方式 【枚举值】 支付宝支付: ALIPAY 微信支付: WECHAT 其他: OTHER |
是 | string[1,32] | |
stage_no |
分期阶段 编码 |
【描述】分期的阶段编码 与创建时的阶段付款计划里的阶段编码对应 【示例值】1 |
是 | number[1,5] | |
is_sync_pay |
是否同步 主动支付 |
【描述】分期单同步模式请传入true 该模式会直接推进分期单进入结算阶段 【示例值】true |
是 | boolean |
响应参数(bizdata):
参数 | 参数名称 | 取值 | 可空 | 类型 | 备注 |
---|---|---|---|---|---|
installment_order_id | 分期单号 | 在代扣等场景下使用 | 否 | string(34) |
请求报文样例:
{"installment_price":10,"is_finish_performance":true,"user_id":"2088102318125883","period_num":1,"out_installment_order_id":"outioi1721182430365","installment_no_type":"PERIOD","stage_no":1,"type":"WITHHOLD","order_id":"2024071701502300000008830039515021","out_request_no":"outreqn1721182430365","installment_no":"1"}
返回报文样例:
{"installment_order_id":"2024071701502301900008830002482148"}
业务错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
SYSTEM_ERROR | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
INVALID_PARAMETER | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |
ADDON_PERIOD_NUM_INVALID | 续租期数参数无效 | 续期租期范围1-12,请填写正确的续租总期数 |
ADDON_PERIOD_NUM_IS_NULL | 续租期数参数为空 | 续租场景,请填写正确的续租总期数 |
INSTALLMENT_FINISH_INVALID | 分期是否完成传参错误 | 请传入正确的分期是否完成 |
INSTALLMENT_PERIOD_NUM_INVALID | 期数无效 | 请传入正确的期数 |
INSTALLMENT_PERIOD_NUM_IS_NULL | 期数为空 | 请传入正确的期数 |
INSTALLMENT_TYPE_INVALID | 分期类型不正确 | 请传入正确的分期类型 |
MRCH_ORDER_ERROR | 订单处理错误 | 创建订单分期 |
ORDER_AND_OUT_ORDER_NULL | 外部订单号与交易组件订单号二者选一 | 外部订单号与交易组件订单号二者选一 |
ORDER_ID_NOT_EXIST | 订单不存在 | 请传入正确的订单号 |
ORDER_MERCHANT_MISMATCH | 商家订单不匹配 | 当前订单对应的商家ID与小程序不匹配,请传入正确的订单号 |
ORDER_USER_ID_INVALIDATE | 订单UID不匹配 | 请传入正确的用户ID |
OUT_ORDER_ID_INVALIDATE | 商户订单号无效 | 请确认传入的商家订单号是否正确 |
PARAMS_VALID_ERROR | 参数非法 | 参数非法 |
PARAM_IS_NULL | 参数为空 | 请传入正确的参数 |
PAY_CHANNEL_TYPE_INVALID | 支付渠道类型非法 | 支付渠道类型非法,请传入正确的支付渠道类型 |
PAY_CHANNEL_TYPE_IS_NULL | 支付渠道为空 | 支付渠道为空,请传入支付渠道 |
RENT_ITEM_QUANTITY_INVALID | 租赁商品数量非法 | 租赁商品数量非法 |
STATUS_INVALID | 订单状态不正确 | 该订单不支持分期 |
TRADE_NO_IS_NULL | 交易号为空 | 交易号为空,请传入交易号 |
USER_ID_IS_NULL | 用户ID不能为空 | 请传入正确的用户 |