2.7 历史订单同步
简要描述:
- 该接口并非标准公开接口,需要企业联系服务商开通该接口权限后方可调用。
- 该接口用于,将已经结算完成的历史订单,同步至我方平台系统实时提现订单,同步订单时,我方系统并不会进行真实结算,只是将订单入库,并进行相关记账。
- 该接口有IP白名单校验,请先进入我们平台完成IP白名单配置。
- 同步结果最终通过2.6-ti-xian-jie-guo-hui-tiao.md回调通知。
请求头参数:
Authorization: Bearer [accessToken]
请求URL:
- /orders/history/add
请求方式:
- POST
参数:
请求参数说明
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
参数 | 类型 | 是否必须 | 说明 |
tradeNo | string | 是 | 企业订单号,订单唯一标示 |
bizFee | BigDecimal | 是 | 业务经营费用(个人到手) |
baseFee | BigDecimal | 是 | 根据合同费率计算来的企业需要外支付的基础服务费。bizFee+baseFee+channelFee=该笔订单,企业需要支付给服务商的总费用 |
channelFee | BigDecimal | 是 | 支付手续费,单位元,如果没有,请传0 |
projectId | string | 否 | 项目Id,当接口指定项目时,会将订单关联指定项目,当没有指定时,系统默认关联最新的有效项目。当调用方项目场景单一时,可以不传,如果有多个项目场景,建议传值。 |
providerId | string | 是 | 服务商ID,当有多个服务商时,必填 |
name | string | 是 | 姓名 |
employeeNo | string | 否 | 自由职业者在企业编号 |
papersType | int | 是 | 证件类型 0:身份证 |
papersNo | string | 是 | 收款人证件号码 |
bankCardNo | string | 是 | 收款账号/银行卡/支付宝账号 |
bankName | string | 否 | 收款人银行卡/支付宝预留姓名 |
bankPhone | string | 是 | 收款人手机号 |
payMonth | string | 是 | 业务发生时间,格式2022-01-01 12:00:00,如果不确定业务发生时间,可以 可以使用支付时间。 |
payTime | string | 是 | 支付时间,时间格式 2022-12-01 12:21:35 |
bizGroup | string | 否 | 用来根据用户的业务类型对订单归集进行自定义分组的标识,建议必填,长度在32个字符串以内。 |
nonce | string | 是 | 随机字符串,长度要求在32位以内。推荐随机数生成算法 |
sign | string | 是 | 通过签名算法计算得出的签名值,详见签名生成算法 |
notifyUrl | string | 否 | 接收该订单处理结果的后端回调url。当该url没有传值时,系统会使用后台开发者配置中的回调链接。注意:该url必须为可以直接访问的http链接,例如:https://www.baidu.com |
paymentType | int | 是 | 个人账户收款方式,当绑定了多个收款方式时,该参数必填。1:银行卡 2:支付宝 |
extendParams | string | 否 | 扩展参数,回调时原文返回,建议JsonString格式。长度限制256。 |
返回结果示例
成功示例
{
"id": "***",
"tradeNo": "***",
"corpId": "***",
"bizFee": "***",
"status": 6,
"created": "2019-04-16 15:35:34",
"providerId": "200213842716786688",
"employeeNo": "1",
"employeeId": "***",
"bankCardNo": "***",
"bankName": "***",
"bankPhone": "***",
"name": "***",
"papersNo": "***",
"papersType": 0,
"sex": 1,
"birthday": 30
}
失败示例
{
"error": "BadRequest",
"message": "ip不在白名单中"
}
响应参数说明
参数 | 类型 | 说明 |
---|---|---|
id | string | 平台订单唯一id |
tradeNo | string | 企业订单号,订单唯一标示 |
corpId | string | 企业id |
bizFee | BigDecimal | 业务经营费用(个人到手) |
status | int | 订单状态:0:支付中,1:支付成功,9:支付失败 |
created | Date | 下单时间 |
providerId | string | 服务商ID |
bankCardNo | string | 银行卡号 |
bankName | string | 银行卡预留姓名 |
bankPhone | string | 银行卡预留手机 |
name | string | 姓名 |
papersNo | string | 证件号 |
papersType | int | 证件类型 0:身份证 |
employeeNo | string | 自由职业者工号 |
employeeId | string | 自由职业者在平台唯一编号 |
sex | string | 性别 |
birthday | string | 出生日期 |