问卷/试卷服务
成长值服务
短信服务

结算支付


1. 支付发起

POST https://tcc-dev.interlib.com.cn/api/tcc-settlement/open-api/payment
消耗
  • application/json
生成
  • */*
参数
名称 说明 类型
orgId
必填
所属租户 integer (int64)
userId
必填
关联用户 integer (int64)
userType
必填
关联用户类型
0/普通用户,1/读者证账户
integer (int32)
paymentTypeCode
必填
支付方式代码
样例 : "WX_NATIVE"
string
fee
必填
订单金额
需小于1w,并保留两位小数
number
financialType
必填
财经类型 string
content
必填
业务数据 string
operator
必填
操作员 string
authCode
可选
(付款码支付必填)
付款码的数字编号
string
body
可选
(扫码或付款码支付必填)
商品简单描述
string
globalid
可选
(统一支付必填)
馆唯一代码
string
kpSign
可选
是否已开发票
0/无需,1/未开,2/已开
integer (int32)
remark
可选
备注 string
调用示例
{
  "authCode": "string",
  "body": "string",
  "content": "[
    {
      'additionalProp1': 'string',
      'additionalProp2': 'string',
      'additionalProp3': 'string'
    }
  ]",
  "fee": 0,
  "financialType": "string",
  "globalid": "string",
  "kpSign": 0,
  "orgId": 0,
  "userId": 0,
  "userType": 0,
  "operator": "string",
  "paymentTypeCode": "WX_NATIVE",
  "remark": "string"
}
响应
HTTP代码 说明 类型
200 OK RestData
201 Created 无内容
401 Unauthorized 无内容
403 Forbidden 无内容
404 Not Found 无内容
响应示例
{
	"code": 200,
	"data": {
  		"orderId": "string",
      "qrCodeUrl": "string",
      "financialIdList": [01, 02]
      "status": 0
	},
	"desc": ""
}

1) 基础入参说明

1. authCode

付款码的数字编号

2. body书写规范

微信接口参数规定 第七项

3. content

JSON字符串数组,根据业务系统自己定义数据内容,将按一致的JSON格式存入数据库。

当多笔财经同时结算时,JSON数组的每个对象都必须包含字段 "fee" 来指定该笔财经金额,且其总和需与订单金额一致。

例如:

[{
  "RDTYPE": "001d",
  "FEETYPEDESCRIBE": "工本费",
  "RDID": "001",
  "TRANID": "1194623864266498216498298",
  "RDNAME": "王子",
  "FEETYPE": "102",
  "RDCERTIFY": "",
  "RDTYPEDESCRIPE": "D类",
  "fee": "0.01"
},{
   "RDTYPE": "001d",
   "FEETYPEDESCRIBE": "工本费",
   "RDID": "001",
   "TRANID": "1194623864266498216498299",
   "RDNAME": "王子",
   "FEETYPE": "102",
   "RDCERTIFY": "",
   "RDTYPEDESCRIPE": "D类",
   "fee": "0.03" 
},...]

4. financialType

财经类型业务系统自己处理,结算服务不规定该类型

2) 支付方式代码

支付方式代码 支付方式名称
PRE_CREATE 订单预创建(无支付)
OFFLINE_CNY 线下人民币付款
UNION_AUTH 银联付款码支付
UNION_SCAN 银联扫码支付
ALIPAY_FKM 支付宝付款码支付
ALIPAY_MOBILE 支付宝手机网站支付
ALIPAY_PC 支付宝PC网站支付
WX_FKM 微信付款码支付
WX_NATIVE 微信原生扫码支付

** 后续会支持

支付方式代码 支付方式名称
ALIPAY_APP 支付宝APP支付
WX_JSAPI 微信H5支付
WX_APP 微信APP支付
OFFLINE_ICCARD IC卡余额付款
ONLINE_BALANCE 在线预缴费付款
ONLINE_CREDIT 在线积分付款

2. 状态查询

GET https://tcc-dev.interlib.com.cn/api/tcc-settlement/open-api/payment/{orderId}
消耗
  • application/json
生成
  • */*
参数
名称 说明 类型
orderId
必填
订单ID string
operator
必填
操作员 string
调用示例

GET https://tcc-dev.interlib.com.cn/api/tcc-settlement/open-api/payment/406d9c3c-b688-41ed-b40a-c55b6f29?operator=string

响应
HTTP代码 说明 类型
200 OK RestData
201 Created 无内容
401 Unauthorized 无内容
403 Forbidden 无内容
404 Not Found 无内容
响应示例
{
  "code": 200,
  "data": 0,
  "desc": "操作成功"
}

1) 支付状态说明

支付状态代码 支付状态描述
0 未支付
1 已支付
2 已取消
3 已退款

2) 状态查询说明

目前支付中心暂不支持支付回调,故支付状态的更新需通过调用接口轮询的方式实现。支付中心建议的轮询时间为3分钟,频率为6-10秒一次,可根据需求自行调整,可随时手动调用查询接口更新。


3.已付退款

DELETE https://tcc-dev.interlib.com.cn/api/tcc-settlement/open-api/payment/{orderId}
消耗
  • application/json
生成
  • */*
参数
名称 说明 类型
orderId
必填
订单ID string
operator
必填
操作员 string
refundFee
可选
退款金额 string
调用示例

DELETE https://tcc-dev.interlib.com.cn/api/tcc-settlement/open-api/payment/406d9c3c-b688-41ed-b40a-c55b6f29?operator=string

响应
HTTP代码 说明 类型
200 OK RestData
201 Created 无内容
401 Unauthorized 无内容
403 Forbidden 无内容
404 Not Found 无内容
响应示例
{
  "code": 200,
  "data": true,
  "desc": "操作成功"
}

1) 退款相关说明

  1. 已退款(包括全额退款和部分退款)的订单不支持再次退款。
  2. 在线支付由于第三方平台限制只支持对当天交易订单进行退款。
  3. 部分退款仅支持线下支付渠道,在线支付由于第三方平台限制只支持全额退款。

4.订单取消

Get https://tcc-dev.interlib.com.cn/api/tcc-settlement/open-api/payment/cancel/{orderId}
消耗
  • application/json
生成
  • */*
参数
名称 说明 类型
orderId
必填
订单ID string
operator
必填
操作员 string
调用示例

GET https://tcc-dev.interlib.com.cn/api/tcc-settlement/open-api/payment/cancel/406d9c3c-b688-41ed-b40a-c55b6f29?operator=string

响应
HTTP代码 说明 类型
200 OK RestData
201 Created 无内容
401 Unauthorized 无内容
403 Forbidden 无内容
404 Not Found 无内容
响应示例
{
  "code": 200,
  "data": true,
  "desc": "操作成功"
}

1) 订单取消说明

  1. 支付宝只有在二维码被扫描(未支付)的情况下关闭订单才能处理成功
  2. 只有未完成状态的订单才可以调用此接口
  3. 无论成功与否,此接口只可调用一次

5.支付重调

POST https://tcc-dev.interlib.com.cn/api/tcc-settlement/open-api/payment/{orderId}
消耗
  • application/json
生成
  • */*
参数
名称 说明 类型
orgId
必填
所属租户 integer (int64)
paymentTypeCode
必填
支付方式代码
样例 : "WX_NATIVE"
string
operator
必填
操作员 string
authCode
可选
(付款码支付必填)
付款码的数字编号
string
body
可选
(扫码或付款码支付必填)
商品简单描述
string
globalid
可选
(统一支付必填)
馆唯一代码
string
kpSign
可选
是否已开发票
0/无需,1/未开,2/已开
integer (int32)
remark
可选
备注 string
调用示例

POST https://tcc-dev.interlib.com.cn/api/tcc-settlement/open-api/payment/406d9c3c-b688-41ed-b40a-c55b6f29?operator=string

响应
HTTP代码 说明 类型
200 OK RestData
201 Created 无内容
401 Unauthorized 无内容
403 Forbidden 无内容
404 Not Found 无内容
响应示例
{
  "code": 200,
  "data": true,
  "desc": "操作成功"
}

1) 支付重调说明

  1. 仅支持未支付且已超过3分钟(二维码失效时间)的订单。
  2. 将使用入参和部分旧的订单信息重新发起支付请求。
  3. 旧的订单和财经将被请求设置为取消订单状态。
  4. 重调后的旧订单被采用特殊手段进行付款,可正常查询并更新状态,再进一步地进行退款操作,属于冗余的安全保障。