通用场景
芝麻go签约三件套前预创建单据,预传入签约基本参数和自定义配置,并支持动态模板配置能力。
公共请求参数
业务请求参数
partner_id必选string(16)
【描述】商户id
【示例值】2088437463829741
template_id必选string(64)
【描述】签约芝麻go的模板id
【示例值】2020122200020903760008552025
out_request_no必选string(128)
【描述】外部请求号,唯一
【示例值】order_12345678
biz_time必选date(32)
【描述】业务发生时间,如2016-07-06 00:00:02
签约超时关单时间依赖这个时间
这个时间会做幂等校验,如果创单幂等,但时间不同会失败
【示例值】2016-07-06 00:00:02
以下参数 可选 传入
alipay_user_idstring(16)
【描述】支付宝用户id。同一个外部请求号,调用方要确保支付宝userid取值不变
新商户建议使用alipay_open_id替代该字段。对于新商户,alipay_user_id字段未来计划逐步回收,存量商户可继续使用。如使用alipay_open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看openid配置申请。
【示例值】2088759402857364
alipay_open_id|支付宝openidstring(128)
【描述】支付宝用户id。同一个外部请求号,调用方要确保支付宝userid取值不变 详情可查看 openid简介
【示例值】074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5
freeze_amount可选price(10)
【描述】冻结金额,单位:元
【示例值】1.00
timeout_express可选string(20)
【描述】超时关单时间
默认1h。1m~15d。m表示分钟,h表示小时,d表示天。该参数数值不接受小数点, 如1.5h,可转换为90m
签约超时关单时间依赖这个时间
【示例值】15m
partner_user_identifier可选string(64)
【描述】商户侧用户唯一标识。ex.商户侧uid
【示例值】user102934889234
isv_pid可选string(16)
【描述】isv商户id
【示例值】2088374762857463
sign_aisle_data可选string(1024)
【描述】签约成功后通知
【示例值】业务方签约标识
expire_aisle_data可选string(1024)
【描述】协议到期后通知
【示例值】业务方到期标识
pay_aisle_data可选string(1024)
【描述】结算成功后通知
【示例值】业务方结算标识
custom_temp_conf可选string(1024)
【描述】废弃字段,勿用
【示例值】show_agreement_list=true
extend_params可选preorderextinfo
【描述】扩展参数
order_feature可选string(1024)
【描述】单据属性,风控系统使用
【示例值】merchant_id@@@2088123456123456|||merchant_name@@@张三营业厅
brand_id可选string(128)
【描述】品牌id
【示例值】123
brand_name可选string(100)
【描述】品牌名称
【示例值】豫章人家
channel可选string(100)
【描述】请求渠道
【示例值】app, alipayminiapp, taobao
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=zhima.credit.pe.zmgo.preorder.create&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'biz_content={
"custom_temp_conf":"show_agreement_list=true",
"freeze_amount":"1.00",
"extend_params":{
"order_feature":"merchant_id@@@2088123456123456|||merchant_name@@@张三营业厅",
"channel":"app, alipayminiapp, taobao",
"brand_name":"豫章人家",
"brand_id":"123"
},
"sign_aisle_data":"业务方签约标识",
"alipay_user_id":"2088759402857364",
"isv_pid":"2088374762857463",
"pay_aisle_data":"业务方结算标识",
"partner_id":"2088437463829741",
"alipay_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
"timeout_express":"15m",
"biz_time":"2016-07-06 00:00:02",
"template_id":"2020122200020903760008552025",
"out_request_no":"order_12345678",
"expire_aisle_data":"业务方到期标识",
"partner_user_identifier":"user102934889234"
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
preorder_no必选string(64)
【描述】芝麻go预创建单号
【示例值】zmgo_aso2019071000020903940000062019
partner_id必选string(16)
【描述】商户id
【示例值】2088990000000000
biz_type必选string(64)
【描述】业务类型
【示例值】hongbaoqiandao
响应示例
正常示例
异常示例
{
"zhima_credit_pe_zmgo_preorder_create_response": {
"code": "10000",
"msg": "success",
"preorder_no": "zmgo_aso2019071000020903940000062019",
"partner_id": "2088990000000000",
"biz_type": "hongbaoqiandao"
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |
acquire_user_lock_fail | 用户锁获取失败 | 用户维度操作并发导致,建议请求频率放低 |
custom_freeze_amount_not_support | 不支持自定义冻结金额 | 商户不支持自定义冻结金额 |
freeze_amount_invalid | 冻结金额不合法 | 冻结金额大于0且小于等于模板配置 |
merchant_agreement_check_failed | 商户合约非法 | 请检查商户合约是否签署,状态是否正常 |
notify_url_not_support | 不支持自定义的商户通知地址 | 当前商户不支持自定义的商户通知地址,如有需要请联系芝麻go方处理。 |
not_support_dynamic_template | 凯发app官方网站的解决方案不支持动态模板 | 凯发app官方网站的解决方案不支持动态模板,如有需要请联系芝麻go同学 |
order_has_closed | 订单已超时关闭 | 订单已超时关闭,建议换单 |
order_indepotent_failed | 单据幂等失败 | 单据幂等命中,关键要素一致校验失败。请检查两次请求关键参数是否一致 |
request_access_illegal | 请求被拦截 | 检查调用信息是否合法(调用的小程序id和操作数据的商户pid是否一致) |
template_invalid | 模板状态异常 | 模板异常,请联系业务 |