机构运营互联互通

运营 收单机构 发卡机构 快速接入
为加强合作机构和银联的技术合作，提升双方的系统运营效率，实现合作机构与银联之间平台（包括监控、流程、事件）的系统对接，通过形成统一的接口与运营联动的规范标准，及时共享运营信息，提高工行与银联之间的联动效率。合作机构和银联将对各自的部分运营监测数据进行互联互通，实现准实时共享。

接入服务商：银联技术开放平台

API ID：55

接口状态：正常

业务申请
暂不支持测试

接口名称

获取token

接口描述

产品token是开放平台每个产品的全局唯一接口调用凭据，用户调用各接口时都需使用产品token。

接口地址

测试地址： 暂无

生产地址： https://openapi.unionpay.com/upapi/ibus/token

请求方式

HTTP GET

请求url参数

名称 标识 字段类型 长度 请求要求 默认值 备注
用户唯一凭证 app_id string M-必填 详情可在登录技术开放平台后“个人中心-我的信息-API认证信息-API认证账号”中查看。
用户唯一凭证密钥 app_secret string M-必填 详情可在登录技术开放平台后“个人中心-我的信息-API认证信息-API认证密钥”中查看。

应答参数

名称 标识 字段类型 长度 请求要求 默认值 备注
过期时间 expire_in string M-必填 凭证有效时间，单位：秒。
产品token token string M-必填 获取到的凭证; 凭证是字符串。

接口名称

分钟指标获取

接口描述

获取本机构最新监测（分钟）指标信息。

接口地址

测试地址： 暂无

生产地址： https://openapi.unionpay/com/upapi/ibus/minutepull

请求方式

HTTP POST

请求url参数

名称 标识 字段类型 长度 请求要求 默认值 备注
时间戳 ts long M-必填 单位：毫秒。对于Java一般使用System.currentTimeMillis();获取。
签名信息 sign string M-必填 详细签名算法可参考附加板块“签名样例代码”部分。
产品token token string M-必填 详情请参考“获取token”接口中应答参数“token”的具体数据。

请求报文体参数

名称 标识 字段类型 长度 请求要求 默认值 备注
当前请求时间戳 reqTime string 19 M-必填 格式：YYYY-MM-DD HH:MM:SS 此时间戳只用于标记请求报文的上送时间， 返回的都为最新监测值，与上送时间戳无关。
机构角色 role string 1 M-必填 受理侧，取值为“F”；发卡侧，取值为“R”
系统机构代码 sysInsCode string 13 M-必填 机构代码

应答参数

名称 标识 字段类型 长度 请求要求 默认值 备注
返回数据 data map 255 M-必填
广域网线路丢包率 plp int O-选填 用最高5位数字来表达百分比
广域网线路端口错包 packetERR int 13 O-选填 错包个数返回long型数字
广域网银联端口出方向带宽利用率 outBandwidth int 13 O-选填 用2位数字来表达百分比，即格式nn表示为nn%
广域网银联端口入方向线路带宽利用率 inBandwidth int 13 O-选填 用2位数字来表达百分比
广域网线路RTT netRTT int 13 O-选填 单位精确到毫秒
排名前三位的失败返回码及占比 respCd string 23 O-选填 格式“XX:nnnn;XX:nnnn;XX:nnnn”,XX为失败应答码，nnnn表示该应答码的占比nn.nn%
交易平均处理时长 aht int 13 O-选填 单位精确到毫秒
系统成功率 sysTsm int 13 O-选填 用最高5位数字来表达百分比
交易5秒超时率 timeoutRate int 13 O-选填 用最高5位数字来表达百分比
当前最高TPS tps int 12 O-选填 四舍五入取整后返回long型数字
TCP链接状态 tcpState string 1 O-选填 1：表示所有的链路状态都正常 0:表示有链路状态不正常
受理冲正率 reverseRate int 13 O-选填 用最高5位数字来表达百分比
TPM tpm int 13 O-选填 四舍五入取整后返回long型数字
承兑率 tsm int 13 O-选填 取两位小数。获取int型数据后，最后两位为小数点后两位数字。即格式为“nnnnn”，其含义为nnn.nn%。后续百分比如无特殊说明，都采用5位数字来表达百分比。
当日累计交易量 qpm int 13 O-选填 返回long型数字
原数据时间点 cntTime string 19 O-选填 格式：YYYY-MM-DD HH:MM，数据采集时间(如果出现，应答与请求保持一致)
响应信息 respMsg string 128 O-选填
响应编号 respCd string 2 M-必填 0001表示处理成功；0020表示报文超长；0021表示访问量太大，无法处理；0023表示处理出错

接口名称

分钟指标上送

接口描述

上送本机构停机事件。

接口地址

测试地址： 暂无

生产地址： https://openapi.unionpay/com/upapi/ibus/minutepush

请求方式

HTTP POST

请求url参数

名称 标识 字段类型 长度 请求要求 默认值 备注
产品token token string M-必填 详情请参考“获取token”接口中应答参数“token”的具体数据。
签名信息 sign string M-必填 详细签名算法可参考附加板块“签名样例代码”部分。
时间戳 ts long M-必填 单位：毫秒。对于Java一般使用System.currentTimeMillis();获取。

请求报文体参数

名称 标识 字段类型 长度 请求要求 默认值 备注
广域网线路丢包率 plp int 13 O-选填 用最高5位数字来表达百分比
广域网线路端口错包 packetERR int 13 O-选填 错包个数返回long型数字
广域网银联端口出方向带宽利用率 outBandwidth int 13 O-选填 用2位数字来表达百分比，即格式nn表示为nn%
广域网银联端口入方向线路带宽利用率 InBandwidth int 13 O-选填 用2位数字来表达百分比，即格式nn表示为nn%
广域网线路RTT netRTT int 13 O-选填 单位精确到毫秒
排名前三位的失败返回码及占比 respCd string 23 O-选填 格式“XX:nnnn;XX:nnnn;XX:nnnn”,XX为失败应答码，nnnn表示该应答码的占比nn.nn%
交易平均处理时长 aht int 13 O-选填 单位精确到毫秒
系统成功率 sysTsm int 13 O-选填 用最高5位数字来表达百分比
交易5秒超时率 timeoutRate int 13 O-选填 用最高5位数字来表达百分比
当前最高TPS tps int 13 O-选填 四舍五入取整后返回long型数字
TCP链接状态 tcpState string 1 O-选填 1：表示所有的链路状态都正常；0:表示有链路状态不正常
受理冲正率 reverseRate int 13 O-选填 用最高5位数字来表达百分比
TPM tpm int 13 O-选填 四舍五入取整后返回long型数字
承兑率 tsm int 13 O-选填 取两位小数。获取int型数据后，最后两位为小数点后两位数字。即格式为“nnnnn”，其含义为nnn.nn%。后续百分比如无特殊说明，都采用5位数字来表达百分比。
当日累计交易量 qpm int 13 O-选填 返回long型数字
当前时间戳 cntTime string 16 M-必填 格式：YYYY-MM-DD HH:MM，
机构角色 role string 1 M-必填 受理侧，取值为“F”；发卡侧，取值为“R”
系统机构代码 sysInsCode string 13 M-必填 机构代码

应答参数

名称 标识 字段类型 长度 请求要求 默认值 备注
响应信息 respMsg string 128 O-选填
事件单号 eventId string 50 C-依条件必填 服务请求报文中存在，则必须填写
银联事件单号 upEventId string 12 C-依条件必填 服务请求报文中存在，则必须填写
响应编号 respCd string 2 M-必填 0001表示处理成功；0020表示报文超长；0021表示访问量太大，无法处理；0023表示处理出错；0024 表示重复
产品详情

资费详情： 

    本产品推广期为2017年10月1日至2018年12月31日，推广期内本产品可免费使用。推广期过后的收费标准将提前30个工作日在本平台另行公示。


应用对象

银联合作机构

接入流程

  1. 如需申请该API，请点击右上角“业务申请”，并认真填写相关内容；

  2. 待业务接口人审核通过后即可调用该API，审核周期约为2-3个工作日；

  3. 技术联调，可参照《“快速接入”产品API技术文档—接入指南》。

应答码参照：
应答码 描述
0000 处理成功。
0001 表示处理成功
0020 表示报文超长
0021 表示访问量太大，无法处理
0023 表示处理出错
0024 表示重复报文
9901 您的IP（XXX.XXX.XXX.XXX）没有登记，请登录银联技术开放平台（open.unionpay.com）进行白名单登记。
9902 您的IP（XXX.XXX.XXX.XXX）已被限制访问，请登录银联技术开放平台（open.unionpay.com）提交申诉请求。
9903 您的IP（XXX.XXX.XXX.XXX）请求过于频繁，已被临时限制，请5分钟后再尝试。
9904 您的 IP(XXX.XXX.XXX.XXX)不属于你设置的开发IP列表，请登录银联技术开放平台（open.unionpay.com）确认相关配置
9905 请求参数值有误，请确认请求参数信息
9906 您的账号不具备当前产品请求权限，如有权限，可重新获取该产品Token后再尝试。
9907 app_id与app_secret验证失败
9908 您的Token已过期，请重新获取Token。
9909 您的Token信息非最新Token，请确保您的系统中使用的是最新的Token值。
9910 您的签名密钥未设置，请登录银联技术开放平台（open.unionpay.com）确认相关配置
9911 您的签名信息验证不通过，请检查您的签名实现是否符合银联技术开放平台（open.unionpay.com）提供的签名规则。
9912 您的报文格式有误，要求报文符合JSON数据格式
9913 你的报文数据有误，未通过数据信息校验，具体原因视业务需求
9914 您的报文无法解密，请检查您在银联技术开放平台（open.unionpay.com）上提供的RSA公钥是否正确。
9917 您的账号不具备当前产品API请求权限，请联系相关业务接口人。
9991 银联技术开放平台系统内部错误：产品服务调用失败
9992 银联技术开放平台系统内部错误：产品服务系统未知错误
9993 银联技术开放平台系统内部错误：产品服务未注册至服务中心

1.获取Token


请求URL

https://openapi.unionpay.com/upapi/[产品名称]/token?app_id=[value]&app_secret=[value]


应答报文结果

{
“token”:”fsddfssseessseee”,
“expire_in”:7200
}


2.分钟指标上送

请求URL

https://IP:port/upapi/ibus/minutepush?token=[token]&sign=[sign]&ts=[ts]

请求报文参数

{
“sysInsCode”: “”,
“role”: “”,
“cntTime”: “”,
……
}

应答报文结果

{
“respCd”： “0000”，
“respMsg”: “”}


3. 分钟指标获取

请求URL

https://IP:port/upapi/ibus/minutepull?token=[token]&sign=[sign]&ts=[ts]

请求报文参数

{
“sysInsCode”: “”,
“role”: “”,
“reqTime”: “”
}

应答报文结果

{
“respCd”： “0000”，
“respMsg”: “”, 
“data”: {
         “role”: “”，
         “cntTime”: “”，
         ……
}
}

1. “快速接入”产品API使用教程请参考在线文档：

《“快速接入”产品API指南—接入指南》；


2. “快速接入”产品API安全调用过程请参考在线文档：

2.1《“快速接入”产品API指南—获取产品token》；

2.2《“快速接入”产品API指南—产品功能接口调用》；


3. “快速接入”产品API接口调用报文签名样例请参考在线文档：

《“快速接入”产品API指南—报文签名样例代码》；


4. “快速接入”产品API测试工具使用说明请参考在线文档：

《“快速接入”产品API指南—“快速接入”测试工具》。
常见问题
1. 调用接口返回提示 {"respMsg":"body or sign is null.","respCd":"9905"}
解答详情：

API接口需使用body部分传送JSON数据，故而HTTP请求的content-type需使用application/json，而不是application/x-www-form-urlencoded。

咨询我们
业务咨询
姓名： 张丹青
电话： 021-20632803
邮箱： zhangdanqing@unionpay.com
技术咨询
姓名： 张明虎
电话： 021-20632674
邮箱： zhangminghu@unionpay.com
热门推荐