2. 银联托收API

API列表

API调用

2.1 已签署托收协议查询接口

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/charge/bankcollect/queryBankAgreementList

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "communityId": 671024,
    "custId":131231,
    "custPhone": "12345678",
    "schemeId": "13645"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
        "resultList": [{
            "agreementId": "托收协议ID ",
            "agreementNum": "托收协议号 ",
            "schemeName": "托收方案名称",
            "schemeId": "托收方案ID",
            "objName": "托收资源",
            "communityName": "项目名称",
            "bankName": "开户银行",
            "bankAcctCode": "托收银行账号",
            "status": "协议状态 (1有效 0无效(已解除))",
            "feeItemTypeNames ": "托收费用科目，多个用逗号隔开"
        }]
    }
}

异常返回示例

{"code":"401","message":"error message"}

2.2 托收协议代扣记录明细查询接口

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/charge/bankcollect/queryBankAgreementDetailList

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "communityId": 671024,
    "agreementId":131231,
    "custId":131231,
    "beginMoth":"2020-04",
    "endMonth":"2019-05"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
        "result":[{
            "yearMonth":"XXXX年XX月",
            "successAmount":"XX   单位分 " ,
            "details":[{
                "resInstName":"托收对象 ",
                "payAmount":"托收金额  单位分",
                "successAmount":"托收成功金额 托收状态为1时，取payAmount;为0时，取0",
                "createdDate":"托收时间，yyyy-MM-dd HH:mm:ss ",
                "handlStatus":"托收状态 1成功；2失败数字",
                "cause":"托收描述",
                "agreementId":"托收协议ID 数字",
                "schemeId":"托收方案ID  数字",
            }]
        }]
    }
}

异常返回示例

{"code":"401","message":"error message"}

2.3 关闭托收协议接口

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/charge/bankcollect/closeBankAgreement

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "communityId": 671024,
    "agreementId": 12345678,
    "schemeId": 13645
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

2.4 新建托收协议接口

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/charge/bankcollect/createBankAgreement

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "communityId":"项目ID",
    "custName":"业主名称",
    "custId":"业主ID",
    "isShareObj":"资源类型：房屋 0|资源 1|合同 2(APP默认是资源)",
    "billObjType":"资源实例类型：1 房屋；2 有房车位；3 仪表；4 无房车位；28 月卡",
    "resInstId":"资源实例id",
    "schemeId":"托收方案ID",
    "bankAcctType":"账户类型 0：银行卡（默认），1：存折",
    "bankCode":"客户开户行",
    "bankProvince":"开户行所在省",
    "bankCity":"开户行所在市",
    "bankAcctCode":"客户银行账号",
    "bankAcctOwer":"开户人",
    "agreementNum":"托收协议号",
    "identifyType":"开户人证件类型",
    "identifyNum":"开户人证件号码",
    "custPhone":"银行预留电话",
    "remark":"备注"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

2.5 查询资源接口

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/charge/bankcollect/queryAgreementResources

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "communityId": 671024,
    "custId": "12345678"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
        resultList:[{
            "billObjType": "2" ,  //1 房屋；2 有房车位；3 仪表；4 无房车位；28 月卡
            "resInstId": "2" ,  //资源实例id
            "resInstName": "1102车位" ,  //资源实例名
        }]
    }
}

异常返回示例

{"code":"401","message":"error message"}

2.6 查询托收方案接口

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/charge/bankcollect/queryApplySchemeList

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "communityId": 671024
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
        "resultList": [{
            "schemeName": "托收方案名称",
            "schemeId": "托收方案ID",
            "agreementSignType": "签约方式 ",
            "interfaceId": "接口ID",
            "interfaceName": "接口名称",
            "parkingFlag":”1可以托收月卡资源 0否”    
        }]
    }
}

异常返回示例

{"code":"401","message":"error message"}

2.7 查询已签署银联协议接口

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/charge/bankcollect/querySignedBankAgreementList

方法：POST

请求参数

请求Body描述(非Form表单数据)

{    
    "communityId":"真实小区id",
    "custId":"客户ID",
    "status":"状态",
    "agreementNum":"协议号"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
        “resultList”:[{
            "custName":"客户名称",
            "bankName":"所属银行",
            "bankAcctCode":"银行账号",
            "bankAcctOwer":"开户人",
            "custPhone":"银行预留电话",
            "identifyType":"证件类型",
            "identifyNum":"证件号",
            "bankAcctType":"账户类型 0：银行卡（默认），1：存折",
            "merId":"商户号",
            "interfaceName":"接口名称",
            "agreementNum":"协议号",
            "status":"状态 1 已签约 0已解约 ",
            "bankCode":"客户开户行"
        }]
    }
}

异常返回示例

{"code":"401","message":"error message"}

2.8 签署银联协议接口

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/charge/bankcollect/signedBankAgreement

方法：POST

请求参数

请求Body描述(非Form表单数据)

{    
    "communityId":"真实小区id",
    "custPhone":"预留电话号码",
    "accountNO":"账号",
    "accountType":"账号类型",
    "accountName":"持卡人姓名",
    "identifyType":"证件类型",
    "identifyNO":"证件号",
    "merId":"商户号",
    "reqSn":"流水号",
    "custId":"客户id",
    "bankCode":"银行编码",
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
        "protocolNO":"协议号 可能为空",
        "reqSn":"原交易请求流水",
    }
}

异常返回示例

{"code":"401","message":"error message"}

2.9 签署银联协议确认接口接口

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/charge/bankcollect/signedBankAgreementConfirm

方法：POST

请求参数

请求Body描述(非Form表单数据)

{    
    "verifyCode":"授权短信",
    "reqSn":"流水号"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
        "protocolNO":"协议号",
    }
}

异常返回示例

{"code":"401","message":"error message"}

2.10 解约银联协议接口

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/charge/bankcollect/terminateBankAgreement

方法：POST

请求参数

请求Body描述(非Form表单数据)

{    
    "communityId":"真实小区id",
    "custPhone":"预留电话号码",
    "accountNO":"账号",
    "accountType":"账号类型",
    "accountName":"持卡人姓名",
    "identifyType":"证件类型",
    "identifyNO":"证件号",
    "protocolNO":"协议号",
    "reqSn":"流水号"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

2.11 解约银联协议确认接口接口

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/charge/bankcollect/terminateBankAgreementConfirm

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "protocolNO":"解约的协议号",
    "verifyCode":"授权短信",
    "reqSn":"流水号"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {

    }
}

异常返回示例

{"code":"401","message":"error message"}

证件类型码含义

成员权限设置（暂不做）

2.12 银行列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/charge/bankcollect/queryBankList

方法：POST

请求参数

请求Body描述(非Form表单数据)

{

}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {

    }
}

异常返回示例

{"code":"401","message":"error message"}

证件类型码含义

错误码列表(12001-12999)