聚合支付平台对接文档
聚合支付对接文档
交行对接支付文档
聚合支付对接文档v2.0
本文档使用 MrDoc 发布
-
+
首页
交行对接支付文档
# API接入认证 ## 接入说明 开放平台的所有服务 URL 的请求参数分为服务商号 agent_no、加密数据data两部分；数据格式使用JSON格式，并根据开放平台要求加密后传送加密串，开放平台接收到加密串后进行解密处理，并响应处理后的加密数据。 网关地址：https://bcm.ruishengyi.com/qz-bcm/pay/ ## 数据加密 接口加解密基于RSA算法、服务商本地生成一对公钥私钥，并与开放平台进行公钥互换 1. 服务商端群内沟通与开放平台互换公钥； 2. 原始数据组成：服务商端封装req_head、req_body两部分参数并转为JSON数据； 3. 对原始JSON数据使用平台公钥加密后得到字符串为data； 4. 服务商端请求对应业务接口，并传入加密后数据data、服务商号agent_no； 5. 开放平台根据服务商号agent_no获取到对应平台私钥解密数据； 6. 开放平台响应数据时，使用服务商号agent_no对应的公钥进行加密并传递加密后的参数； 7. 服务商端接收到消息使用服务商私钥进行解密； 格式 ```json {"data":"qNS4gwe2pdU/5GzNc5v3QkfOby5Ckt5IYnV3ZZ9nbU6yUzcjeXIsTyNAiOZaZdoHpgfklqqPiAmwgoEOVVKf1LdMo1vlBN0TS9GKPB18u5f36EHDnwJVJY6pmqkYGUCGE3Nom0x1+nnayEFI794IB5PfIMVO/WEikg9Agvz9B93aN85Yw230F0g/nntGQS1i9xm1o+O9kZPBYIS+66gi3aXekvdmVRDjZODLdLeyYglEi/o7XaUPneHEqObDhR3xuxVYJn8zysR7FQx1TUKDoMMtey7p0OVaYMsYfnq7dxrzJMArmh/mhjTWLkw/BTUN9zaeTfpXCu66iuLh1dl9PTK7uzUCwo6I/xhkwq5VqCiCkQOlY0DqlzB77KZnmM1ZWamT7Yfz3FfoWPBlXC2m26EKm9NVTSf+8Sa0n56yo4ERo39xhVaJEjB77KZnmM1ZBSOBuCOrd7pcZwFDB20A19IeIvkVsOGAcvIeUSARhOUN7f85S81vaFsai7Jv8rP/23m/hAlMws/cI7t4qSSOHFXrhQtGrCY4iAuPkm69KXytf616JO24kUeKb5B0mjR6Ph5H0N/TxLigoLH0s5CGwaA9nacj4E2JARvjDBtf7i4YuSxiYZ0e+MF3gwrAIL0DniMFr9NQmlBxqUaw6jGX8zTEb4cFQ6R5AmvzXOKu308=","agent_no":"xxxxxx","app_id"":"xxxxxx"} ``` # 业务接口 ## 被扫付款码接口 - 接口说明： - 用户提供微信或支付宝端二维码信息，商户扫描用户条码/二维码信息通过支付平台提供的被扫支付接口完成支付的过程。该场景下商户将识别到的条码/二维码与完整订单信息一起传递给支付平台，由支付平台发往微信支付宝等。当接口返回支付中或交易状态不明时， 需要调用订单查询接口查询订单实际支付状态。 - 调用方式 - **HTTP POST** - 编码格式 - **UTF-8** - 接口地址 - **/barcodePay** ### 请求参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | -------- | -------------------- | ---- | -------- | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | 1 | req_head | str | false | 1 | req_head | req_head:{} | | 1.1 | trans_time | str | true | 15 | 交易时间 yyyyMMddHHmmss | 20210816153011 | | 1.2 | version | str | true | 100 | 终端版本信息 | V-1.0 | | 2 | req_body | str | false | 1 | req_body | req_body:{} | | 2.1 | valid_period | str | false | 14 | 交易失效时间 | 20210316143200 | | 2.2 | scan_code_text | str | true | 200 | 付款码文本 | 1258643354165444 | | 2.3 | terminal_info | str | false | 50 | 终端号（该字段必输） | 00000001 | | 2.4 | partner_id | str | false | 32 | 服务商编号 | 1359663251125 | | 2.5 | mer_memo | str | false | 200 | 商户内部备注 | 备注 | | 2.6 | require_fields | list | false | 1000 | 需要通知或查询中返回的字段，可以上送需要在后台通知中额外返回的字段 | [{"require_field":"bank_tran_no"},{"require_field":"third_party"}] | | 2.6.1 | require_field | str | false | | 额外返回的属性 | | | 2.7 | currency | str | true | 3 | 币种 | CNY | | 2.8 | term_batch_no | str | false | 6 | 终端批次号 | 000123 | | 2.9 | tran_scene | str | true | 40 | 交易场景 | B2C-API-SCANCODE | | 2.10 | ip | str | true | 40 | ip | 182.119.117.128 | | 2.11 | addi_trade_data | str | false | 200 | 附加交易信息 | 示例：{ "method":"CI","value":{"dynamic_token_out_biz_no":"5453113"}}详情见字段说明3.5 | | 2.11.1 | method | str | false | | 用法标识 | | | 2.11.2 | value | str | false | | 用法取值 | | | 2.11.2.1 | card_no | str | false | | 证件号 | | | 2.11.2.2 | name | str | false | | 持卡人姓名 | | | 2.11.2.3 | card_type | str | false | | 证件类型 | | | 2.12 | mer_ptc_id | str | true | 20 | 商户编号 | 301310063009501 | | 2.13 | mer_trade_time | str | true | 6 | 商户侧交易时间 | 123652 | | 2.14 | term_pos_no | str | false | 6 | 终端流水号 | 000757 | | 2.15 | mer_trade_date | str | true | 8 | 商户侧交易日期 | 20210316 | | 2.16 | shop_id | str | false | 32 | 门店编号 | 19000002 | | 2.17 | pay_mer_tran_no | str | false | 40 | 商户交易编号 | 12185644621782145186 | | 2.18 | total_amount | str | true | 15 | 商户订单总金额（元） | 100.00 | | 2.19 | location | str | true | 7 | 线上或线下 | ONLINE/OFFLINE | | 2.20 | detail | str | false | 500 | 商品详情 | 商品：尺寸 | | 2.21 | tran_content | str | false | 500 | 交易内容 | 交易内容： | | 2.22 | royalty_info | list | false | 1000 | 商户分账信息 | [{"serial_no":"01","amount":"5.00"},{"serial_no":"02","amount":"5.00"}] | | 2.23 | disable_pay_channels | str | false | 100 | 支付禁用渠道 | balance, moneyFund多个之间用,分隔，具体见字段说明3.4 | | 2.24 | term_info | obj | false | 500 | 终端信息（此字段需要必输） | | | 2.24.1 | device_type | str | true | 2 | 设备类型（终端设备类型，受理方可参考终端 注册时的设备类型填写，取值如下： 01：自动柜员机（含 ATM 和 CDM） 和多媒体自助终端 02：传统 POS 03： mPOS 04：智能 POS 05： II 型固定电话 06：云闪付终端； 07：保留使用； 08：手机 POS； 09：刷脸付终端；15 10：条码支付受理终端； 11：条码支付辅助受理终端； 12： 行业终端（公交、地铁用于指 定行业的终端）； 13： MIS 终端） | 10 | | 2.24.2 | secret_text | str | false | 16 | 密文数据（仅在被扫支付类交易报文中出现： 64bit 的密文数据，对终端硬件序列 号和加密随机因子加密后的结果。 本子域取值为： 64bit 密文数据进行 base64 编码后的结果） | OTk3MzBFQ0Q\u003d | | 2.24.3 | app_version | str | false | 8 | 应用程序版本号（终端应用程序的版本号。应用程序 变更应保证版本号不重复。 当长度 不足时，右补空格。） | 21.06.23 | | 2.24.4 | serial_num | str | false | 50 | 终端序列号（出现要求： 终端类型（device_type）填写为 02、 03、 04、 05、 06、 08、 09 或 10 时，必须填写终端序列号。） | 000002020940026552 | | 2.24.5 | encrypt_rand_num | str | false | 10 | 加密随机因子（仅在被扫支付类交易报文中出现： 若付款码为 19 位数字，则取后 6 位； 若付款码为 EMV 二维码，则取其 tag 57 的卡号/token 号的后 6 位） | 565551 | | 2.24.6 | network_license | str | false | 5 | 终端入网认证编号（银行卡受理终端产品应用认证编 号。该编号由“中国银联标识产品 企业资质认证办公室”为通过入网 认证的终端进行分配。 银联直连终 端必填。 格式： 5 位字符，例如 P3100） | | | 2.25 | location_info | obj | false | 500 | 基站信息 | | | 2.25.1 | telecom_network_id | str | false | 4 | 电信网络识别码 | 5D18 | | 2.25.2 | lbs_signal3 | str | false | 4 | 基站信号3(SIG(移动、联通)， 16 进制) | 0027 | | 2.25.3 | lbs_signal1 | str | false | 4 | 基站信号1（SIG(移动、联通)， 16 进制） | 0044 | | 2.25.4 | lbs_signal2 | str | false | 4 | 基站信号2（SIG(移动、联通)， 16 进制） | 002B | | 2.25.5 | location_cd1 | str | false | 4 | 位置区域码1（LAC(移动、联通)， 16 进制） | 18C0 | | 2.25.6 | icc_id | str | false | 20 | ICCID（SIM卡卡号） | | | 2.25.7 | location_cd3 | str | false | 4 | 位置区域码3（LAC(移动、联通)， 16 进制） | 18C0 | | 2.25.8 | telecom_lbs_signal | str | false | 4 | 电信基站信号（SIG（电信），16进制） | 004F | | 2.25.9 | mobile_country_cd | str | false | 3 | 移动国家代码（基站信息，由国际电联(ITU)统一分配的移动 国家代码（MCC）。 中国为 460） | 460 | | 2.25.10 | location_cd2 | str | false | 4 | 位置区域码2（LAC(移动、联通)， 16 进制） | 18C0 | | 2.25.11 | telecom_system_id | str | false | 4 | 电信系统识别码（NID（电信），电信网络识别码,由电信各由地 级分公司分配。每个地级市可能有1到3个NID） | 0011 | | 2.25.12 | mobile_network_num | str | false | 2 | 移动网络代码（基站信息，由国际电联(ITU)统一分配的移动 网络号码（MNC）。 移动： 00、 02、 04、 07；联通： 01、 06、 09； 电信： 03、 05、 11） | 11 | | 2.25.13 | lbs_num2 | str | false | 12 | 基站编号2（CID(移动、联通)， 16 进制） | 000000004E2E | | 2.25.14 | telecom_lbs | str | false | 4 | 电信基站（BID（电信），电信网络中的小区识别码，等 效于基站） | A206 | | 2.25.15 | lbs_num1 | str | false | 12 | 基站编号1（CID(移动、联通)， 16 进制） | 000000004DDD | | 2.25.16 | lbs_num3 | str | false | 12 | 基站编号3（CID(移动、联通)， 16 进制） | 000000004E30 | | 2.26 | longitude | str | false | 10 | 经度（该字段必输） | | | 2.27 | latitude | str | false | 10 | 纬度（该字段必输） | | ### 响应参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ----- | ------------------- | ---- | -------- | -------- | --------------------------------- | -------------------- | | 1 | biz_state | str | true | 1 | 返回访问状态字S-成功F-失败 | S | | 2 | rsp_code | str | true | 60 | 返回码 | | | 3 | rsp _msg | str | | 60 | 逻辑异常返回信息 | | | 4 | rsp_body | str | false | 1 | rsp_body | rsp_body;{} | | 4.1 | pay_mer_tran_no | str | false | 40 | 商户交易编号 | 12185644621782145186 | | 4.2 | total_amount | str | false | 15 | 商户订单总金额 | 99.00 | | 4.3 | trd_dsct_amount | str | false | 15 | 第三方活动优惠金额 | 2.00 | | 4.4 | require_values | str | false | 1000 | 额外返回的字段 | require_values:{} | | 4.4.1 | bank_tran_no | str | false | | 银行端交易流水号 | | | 4.4.2 | refund_info | str | false | | 微信支付宝详细退货信息 | | | 4.4.3 | payment_info | str | false | | 微信支付宝详细付款信息 | | | 4.4.4 | third_party | str | false | | 第三方渠道 | | | 4.4.5 | third_party_tran_no | str | false | | 第三方渠道交易流水号 | | | 4.5 | currency | str | false | | 币种 | | | 4.6 | detail | str | false | 500 | 商品详情 | 商品详情：xxx | | 4.7 | buyer_pay_amount | str | false | 15 | 买家实付金额 | 96.00 | | 4.8 | sys_order_no | str | false | 64 | 交行内部订单号 | 010220215522230 | | 4.9 | pay_dsct_amount | str | false | 15 | 支付优惠金额 | 1.00 | | 5 | rsp_head | str | false | 1 | rspHead | rspHead:{} | | 5.1 | trans_code | str | false | | 交易标识 | | | 5.2 | response_code | str | false | 15 | 返回码 | response_code | | 5.3 | response_status | str | true | 1 | 交易状态 P-处理中 F-失败 S-成功 | response_status | | 5.4 | response_time | str | false | 15 | 响应时间 | response_time | | 5.5 | response_msg | str | false | 200 | 返回码描述 | response_msg | ## 订单查询接口 - 接口说明 - 需要查询订单及明细状态，调用此接口 - 支持两种方式查询： - pay_mer_tran_no + mer_trade_date - sys_order_no - 调用方式 - **HTTP POST** - 编码格式 - **UTF-8** - 接口地址 - **/payOrder** ### 请求参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ----- | --------------- | ---- | -------- | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | 1 | req_head | str | false | 1 | | req_head | | 1.1 | trans_time | str | false | 14 | 交易时间 yyyyMMddHHmmss | 20210816153011 | | 1.2 | version | str | true | 100 | 版本号，默认上送1.0 | 1.0 | | 2 | req_body | str | false | 1 | | req_body | | 2.1 | mer_trade_date | str | false | 8 | 原交易商户侧交易日期 yyyyMMdd | 20210312 | | 2.2 | partner_id | str | false | 32 | 服务商编号 | 000202102036258 | | 2.3 | pay_mer_tran_no | str | false | 40 | 商户交易编号，商户自定义的订单号，当日不可重复 | 12185644621782145186 | | 2.4 | tran_scene | str | true | 40 | 交易场景，支付交易上送的交易场景，如B2C-API-DISPLAYCODE等 | B2C-API-DISPLAYCODE | | 2.5 | require_fields | list | false | 1 | 目前支持的字段包括银行端交易流水号bank_tran_no、第三方渠道third_party、第三方渠道交易流水号third_party_tran_no、微信支付宝详细付款信息payment_info、微信支付宝详细付款信息refund_info | [{"require_field":"bank_tran_no"},{"require_field":"third_party"}] | | 2.5.1 | require_field | str | false | | 额外返回的属性 | | | 2.6 | mer_ptc_id | str | true | 15 | 商户编号 | 131058140000089 | | 2.7 | sys_order_no | str | false | 32 | 交行系统订单号，订单号和商户交易编号二选一，若送了优先使用系统订单号查询 | 01000020201211131343 | ### 响应参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ----- | ---------------- | ---- | -------- | -------- | ------------------------------- | ------------------------------------------------------------ | | 1 | biz_state | str | true | 1 | 返回访问状态字S-成功F-失败 | S | | 2 | rsp_code | str | true | 60 | 返回码 | | | 3 | rsp _msg | str | | 60 | 逻辑异常返回信息 | | | 4 | rsp_body | str | false | 10 | | rsp_body | | 4.1 | mer_memo | str | false | 200 | 商户内部备注 | | | 4.2 | trd_dsct_amount | str | false | 18 | 第三方活动优惠金额 | | | 4.3 | require_values | str | false | 1 | | | | 4.3.1 | bank_tran_no | str | false | | | | | 4.3.2 | third_party | str | false | | | | | 4.4 | tran_state | str | false | 20 | PROCESS：处理中 | PROCESS 处理中SUCCESS 交易成功FAILURE 交易失败 | | 4.5 | currency | str | false | 3 | 币种目前只支持CNY | CNY | | 4.6 | buyer_pay_amount | str | false | 18 | 买家实付金额 | | | 4.7 | tran_state_code | str | false | 10 | 交易状态码 | | | 4.8 | tran_state_msg | str | false | 100 | 交易状态提示 | | | 4.9 | pay_mer_tran_no | str | false | 40 | 商户交易编号 | | | 4.10 | total_amount | str | false | 18 | 商户订单总金额 | | | 4.11 | refunded_amt | str | false | 18 | 商户已退款金额 | | | 4.12 | tran_content | str | false | 500 | 交易内容 | | | 4.13 | pay_dsct_amount | str | false | 18 | 支付优惠金额 | | | 4.14 | order_status | str | false | 20 | 订单状态 以此字段来确定订单状态 | INITIAL初始化PAIED交易成功WAITPAY等待支付REFUNDED部分退款REFUNDALL全部退款CLOSED订单关闭 | | 5 | rsp_head | str | false | 10 | | rsp_head | | 5.1 | trans_code | str | false | 10 | 交易码 | | | 5.2 | response_code | str | false | 14 | 响应码 | | | 5.3 | response_status | str | false | | 交易状态 | 交易状态P:处理中 F:失败 S:成功 | | 5.4 | response_time | str | false | | 响应时间 | | | 5.5 | response_msg | str | false | | 响应信息 | | ## 退款接口 - 接口说明 - 对于支付完成的交易，需要进退款操作的，调用此接口来进行退款 - 调用方式 - **HTTP POST** - 编码格式 - **UTF-8** - 接口地址 - **/refund** ### 请求参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ----- | ------------------ | ---- | -------- | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | 1 | req_head | obj | true | 1 | 请求头 | req_head | | 1.1 | trans_time | str | true | 14 | 交易时间， 格式：yyyyMMddHHmmss | 20210816153011 | | 1.2 | version | str | true | 100 | 版本号，默认上送2.0 | 2.0 | | 2 | req_body | obj | true | 1 | 请求体 | req_body | | 2.1 | royalty_info | list | false | | 商户分账信息（最多6组） | [{"serial_no":"01","amount":"5.00"},{"serial_no":"02","amount":"5.00"}] | | 2.1.1 | amount | str | false | | 分账金额 | | | 2.1.2 | serial_no | str | false | | 分账的序号 | | | 2.2 | amount | str | true | 18 | 退款金额，单位元 | 1.00 | | 2.3 | tran_scene | str | true | 40 | 交易场景，上送原支付交易场景如：B2C-API-DISPLAYCODE | B2C-API-DISPLAYCODE | | 2.4 | mer_ptc_id | str | true | 15 | 商户编号 | 301310063009501 | | 2.5 | notify_url | str | false | 200 | 后台通知地址 | | | 2.6 | mer_trade_date | str | false | 8 | 原交易商户侧交易日期 | 20200805 | | 2.7 | shop_id | str | false | 32 | 门店id | 15762125456741 | | 2.8 | partner_id | str | false | 32 | 服务商编号 | FWS201906290001 | | 2.9 | pay_mer_tran_no | str | false | 40 | 原交易商户交易编号 | 12185644621782145185 | | 2.10 | mer_memo | str | false | 200 | 商户内部备注 | 退款测试 | | 2.11 | refund_mer_tran_no | str | true | 40 | 商户退款的交易编号 | 12185644621782145186 | | 2.12 | currency | str | true | 3 | 币种，境内商户仅支持人民币,固定上送CNY | CNY | | 2.13 | mer_refund_time | str | true | 6 | 商户侧退款时间 格式：hhmmss | 110600 | | 2.14 | mer_refund_date | str | true | 8 | 商户侧退款日期 格式：yyyyMMdd | 20201215 | | 2.15 | tran_content | str | false | 500 | 交易内容，可查询 | 交易内容 | | 2.16 | sys_order_no | str | false | 32 | 交行内部订单号，交行内部订单号和商户交易编号二选一，若同时上送优先使用系统订单号 | 2020080502215132 | ### 响应参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ---- | ------------------ | ---- | -------- | -------- | ------------------------------------------------ | -------------- | | 1 | biz_state | str | true | 1 | 返回访问状态字S-成功F-失败 | S | | 2 | rsp_code | str | true | 60 | 返回码 | | | 3 | rsp _msg | str | | 60 | 逻辑异常返回信息 | | | 4 | rsp_body | obj | false | 1 | 响应体 | rsp_body | | 4.1 | done_refund_amount | str | false | 18 | 合计已退款金额 | 2.00 | | 4.2 | total_amount | str | false | 18 | 该笔退款对应的交易的订单金额 | 10.00 | | 4.3 | refund_amount | str | false | 18 | 本次退款请求对应的退款金额 | 1.00 | | 4.4 | currency | str | false | 3 | 币种目前只支持CNY | CNY | | 4.5 | channel_type | str | false | 2 | 通道类型 01本行B2C 02跨行B2C 03本行B2B 04跨行B2B | 01 | | 4.6 | refund_order_no | str | false | 20 | 退款单据号 | 202101130002 | | 4.7 | sys_order_no | str | false | 32 | 交行内部订单号 | 202101130002 | | 4.8 | pay_dsct_amount | str | false | 18 | 退款支付优惠金额 | 1.00 | | 5 | rsp_head | obj | false | 1 | 响应头 | rsp_head | | 5.1 | trans_code | str | false | 10 | 交易码 | MPNG020701 | | 5.2 | response_code | str | false | 14 | 响应码 | ECBSPY0000 | | 5.3 | response_status | str | false | 1 | 交易状态P:处理中 F:失败 S:成功 | S | | 5.4 | response_time | str | false | 14 | 响应时间 | 20201211131343 | | 5.5 | response_msg | str | false | 128 | 响应信息 | 交易成功 | ## 退款查询接口 - 接口说明 - 提交退款申请后，通过调用该接口查询退款状态。 - 支持两种方式查询： - pay_mer_tran_no + mer_trade_date - sys_order_no - 调用方式 - **HTTP POST** - 编码格式 - **UTF-8** - 接口地址 - **/refundOrder** ### 请求参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ---- | ------------------ | ---- | -------- | -------- | ------------------------------------------------------------ | --------------------- | | 1 | req_head | str | false | 1 | | req_head | | 1.1 | trans_time | str | false | 14 | 交易时间 yyyyMMddHHmmss | 20210816153011 | | 1.2 | version | str | true | 100 | 版本号 | 1.0 | | 2 | req_body | str | false | 1 | | req_body | | 2.1 | partner_id | str | false | 32 | 服务商编号 | 000202102036258 | | 2.2 | tran_scene | str | true | 40 | 交易场景，原支付交易的场景：如B2C-API-DISPLAYCODE | B2C-API-DISPLAYCODE | | 2.3 | refund_mer_tran_no | str | false | 28 | 商户退款的交易编号，需确保当日不重复 | 12185644621782145186 | | 2.4 | mer_ptc_id | str | true | 15 | 商户编号 | 131058140000089 | | 2.5 | mer_refund_date | str | false | 8 | 商户侧退款日期，格式：hhmmss | 20201215 | | 2.6 | sys_order_no | str | false | 32 | 交行内部订单号，交行内部订单号和商户退款交易编号二选一，若送了优先使用系统订单号查询 | 012185644621782145185 | ### 响应参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ---- | ------------------ | ---- | -------- | -------- | ------------------------------- | ------------------------------------------------------------ | | 1 | biz_state | str | true | 1 | 返回访问状态字S-成功F-失败 | S | | 2 | rsp_code | str | true | 60 | 返回码 | | | 3 | rsp _msg | str | | 60 | 逻辑异常返回信息 | | | 4 | rsp_body | str | false | | | rsp_body | | 4.1 | tran_state_msg | str | false | 100 | 交易状态提示 | | | 4.2 | order_status | str | false | 20 | 订单状态 以此字段来确定订单状态 | INITIAL初始化PAIED交易成功WAITPAY等待支付REFUNDED部分退款REFUNDALL全部退款CLOSED订单关闭 | | 4.3 | mer_memo | str | false | 200 | 商户内部备注 | | | 4.4 | done_refund_amount | str | false | 18 | 合计已退款金额 | | | 4.5 | total_amount | str | false | 18 | 该笔退款对应的交易的订单金额 | | | 4.6 | refund_amount | str | false | 18 | 本次退款请求对应的退款金额 | | | 4.7 | tran_state | str | false | 20 | PROCESS：处理中 | PROCESS 处理中SUCCESS 交易成功FAILURE 交易失败 | | 4.8 | currency | str | false | 3 | 币种目前只支持CNY | | | 4.9 | tran_content | str | false | 500 | 交易内容 | | | 4.10 | tran_state_code | str | false | 10 | 交易状态码 | | | 4.11 | pay_dsct_amount | str | false | 18 | 退款支付优惠金额 | | | 5 | rsp_head | str | false | | | rsp_head | | 5.1 | trans_code | str | false | 10 | 交易码 | | | 5.2 | response_code | str | false | 14 | 响应码 | | | 5.3 | response_status | str | false | 1 | 交易状态 | 交易状态P:处理中 F:失败 S:成功 | | 5.4 | response_time | str | false | 14 | 响应时间 | | | 5.5 | response_msg | str | false | 128 | 响应信息 | | ## 关闭订单接口 - 接口说明 - 通过此接口关闭此前已创建的订单。 - 调用方式 - **HTTP POST** - 编码格式 - **UTF-8** - 接口地址 - **/closeOrder** ### 请求参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ---- | ----------------- | ---- | -------- | -------- | ----------------------- | -------------------- | | 1 | req_head | str | true | 1 | req_head | req_head：{} | | 1.1 | trans_time | str | true | 14 | 交易时间 yyyyMMddHHmmss | 20210816153011 | | 1.2 | version | str | true | 100 | 版本信息 | V-1.0 | | 2 | req_body | str | false | 1 | req_body | req_body:{} | | 2.1 | mer_trade_date | str | true | 8 | 商户侧原交易日期 | 20210317 | | 2.2 | partner_id | str | false | 40 | 服务商编号 | 12223666998512 | | 2.3 | pay_mer_tran_no | str | false | 46 | 支付交易商户交易编号 | 20210316210124678562 | | 2.4 | mer_ptc_id | str | true | 15 | 商户编号 | 133182110000071 | | 2.5 | close_mer_tran_no | str | true | 46 | 商户交易编号 | 20210316210124678562 | ### 响应参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ---- | ----------------- | ---- | -------- | -------- | --------------------------------- | ---------------------------- | | 1 | biz_state | str | true | 1 | 返回访问状态字S-成功F-失败 | 0 | | 2 | rsp_code | str | true | 60 | 返回码 | | | 3 | rsp _msg | str | | 60 | 逻辑异常返回信息 | | | 4 | rsp_body | str | false | 1 | rsp_body | rsp_body:{} | | 4.1 | close_mer_tran_no | str | false | 46 | 订单号 | 040220210316205912002052267Y | | 5 | rsp_head | str | false | 1 | rsp_head | rsp_head:{} | | 5.1 | trans_code | str | true | 10 | 交易标识 | MPNG020705 | | 5.2 | response_code | str | false | 14 | 返回码 | CIPP0000PY0000 | | 5.3 | response_status | str | true | 2 | 交易状态 P-处理中 F-失败 S-成功 | S | | 5.4 | response_time | str | false | 14 | 响应时间 | 202103171100 | | 5.5 | response_msg | str | false | 128 | 返回码描述 | 交易成功 | ## 主扫聚合码接口 - 接口说明 - 本接口返回的地址可以制作成动态二维码用于用户使用手机端扫码支付某一笔订单时调用，该二维码有效期可自定义，并且无论成功失败，该码只可扫一次。 - 调用方式 - **HTTP POST** - 编码格式 - **UTF-8** - 接口地址 - **/qrPay** ### 请求参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ------- | -------------------- | ---- | -------- | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | 1 | req_head | str | true | 1 | req_head | req_head：{} | | 1.1 | trans_time | str | true | 14 | 交易时间 yyyyMMddHHmmss | 20210816153011 | | 1.2 | version | str | true | 100 | 版本信息 | V-1.0 | | 2 | req_body | str | false | 1 | | req_body:{} | | 2.1 | royalty_info | list | false | 1000 | 商户分账信息 | [{"serial_no":"01","amount":"5.00"},{"serial_no":"02","amount":"5.00"}] | | 2.1.1 | amount | str | false | | 分账金额 | | | 2.1.2 | serial_no | str | false | | 分账的序号 | | | 2.2 | valid_period | str | false | 14 | 用于定义二维码的有效时间，默认5分钟 | 20210316095311 | | 2.3 | tran_scene | str | true | 40 | 交易场景 | B2C-API-DISPLAYCODE | | 2.4 | terminal_info | str | false | 50 | 终端号 | 00000001 | | 2.5 | mer_ptc_id | str | true | 15 | 商户编号 | 301310063009501 | | 2.6 | mer_trade_time | str | true | 6 | 商户侧交易时间 | 095711 | | 2.7 | notify_url | str | false | 200 | 后台通知地址 | | | 2.8 | location_id | str | false | 100 | 经纬度信息 | 102.13,112.09 | | 2.9 | mer_trade_date | str | true | 8 | 商户侧交易日期 | 20210316 | | 2.10 | shop_id | str | false | 40 | 门店编号 | 332211001 | | 2.11 | fee_split_info | str | false | 1 | 服务商分润信息 | fee_split_info:{} | | 2.11.1 | partner_amount | str | false | | 服务商分润金额 | | | 2.11.2 | mer_amount | str | false | | 商户结算金额 | | | 2.12 | partner_id | str | false | 32 | 服务商编号 | 102365214532 | | 2.13 | pay_mer_tran_no | str | true | 40 | 商户交易编号 | 12185644621782145186 | | 2.14 | jump_url | str | false | 200 | 不带报文的前台跳转地址 | | | 2.15 | mer_memo | str | false | 200 | 商户内部备注 | 备注 | | 2.16 | total_amount | str | false | 15 | 商户订单总金额（元） | 1.00 | | 2.17 | require_fields | list | false | 1 | 需要通知或查询中返回的字段，可以上送需要在后台通知中额外返回的字段 | [{"require_field":"bank_tran_no"},{"require_field":"third_party"}] | | 2.17.1 | require_field | str | false | | 额外返回的属性 | | | 2.18 | location | str | true | 7 | 线上或线下 | ONLINE-线上 OFFLINE-线下 | | 2.19 | currency | str | true | 3 | 币种 | CNY | | 2.20 | tran_content | str | false | 500 | 交易内容 | 商品名称：xxx | | 2.21 | disable_pay_channels | str | false | 100 | 支付禁用渠道 | balance, moneyFund多个之间用,分隔，具体见字段说明3.4 | | 2.22 | term_info | obj | false | 500 | 终端信息 | | | 2.22.1 | device_type | str | true | 2 | 设备类型（终端设备类型，受理方可参考终端 注册时的设备类型填写，取值如下： 01：自动柜员机（含 ATM 和 CDM） 和多媒体自助终端 02：传统 POS 03： mPOS 04：智能 POS 05： II 型固定电话 06：云闪付终端； 07：保留使用； 08：手机 POS； 09：刷脸付终端；15 10：条码支付受理终端； 11：条码支付辅助受理终端； 12： 行业终端（公交、地铁用于指 定行业的终端）； 13： MIS 终端） | 10 | | 2.22.2 | secret_text | str | false | 16 | 密文数据（仅在被扫支付类交易报文中出现： 64bit 的密文数据，对终端硬件序列 号和加密随机因子加密后的结果。 本子域取值为： 64bit 密文数据进行 base64 编码后的结果） | OTk3MzBFQ0Q\u003d | | 2.22.3 | app_version | str | false | 8 | 应用程序版本号（终端应用程序的版本号。应用程序 变更应保证版本号不重复。 当长度 不足时，右补空格。） | 21.06.23 | | 2.22.4 | serial_num | str | false | 50 | 终端序列号（出现要求： 终端类型（device_type）填写为 02、 03、 04、 05、 06、 08、 09 或 10 时，必须填写终端序列号。） | 000002020940026552 | | 2.22.5 | encrypt_rand_num | str | false | 10 | 加密随机因子（仅在被扫支付类交易报文中出现： 若付款码为 19 位数字，则取后 6 位； 若付款码为 EMV 二维码，则取其 tag 57 的卡号/token 号的后 6 位） | 565551 | | 2.22.6 | network_license | str | false | 5 | 终端入网认证编号（银行卡受理终端产品应用认证编 号。该编号由“中国银联标识产品 企业资质认证办公室”为通过入网 认证的终端进行分配。 银联直连终 端必填。 格式： 5 位字符，例如 P3100） | | | 2.23 | location_info | obj | false | 500 | 基站信息 | | | 2.23.1 | telecom_network_id | str | false | 4 | 电信网络识别码（NID（电信），电信网络识别码,由电信各由地 级分公司分配。每个地级市可能有1到3个NID） | 5D18 | | 2.23.2 | lbs_signal3 | str | false | 4 | 基站信号3（SIG(移动、联通)， 16 进制） | 0027 | | 2.23.3 | lbs_signal1 | str | false | 4 | 基站信号1（SIG(移动、联通)， 16 进制） | 0044 | | 2.23.4 | lbs_signal2 | str | false | 4 | 基站信号2（SIG(移动、联通)， 16 进制） | 002B | | 2.23.5 | location_cd1 | str | false | 4 | 位置区域码1（LAC(移动、联通)， 16 进制） | 18C0 | | 2.23.6 | icc_id | str | false | 20 | ICCID（SIM卡卡号） | | | 2.23.7 | location_cd3 | str | false | 4 | 位置区域码3（LAC(移动、联通)， 16 进制） | 18C0 | | 2.23.8 | telecom_lbs_signal | str | false | 4 | 电信基站信号（SIG（电信），16进制） | 004F | | 2.23.9 | mobile_country_cd | str | false | 3 | 移动国家代码（基站信息，由国际电联(ITU)统一分配的移动 国家代码（MCC）。 中国为 460） | 460 | | 2.23.10 | location_cd2 | str | false | 4 | 位置区域码2（LAC(移动、联通)， 16 进制） | 18C0 | | 2.23.11 | telecom_system_id | str | false | 4 | 电信系统识别码（SID（电信），电信系统识别码,每个地级市只 有一个 SID） | 0011 | | 2.23.12 | mobile_network_num | str | false | 2 | 移动网络代码（基站信息，由国际电联(ITU)统一分配的移动 网络号码（MNC）。 移动： 00、 02、 04、 07；联通： 01、 06、 09； 电信： 03、 05、 11） | 11 | | 2.23.13 | lbs_num2 | str | false | 12 | 基站编号2（CID(移动、联通)， 16 进制） | 000000004E2E | | 2.23.14 | telecom_lbs | str | false | 4 | 电信基站（BID（电信），电信网络中的小区识别码，等 效于基站） | A206 | | 2.23.15 | lbs_num1 | str | false | 12 | 基站编号1（CID(移动、联通)， 16 进制） | 000000004DDD | | 2.23.16 | lbs_num3 | str | false | 12 | 基站编号3（CID(移动、联通)， 16 进制） | 000000004E30 | | 2.24 | longitude | str | false | 10 | 经度 | | | 2.25 | latitude | str | false | 10 | 纬度 | | | 2.26 | ip | str | false | 40 | 终端IP（如经纬度（longitude、latitude）这两字段未上送， 该字段必送。） | | ### 响应参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ---- | ----------------- | ---- | -------- | -------- | ------------------------------------------------------------ | ---------------------------------------------------- | | 1 | biz_state | str | true | 1 | 返回访问状态字S-成功F-失败 | S | | 2 | rsp_code | str | true | 60 | 返回码 | | | 3 | rsp _msg | str | | 60 | 逻辑异常返回信息 | | | 4 | rsp_body | str | false | 1 | rsp_body | rsp_body:{} | | 4.1 | shop_id | str | false | 40 | 门店识别号 | 00012532541 | | 4.2 | pay_mer_tran_no | str | false | 40 | 商户交易编号 | 12185644621782145186 | | 4.3 | display_code_text | str | false | 500 | 收款二维码文本（测试环境要在前面加上http://yunbanktest.bankcomm.com/tcipp/pmss/cipp.jsp?qrCode= ） | https://qr.95516.com/03010000/kl6im4od20200804123754 | | 5 | rsp_head | str | false | 1 | rsp_head | rsp_head：{} | | 5.1 | trans_code | str | true | 10 | 交易标识 | MPNG210001 | | 5.2 | response_code | str | false | 15 | 返回码 | CIPP0004PY0001 | | 5.3 | response_status | str | true | 1 | 交易状态 P-处理中 F-失败 S-成功 | F | | 5.4 | response_time | str | false | 14 | 响应时间 | 20210316102322 | | 5.5 | response_msg | str | false | 200 | 返回码描述 | 交易失败 | ## 交易回调通知接口 - 接口说明 - 通过交易时传递的notify_url后台通知地址，进行交易回调通知 - 调用方式 - **HTTP POST** - 编码格式 - **UTF-8** ### 请求参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ---- | ----------------------- | ---- | -------- | -------- | ------------------------------------------- | -------------------------- | | 1 | notify_url | str | true | 200 | 该参数必输，为通知第三方的URL. | | | 2 | tran_type | str | true | 6 | 交易类型 PAY-支付 | PAY | | 3 | mer_tran_no | str | true | 28 | 商户交易编号 | mer_tran_no | | 4 | tran_state | str | true | 8 | 交易状态 SUCCESS：交易成功 FAILURE 交易失败 | tran_state | | 5 | tran_state_code | str | true | 10 | 交易状态码 | tran_state_code | | 6 | tran_state_msg | str | true | 100 | 交易状态提示 | tran_state_msg | | 7 | partner_id | str | true | 32 | 服务商编号 | 123456 | | 8 | mer_ptc_id | str | true | 15 | 商户编号 | mer_ptc_id | | 9 | final_time | str | true | 14 | 交易终态时间 | 20200804153000 | | 10 | total_amount | str | true | 18 | 商户订单总金额（元） | 100.00 | | 11 | buyer_pay_amount | str | true | 18 | 买家实付金额 | 95.00 | | 12 | trd_dsct_amount | str | true | 18 | 第三方活动优惠金额 | 1.00 | | 13 | pay_dsct_amount | str | true | 18 | 支付优惠金额 | 1.00 | | 14 | points | str | true | 10 | 交易使用积分 | 100 | | 15 | points_deduction_amount | str | true | 18 | 积分抵扣金额 | 0.20 | | 16 | coupon_total_amount | str | true | 18 | 优惠券抵扣金额 | 1.00 | | 17 | instlmt_no | str | true | 2 | 分期数 | 12 | | 18 | currency | str | true | 3 | 币种 | CNY | | 19 | tran_content | str | true | 500 | 交易内容 | 交易内容 | | 20 | mer_memo | str | true | 200 | mer_memo | mer_memo | | 21 | require_values | str | true | 1 | 需要返回的值 | require_values | | 21.1 | bank_tran_no | str | true | 32 | 银行端交易流水 | bank_tran_no | | 21.2 | third_party | str | true | 20 | 微信、 支付宝、 银联 | 01微信02支付宝03银联04交行 | | 21.3 | third_party_tran_no | str | true | 62 | 第三方渠道交易流水号 | third_party_tran_no | | 21.4 | payment_info | str | true | 1000 | 微信支付宝详细付款信息 | payment_info | | 21.5 | open_id | str | true | 1000 | 付款人信息（微信用户标识/支付宝用户ID） | open_id | | 21.6 | sub_openId | str | true | 1000 | 付款人信息（微信用户子标识/买家支付宝账号） | sub_openId | ### 响应参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ---- | --------- | ---- | -------- | -------- | -------------------------- | ------ | | 1 | biz_state | str | true | 1 | 返回访问状态字S-成功F-失败 | S | | 2 | rsp_code | str | true | 60 | 返回码 | | | 3 | rsp _msg | str | | 60 | 逻辑异常返回信息 | | ## 账单下载接口 - 接口说明 - 此接口可下载历史交易对账单 - 调用方式 - **HTTP POST** - 编码格式 - **UTF-8** - 接口地址 - **/dowNewPostStmt** ### 请求参数 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ---- | ----------- | ---- | -------- | -------- | ---------- | ---------------- | | 1 | stmt_date | str | true | 10 | 清算日期 | yyyy-MM-dd | | 2 | isv_no | str | false | 40 | 联盟商编号 | | | 3 | merch_code | str | true | 40 | 商户号 | | | 4 | template_no | str | false | 4 | 模板编号 | 02-标准api对账单 | ### 响应参数 - 业务参数统一在响应header中获取，key为rsp_biz_content - 当biz_state=S时，响应体以流方式响应账单文件。 | 序号 | 参数名 | 类型 | 是否必输 | 最大长度 | 描述 | 示例值 | | ---- | --------- | ---- | -------- | -------- | -------------------------- | ------ | | 1 | biz_state | str | true | 1 | 返回访问状态字S-成功F-失败 | S | | 2 | rsp_code | str | false | 60 | 返回码 | | | 3 | rsp _msg | str | false | 60 | 逻辑异常返回信息 | | | 4 | file_name | str | false | | 文件名称 | |
聚合支付平台
2023年4月19日 17:48
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
分享
链接
类型
密码
更新密码