流量接入 API 列表

接口

预审

功能说明

在接入流程中，合作渠道在提交授信申请前调用该接口进行用户准入判断。验证用户在平台是否具有借贷申请资格，该接口超时时间为5秒，接口超时后支持重试。idNo、phone和phoneAndIdNo传一个即可，按照预定的撞库方式传，MD5采用32位。

请求URL： /ex/api/vcc/applyPretrialAudit/{channelCode}

请求方式： POST

请求参数 bizData：

name String 必填

【姓名】传入姓名，用于识别对应用户或业务对象。明文

idNo String 可选

【身份证号】传入身份证号，用于完成用户识别或联系。MD5(身份证号)

phone String 可选

【手机号】传入手机号，用于完成用户识别或联系。MD5(手机号)

phoneAndIdNo String 可选

【手机号和身份证号】传入手机号和身份证号，用于完成用户识别或联系。MD5(手机号+身份证号)

响应参数 bizData：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

businessCode String 必填

【业务状态码】用于细分接口返回的业务处理状态。0000：允许进件
1001：不允许进件(不重试)
1002：在贷用户，不允许进件
1003：用户审核失败，30天内不允许进件
1004：黑名单用户，不允许进件

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

获取静态协议

功能说明

获取静态页面（用户注册授信协议）

在接入流程中，合作渠道调用该接口获取协议模板，用于向用户展示授信相关协议。

请求URL： /ex/api/vcc/staticPage/{channelCode}

请求方式： POST

请求参数 bizData：

agreementType String 必填

【类型】用于指定类型。REGISTER:注册协议
CREDIT:授信协议

displayProtocolHeader Integer 可选

【是否展示协议头】用于控制静态协议页面是否展示协议头部。1不展示，0展示(默认)

响应参数 bizData：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

businessCode String 必填

【业务状态码】用于细分接口返回的业务处理状态。

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

data Agreement 必填

【结果】承载接口返回的业务结果数据。List列表

{
  "sign": "[String]",
  "bizData": {
    "code": "[Integer]",
    "businessCode": "[String]",
    "msg": "[String]",
    "data": [{
      "agreementName": "[String]",
      "pageUrl": "[String]"
    }]
  }
}

提交授信申请

功能说明

当进件数据不符合要求时，也会同步返回进件失败。
当用户预审通过后，通过该接口提交用户信息，由平台风控进行自动审核，待审核通过后，会分配信用额度。

在接入流程中，该接口用于提交用户授信申请；启用授信阶段个人签章时，自牧进件校验通过后授信查询返回 145 审批中，并进入待签协议处理环节。

请求URL： /ex/api/vcc/applyLoan/{channelCode}

请求方式： POST

请求参数 bizData：

orderNo String 必填

【订单号】渠道发起授信申请时生成并传入的业务订单号。渠道订单号

channelUserId String 可选

【渠道用户ID】渠道侧为用户分配的唯一标识。渠道用户ID

userName String 必填

【借款人姓名】传入借款人姓名，用于识别对应用户或业务对象。

idCardNo String 必填

【用户身份证号】传入用户身份证号，用于完成用户识别或联系。

phone String 必填

【用户手机号】传入用户手机号，用于完成用户识别或联系。

email String 可选

【用户邮箱】传入用户邮箱，用于完成用户识别或联系。

address String 必填

【详细居住地址】用于补充详细居住地址信息。省市区及之后的详细地址，不能有特殊字段，例如"l"，"！"，"？"，"。"，"，"

districtCode String 必填

【详细居住地址区域区号】用于补充详细居住地址区域区号信息。比如：传18位省市区code

province String 必填

【详细居住地址省】用于补充详细居住地址省信息。

city String 必填

【详细居住地址市】用于补充详细居住地址市信息。

district String 必填

【详细居住地址区】用于补充详细居住地址区信息。

workUnit String 可选

【单位名称】传入单位名称，用于识别对应用户或业务对象。

workUnitOfficeNum String 可选

【单位电话】传入单位电话，用于完成用户识别或联系。

workUnitAddress String 可选

【单位地址】用于补充单位地址信息。省市区及之后的详细地址，不能有特殊字段

workUnitAddressCode String 可选

【单位地址区域区号】用于补充单位地址区域区号信息。比如：传18位省市区code

workProvince String 可选

【单位地址省】用于补充单位地址省信息。

workCity String 可选

【单位地址市】用于补充单位地址市信息。

workDistrict String 可选

【单位地址区】用于补充单位地址区信息。

position String 必填

【公司性质】调用接口时用于传入公司性质。公司性质列表

industry String 必填

【公司行业】调用接口时用于传入公司行业。公司行业

loanDemandPurpose String 必填

【借款用途】用于说明用户本次申请借款的用途。借款用途枚举值列表

education String 必填

【教育程度(学历)】调用接口时用于传入教育程度(学历)。教育程度枚举值列表

occupation String 必填

【职业】调用接口时用于传入职业。职业枚举值列表

income String 必填

【收入方式】用于指定收入方式。收入方式枚举值列表

incomeRange String 必填

【收入范围】调用接口时用于传入收入范围。收入范围枚举值列表

marryStatus String 必填

【婚姻状态】用于反映婚姻状态。婚姻状态枚举值列表

hasCar Boolean 可选

【是否有车】用于标识有车情况。

hasSocialSecurity Boolean 可选

【是否有社保】用于标识有社保情况。

hasHouse Boolean 可选

【是否有房产】用于标识有房产情况。

hasCreditCard Boolean 可选

【是否有信用卡】用于标识有信用卡情况。

creditStanding String 可选

【信用状态】用于反映信用状态。1（良好）、2（无信用卡或借贷）、3（少量逾期）、4（较差）

emergencyContactNameA String 必填

【紧急联系人1姓名】传入紧急联系人1姓名，用于识别对应用户或业务对象。姓名要求是中文

emergencyContactPhoneA String 必填

【紧急联系人1手机号】传入紧急联系人1手机号，用于完成用户识别或联系。

emergencyContactRelationA String 必填

【紧急联系人1关系】调用接口时用于传入紧急联系人1关系。联系人关系枚举值列表

emergencyContactNameB String 必填

【紧急联系人2姓名】传入紧急联系人2姓名，用于识别对应用户或业务对象。姓名要求是中文

emergencyContactPhoneB String 必填

【紧急联系人2手机号】传入紧急联系人2手机号，用于完成用户识别或联系。

emergencyContactRelationB String 必填

【紧急联系人2关系】调用接口时用于传入紧急联系人2关系。联系人关系枚举值列表

authInfo json 必填

【认证信息】承载用户身份识别与实名认证相关数据。{"ocr":{}}, ocr字段见下表

ocr 字段信息

name String 必填

【姓名】传入姓名，用于识别对应用户或业务对象。

citizen_id String 必填

【身份证号】传入身份证号，用于完成用户识别或联系。

valid_date_begin String 必填

【有效期起始时间】记录有效期起始时间，便于关联业务时点。示例："20171226"

valid_date_end String 必填

【有效期截止时间】记录有效期截止时间，便于关联业务时点。示例："20171226"

address String 必填

【身份证地址】用于补充身份证地址信息。

gender String 必填

【性别】调用接口时用于传入性别。示例：男

nation String 必填

【种族】调用接口时用于传入种族。

agency String 必填

【签发机关】调用接口时用于传入签发机关。

picModel String 必填

【照片获取方式】用于指定身份证和活体图片的提供方式。1:url下载；2:图片的base64传输

idCardBaseContentA Base64 可选

【身份证正面】调用接口时用于传入身份证正面。小于100KB；当picModel=2时必填

idCardBaseContentB Base64 可选

【身份证背面】调用接口时用于传入身份证背面。小于100KB；当picModel=2时必填

livePhotoContent Base64 可选

【活体数据，人脸识别照片】调用接口时用于传入活体数据，人脸识别照片。当picModel=2时必填

idCardBaseContentAUrl String 可选

【身份证正面照片下载地址】提供身份证正面照片下载地址，便于调用方访问对应资源。当picModel=1时必填

idCardBaseContentBUrl String 可选

【身份证反面照片下载地址】提供身份证反面照片下载地址，便于调用方访问对应资源。当picModel=1时必填

livePhotoContentUrl String 可选

【活体照片下载地址】提供活体照片下载地址，便于调用方访问对应资源。当picModel=1时必填

liveType String 必填

【活体类型】用于指定本次活体检测使用的服务类型。取值为 shang_tang / teng_xun / face / link_face / yi_tu / you_tu / baidu_ps / tengxun_paas

result_idcard_photo Object 必填

【活体数据】承载指定活体服务返回的人脸比对结果。见下表，通过liveType取不同的值

result_idcard_photo 字段（按 liveType）

liveType = shang_tang

security_score Float 必填

【人脸比对得分】记录人脸比对得分，用于参考本次识别或比对结果。值为0~1，值越大表示是同一个人的可能性越大，用姓名、身份证号到第三方核查后台查询预留照片，然后与客户通过接口上传的活体数据进行比对

ref_score Float 必填

【人脸比对得分】记录人脸比对得分，用于参考本次识别或比对结果。值为0~1，值越大表示是同一个人的可能性越大，对通过接口上传的人脸照片和活体数据进行比对

liveType = teng_xun

liveRate String 必填

【活体检测分数】记录活体检测分数，用于参考本次识别或比对结果。活体检测分数

similarity String 必填

【人脸比对分数】记录人脸比对分数，用于参考本次识别或比对结果。人脸比对分数

liveType = face

thresholds Object 必填

【置信度阈值】提供人脸比对结果可参考的置信度阈值。一组用于参考的置信度阈值，包含四个字段（均为Float类型，取值[0,100]）："1e-3":千分之一误识率阈值；"1e-4":万分之一；"1e-5":十万分之一；"1e-6":百万分之一

confidence Float 必填

【比对结果的置信度】记录比对结果的置信度，用于参考本次识别或比对结果。Float类型，取值[0,100]，数字越大表示两张照片越可能是同一个人。例如：74.498

liveType = link_face

confidence Float 必填

【置信度】记录置信度，用于参考本次识别或比对结果。值为0~1，活体照片与公安部数据源比对结果，值越大表示同一个人的可能性越大

liveType = aliyun

aliyun_pass_result String 必填

【比对结果】用于反映比对结果。值为1或0；1代表通过，0代表不通过

liveType = yi_tu

yitu_pass_reuslt String 必填

【比对结果】用于反映比对结果。值为1或0；1代表通过，0代表不通过

liveType = you_tu

youtu_pass_result String 必填

【比对结果】用于反映比对结果。值为1或0；1代表通过，0代表不通过

liveType = baidu_ps

baidu_pair_verify_result String 必填

【是否同一人】用于标识同一人情况。值为1或0；0是，1否

baidu_pair_verify_similarity String 必填

【评分】记录评分，用于参考本次识别或比对结果。取值范围[0,100]

liveType = tengxun_paas

tengxun_paas_sim String 必填

【相似度】记录相似度，用于参考本次识别或比对结果。推荐相似度大于等于70时可判断为同一人

scenarioData Object 可选

【额外信息】承载当前业务场景需要补充的额外信息。当需要额外信息时，需要放入该字段

nocustomers String 可选

【首复贷】用于区分用户是首次借款还是复贷。1:首次贷款(新客)；2:复贷(老客)

bankCode String 可选

【银行编码】用于标识银行卡所属银行。

bankCardNumber String 可选

【银行卡号】传入银行卡号，用于完成用户识别或联系。

reservePhoneNumber String 可选

【银行预留手机号】传入银行预留手机号，用于完成用户识别或联系。

响应参数 bizData：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

businessCode String 必填

【业务状态码】用于细分接口返回的业务处理状态。0001：其他错误，可重试
1014：风控数据导入失败，可重试
3008：紧急联系人错误
3009：借款人地址错误
3015：保存用户详情错误，身份证与历史数据不一致
3016：保存用户详情错误，姓名与历史数据不一致
3018：用户注销后未过可注册时间，无法再次注册
1005：审核失败
1001：不允许进件
0003：参数错误
3030：没有经过预审或预审已过期

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

{
  "sign": "[String]",
  "bizData": {
    "orderNo": "[String]",
    "channelUserId": "[String]",
    "userName": "[String]",
    "idCardNo": "[String]",
    "phone": "[String]",
    "email": "[String]",
    "address": "[String]",
    "districtCode": "[String]",
    "loanDemandPurpose": "[Enum]",
    "education": "[Enum]",
    "occupation": "[String]",
    "income": "[String]",
    "incomeRange": "[Boolean]",
    "marryStatus": "[String]",
    "hasCar": "[Boolean]",
    "hasSocialSecurity": "[Boolean]",
    "hasHouse": "[Boolean]",
    "hasCreditCard": "[Boolean]",
    "creditStanding": "[String]",
    "emergencyContactNameA": "[String]",
    "emergencyContactPhoneA": "[String]",
    "emergencyContactRelationA": "[String]",
    "emergencyContactNameB": "[String]",
    "emergencyContactPhoneB": "[String]",
    "emergencyContactRelationB": "[String]",
    "authInfo": {
      "ocr": {
        "name": "[String]",
        "citizen_id": "[String]",
        "valid_date_begin": "20171226",
        "valid_date_end": "20271226",
        "address": "[String]",
        "gender": "[String]",
        "nation": "[String]",
        "agency": "[String]",
        "idCardBaseContentA": "[Base64]",
        "idCardBaseContentB": "[Base64]",
        "livePhotoContent": "[Base64]",
        "idCardBaseContentAUrl": "[String]",
        "idCardBaseContentBUrl": "[String]",
        "livePhotoContentUrl": "[String]",
        "picModel": "[String]",
        "liveType": "[String]",
        "result_idcard_photo": {
          // 根据liveType填写对应字段
        }
      }
    },
    "scenarioData": {
      "auditAmount": "申请金额",
      "auditTerm": "申请期数",
      "rate": "月利率(精确到小数点后6位)"
    }
  }
}

查询授信状态

功能说明

查询授信结果，授信结果枚举见订单状态码枚举值：140 进件成功、145 审批中、150 审批通过、151 审批拒绝。

在接入流程中，合作渠道通过该接口查询用户的授信结果和授信额度。

请求URL： /ex/api/vcc/queryApplyResult/{channelCode}

请求方式： POST

请求参数 bizData：

orderNo String 必填

【授信订单号】用于关联授信申请及其后续查询或回调。

响应参数 bizData：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

businessCode String 必填

【业务状态码】用于细分接口返回的业务处理状态。

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

data Object 必填

【结果】承载接口返回的业务结果数据。见下表

{
  "sign": "[String]",
  "bizData": {
    "code": "[Integer]",
    "businessCode": "[String]",
    "msg": "[String]",
    "data": {
      "orderNo": "[String]",
      "status": "[String]",
      "reason": "[String]",
      "approvalAmount": "[String]",
      "useAmount": "[String]",
      "approvalTerm": "[String]",
      "validDate": "[Long]"
    }
  }
}

查询额度

功能说明

查询用户当前额度状态，以及总额度和可用额度等。

在购物用信前，合作渠道通过该接口查询用户额度状态；额度有效时才可继续发起购物用信。

请求URL： /ex/api/vcc/getCreditAmount/{channelCode}

请求方式： POST

请求参数 bizData：

orderNo String 必填

【授信订单号】用于关联授信申请及其后续查询或回调。

响应参数 bizData：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

businessCode String 必填

【业务状态码】用于细分接口返回的业务处理状态。

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

data Object 必填

【结果】承载接口返回的业务结果数据。见下表

{
  "sign": "[String]",
  "bizData": {
    "code": "[Integer]",
    "businessCode": "[String]",
    "msg": "[String]",
    "data": {
      "orderNo": "[String]",
      "status": "[String]",
      "approvalAmount": "[String]",
      "useAmount": "[String]",
      "approvalTerm": "[String]",
      "validDate": "[Long]",
      "fixedAmount": "[String]",
      "temporaryAmount": "[String]",
      "temporaryDeadLine": "[Long]"
    }
  }
}

获取商城 URL

功能说明

获取商城购物以及还款跳转的 H5 页面。

在购物用信流程中，该接口用于获取便荔卡包商城首页 URL 并引导用户购物；在查账还款流程中，用于获取便荔卡包首页 URL，由页面继续引导用户查看账单并还款。

请求URL： /ex/api/vcc/getUrl/{channelCode}

请求方式： POST

请求参数 bizData：

channelOrderNumber String 必填

【授信订单号】用于获取该授信订单对应的商城页面。

searchType String 可选

【查询类型】用于指定本次需要获取的商城页面类型。不传值时返回便荔卡包首页；借款建议传值获取便荔商城首页，还款传值获取便荔卡包首页链接。查询类型枚举见获取 URL 类型。

响应参数 bizData：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

businessCode String 必填

【业务状态码】用于细分接口返回的业务处理状态。1000：用户已注销

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

data String 必填

【结果】承载接口返回的业务结果数据。

返回信息 data：

url String 必填

【url】接口返回的商城页面访问地址。跳转自牧H5链接

还款计划查询（合并）

功能说明

还款计划查询（月度维度）

在查账还款流程中，合作渠道通过该接口查询用户当月总待还金额。

请求URL： /ex/api/vcc/searchRepaymentPlan/{channelCode}

请求方式： POST

请求参数 bizData：

orderNo String 必填

【授信订单号】用于关联授信申请及其后续查询或回调。

响应参数 bizData：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

businessCode String 必填

【业务状态码】用于细分接口返回的业务处理状态。

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

data RepaymentPlan 必填

【结果】承载接口返回的业务结果数据。

{
  "sign": "[String]",
  "bizData": {
    "code": "[Integer]",
    "businessCode": "[String]",
    "msg": "[String]",
    "data": [{
      "requiredRepaymentMonth": "[String]",
      "requiredRepayment": "[String]",
      "actRepayment": "[String]",
      "dueTime": "[String]"
    }]
  }
}

还款计划查询（明细）

功能说明

在查账还款流程中，合作渠道通过该接口查询用户每笔购物借据的待还信息。

请求URL： /ex/api/vcc/searchRepaymentAllPlan/{channelCode}

请求方式： POST

请求参数 bizData：

orderNo String 必填

【授信订单号】用于关联授信申请及其后续查询或回调。

consumerOrderNo String 必填

【消费订单号】商户下单时传入的商户系统内部订单号。

响应参数 bizData：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

businessCode String 必填

【业务状态码】用于细分接口返回的业务处理状态。

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

data RepaymentPlan 必填

【结果】承载接口返回的业务结果数据。

返回信息 data：

orderNo String 必填

【授信订单号】用于关联授信申请及其后续查询或回调。

consumerOrderNo String 必填

【消费订单号】商户下单时传入的商户系统内部订单号。

totalRepaymentAmount String 必填

【应还总金额】用于返回应还总金额。

totalReduceRepayment String 必填

【总减免金额】用于返回总减免金额。

totalActRepayment String 必填

【实还金额】用于返回实还金额。

repaymentPlan RepaymentPlan 必填

【每期的还款计划】包含该订单各期的还款计划明细。List列表

RepaymentPlan 属性

periodNo String 必填

【期数】用于说明期数。

repaymentStatus Integer 必填

【还款状态】用于反映还款状态。0（未还款）；2（已逾期）；3（已还款）；4（部分入账）

principal String 必填

【本金】用于传入本金。

interest String 必填

【利息】用于传入利息。

overdueInterest String 必填

【罚息】用于传入罚息。

serviceFee String 必填

【服务费】用于传入服务费。

dueTime String 必填

【还款日期（到期时间）】调用接口时用于传入还款日期（到期时间）。yyyy-MM-dd

requiredRepayment String 必填

【应还金额】用于传入应还金额。

actPrincipal String 必填

【实还本金】用于传入实还本金。

actInterest String 必填

【实还利息】用于传入实还利息。

actServiceFee String 必填

【实还服务费】用于传入实还服务费。

actOverdueInterest String 必填

【实还罚息】用于传入实还罚息。

repayAmount String 必填

【实还金额】用于传入实还金额。

reduceInterest String 必填

【减免利息】用于传入减免利息。

reduceServiceFee String 必填

【减免服务费】用于传入减免服务费。

reduceOverdueInterest String 必填

【减免罚息】用于传入减免罚息。

reduceAmount String 必填

【减免总金额】用于传入减免总金额。

repayTime String 必填

【实际还款时间】记录实际还款时间，便于关联业务时点。yyyy-MM-dd

hasAllPaid Integer 必填

【是否结清】用于标识该订单是否已结清。1：未结清；2：已结清；3：退货结清

已签章协议上传

功能说明

渠道完成个人电子签章后，主动通知我方签章处理结果；该接口作为签章结果回传的主路径，查询接口（6.6）作为通知失败、网络异常或状态不一致时的兜底能力。

请求URL： /ex/api/vcc/uploadContract/{channelCode}

请求方式： POST

请求参数 bizData：

orderNo String 必填

【授信订单号】用于关联授信申请及其后续查询或回调。需与授信申请订单号、待签协议通知中的orderNo一致

signApplyNo String 必填

【本次签约申请流水号】用于关联同一次协议签署申请及其后续结果。需与待签协议通知中的signApplyNo一致

status String 必填

【签章处理状态】用于反映签章处理状态。1=签章完成，0=签章失败

failCode String 可选

【签章失败编码】用于唯一标识签章失败编码。签章失败时返回，用于问题定位和补签处理

failMsg String 可选

【签章失败原因】调用接口时用于传入签章失败原因。签章失败时返回，描述失败原因

contractInfo List\<Contract\> 可选

【已签章协议列表】包含本次业务关联的已签章协议信息。签章成功时必填，签章失败时可为空

响应参数 bizData：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

businessCode String 必填

【业务状态码】用于细分接口返回的业务处理状态。0000：上传成功；0010：上传失败

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

回调推送

授信结果推送

功能说明

在订单被审核后，会推送订单审核状态给渠道：150 表示审批通过，151 表示审批拒绝。回调的响应参数明文返回。

在授信流程中，自牧通过该接口主动向合作渠道推送用户的授信结果。

请求URL： 渠道提供

请求方式： POST

请求参数 bizData：

orderNo String 必填

【授信订单号】用于关联授信申请及其后续查询或回调。

loanStatus String 必填

【订单状态码】回调中用于传递订单状态码。订单状态码

approvalAmount String 必填

【授信金额】用于返回授信金额。授信通过必填

approvalTerm String 必填

【审批期数】用于说明审批期数。授信通过必填，状态为审批通过时，不为空

validDate Long 必填

【额度到期日】记录额度到期日，便于关联业务时点。授信通过必填，10位时间戳

channelUserId String 待确认：原文未说明

【渠道用户id】渠道侧为用户分配的唯一标识。渠道用户id（如果进件有传就有，进件没传可以没有）

creditTime Long 必填

【授信时间】记录授信时间，便于关联业务时点。授信通过必填，10位时间戳

reason String 可选

【拒绝原因】回调中用于传递拒绝原因。

响应参数：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

{
  "sign": "[String]",
  "bizData": {
    "orderNo": "[Integer]",
    "loanStatus": "[Integer]",
    "approvalAmount": "[String]",
    "approvalTerm": "[Integer]",
    "validDate": "[Long]"
  }
}

{
  "code": "[Integer]",
  "msg": "[String]"
}

订单推送

功能说明

用户在商城购物下单成功后，自牧通过该接口将订单借据信息推送给合作渠道。

请求URL： 渠道提供

请求方式： POST

请求参数 bizData：

orderNo String 必填

【授信订单号】用于关联授信申请及其后续查询或回调。

consumerOrderNo String 必填

【消费订单号】商户下单时传入的商户系统内部订单号。

term String 必填

【期数】用于说明期数。

orderAmount String 待确认：原文未说明

【订单金额】用于返回订单金额。

goodsName String 待确认：原文未说明

【商品名称】传入商品名称，用于识别对应用户或业务对象。

orderTime String 待确认：原文未说明

【下单时间】记录下单时间，便于关联业务时点。yyyy-MM-dd HH:mm:ss

updateTime String 待确认：原文未说明

【通知时间】记录通知时间，便于关联业务时点。yyyy-MM-dd HH:mm:ss

响应参数：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

{
  "sign": "[String]",
  "bizData": {
    "orderNo": "[String]",
    "consumerOrderNo": "[String]",
    "term": "[String]",
    "orderAmount": "[String]",
    "goodsName": "[String]",
    "orderTime": "[String]",
    "updateTime": "[String]"
  }
}

{
  "code": "[Integer]",
  "msg": "[String]"
}

订单状态推送

功能说明

当订单状态变更时，会推送当前订单状态给渠道：200 表示贷款结清，210 表示退货结清。

在购物用信后，用户退货或结清时，自牧通过该接口主动向合作渠道推送订单状态变化。

请求URL： 渠道提供

请求方式： POST

请求参数 bizData：

orderNo String 必填

【授信订单号】用于关联授信申请及其后续查询或回调。

consumerOrderNo String 必填

【消费订单号】商户下单时传入的商户系统内部订单号。

loanStatus String 必填

【订单状态码】回调中用于传递订单状态码。订单状态码枚举值

updateTime String 必填

【更新时间】记录更新时间，便于关联业务时点。10位时间戳

响应参数：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

{
  "sign": "[String]",
  "bizData": {
    "orderNo": "[String]",
    "consumerOrderNo": "[String]",
    "loanStatus": "[String]",
    "updateTime": "[String]"
  }
}

{
  "code": "[Integer]",
  "msg": "[String]"
}

提额推送

功能说明

当额度变更时，会推送当前额度给渠道。

提额完成后，自牧通过该接口将用户提额信息推送给合作渠道，渠道可据此展示提额信息并引导用户购物。

请求URL： 渠道提供

请求方式： POST

请求参数 bizData：

orderNo String 必填

【授信订单号】用于关联授信申请及其后续查询或回调。

type String 必填

【额度调整类型】用于指定额度调整类型。01：固定提额；02：临时提额

amount String 必填

【额度调整金额】用于返回额度调整金额。

startTime String 必填

【生效时间】记录生效时间，便于关联业务时点。

endTime String 必填

【到期时间】记录到期时间，便于关联业务时点。

响应参数：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

{
  "sign": "[String]",
  "bizData": {
    "list": [
      {
        "amount": "1111",
        "endTime": "2025-02-26 10:40:06",
        "orderNo": "6666",
        "startTime": "2025-02-26 10:40:05",
        "type": "01"
      },
      {
        "amount": "2222",
        "endTime": "2025-02-26 10:40:06",
        "orderNo": "6666",
        "startTime": "2025-02-26 10:40:06",
        "type": "02"
      }
    ]
  }
}

{
  "code": "[Integer]",
  "msg": "[String]"
}

待签协议推送

功能说明

授信提交成功后下发需要渠道完成个人电子签章的协议。渠道方使用 templateFileUrl 下载我方生成的待签PDF，按 signMethod 和 signKeyword 完成签章，完成签章后调用5.9上传已签章协议。

请求URL： 渠道提供

请求方式： POST

请求参数 bizData：

orderNo String 必填

【授信订单号】用于关联授信申请及其后续查询或回调。与授信申请订单号一致

signApplyNo String 必填

【本次签约申请流水号】用于关联同一次协议签署申请及其后续结果。我方生成的本次签约申请流水号。同一orderNo因重发、补签或重新签署产生多次签约时，用于区分不同签约批次

userName String 必填

【用户姓名】传入用户姓名，用于识别对应用户或业务对象。

idCardNo String 必填

【用户身份证号】传入用户身份证号，用于完成用户识别或联系。

phone String 必填

【用户手机号】传入用户手机号，用于完成用户识别或联系。

templates List\<Object\> 必填

【协议列表】包含本次待签的协议模板信息。协议对象数组，原则上只下发需要渠道完成个人电子签章的协议

响应参数：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

{
  "sign": "签名",
  "bizData": {
    "orderNo": "af9bb8c94fad42729cc5a80df22d42d0",
    "signApplyNo": "1078cac356e04fa883abff35eb434009",
    "userName": "张三",
    "idCardNo": "[待确认：请提供已审核的脱敏示例]",
    "phone": "[待确认：请提供已审核的脱敏示例]",
    "templates": [
      {
        "templateCode": "882129",
        "templateName": "用户授权协议",
        "templateFileUrl": "https://example.com/1078cac356e04fa883abff35eb434009.pdf",
        "signMethod": "KEYWORD",
        "signKeyword": "signKeyword"
      },
      {
        "templateCode": "8822122",
        "templateName": "用户注册协议",
        "templateFileUrl": "https://example.com/1078cac356e04fa883abff35eb434021.pdf",
        "signMethod": "KEYWORD",
        "signKeyword": "signKeyword"
      }
    ]
  }
}

{
  "code": "[Integer]",
  "msg": "[String]"
}

签章结果查询

功能说明

该接口用于已签章协议上传失败、网络异常、状态不一致或超时未收到签章文件时的兜底查询。

请求URL： 渠道提供

请求方式： POST

请求参数 bizData：

orderNo String 必填

【授信订单号】用于关联授信申请及其后续查询或回调。与授信申请订单号一致

signApplyNo String 必填

响应说明

与其他回调接口明文返回不同，该接口响应涉及协议文件地址等敏感信息，需要进行加密处理。加密规则与接口（5.x）同步响应的加密逻辑相同，即先签名再 AES 加密。

响应格式（加密后）：

bizData 解密后的明文结构：

code Integer 必填

【响应码】用于标识本次接口请求的处理结果。0成功，-1失败

msg String 必填

【响应状态码描述信息】用于说明响应码或业务状态对应的结果信息。

data Object 待确认：原文未说明

【结果】承载接口返回的业务结果数据。见下表

数据字典

教育程度枚举值列表

枚举	描述
MASTER	硕士及以上
UNDER_GRADUATE	本科
JUNIOR_COLLEGE	大专
TECHNICAL_SECONDARY_SCHOOL	中专
TECHNICAL_SCHOOL	技校
HIGH_SCHOOL	高中
MIDDLE_SCHOOL	初中
PRIMARY_SCHOOL	小学
OTHER	其他

职业枚举值列表

枚举	描述
WORKER	工人
TEACHER	教师
WHITE_COLLAR	白领
CAREER_BUILDER	创业者
SELF_EMPLOYER	个体户
EMPLOYEE	公司职员
BISUNESS_ENTITY	企业法人
ONLINE_STORE_OWNER	网店店主
UNEMPLOYED	暂无职业
OTHER	其他

收入方式枚举值列表

枚举	描述
CASH	现金计算
PAY_CARD	工资卡
CASH_AND_PAY_CARD	混合

收入范围枚举值列表

枚举	描述
BELOW_1000	小于1000元
BELOW_3000	1000至3000元
BELOW_5000	3000至5000元
BELOW_8000	5000至8000元
BELOW_10000	8000至10000元
BELOW_15000	10000至15000元
BELOW_20000	15000至20000元
ABOVE_20000	大于20000元

联系人关系枚举值列表

枚举	描述
PARENT	父母
CHILDREN	子女
BROTHER	兄弟姐妹
COLLEAGUE	同事
CLASSMATE	同学
FRIEND	朋友
SPOUSE	夫妻
SELF	本人
OTHER	其他

婚姻状态枚举值列表

枚举	描述
SINGLE	未婚
MARRIED	已婚
DIVORCED	离异
WINDOWED	丧偶
OTHER	其他

借款用途枚举值列表

枚举	描述
PERSONAL_DAILY_CONSUMPTION	个人日常消费（渠道无需提供，平台特有）
HOUSEHOLD_ELECTRIC_APPLIANCES	家用电器
MOBILE_DIGITAL	手机数码
FAMILY_DECORATION	家庭装修
SHOPPING	电商购物
GAME	游戏
FURNITURE_HOME	家具家居
TOURIST_HOLIDAY	旅游度假
RENTAL	租房
EDUCATION_AND_TRAINING	教育培训
WEDDING	婚庆
HEALTH_CARE	健康医疗

订单状态码列表

状态码	描述
140	进件成功
145	审批中
150	审批通过
151	审批拒绝
152	贷前关闭订单
160	提现成功
167	放款中
170	放款成功
171	放款失败
200	贷款结清
210	退货结清
300	用户已注销

银行编码

银行code	银行名称
ICBC	工商银行
BOC	中国银行
CCB	建设银行
POST	邮政储蓄银行
ECITIC	中信银行
CEB	光大银行
CMBC	民生银行
GDB	广发银行
CMBCHINA	招商银行
CIB	兴业银行
PINGAN	平安银行
HXB	华夏银行
SPDB	浦发银行
ABC	农业银行
BOCO	交通银行
BCCB	北京银行
SHB	上海银行

公司性质

公司性质code	描述
DEFAULT	默认
FOREIGN	外商投资企业
INDIVIDUAL	个体工商户
GOVERNMENT	政府机关
PRIVATE	私营
STATE_OWN	国企
JOINT	合资
PEOPLE_PRIVATE	民营
BUSINESS_UNIT	事业单位
LIMITED	有限责任公司
JOINT_STOCK	股份责任公司
SOLO	独资企业
PARTNERSHIP	合伙制企业
OTHER	其他

公司行业列表

公司行业code	描述
AGRICULTURE	农、林、牧、渔、养殖种植业
MANUFACTURING	制造、工程、加工、采矿业
ELECTRIC	电力、燃气、水产供应业
BUSINESS_SERVICE	商业服务、住宿餐饮、零售业
REAL_ESTATE	建筑、房地产、出版
FINANCIAL	金融业、保险、证券
STYLISTIC	文化、体育、娱乐业
COMPUTER	计算机、互联网、信息技术服务业
SCIENCE_EDUCATION	教育、科学研究和技术服务业
TRAFFIC	交通、运输、政府、公共管理

获取 URL 类型

查询类型	描述
MALL_HOME_PAGE_URL	获取便荔商城首页 H5 链接
CARD_BAG_URL	获取便荔卡包首页 H5 链接