|
@@ -0,0 +1,188 @@
|
|
|
|
+# 4. 通用接口
|
|
|
|
+
|
|
|
|
+## 4.1. 接口地址
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+通用接口包括 交易异步通知,交易查询,退款,退款查询接口
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+接口名称 |测试地址 |生产地址
|
|
|
|
+ ------- |-----------|-------
|
|
|
|
+ 交易查询接口 |<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. 异步通知报文
|
|
|
|
+
|
|
|
|
+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. 请求报文格式
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+| 参数 | 类型 | 属性 | 描述 |
|
|
|
|
+| ------------- | ------------ | ---- | ------------------------------------------------------------ |
|
|
|
|
+| 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 签名 |
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+3. 响应报文格式
|
|
|
|
+
|
|
|
|
+| 参数 | 类型 | 属性 | 描述 |
|
|
|
|
+| ------------- | ---------- | ---- | ------------------------------------------------------------ |
|
|
|
|
+| 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.接口功能说明
|
|
|
|
+
|
|
|
|
+该接口为接入商家提供交易退款的功能。
|
|
|
|
+
|
|
|
|
+2.请求报文格式
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+| 参数 | 类型 | 属性 | 描述 |
|
|
|
|
+| ------------- | ------------ | ---- | ------------------------------------------------------------ |
|
|
|
|
+| 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. 1. 接口说明
|
|
|
|
+
|
|
|
|
+ 该接口为接入商家提供退款查询的功能。
|
|
|
|
+
|
|
|
|
+ 1. 请求报文格式
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ | 参数 | 类型 | 属性 | 描述 |
|
|
|
|
+ | ------------- | ------------ | ---- | ------------------------------------------------------------ |
|
|
|
|
+ | 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 |
|