E付通-标准接口
    E付通-标准接口
    • 文档修订记录
    • API调用协议
    • 文档说明
    • 接口版本1.4.50
      • 4.1 学生信息
        • 4.1.1.学生列表(校内生)
        • 4.1.2.按学号获取学生信息
        • 4.1.3.学生信息插入/更新
        • 4.1.4.学生信息插入/更新(批量:最大条数100条)
        • 4.1.5.学生信息插入/更新结果查询
        • 4.1.6.学号变更(批量:最大条数100条)
        • 4.1.7.学号变更结果查询
        • 4.1.8.获取学生变更记录
        • 4.1.9.班级信息插入/更新
        • 4.1.10.班级信息插入/更新(批量:最大数量100条)
        • 4.1.11学生异动(需审核)
        • 4.1.12学号变更(单条,同步处理)
        • 4.1.13查询院系列表
        • 4.1.14查询专业列表
        • 4.1.15查询班级列表
        • 4.1.16查询异动信息处理结果
        • 4.1.17 同步临时用户
      • 4.2 收费项目
        • 4.2.1.获取收费项目
        • 4.2.2.非应收款采集信息配置
      • 4.3 应收款
        • 4.3.1.获取应收款标准名称
        • 4.3.2.按学号发布/更新应收款
        • 4.3.3.按学号申请贷款(缓缴)
        • 4.3.4.按学号申请缓缴
        • 4.3.5.按学号撤销缓缴
        • 4.3.6.按学号申请减免
        • 4.3.7.获取学生应收款
        • 4.3.8.获取学生缴费情况
        • 4.3.9.获取学生缴费情况(批量)
        • 4.3.10.同步收费信息
        • 4.3.11.同步收费信息(批量)
        • 4.3.12.收费信息作废
        • 4.3.13.按学号作废减免
        • 4.3.14.按学号作废贷款(缓缴)
        • 4.3.15.同步收费信息(按项目冲抵)
        • 4.3.16.获取应收标准金额
        • 4.3.17.按学号申请贷款(贷款)
        • 4.3.18.按学号作废贷款(贷款)
        • 4.3.19.贷款记录查询
        • 4.3.20.减免记录查询
        • 4.3.21.缓缴记录查询(包含贷款申请)
        • 4.3.22.收费记录查询(应收款)
        • 4.3.23.退款记录查询(应收款)
      • 4.4 同步
        • 4.4.1.通知收费结果(不建议使用)
        • 4.4.2.同步应收款金额
        • 4.4.3.同步学生变更信息
        • 4.4.4.同步非应收款金额
      • 4.5 非应收款
        • 4.5.1.获取学生非应收款信息
        • 4.5.2.获取学生非应收款信息(批量)
        • 4.5.3.同步非应收款收费信息
        • 4.5.4.同步非应收款收费信息(批量)
      • 4.6 代收费
        • 4.6.1.获取代收费结算信息
        • 4.6.2.获取代收费结算信息(批量)
      • 4.7 字典参数
        • 4.7.1.查询字典项
    • 接口版本1.4.40
      • 4.1 学生信息
        • 4.1.1.学生列表(校内生)
        • 4.1.2.按学号获取学生信息
        • 4.1.3.学生信息插入/更新
        • 4.1.4.学生信息插入/更新(批量:最大条数100条)
        • 4.1.5.学生信息插入/更新结果查询
        • 4.1.6.学号变更(批量:最大条数100条)
        • 4.1.7.学号变更结果查询
        • 4.1.8.获取学生变更记录
        • 4.1.9.班级信息插入/更新
        • 4.1.10.班级信息插入/更新(批量:最大数量100条)
        • 4.1.11学生异动(需审核)
        • 4.1.12学号变更(单条,同步处理)
        • 4.1.13查询院系列表
        • 4.1.14查询专业列表
        • 4.1.15查询班级列表
        • 4.1.16查询异动信息处理结果
      • 4.2 收费项目
        • 4.2.1.获取收费项目
      • 4.3 应收款
        • 4.3.1.获取应收款标准名称
        • 4.3.2.按学号发布/更新应收款
        • 4.3.3.按学号申请贷款(缓缴)
        • 4.3.4.按学号申请缓缴
        • 4.3.5.按学号撤销缓缴
        • 4.3.6.按学号申请减免
        • 4.3.7.获取学生应收款
        • 4.3.8.获取学生缴费情况
        • 4.3.9.获取学生缴费情况(批量)
        • 4.3.10.同步收费信息
        • 4.3.11.同步收费信息(批量)
        • 4.3.12.收费信息作废
        • 4.3.13.按学号作废减免
        • 4.3.14.按学号作废贷款(缓缴)
        • 4.3.15.同步收费信息(按项目冲抵)
        • 4.3.16.获取应收标准金额
        • 4.3.17.按学号申请贷款(贷款)
        • 4.3.18.按学号作废贷款(贷款)
        • 4.3.19.贷款记录查询
        • 4.3.20.减免记录查询
        • 4.3.21.缓缴记录查询(包含贷款申请)
        • 4.3.22.收费记录查询(应收款)
        • 4.3.23.退款记录查询(应收款)
      • 4.4 同步
        • 4.4.1.通知收费结果(不建议使用)
        • 4.4.2.同步应收款金额
        • 4.4.3.同步学生变更信息
        • 4.4.4.同步非应收款金额
      • 4.5 非应收款
        • 4.5.1.获取学生非应收款信息
        • 4.5.2.获取学生非应收款信息(批量)
      • 4.6 代收费
        • 4.6.1.获取代收费结算信息
        • 4.6.2.获取代收费结算信息(批量)
      • 4.7 字典参数
        • 4.7.1.查询字典项
    • 接口版本1.4.35
      • 4.1 学生信息
        • 4.1.1.学生列表(校内生)
        • 4.1.2.按学号获取学生信息
        • 4.1.3.学生信息插入/更新
        • 4.1.4.学生信息插入/更新(批量:最大条数100条)
        • 4.1.5.学生信息插入/更新结果查询
        • 4.1.6.学号变更(批量:最大条数100条)
        • 4.1.7.学号变更结果查询
        • 4.1.8.获取学生变更记录
        • 4.1.9.班级信息插入/更新
        • 4.1.10.班级信息插入/更新(批量:最大数量100条)
        • 4.1.11学生异动(需审核)
        • 4.1.12学号变更(单条,同步处理)
        • 4.1.13查询院系列表
        • 4.1.14查询专业列表
        • 4.1.15查询班级列表
        • 4.1.16查询异动信息处理结果
      • 4.2 收费项目
        • 4.2.1.获取收费项目
      • 4.3 应收款
        • 4.3.1.获取应收款标准名称
        • 4.3.2.按学号发布/更新应收款
        • 4.3.3.按学号申请贷款(缓缴)
        • 4.3.4.按学号申请缓缴
        • 4.3.5.按学号撤销缓缴
        • 4.3.6.按学号申请减免
        • 4.3.7.获取学生应收款
        • 4.3.8.获取学生缴费情况
        • 4.3.9.获取学生缴费情况(批量)
        • 4.3.10.同步收费信息
        • 4.3.11.同步收费信息(批量)
        • 4.3.12.收费信息作废
        • 4.3.13.按学号作废减免
        • 4.3.14.按学号作废贷款(缓缴)
        • 4.3.15.同步收费信息(按项目冲抵)
        • 4.3.16.获取应收标准金额
        • 4.3.17.按学号申请贷款(贷款)
        • 4.3.18.按学号作废贷款(贷款)
        • 4.3.19.贷款记录查询
        • 4.3.20.减免记录查询
        • 4.3.21.缓缴记录查询(包含贷款申请)
        • 4.3.22.收费记录查询(应收款)
        • 4.3.23.退款记录查询(应收款)
      • 4.4 同步
        • 4.4.1.通知收费结果(不建议使用)
        • 4.4.2.同步应收款金额
        • 4.4.3.同步学生变更信息
        • 4.4.4.同步非应收款金额
        • 4.4.5.同步代收费结算信息
      • 4.5 非应收款
        • 4.5.1.获取学生非应收款信息
        • 4.5.2.获取学生非应收款信息(批量)
      • 4.6 代收费
        • 4.6.1.获取代收费结算信息
        • 4.6.2.获取代收费结算信息(批量)
      • 4.7 字典参数
        • 4.7.1.查询字典项
    • 接口版本1.4.34
      • 4.1 学生信息
        • 4.1.1.学生列表(校内生)
        • 4.1.2.按学号获取学生信息
        • 4.1.3.学生信息插入/更新
        • 4.1.4.学生信息插入/更新(批量:最大条数100条)
        • 4.1.5.学生信息插入/更新结果查询
        • 4.1.6.学号变更(批量:最大条数100条)
        • 4.1.7.学号变更结果查询
        • 4.1.8.获取学生变更记录
        • 4.1.9.班级信息插入/更新
        • 4.1.10.班级信息插入/更新(批量:最大数量100条)
        • 4.1.11学生异动(需审核)
        • 4.1.12学号变更(单条,同步处理)
        • 4.1.13查询院系列表
        • 4.1.14查询专业列表
        • 4.1.15查询班级列表
        • 4.1.16查询异动信息处理结果
      • 4.2 收费项目
        • 4.2.1.获取收费项目
      • 4.3 应收款
        • 4.3.1.获取应收款标准名称
        • 4.3.2.按学号发布/更新应收款
        • 4.3.3.按学号申请贷款(缓缴)
        • 4.3.4.按学号申请缓缴
        • 4.3.5.按学号撤销缓缴
        • 4.3.6.按学号申请减免
        • 4.3.7.获取学生应收款
        • 4.3.8.获取学生缴费情况
        • 4.3.9.获取学生缴费情况(批量)
        • 4.3.10.同步收费信息
        • 4.3.11.同步收费信息(批量)
        • 4.3.12.收费信息作废
        • 4.3.13.按学号作废减免
        • 4.3.14.按学号作废贷款(缓缴)
        • 4.3.15.同步收费信息(按项目冲抵)
        • 4.3.16.获取应收标准金额
        • 4.3.17.按学号申请贷款(贷款)
        • 4.3.18.按学号作废贷款(贷款)
        • 4.3.19.贷款记录查询
        • 4.3.20.减免记录查询
        • 4.3.21.缓缴记录查询(包含贷款申请)
        • 4.3.22.收费记录查询(应收款)
        • 4.3.23.退款记录查询(应收款)
      • 4.4 同步
        • 4.4.1.通知收费结果(不建议使用)
        • 4.4.2.同步应收款金额
        • 4.4.3.同步学生变更信息
        • 4.4.4.同步非应收款金额
        • 4.4.5.同步代收费结算信息
      • 4.5 非应收款
        • 4.5.1.获取学生非应收款信息
        • 4.5.2.获取学生非应收款信息(批量)
      • 4.6 代收费
        • 4.6.1.获取代收费结算信息
        • 4.6.2.获取代收费结算信息(批量)
      • 4.7 字典参数
        • 4.7.1.查询字典项
    • 接口版本1.4.33
      • 4.1 学生信息
        • 4.1.1.学生列表(校内生)
        • 4.1.2.按学号获取学生信息
        • 4.1.3.学生信息插入/更新
        • 4.1.4.学生信息插入/更新(批量:最大条数100条)
        • 4.1.5.学生信息插入/更新结果查询
        • 4.1.6.学号变更(批量:最大条数100条)
        • 4.1.7.学号变更结果查询
        • 4.1.8.获取学生变更记录
        • 4.1.9.班级信息插入/更新
        • 4.1.10.班级信息插入/更新(批量:最大数量100条)
        • 4.1.11学生异动(需审核)
        • 4.1.12学号变更(单条,同步处理)
        • 4.1.13查询院系列表
        • 4.1.14查询专业列表
        • 4.1.15查询班级列表
        • 4.1.16查询异动信息处理结果
      • 4.2 收费项目
        • 4.2.1.获取收费项目
      • 4.3 应收款
        • 4.3.1.获取应收款标准名称
        • 4.3.2.按学号发布/更新应收款
        • 4.3.3.按学号申请贷款(缓缴)
        • 4.3.4.按学号申请缓缴
        • 4.3.5.按学号撤销缓缴
        • 4.3.6.按学号申请减免
        • 4.3.7.获取学生应收款
        • 4.3.8.获取学生缴费情况
        • 4.3.9.获取学生缴费情况(批量)
        • 4.3.10.同步收费信息
        • 4.3.11.同步收费信息(批量)
        • 4.3.12.收费信息作废
        • 4.3.13.按学号作废减免
        • 4.3.14.按学号作废贷款(缓缴)
        • 4.3.15.同步收费信息(按项目冲抵)
        • 4.3.16.获取应收标准金额
        • 4.3.17.按学号申请贷款(贷款)
        • 4.3.18.按学号作废贷款(贷款)
        • 4.3.19.贷款记录查询
        • 4.3.20.减免记录查询
        • 4.3.21.缓缴记录查询(包含贷款申请)
        • 4.3.22.收费记录查询(应收款)
        • 4.3.23.退款记录查询(应收款)
      • 4.4 同步
        • 4.4.1.通知收费结果(不建议使用)
        • 4.4.2.同步应收款金额
        • 4.4.3.同步学生变更信息
        • 4.4.4.同步非应收款金额
        • 4.4.5.同步代收费结算信息
      • 4.5 非应收款
        • 4.5.1.获取学生非应收款信息
        • 4.5.2.获取学生非应收款信息(批量)
      • 4.6 代收费
        • 4.6.1.获取代收费结算信息
        • 4.6.2.获取代收费结算信息(批量)
      • 4.7 字典参数
        • 4.7.1.查询字典项
    • 接口版本1.4.32
      • 4.1 学生信息
        • 4.1.1.学生列表(校内生)
        • 4.1.2.按学号获取学生信息
        • 4.1.3.学生信息插入/更新
        • 4.1.4.学生信息插入/更新(批量:最大条数100条)
        • 4.1.5.学生信息插入/更新结果查询
        • 4.1.6.学号变更(批量:最大条数100条)
        • 4.1.7.学号变更结果查询
        • 4.1.8.获取学生变更记录
        • 4.1.9.班级信息插入/更新
        • 4.1.10.班级信息插入/更新(批量:最大数量100条)
        • 4.1.11学生异动(需审核)
        • 4.1.12学号变更(单条,同步处理)
        • 4.1.13查询院系列表
        • 4.1.14查询专业列表
        • 4.1.15查询班级列表
        • 4.1.16查询异动信息处理结果
      • 4.2 收费项目
        • 4.2.1.获取收费项目
      • 4.3 应收款
        • 4.3.1.获取应收款标准名称
        • 4.3.2.按学号发布/更新应收款
        • 4.3.3.按学号申请贷款(缓缴)
        • 4.3.4.按学号申请缓缴
        • 4.3.5.按学号撤销缓缴
        • 4.3.6.按学号申请减免
        • 4.3.7.获取学生应收款
        • 4.3.8.获取学生缴费情况
        • 4.3.9.获取学生缴费情况(批量)
        • 4.3.10.同步收费信息
        • 4.3.11.同步收费信息(批量)
        • 4.3.12.收费信息作废
        • 4.3.13.按学号作废减免
        • 4.3.14.按学号作废贷款(缓缴)
        • 4.3.15.同步收费信息(按项目冲抵)
        • 4.3.16.获取应收标准金额
        • 4.3.17.按学号申请贷款(贷款)
        • 4.3.18.按学号作废贷款(贷款)
        • 4.3.19.贷款记录查询
        • 4.3.20.减免记录查询
        • 4.3.21.缓缴记录查询(包含贷款申请)
        • 4.3.22.收费记录查询(应收款)
        • 4.3.23.退款记录查询(应收款)
      • 4.4 同步
        • 4.4.1.通知收费结果(不建议使用)
        • 4.4.2.同步应收款金额
        • 4.4.3.同步学生变更信息
        • 4.4.4.同步非应收款金额
        • 4.4.5.同步代收费结算信息
      • 4.5 非应收款
        • 4.5.1.获取学生非应收款信息
        • 4.5.2.获取学生非应收款信息(批量)
      • 4.6 代收费
        • 4.6.1.获取代收费结算信息
        • 4.6.2.获取代收费结算信息(批量)
      • 4.7 字典参数
        • 4.7.1.查询字典项
    • 接口版本1.4.31
      • 4.1 学生信息
        • 4.1.1.学生列表(校内生)
        • 4.1.2.按学号获取学生信息
        • 4.1.3.学生信息插入/更新
        • 4.1.4.学生信息插入/更新(批量:最大条数100条)
        • 4.1.5.学生信息插入/更新结果查询
        • 4.1.6.学号变更(批量:最大条数100条)
        • 4.1.7.学号变更结果查询
        • 4.1.8.获取学生变更记录
        • 4.1.9.班级信息插入/更新
        • 4.1.10.班级信息插入/更新(批量:最大数量100条)
        • 4.1.11学生异动(需审核)
        • 4.1.12学号变更(单条,同步处理)
        • 4.1.13查询院系列表
        • 4.1.14查询专业列表
        • 4.1.15查询班级列表
        • 4.1.16查询异动信息处理结果
      • 4.2 收费项目
        • 4.2.1.获取收费项目
      • 4.3 应收款
        • 4.3.1.获取应收款标准名称
        • 4.3.2.按学号发布/更新应收款
        • 4.3.3.按学号申请贷款(缓缴)
        • 4.3.4.按学号申请缓缴
        • 4.3.5.按学号撤销缓缴
        • 4.3.6.按学号申请减免
        • 4.3.7.获取学生应收款
        • 4.3.8.获取学生缴费情况
        • 4.3.9.获取学生缴费情况(批量)
        • 4.3.10.同步收费信息
        • 4.3.11.同步收费信息(批量)
        • 4.3.12.收费信息作废
        • 4.3.13.按学号作废减免
        • 4.3.14.按学号作废贷款(缓缴)
        • 4.3.15.同步收费信息(按项目冲抵)
        • 4.3.16.获取应收标准金额
        • 4.3.17.按学号申请贷款(贷款)
        • 4.3.18.按学号作废贷款(贷款)
        • 4.3.19.贷款记录查询
        • 4.3.20.减免记录查询
        • 4.3.21.缓缴记录查询(包含贷款申请)
        • 4.3.22.收费记录查询(应收款)
        • 4.3.23.退款记录查询(应收款)
      • 4.4 同步
        • 4.4.1.通知收费结果(不建议使用)
        • 4.4.2.同步应收款金额
        • 4.4.3.同步学生变更信息
        • 4.4.4.同步非应收款金额
        • 4.4.5.同步代收费结算信息
      • 4.5 非应收款
        • 4.5.1.获取学生非应收款信息
        • 4.5.2.获取学生非应收款信息(批量)
      • 4.6 代收费
        • 4.6.1.获取代收费结算信息
        • 4.6.2.获取代收费结算信息(批量)
      • 4.7 字典参数
        • 4.7.1.查询字典项
    • 接口版本1.4.30
      • 4.1 学生信息
        • 4.1.1.学生列表(校内生)
        • 4.1.2.按学号获取学生信息
        • 4.1.3.学生信息插入/更新
        • 4.1.4.学生信息插入/更新(批量:最大条数100条)
        • 4.1.5.学生信息插入/更新结果查询
        • 4.1.6.学号变更(批量:最大条数100条)
        • 4.1.7.学号变更结果查询
        • 4.1.8.获取学生变更记录
        • 4.1.9.班级信息插入/更新
        • 4.1.10.班级信息插入/更新(批量:最大数量100条)
        • 4.1.11学生异动(需审核)
        • 4.1.12学号变更(单条,同步处理)
        • 4.1.13查询院系列表
        • 4.1.14查询专业列表
        • 4.1.15查询班级列表
        • 4.1.16查询异动信息处理结果
      • 4.2 收费项目
        • 4.2.1.获取收费项目
      • 4.3 应收款
        • 4.3.1.获取应收款标准名称
        • 4.3.2.按学号发布/更新应收款
        • 4.3.3.按学号申请贷款(缓缴)
        • 4.3.4.按学号申请缓缴
        • 4.3.5.按学号撤销缓缴
        • 4.3.6.按学号申请减免
        • 4.3.7.获取学生应收款
        • 4.3.8.获取学生缴费情况
        • 4.3.9.获取学生缴费情况(批量)
        • 4.3.10.同步收费信息
        • 4.3.11.同步收费信息(批量)
        • 4.3.12.收费信息作废
        • 4.3.13.按学号作废减免
        • 4.3.14.按学号作废贷款(缓缴)
        • 4.3.15.同步收费信息(按项目冲抵)
        • 4.3.16.获取应收标准金额
        • 4.3.17.按学号申请贷款(贷款)
        • 4.3.18.按学号作废贷款(贷款)
        • 4.3.19.贷款记录查询
        • 4.3.20.减免记录查询
        • 4.3.21.缓缴记录查询(包含贷款申请)
        • 4.3.22.收费记录查询(应收款)
        • 4.3.23.退款记录查询(应收款)
      • 4.4 同步
        • 4.4.1.通知收费结果(不建议使用)
        • 4.4.2.同步应收款金额
        • 4.4.3.同步学生变更信息
        • 4.4.4.同步非应收款金额
        • 4.4.5.同步代收费结算信息
      • 4.5 非应收款
        • 4.5.1.获取学生非应收款信息
        • 4.5.2.获取学生非应收款信息(批量)
      • 4.6 代收费
        • 4.6.1.获取代收费结算信息
        • 4.6.2.获取代收费结算信息(批量)
      • 4.7 字典参数
        • 4.7.1.查询字典项

    文档说明

    公共参数#

    公共参数放置在http header中
    调用任何一个API都必须传入的参数,放置在请求头中,目前支持的公共参数有:
    参数名称参数类型是否必须参数描述
    app-keyString是渠道标识,由E付通分配
    timestampNumber(14)是请求时间,格式为yyyyMMddHHmmss,时区为GMT+8,例如:20180101121512。E付通API服务端允许客户端请求最大时间误差为10分钟。
    x-signString(32)是API输入参数签名结果,签名算法参照下面的介绍。
    调用任何一个API的返回公共参数,放置在响应头中:
    参数名称参数类型是否必须参数描述
    app-keyString是渠道标识,由E付通分配
    timestampNumber(14)是响应时间,格式为yyyyMMddHHmmss,时区为GMT+8,例如:20180101121512。E付通API服务端允许客户端请求最大时间误差为10分钟。
    x-signString(32)是API输入参数签名结果,签名算法参照下面的介绍。

    业务参数#

    API调用除了必须包含公共参数外,如果API本身有业务级的参数也必须传入,业务参数以json的格式放置在http body中,每个API的业务级参数请考API文档说明。

    签名算法#

    为了防止API调用过程中被恶意篡改,调用任何一个API都需要携带签名,E付通服务端会根据请求参数,对签名进行验证,签名不合法的请求将会被拒绝。E付通目前支持的签名算法为MD5,签名大体过程如下: 将业务参数转为json字符串,并将公共参数中的app-key,timestamp, sign_key这三个参数的参数值依次拼接在业务参数后面如:
    业务参数:
    json_str:{“id”:”123456”,”name”:”张三”,”age”:”18”}
    公共参数:
    app-key:app
    timestamp:20180101121512
    拼装后字符串:json_str + app-key + timestamp + sign_key
    将拼装后的字符串采用utf-8编码,并使用MD5算法加密得到签名结果:
    x-sign = MD5(utf8(json_str + app-key + timestamp + sign_key))

    调用示例#

    设置参数值:#

    公共参数:#

    app-key = "test"
    timestamp = "20180101123514"

    业务参数:#

    id = "FA357C3C7F634EA3924A6E80C8415A15"
    name = "张三"

    参数拼接(假设sign_key为:123456)#

    {"id": "FA357C3C7F634EA3924A6E80C8415A15","name":"张三"}test20180101123514123456

    生成签名#

    x-sign = Md5({"id": "FA357C3C7F634EA3924A6E80C8415A15","name":"张三"}test20180101123514123456)

    发送请求#

    将公共参数和签名值x-sign存放于请求头中,业务参数以json格式存放于请求体。采用post请求到相应接口地址

    报文实例#

    请求报文
    {"id": "1001","name":"张三"}
    返回报文
    {
        "resp_code":"0000",
        "resp_msg":"请求成功",
        "resp_data":{}
    }

    注意事项#

    所有的请求和响应数据编码皆为utf-8格式,采用post请求
    Content-Type请使用application/json

    公共错误码解释#

    错误码错误消息解决方案
    9001未能获取渠道标识(app-key)或标识不匹配参见公共参数
    9002未能获取时间戳(timestamp)或格式错误参见公共参数
    9003未能获取签名(x-sign)参见公共参数
    9004请求超时参见公共参数
    9005签名验证失败 
    9403没有接口权限需要E付通配置权限
    4000未知错误/业务错误
    修改于 2024-12-23 06:18:43
    上一页
    API调用协议
    下一页
    4.1.1.学生列表(校内生)
    Built with