网上银行系统商户API查询接口手册V1[1]1.doc

中国工商银行网上银行系统中国工商银行网上银行系统 APIAPI 查询接口查询接口 V6 0 中国工商银行软件开发中心中国工商银行软件开发中心 Copyright Reserved 2005 年年 8 月月 商户手册 网上银行商户手册 v3 0 Copyright ICBC SDC 2001 5 1 前前 言言 该文档说明了商户使用工行提供的 API 接口进行查询时的通信方式和需要 上送的数据和工行返回信息的格式 网上银行商户手册 v3 0 Copyright ICBC SDC 2001 5 2 目目 录录 前 言 1 1 商户端的接口 商户端的接口 3 1 1 参数名及其内容列表 3 1 2 一个链接例子 3 2 银行反馈信息的接口 银行反馈信息的接口 4 网上银行商户手册 v3 0 Copyright ICBC SDC 2001 5 3 1 商户端的接口 商户端的接口 商户实现双向的 ssl 与工行服务器建立连接 建立 ssl 连接时使用商户的 api 证书 文件名类似 e 的软证书 之后商户必须将查询上送数据用工行规定的格式以 Form 提交方式中的 Post 方法 将数据提交到中国工商银行指定的 API 查询 URL https servlet ICBCINBSEBusinessServlethttps servlet ICBCINBSEBusinessServlet 严格区分大小写 严格区分大小写 请请 联系所在地分行确认投产环境和测试环境的联系所在地分行确认投产环境和测试环境的 IPIP 地址地址 1 1 参数名及其内容列表参数名及其内容列表 1 1 1 B2B 订单交易状态查询的订单交易状态查询的 API 接口接口 1 1 1 1 请求数据格式 请求数据格式 变量名称变量名称变量命名变量命名长度定义长度定义说明说明 接口名称APIName MAX 30 必输 签名 上送 EAPI 区别大小写 接口版本号APIVersion 15 必输 签名 上送 001 001 001 001 请求数据 xml 包 格式见下 MerReqDataMerReqData 请求数据中的请求数据中的xmlxml包格式 注意 包格式 注意 xmlxml包中所有字段都是必输项 包中所有字段都是必输项 订单号 交易日期 商家号码 商城账号 1 1 1 2 返回数据格式返回数据格式 注意 返回数据是经过了注意 返回数据是经过了 url 编码的 编码的 查询查询b2bb2b订单信息返回有两种格式 如果查询成功则返回是一个订单信息返回有两种格式 如果查询成功则返回是一个xmlxml包 格式 包 格式 网上银行商户手册 v3 0 Copyright ICBC SDC 2001 5 4 接口名称 接口版本号 订单号 交易日期 商家号码 商城账号 指令序号 订单处理状态 指令错误信息 订单总金额 支付币种 返回通知日期时间 收款人账号 收款人户名 校验联名标志 商城联名标志 客户联名标志 联名会员号 商户签名证书id 如果查询失败则返回只有五位错误码 含义可以见文档后面 如果查询失败则返回只有五位错误码 含义可以见文档后面 1 1 2 B2C 订单交易状态查询的订单交易状态查询的 API 接口接口 1 1 1 1 请求数据格式 请求数据格式 变量名称变量名称变量命名变量命名长度定义长度定义说明说明 接口名称APIName MAX 30 必输 签名 上送 EAPI 区别大小写 接口版本号APIVersion 15 必输 签名 上送 001 001 002 001 请求数据 xml 包 格式见下 MerReqDataMerReqData 请求数据中的请求数据中的xmlxml包格式 注意 包格式 注意 xmlxml包中所有字段都是必输项 包中所有字段都是必输项 订单号 交易日期 网上银行商户手册 v3 0 Copyright ICBC SDC 2001 5 5 商家号码 商城账号 1 1 1 2 返回数据格式返回数据格式 注意 返回数据是经过了注意 返回数据是经过了 url 编码的 编码的 查询查询b2cb2c订单信息返回有两种格式 如果查询成功则返回是一个订单信息返回有两种格式 如果查询成功则返回是一个xmlxml包 格式 包 格式 接口名称 接口版本号 订单号 交易日期 商家号码 商城账号 指令序号 订单处理状态 指令错误信息 订单总金额 支付币种 返回通知日期时间 商城账号 商城户名 校验联名标志 商城联名标志 客户联名标志 联名会员号 商户签名证书id 如果查询失败则返回只有五位错误码 含义可以见文档后面 如果查询失败则返回只有五位错误码 含义可以见文档后面 1 1 3 C2C 订单交易状态查询的订单交易状态查询的 API 接口接口 1 1 1 1 请求数据格式 请求数据格式 变量名称变量名称变量命名变量命名长度定义长度定义说明说明 接口名称APIName MAX 30 必输 签名 上送 EAPI 区别大小写 接口版本号APIVersion 15 必输 签名 上送 001 001 003 001 网上银行商户手册 v3 0 Copyright ICBC SDC 2001 5 6 请求数据 xml 包 格式见下 MerReqDataMerReqData 请求数据中的请求数据中的xmlxml包格式 注意 包格式 注意 xmlxml包中所有字段都是必输项 包中所有字段都是必输项 订单号 交易日期 商家号码 商城账号 1 1 1 2 返回数据格式返回数据格式 注意 返回数据是经过了注意 返回数据是经过了 url 编码的 编码的 查询查询c2cc2c订单信息返回有两种格式 如果查询成功则返回是一个订单信息返回有两种格式 如果查询成功则返回是一个xmlxml包 格式 包 格式 接口名称 接口版本号 订单号 交易日期 商家号码 商城账号 指令序号 订单处理状态 指令错误信息 订单总金额 支付币种 返回通知日期时间 收款人账号 收款人户名 校验联名标志 商城联名标志 客户联名标志 联名会员号 卖家收款卡号 卖家收款人户名 网上银行商户手册 v3 0 Copyright ICBC SDC 2001 5 7 商户签名证书id 如果查询失败则返回只有五位错误码 含义可以见文档后面 如果查询失败则返回只有五位错误码 含义可以见文档后面 1 2 一个链接例子一个链接例子 以下给出商户提交查询请求的例子 注意避免使用中文的全角符号 form 不能有 name 属性 另外注意协议是 https input type hidden name MerReqDataMerReqData value 19821981200508 160200EC00000321020002910900 0018680 1 3 注意事项注意事项 1 商城证书 id 对商城账号必须有查询权限 2 请求数据中不要有多余的空格 3 关于双向 SSL 的建立我们会提供 java 和 net 的两个例子 开发时可以 参照 4 从商户 Post 过来的数据 参数名的名称必须与接口表中完全相同参数名的名称必须与接口表中完全相同 名名 称中的字母大小写均要相同 不能进行随意更改称中的字母大小写均要相同 不能进行随意更改 在在 formform 中的提交按钮中的提交按钮 inputtype submit 中中 submitsubmit 不能有不能有 NameName 属性属性 此外 如 果其他 inputinput 项的 Name 中使用了双引号 如 则一定注意在引号内不要包含空格 不要写成 Merchant URL 或者 Mer chantURL 5 要求商户使用字符集 GBK 6 注意请求地址以 https 开头 7 注意对于请求中的 MerReqDataMerReqData 这项的值最好经过 URL 编码后再上送 否则对于一些特殊字符可能会被 URL 解码造成错误 就目前的包格式来 看不编码也不会有问题 网上银行商户手册 v3 0 Copyright ICBC SDC 2001 5 8 1 4 错误代码含义错误代码含义 40972API 查询的订单不存在 40973API 查询过程中系统异常 40976API 查询系统异常 40977商户证书信息错 40978解包商户请求数据报错 40979查询的订单不存在 40980API 查询过程中系统异常 40981给商户打包返回数据错 40982系统错误 40983查询的订单不唯一 40987请求数据中接口名错误 40947商户代码或者商城账号有误 40948商城状态非法 40949商城类别非法 40950商城应用类别非法 40951商户证书 id 状态非法 40952商户证书 id 未绑定 40953商户 id 权限非法 40954检查商户状态时数据库异常 1 5 指令状态含义 指令状态含义 b2b 3 指令处理完成 转账成功 4 指令处理失败 转账未完成 6 指令超过支付人的限额 正在等待主管会计批复 7 指令超过支付人的限额 正在等待主管会计第二次批复 8 指令超过支付人的限额 被主管会计否决 9 银行正在处理 可疑 b2c 0 支付成功 未清算 1 支付成功 已清算 2 支付失败 3 支付可疑交易 网上银行商户手册 v3 0 Copyright ICBC SDC 2001 5 9 c2c 0 支付成功 未清算 1 支付成功 已清算 2 支付失败 3 支付可疑交易 1 6 商户端开发的例子商户端开发的例子 1 6 1 java 版版 try ssl SSLSocketFactory factory null try char passphrase pswd toCharArray SSLContext ctx SSLContext getInstance TLS 证书类型可以根据实际情况填写 KeyManagerFactory kmf KeyManagerFactory getInstance IbmX509 证书类型可以根据实际情况填写 TrustManagerFactory tmf TrustManagerFactory getInstance IbmX509 ks type 是证书库的类型 KeyStore ks KeyStore getInstance ks type if new File keystore isFile System out println ClientAuthA Missing keyStore keystore throw new IOException Missing keystore keystore ks load new FileInputStream keystore passphrase kmf init ks passphrase tmf init ks ctx init kmf getKeyManagers tmf getTrustManagers null factory ctx getSocketFactory catch Exception e e printStackTrace throw new IOException e getMessage 网上银行商户手册 v3 0 Copyright ICBC SDC 2001 5 10 根据 ip 和 port 建立连接 SSLSocket socket SSLSocket factory createSocket hostIP hostPort socket setSoTimeout timeout socket startHandshake ssl SSLSession session socket getSession if session null System out println ClientAuthA Failed to get session context throw new IOException Failed to get session context java io InputStream is null java io OutputStream os null try os socket getOutputStream catch IOException e System out println ClientAuthA Error getting output stream throw new IOException Error getting output stream try is socket getInputStream catch IOException e System out println ClientAuthA Error getting input stream throw new IOException Error getting input stream istream new BufferedReader new InputStreamReader is ostream new BufferedWriter new OutputStreamWriter os catch Exception e if e instanceof UnknownHostException e printStackTrace System out throw new IOException Unknown Host Exception if e instanceof IOException e printStackTrace System out throw new IOException e getMessage 网上银行商户手册 v3 0 Copyright ICBC SDC 2001 5 11 else throw new RuntimeException e toString 版版 include stdafx h include include include void main int argc TCHAR argv if argc 3 printf USAGE s webserver username n argv 0 return Open the internet connection HINTERNET hInternetSession InternetOpen Wininet Client App INTERNET OPEN TYPE PRECONFIG NULL NULL 0 HINTERNET hInternetConnect InternetConnect hInternetSession argv 1 INTERNET DEFAULT HTTPS PORT INTERNET SERVICE HTTP 0 0 HINTERNET hHttpOpenRequest HttpOpenRequest hInternetConnect GET HTTP VERSION NULL INTERNET FLAG SECURE INTERNET FLAG RELOAD INTERNET FLAG KEEP CONNECTION INTERNET FLAG IGNORE CERT CN INVALID INTERNET FLAG IGNORE CERT DATE INVALID 0 BOOL bRet DWORD dwLastError 0 Send the HTTP request bRet HttpSendRequest hHttpOpenRequest NULL 0 0 0 if bRet dwLastError GetLastError Get the certificate information from the server if available 网上银行商户手册 v3 0 Copyright ICBC SDC 2001 5 12 INTERNET CERTIFICATE INFO sInfo DWORD length sizeof sInfo InternetQueryOption hHttpOpenRequest INTERNET OPTION SECURITY CERTIFICATE STRUCT LPVOID printf The Issuer of the server certificate is n s n sInfo lpszIssuerInfo printf The Subject of the server certificate is n s n sInfo lpszSubjectInfo Look up the local certicate store to get a certificate that matches the one of the server PCCERT CONTEXT pCertContext NULL HCERTSTORE hCertStore CertOpenSystemStore NULL MY char pszIssuer 256 0 char pszSubject 256 0 BOOL bGotCert FALSE while pCertContext CertEnumCertificatesInStore hCertStore pCertContext printf The following certificates are available n CertGetNameString pCertContext CERT NAME SIMPLE DISPLAY TYPE CERT NAME ISSUER FLAG NULL pszIssuer 256 printf Issuer s n pszIssuer CertGetNameString pCertContext CERT NAME SIMPLE DISPLAY TYPE 0 NULL pszSubject 256 printf Subject s n pszSubject if strcmp pszSubject argv 2 0 printf nFound a certificate that matches the web server certificate n break If