|
|
@@ -1,132 +1,149 @@
|
|
|
-# 移动端H5页面支付接入规范文档V4.2.1
|
|
|
+# 移动端H5页面支付接入规范文档V4.3.1
|
|
|
[上海偶可贝网络科技有限公司](https://www.allpayx.com)
|
|
|
|
|
|
-* 版本信息：中文 V4.2.1
|
|
|
-* 更新时间：2018 年6 月
|
|
|
+* 版本信息：中文 V4.3.1
|
|
|
+* 更新时间：2018 年12 月
|
|
|
|
|
|
#### 1.概述
|
|
|
|
|
|
AllPay为基于移动H5页面支付集成云端SDK，以帮助客户实现快速、安全、集 中式的接入支付渠道。
|
|
|
|
|
|
-#### 2.通用API说明
|
|
|
-商户服务器和 AllPay 网关对接的通用接口,每个渠道都具有的功能,包括:消费,退款,查询接口。
|
|
|
+#### 2.交易流程
|
|
|
+
|
|
|
|
|
|
-##### 2.1. 验签说明
|
|
|
+##### 3. 验签说明
|
|
|
|
|
|
```
|
|
|
1.对于发送到 ALLPAY 系统的 POST 请求报文，其中所有传入参数(除 signature 参数外)按照字段名的 ASCII 码从小到大排序后(字典序)，使用 URL 键值对的格式(即 key1=value1&key2=value2...)拼接成字符串 String1。
|
|
|
|
|
|
2.在 String1 最后直接拼接(不需要用“&”连接)双方约定的签名密钥 K1(接入时 ALLPAY 时分配)，得到 stringSignTemp 字符串,并对 stringSignTemp 进行 md5 运算，得到 signature 的值。
|
|
|
|
|
|
-3.示例签名串 acqID=99020344&backURL=http://example.com/example&charSet=UTF- 8&frontURL=nil&merID=000000000000015&merReserve=nil&orderAmount=0.01&orderCurre ncy=CNY&orderNum=869873851812&paymentSchema=APMP&signType=MD5&transTime= 20151112151356&transType=PURC&version=VER0000000022f2c77e3718c47cfb47a89a6fbc9d361
|
|
|
+3.示例签名串 acqID=99020344&backURL=https://baidu.com&charSet=UTF-8&detailInfo=W3siZ29vZHNfbmFtZSI6IuWNjuS4ulAyMCIsInF1YW50aXR5IjoiMiJ9LHsiZ29vZHNfbmFtZSI6IuWNjuS4ulAyMCBwbHVzIiwicXVhbnRpdHkiOiI0In1d&frontURL=https://mchapi.allpayx.com/demo&goodsInfo=华为P20&merID=000000000000015&merReserve=你好&orderAmount=1&orderCurrency=HKD&orderNum=dKmdb4S9Tv1a9ZpkMjeDawV82MCJ&paymentSchema=AP&signType=MD5&transTime=20181206134515&transType=PURC&version=VER0000000022f2c77e3718c47cfb47a89a6fbc9d361
|
|
|
|
|
|
```
|
|
|
-##### 2.2. 通用API 接入地址
|
|
|
-
|
|
|
- 交易名称 |开发调试地址|生产交易地址
|
|
|
- ------- |-----------|-------
|
|
|
- 消费接口 |https://mchapi.allpayx.com/testjspay |https://mchapi.allpayx.com/jspay
|
|
|
- 查询接口 |https://testapi.allpayx.com/pay/v1 |https://api.allpayx.com/pay/v1
|
|
|
- 退款接口 |https://testapi.allpayx.com/pay/v1 |https://api.allpayx.com/pay/v1
|
|
|
-
|
|
|
-
|
|
|
-#### 3. API接口
|
|
|
-##### 3.1. 消费交易接口
|
|
|
-
|
|
|
-将相关参数,以表单形式提交到指定 url,即可调起支付。
|
|
|
-
|
|
|
-
|
|
|
- 序号 |名称 |长度|类型|参数名称|备注
|
|
|
- -----|-----|----|----|------|------
|
|
|
- 1|版本号|12|文本|version |统一填写为“VER000000002”
|
|
|
- 2|字符集编码 |6|文本|charSet |统一填写为“UTF-8”
|
|
|
- 3|交易类型 |4|文本|transType |消费交易填写“PURC”
|
|
|
- 4|订单号 |60|文本|orderNum |商户自行定义，需保证同一商户号下订单号不能重复
|
|
|
- 5|订单金额 |12|文本|orderAmount |如 100 元，表示为 100 或 100.00
|
|
|
- 6|订单币种 |3|文本|orderCurrency |人民币填写“CNY”,美元填写"USD"
|
|
|
- 7|前端 URL 地址 |400|文本|frontURL |支付结果前端通知到该地址
|
|
|
- 8|后端 URL 地址 |400|文本|backURL |支付结果异步通知到该地址
|
|
|
- 9|商户预留字段 |1024 |文本|merReserve |商户预留内容，可传任意内容，如购买商品信息、员号等，但不要传特殊符号，如逗号。
|
|
|
- 10|商户代码 |15 |文本|merID |商户 ID，由AllPay 分配
|
|
|
- 11|收单行 ID |11 |文本|acqID |收单行 ID "99020344"
|
|
|
- 12|支付渠道代码 |10 |文本|paymentSchema|渠道代码：微信：WX, 支付报"APMP",银联 "UP"
|
|
|
- 13|商品信息 |60 |文本|goodsInfo | 商品信息
|
|
|
- 14|交易时间 |14 |文本|transTime |交易时间,格式:"yyyyMMddHHmmss"
|
|
|
- 15|签名类型 |3 |文本|signType |MD5
|
|
|
- 16|签名 |32 |文本|signature |采用 MD5 签名
|
|
|
-
|
|
|
-##### 3.2. 异步通知报文
|
|
|
-
|
|
|
- 序号 |名称 |长度|类型|参数名称|备注
|
|
|
- -----|-----|----|----|------|------
|
|
|
- 1|版本号|12|文本|version |统一填写为“VER000000002”
|
|
|
- 2|字符集编码 |6|文本|charSet |统一填写为“UTF-8”
|
|
|
- 3|交易类型 |4|文本|transType |消费交易填写“PURC”
|
|
|
- 4|订单号 |60|文本|orderNum |商户自行定义，需保证同一商户号下订单号不能重复
|
|
|
- 5|订单金额 |12|文本|orderAmount |如 100 元，表示为 100 或 100.00
|
|
|
- 6|订单币种 |3|文本|orderCurrency |人民币填写“CNY”,美元填写"USD"
|
|
|
- 7|清算金额 |12 |文本|settAmount |如 100 元，表示为 100 或 100.00
|
|
|
- 8|清算币种 |3|文本|settCurrency |符合 ISO 标准，填写数字类型
|
|
|
- 9|清算汇率 |7|文本|rate |实际汇率，7 位有效数字
|
|
|
- 10|商户预留字段 |1024 |文本|merReserve |商户预留内容，可传任意内容，如购买商品信息、员号等，但不要传特殊符号，如逗号。
|
|
|
- 11|GW 交易 ID |32|文本|transID |GW 系统生成的交易 ID，每笔交易保持唯一
|
|
|
- 12|商户代码 |15 |文本|merID |商户 ID，由AllPay 分配
|
|
|
- 13|收单行 ID |11 |文本|acqID |收单行 ID "99020344"
|
|
|
- 14|支付渠道代码 |10 |文本|paymentSchema|渠道代码：微信：WX, 支付报"APMP",银联 "UP"
|
|
|
- 15|交易应答码 |2 |文本|RespCode |应答码 00-成功
|
|
|
- 16|应答文字信息 |20 |文本|RespMsg |应答消息，全部为英文字符
|
|
|
- 17|交易时间 |14 |文本|transTime |交易时间,格式:"yyyyMMddHHmmss"
|
|
|
- 18|GW 处理时间 |14 |文本|GWTime |YYYYMMDDHHMMSS，为 GW 时间，目前为本地交易时间
|
|
|
- 19|签名类型 |3 |文本|signType |MD5
|
|
|
- 20|签名 |32 |文本|signature |采用 MD5 签名
|
|
|
-
|
|
|
-
|
|
|
-##### 3.3. 查询交易接口
|
|
|
+#### 4.通用API说明
|
|
|
|
|
|
|
|
|
|
|
|
+商户服务器和 AllPay 网关对接的通用接口,每个渠道都具有的功能,包括:消费,查询，退款,退款查询接口。
|
|
|
+
|
|
|
+##### 4.1. 通用API 接入地址
|
|
|
+
|
|
|
+| 接口名称 | 测试地址 | 生产地址 |
|
|
|
+| ------------ | ----------------------------------------- | ------------------------------------- |
|
|
|
+| 消费接口 | <https://mchapi.allpayx.com/testjspay> | <<https://mchapi.allpayx.com/jspay>> |
|
|
|
+| 交易查询接口 | <https://testapi.allpayx.com/pay> | <https://api.allpayx.com/pay> |
|
|
|
+| 退款接口 | <https://testapi.allpayx.com/refund> | <https://api.allpayx.com/refund> |
|
|
|
+| 退款查询接口 | <https://testapi.allpayx.com/refundquery> | <https://api.allpayx.com/refundquery> |
|
|
|
+
|
|
|
+##### 4.2. 消费交易接口
|
|
|
+
|
|
|
+1. 请求报文格式
|
|
|
+
|
|
|
+下面列举的字段为通用字段，每个渠道都需要上送，部分渠道有渠道专属字段，具体字段请到该渠道的专属渠到字段说明处查看. 消费接口分为跳转型和参数返回型，默认为跳转型，参数返回型会在 第5章（渠道专属配置）里面说明
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+| 参数 | 类型 | 属性 | 描述 |
|
|
|
+| ------------- | ------------ | ---- | ------------------------------------------------------------ |
|
|
|
+| version | String(12) | M | 统一填写为“VER000000002” |
|
|
|
+| charSet | String(6) | M | 统一填写为“UTF-8” |
|
|
|
+| transType | String(4) | M | 消费交易填写“PURC” |
|
|
|
+| orderNum | String(60) | M | 订单号：商户自行定义，需保证同一商户号下订单号不能重复 |
|
|
|
+| orderAmount | String(12) | M | 订单金额：如 100 元，表示为 100 或 100.00 |
|
|
|
+| orderCurrency | String(3) | M | 订单币种：ISO标准 如：人民币填写“CNY”,美元填写"USD" |
|
|
|
+| frontURL | String(400) | M | 支付完成后跳转到该地址 |
|
|
|
+| backURL | String(400) | M | 支付结果异步通知到该地址 |
|
|
|
+| merReserve | String(1024) | M | 商户预留内容，可传任意内容，如购买商品信息、员号等，但不要传特殊符号，如逗号。 |
|
|
|
+| merID | String(15) | M | 商户 ID，由AllPay 分配 |
|
|
|
+| acqID | String(11) | M | 收单行 ID "99020344" |
|
|
|
+| paymentSchema | String(10) | M | 渠道代码：[点击查看详情](https://git.allpayx.com/OpenAPI/b2c_pc_payment/src/master/paymentSchema.md) |
|
|
|
+| goodsInfo | String(60) | M | 商品信息,在支付页面上显示 |
|
|
|
+| detailInfo | String(400) | M | 商品明细 格式： [{"goods_name":"iPhone X","quantity":"2"},{"goods_name":"iPhone 8","quantity":"4"}]，需对该字段base64后签名上送 |
|
|
|
+| transTime | String(14) | M | 交易时间,格式:"yyyyMMddHHmmss" |
|
|
|
+| signType | String(3) | M | MD5 |
|
|
|
+| signature | String(32) | M | 采用 MD5 签名 |
|
|
|
+
|
|
|
+1. 跳转型消费接口响应报文
|
|
|
+
|
|
|
+ 商户需要提供一个 http/https 协议的接口，包含在参数里传递给 SDK，即 backURL。AllPay
|
|
|
+ 服务器在支付完成后，会以 Get 方式调用 backURL，通知支付结果。
|
|
|
+
|
|
|
+参数如下表:
|
|
|
+
|
|
|
+| 参数 | 类型 | 属性 | 描述 |
|
|
|
+| ------------- | ------------ | ---- | ------------------------------------------------------------ |
|
|
|
+| version | String(12) | M | 统一填写为“VER000000002” |
|
|
|
+| charSet | String(6) | M | 统一填写为“UTF-8” |
|
|
|
+| transType | String(4) | M | 消费交易填写“PURC” |
|
|
|
+| orderNum | String(60) | M | 订单号 |
|
|
|
+| orderAmount | String(12) | M | 订单金额：如 100 元，表示为 100 或 100.00 |
|
|
|
+| orderCurrency | String(3) | M | 订单币种：ISO标准 如：人民币填写“CNY”,美元填写"USD" |
|
|
|
+| settAmount | String(12) | M | 清算金额：如 100 元，表示为 100 或 100.00 |
|
|
|
+| settCurrency | String(3) | M | 清算币种：符合 ISO 标准 |
|
|
|
+| rate | String(7) | M | 实际汇率，7 位有效数字 |
|
|
|
+| merReserve | String(1024) | M | 商户预留内容，可传任意内容，如购买商品信息、员号等，但不要传特殊符号，如逗号。 |
|
|
|
+| transID | String(32) | M | GW 系统生成的交易 ID，每笔交易保持唯一 |
|
|
|
+| merID | String(15) | M | 商户 ID，由AllPay 分配 |
|
|
|
+| acqID | String(11) | M | 收单行 ID "99020344" |
|
|
|
+| paymentSchema | String(10) | M | 渠道代码：[点击这里](https://git.allpayx.com/OpenAPI/b2c_pc_payment/src/master/paymentSchema.md) |
|
|
|
+| RespCode | String(2) | M | 应答码 00-成功 |
|
|
|
+| RespMsg | String(20) | M | 应答消息，全部为英文字符 |
|
|
|
+| transTime | String(14) | M | 交易时间,格式:"yyyyMMddHHmmss" |
|
|
|
+| GWTime | String(14) | M | YYYYMMDDHHMMSS，为 GW 时间，目前为本地交易时间 |
|
|
|
+| signType | String(3) | M | MD5 |
|
|
|
+| signature | String(32) | M | signature |
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+##### 4.3. 查询交易接口
|
|
|
+
|
|
|
1. 接口说明
|
|
|
|
|
|
该接口为接入商家提供交易查询的功能。
|
|
|
|
|
|
-2. 请求报文格式
|
|
|
-
|
|
|
-
|
|
|
- 序号 |名称 |长度|类型|参数名称|备注
|
|
|
- -----|-----|----|----|------|------
|
|
|
- 1|版本号|12|文本|version |统一填写为“VER000000002”
|
|
|
- 2|字符集编码 |6|文本|charSet |统一填写为“UTF-8”
|
|
|
- 3|交易类型 |4|文本|transType |查询填写“INQY”
|
|
|
- 4|订单号 |60|文本|orderNum |商户自行定义，需保证同一商户号下订单号不能重复
|
|
|
- 5|商户预留字段 |1024 |文本|merReserve |商户保留
|
|
|
- 6|商户代码 |15 |文本|merID |商户 ID，由AllPay 分配
|
|
|
- 7|收单行 ID |11 |文本|acqID |收单行 ID "99020344"
|
|
|
- 8|支付渠道代码 |10 |文本|paymentSchema|渠道代码："WX
|
|
|
- 9|交易时间 |14 |文本|transTime |交易时间,格式:"yyyyMMddHHmmss"
|
|
|
- 10|签名类型 |3 |文本|signType |MD5
|
|
|
- 11|签名 |32 |文本|signature |采用 MD5 签名
|
|
|
-
|
|
|
-
|
|
|
-3. 响应报文格式
|
|
|
-
|
|
|
-
|
|
|
- 序号 |名称 |长度|类型|参数名称|备注
|
|
|
- -----|-----|----|----|------|------
|
|
|
- 1|版本号|12|文本|version |统一填写为“VER000000002”
|
|
|
- 2|字符集编码 |6|文本|charSet |统一填写为“UTF-8”
|
|
|
- 3|交易类型 |4|文本|transType |查询交易填写为“INQY
|
|
|
- 4|订单号 |60|文本|orderNum |商户自行定义，需保证同一商户号下订单号不能重复
|
|
|
- 5|GW 交易 ID |32|文本|transID |GW 系统生成的交易 ID，每笔交易保持唯一
|
|
|
- 6|商户代码 |15 |文本|merID |商户 ID，由AllPay 分配
|
|
|
- 7|收单行 ID |11 |文本|acqID |收单行 ID "99020344"
|
|
|
- 8|交易应答码 |2 |文本|RespCode |应答码 00-成功
|
|
|
- 9|应答文字信息 |20 |文本|RespMsg |应答消息，全部为英文字符
|
|
|
- 10|交易时间 |14 |文本|transTime |交易时间,格式:"yyyyMMddHHmmss"
|
|
|
- 11|GW 处理时间 |14 |文本|GWTime |YYYYMMDDHHMMSS，为 GW 时间，目前为本地交易时间
|
|
|
- 12|签名类型 |3 |文本|signType |MD5
|
|
|
- 13|签名 |32 |文本|signature |采用 MD5 签名
|
|
|
-
|
|
|
-##### 3.4. 退款交易接口
|
|
|
+ 2 .请求报文格式
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+| 参数 | 类型 | 属性 | 描述 |
|
|
|
+| ------------- | ------------ | ---- | ------------------------------------------------------------ |
|
|
|
+| version | String(12) | M | 统一填写为“VER000000002” |
|
|
|
+| charSet | String(6) | M | 统一填写为“UTF-8” |
|
|
|
+| transType | String(4) | M | 查询填写“INQY” |
|
|
|
+| orderNum | String(60) | M | 订单号 |
|
|
|
+| merReserve | String(1024) | M | 商户预留内容，可传任意内容，如购买商品信息、员号等，但不要传特殊符号，如逗号。 |
|
|
|
+| merID | String(15) | M | 商户 ID，由AllPay 分配 |
|
|
|
+| acqID | String(11) | M | 收单行 ID "99020344" |
|
|
|
+| paymentSchema | String(10) | M | 渠道代码：[点击这里](https://git.allpayx.com/OpenAPI/b2c_pc_payment/src/master/paymentSchema.md) |
|
|
|
+| transTime | String(14) | M | 交易时间,格式:"yyyyMMddHHmmss" |
|
|
|
+| signType | String(3) | M | MD5 |
|
|
|
+| signature | String(32) | M | 采用 MD5 签名 |
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+1. 响应报文格式
|
|
|
+
|
|
|
+| 参数 | 类型 | 属性 | 描述 |
|
|
|
+| ------------- | ---------- | ---- | ------------------------------------------------------------ |
|
|
|
+| version | String(12) | M | 统一填写为“VER000000002” |
|
|
|
+| charSet | String(6) | M | 统一填写为“UTF-8” |
|
|
|
+| transType | String(4) | M | 查询填写“INQY” |
|
|
|
+| orderNum | String(60) | M | 订单号 |
|
|
|
+| transID | String(32) | M | GW 系统生成的交易 ID，每笔交易保持唯一 |
|
|
|
+| merID | String(15) | M | 商户 ID，由AllPay 分配 |
|
|
|
+| acqID | String(11) | M | 收单行 ID "99020344" |
|
|
|
+| paymentSchema | String(10) | M | 渠道代码：[点击这里](https://git.allpayx.com/OpenAPI/b2c_pc_payment/src/master/paymentSchema.md) |
|
|
|
+| RespCode | String(2) | M | 应答码 00-成功 |
|
|
|
+| RespMsg | String(20) | M | 应答消息，全部为英文字符 |
|
|
|
+| transTime | String(14) | M | 交易时间,格式:"yyyyMMddHHmmss" |
|
|
|
+| GWTime | String(14) | M | YYYYMMDDHHMMSS，为 GW 时间，目前为本地交易时间 |
|
|
|
+| signType | String(3) | M | MD5 |
|
|
|
+| signature | String(32) | M | signature |
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+##### 4.4 退款交易接口
|
|
|
|
|
|
1.接口功能说明
|
|
|
|
|
|
@@ -134,65 +151,108 @@ AllPay为基于移动H5页面支付集成云端SDK，以帮助客户实现快速
|
|
|
|
|
|
2.请求报文格式
|
|
|
|
|
|
- 序号 |名称 |长度|类型|参数名称|备注
|
|
|
- -----|-----|----|----|------|------
|
|
|
- 1|版本号|12|文本|version |统一填写为“VER000000002”
|
|
|
- 2|字符集编码 |6|文本|charSet |统一填写为“UTF-8”
|
|
|
- 3|交易类型 |4|文本|transType |退款填写“REFD”
|
|
|
- 4|订单号 |60|文本|orderNum |商户自行定义，需保证同一商户号下订单号不能重复
|
|
|
- 5|退款金额 |12|文本|returnAmount |如 100 元，表示为 100 或 100.00
|
|
|
- 6|订单币种 |3|文本|orderCurrency |人民币填写“CNY”,美元填写"USD"
|
|
|
- 7|商户预留字段 |1024 |文本|merReserve |商户预留内容，可传任意内容，如购买商品信息、员号等，但不要传特殊符号，如逗号。
|
|
|
- 8|商户代码 |15 |文本|merID |商户 ID，由AllPay 分配
|
|
|
- 9|收单行 ID |11 |文本|acqID |收单行 ID "99020344"
|
|
|
- 10|支付渠道代码 |10 |文本|paymentSchema|渠道代码："WX
|
|
|
- 11|交易时间 |14 |文本|transTime |交易时间,格式:"yyyyMMddHHmmss"
|
|
|
- 12|签名类型 |3 |文本|signType |MD5
|
|
|
- 13|签名 |32 |文本|signature |采用 MD5 签名
|
|
|
+
|
|
|
+
|
|
|
+| 参数 | 类型 | 属性 | 描述 |
|
|
|
+| ------------- | ------------ | ---- | ------------------------------------------------------------ |
|
|
|
+| version | String(12) | M | 统一填写为“VER000000002” |
|
|
|
+| charSet | String(6) | M | 统一填写为“UTF-8” |
|
|
|
+| transType | String(4) | M | 退款填写“REFD” |
|
|
|
+| orderNum | String(60) | M | 原交易订单号 |
|
|
|
+| refundNum | String(60) | M | 退款订单号:商户自行定义，需保证同一商户号下退款订单号不能重复 |
|
|
|
+| returnAmount | String(12) | M | 退款金额：如 100 元，表示为 100 或 100.00 |
|
|
|
+| orderCurrency | String(3) | M | 订单币种：ISO标准 如：人民币填写“CNY”,美元填写"USD" |
|
|
|
+| merReserve | String(1024) | M | 商户预留内容，可传任意内容，如购买商品信息、员号等，但不要传特殊符号，如逗号。 |
|
|
|
+| merID | String(15) | M | 商户 ID，由AllPay 分配 |
|
|
|
+| acqID | String(11) | M | 收单行 ID "99020344" |
|
|
|
+| paymentSchema | String(10) | M | 渠道代码：[点击这里](https://git.allpayx.com/OpenAPI/b2c_pc_payment/src/master/paymentSchema.md) |
|
|
|
+| transTime | String(14) | M | 交易时间,格式:"yyyyMMddHHmmss" |
|
|
|
+| signType | String(3) | M | MD5 |
|
|
|
+| signature | String(32) | M | 采用 MD5 签名 |
|
|
|
|
|
|
3.响应报文格式
|
|
|
|
|
|
+| 参数 | 类型 | 属性 | 描述 |
|
|
|
+| --------- | ---------- | ---- | ---------------------------------------------- |
|
|
|
+| version | String(12) | M | 统一填写为“VER000000002” |
|
|
|
+| charSet | String(6) | M | 统一填写为“UTF-8” |
|
|
|
+| transType | String(4) | M | 退款填写“REFD” |
|
|
|
+| refundNum | String(60) | M | 退款订单号 |
|
|
|
+| transID | String(32) | M | GW 系统生成的交易 ID，每笔交易保持唯一 |
|
|
|
+| merID | String(15) | M | 商户 ID，由AllPay 分配 |
|
|
|
+| acqID | String(11) | M | 收单行 ID "99020344" |
|
|
|
+| RespCode | String(2) | M | 应答码 00-成功 |
|
|
|
+| RespMsg | String(20) | M | 应答消息，全部为英文字符 |
|
|
|
+| transTime | String(14) | M | 交易时间,格式:"yyyyMMddHHmmss" |
|
|
|
+| GWTime | String(14) | M | YYYYMMDDHHMMSS，为 GW 时间，目前为本地交易时间 |
|
|
|
+| signType | String(3) | M | MD5 |
|
|
|
+| signature | String(32) | M | signature |
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+##### 4.5. 退款查询接口
|
|
|
+
|
|
|
+1.接口说明
|
|
|
+
|
|
|
+ 该接口为接入商家提供退款查询的功能。
|
|
|
+
|
|
|
+2.请求报文格式
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+| 参数 | 类型 | 属性 | 描述 |
|
|
|
+| ------------- | ------------ | ---- | ------------------------------------------------------------ |
|
|
|
+| version | String(12) | M | 统一填写为“VER000000002” |
|
|
|
+| charSet | String(6) | M | 统一填写为“UTF-8” |
|
|
|
+| transType | String(4) | M | 查询填写“RFQY” |
|
|
|
+| refundNum | String(60) | M | 退款订单号 |
|
|
|
+| merReserve | String(1024) | M | 商户预留内容，可传任意内容，如购买商品信息、员号等，但不要传特殊符号，如逗号。 |
|
|
|
+| merID | String(15) | M | 商户 ID，由AllPay 分配 |
|
|
|
+| acqID | String(11) | M | 收单行 ID "99020344" |
|
|
|
+| paymentSchema | String(10) | M | 渠道代码：[点击这里](https://git.allpayx.com/OpenAPI/b2c_pc_payment/src/master/paymentSchema.md) |
|
|
|
+| transTime | String(14) | M | 交易时间,格式:"yyyyMMddHHmmss" |
|
|
|
+| signType | String(3) | M | MD5 |
|
|
|
+| signature | String(32) | M | 采用 MD5 签名 |
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+1. 响应报文格式
|
|
|
+
|
|
|
+| 参数 | 类型 | 属性 | 描述 |
|
|
|
+| ------------- | ---------- | ---- | ------------------------------------------------------------ |
|
|
|
+| version | String(12) | M | 统一填写为“VER000000002” |
|
|
|
+| charSet | String(6) | M | 统一填写为“UTF-8” |
|
|
|
+| transType | String(4) | M | 查询填写“REFD” |
|
|
|
+| refundNum | String(60) | M | 退款订单号 |
|
|
|
+| transID | String(32) | M | GW 系统生成的交易 ID，每笔交易保持唯一 |
|
|
|
+| merID | String(15) | M | 商户 ID，由AllPay 分配 |
|
|
|
+| acqID | String(11) | M | 收单行 ID "99020344" |
|
|
|
+| paymentSchema | String(10) | M | 渠道代码：[点击这里](https://git.allpayx.com/OpenAPI/b2c_pc_payment/src/master/paymentSchema.md) |
|
|
|
+| RespCode | String(2) | M | 应答码 00-成功 |
|
|
|
+| RespMsg | String(20) | M | 应答消息，全部为英文字符 |
|
|
|
+| transTime | String(14) | M | 交易时间,格式:"yyyyMMddHHmmss" |
|
|
|
+| GWTime | String(14) | M | YYYYMMDDHHMMSS，为 GW 时间，目前为本地交易时间 |
|
|
|
+| signType | String(3) | M | MD5 |
|
|
|
+| signature | String(32) | M | signature |
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+##### 5.渠道专属配置
|
|
|
+
|
|
|
+##### 5.1 APMP渠道
|
|
|
+
|
|
|
+ 消费接口专属字段
|
|
|
+
|
|
|
+- 请求报文
|
|
|
+
|
|
|
+ | Parameter | Type | Required | Description | Sample |
|
|
|
+ | --------- | ---------- | -------- | ------------------------------------------------------------ | -------------------------------------- |
|
|
|
+ | timeout | String(10) | O | The default is 12h. Please contact Alipay Technical Support if you need to use other values. Max value is 15d. This parameter controls the valid time from login to completion. | 5m 10m 15m 30m 1h 2h 3h 5h 10h 12h 1d. |
|
|
|
+
|
|
|
+####
|
|
|
+
|
|
|
|
|
|
- 序号 |名称 |长度|类型|参数名称|备注
|
|
|
- -----|-----|----|----|------|------
|
|
|
- 1|版本号|12|文本|version |统一填写为“VER000000002”
|
|
|
- 2|字符集编码 |6|文本|charSet |统一填写为“UTF-8”
|
|
|
- 3|交易类型 |4|文本|transType |退款填写“REFD”
|
|
|
- 4|订单号 |60|文本|orderNum |商户自行定义，需保证同一商户号下订单号不能重复
|
|
|
- 5|GW 交易 ID |32|文本|transID |GW 系统生成的交易 ID，每笔交易保持唯一
|
|
|
- 6|商户代码 |15 |文本|merID |商户 ID，由AllPay 分配
|
|
|
- 7|收单行 ID |11 |文本|acqID |收单行 ID "99020344"
|
|
|
- 8|交易应答码 |2 |文本|RespCode |应答码 00-成功
|
|
|
- 9|应答文字信息 |20 |文本|RespMsg |应答消息，全部为英文字符
|
|
|
- 10|交易时间 |14 |文本|transTime |交易时间,格式:"yyyyMMddHHmmss"
|
|
|
- 11|GW 处理时间 |14 |文本|GWTime |YYYYMMDDHHMMSS，为 GW 时间，目前为本地交易时间
|
|
|
- 12|签名类型 |3 |文本|signType |MD5
|
|
|
- 13|签名 |32 |文本|signature |采用 MD5 签名
|
|
|
-
|
|
|
-#### 4. 错误码
|
|
|
-
|
|
|
-若商户请求AllPay网关时，请求的参数错误或参数缺失时，AllPay网关会将错误信息以JSON格式返回给客户端，供商户解析调用，以下是相关错误信息返回参数的说明
|
|
|
-
|
|
|
-| 参数应答码code | 对应应答信息msg |
|
|
|
-| -------------- | ------------------------------------------ |
|
|
|
-| U1 | Clientid not found |
|
|
|
-| U2 | Signature error |
|
|
|
-| V1 | Parameter missing |
|
|
|
-| E1 | Exceed the limit |
|
|
|
-| R1 | Orderno repeat |
|
|
|
-| C1 | Order currency is not set |
|
|
|
-| P1 | paychannel error |
|
|
|
-| I1 | Illegal request address |
|
|
|
-| T1 | Parameter missing（version或tranType） |
|
|
|
-| T2 | Txntype error |
|
|
|
-| T3 | transaction is not exist or fail |
|
|
|
-| T4 | The maximum amount exceeds the upper limit |
|
|
|
-| 99 | System error
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
-#### 5.技术支持
|
|
|
+#### 6.技术支持
|
|
|
|
|
|
如果您在调试时遇到问题，请我们联系:support@allpayx.com。
|
|
|
|
