Browse Source

修改v5接口文档

tao.zhou 5 years ago
parent
commit
56770f7f6d
2 changed files with 116 additions and 30 deletions
  1. 61 18
      AllPay_Integration_Specification_CH.md
  2. 55 12
      AllPay_Integration_Specification_EN.md

+ 61 - 18
AllPay_Integration_Specification_CH.md

@@ -5,7 +5,7 @@
 * 更新时间:2019 年1 月
 
 ## 1.概述
-AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全、集中式的接入支付渠道。
+AllPay 为客户提供统一的API接入,以帮助客户实现快速、安全、集中式的接入支付渠道。
 ## 2.交易流程 
 ![image](https://git.allpayx.com/OpenAPI/b2c/raw/master/images/pc_flowsheet.png)
 ## 3.验签说明 
@@ -82,7 +82,7 @@ AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全
 | merID         | String(15)   | M    | 商户 ID,由 AllPay 分配                                      |
 | acqID         | String(11)   | M    | 收单行 ID "99020344"                                         |
 | paymentSchema | String(10)   | M    | 渠道代码:[点击这里](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
-| RespCode      | String(2)    | M    | 应答码 00-成功                                               |
+| RespCode      | String(2)    | M    | 应答码 00-成功,01-失败。详情见本文档第6章应答码 |
 | RespMsg       | String(20)   | M    | 应答消息                                                     |
 | transID       | String(32)   | M    | GW 系统生成的交易 ID,每笔交易保持唯一                       |
 | GWTime        | String(14)   | M    | yyyyMMddHHmmss,为 GW 时间                                   |
@@ -95,7 +95,15 @@ AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全
 
 1.接口说明
 
- 该接口为接入商家提供交易查询的功能。
+ 该接口为接入商家提供消费查询的功能。
+
+(1)接口补充说明
+ * 商户发起消费交易后,可通过该接口查询消费交易的状态
+
+(2)接口交易流程
+<div align=center>
+ ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665470156706.jpg)
+</div>
 
 2.请求报文格式 
 
@@ -124,7 +132,7 @@ AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全
 | merID         | String(15) | M    | 商户 ID,由 AllPay 分配                                      |
 | acqID         | String(11) | M    | 收单行 ID "99020344"                                         |
 | paymentSchema | String(10) | M    | 渠道代码:[点击这里](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
-| RespCode      | String(2)  | M    | 应答码 00-成功                                               |
+| RespCode      | String(2)  | M    | 应答码 00-成功,01-失败。详情见本文档第6章应答码 |
 | RespMsg       | String(20) | M    | 应答消息                                                     |
 | transTime     | String(14) | M    | 交易时间,格式:"yyyyMMddHHmmss"                             |
 | GWTime        | String(14) | M    | YYYYMMDDHHMMSS,为 GW 时间,目前为本地交易时间               |
@@ -135,7 +143,17 @@ AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全
 
 1.接口功能说明 
 
-该接口为接入商家提供交易退款的功能。备注:外卡交易当日不能做退款,可以做撤销,只能隔天退款。
+ 该接口为接入商家提供交易退款的功能。
+
+(1)接口补充说明
+ * 该接口在消费交易成功后发起,要求指定原订单号
+ * 外卡交易当日不能做退款,可以做撤销,只能隔日退款
+ * 正常情况下,商户当日退款金额,不得大于当日成功交易额
+
+(2)接口交易流程
+ <div align=center>
+ ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665469966231.jpg)
+ </div>
 
 2.请求报文格式 
 
@@ -167,7 +185,7 @@ AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全
 | merID     | String(15) | M    | 商户 ID,由 AllPay 分配                         |
 | acqID     | String(11) | M    | 收单行 ID "99020344"                           |
 | paymentSchema | String(10) | M    | 渠道代码:[点击这里](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
-| RespCode  | String(2)  | M    | 应答码 00-成功                                 |
+| RespCode  | String(2)  | M    | 应答码 00-成功,01-失败。详情见本文档第6章应答码 |
 | RespMsg   | String(20) | M    | 应答消息                       |
 | transTime | String(14) | M    | 交易时间,格式:"yyyyMMddHHmmss"                 |
 | GWTime    | String(14) | M    | YYYYMMDDHHMMSS,为 GW 时间,目前为本地交易时间 |
@@ -179,6 +197,14 @@ AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全
 1.接口说明
 
  该接口为接入商家提供退款查询的功能。
+ 
+(1)接口补充说明
+ * 该接口用于商户在退款发起后,查询退款交易的处理状态
+
+(2)接口交易流程
+ <div align=center>
+ ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665470092257.jpg)
+ </div>
 
 2.请求报文格式 
 
@@ -207,7 +233,7 @@ AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全
 | merID         | String(15) | M    | 商户 ID,由 AllPay 分配                                      |
 | acqID         | String(11) | M    | 收单行 ID "99020344"                                         |
 | paymentSchema | String(10) | M    | 渠道代码:[点击这里](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
-| RespCode      | String(2)  | M    | 应答码 00-成功                                               |
+| RespCode      | String(2)  | M    | 应答码 00-成功,01-失败。详情见本文档第6章应答码 |
 | RespMsg       | String(20) | M    | 应答消息                                                     |
 | transTime     | String(14) | M    | 交易时间,格式:"yyyyMMddHHmmss"                             |
 | GWTime        | String(14) | M    | YYYYMMDDHHMMSS,为 GW 时间,目前为本地交易时间               |
@@ -218,7 +244,7 @@ AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全
 
 1.接口说明
 
- 该接口为接入商家提供预授权功能
+ 预授权接口适用于外卡交易,包括VISA、万事达、JCB等卡品牌。预授权交易不会参与清算,发卡银行会暂时冻结用户资金
 
 2.请求报文格式
 
@@ -263,7 +289,7 @@ AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全
 | merID         | String(15)   | M    | 商户 ID,由 AllPay 分配                                      |
 | acqID         | String(11)   | M    | 收单行 ID "99020344"                                         |
 | paymentSchema | String(10)   | M    | 渠道代码:FC                                                 |
-| RespCode      | String(2)    | M    | 应答码 00-成功                                               |
+| RespCode      | String(2)    | M    | 应答码 00-成功,01-失败。详情见本文档第6章应答码 |
 | RespMsg       | String(20)   | M    | 应答消息                                                     |
 | transID       | String(32)   | M    | GW 系统生成的交易 ID,每笔交易保持唯一                       |
 | GWTime        | String(14)   | M    | yyyyMMddHHmmss,为 GW 时间                                   |
@@ -276,7 +302,16 @@ AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全
 
 1.接口说明
 
- 该接口为接入商家提供预授权完成功能。
+ 预授权完成接口适用于外卡交易,包括VISA、万事达、JCB等卡品牌。预授权完成交易与消费交易相似,交易成功后,会对商户进行资金的清算。 
+(1)接口补充说明
+ * 该接口在预授权交易成功后发起,要求指定原预授权订单号,时间相隔最长不超过30天
+ * 预授权完成交易金额,不能大于预授权交易金额
+ * 预授权交易,只支持一次成功的预授权完成交易
+
+(2)接口交易流程
+ <div align=center>
+ ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665464464405.jpg)
+ </div>
 
 2.请求报文格式
 
@@ -308,7 +343,7 @@ AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全
 | merID         | String(15) | M    | 商户 ID,由 AllPay 分配                        |
 | acqID         | String(11) | M    | 收单行 ID "99020344"                           |
 | paymentSchema | String(10) | M    | 渠道代码:FC                                   |
-| RespCode      | String(2)  | M    | 应答码 00-成功                                 |
+| RespCode      | String(2)  | M    | 应答码 00-成功,01-失败。详情见本文档第6章应答码 |
 | RespMsg       | String(20) | M    | 应答消息                                       |
 | transTime     | String(14) | M    | 交易时间,格式:"yyyyMMddHHmmss"               |
 | GWTime        | String(14) | M    | YYYYMMDDHHMMSS,为 GW 时间,目前为本地交易时间 |
@@ -318,8 +353,15 @@ AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全
 ### 4.8 外卡撤销接口
 
 1.接口说明
-
- 该接口为接入商家提供对外卡消费、预授权、预授权完成的撤销。备注:外卡消费撤销只能在消费当日完成,隔天不能做消费撤销。
+ 撤销接口适用于外卡交易,包括VISA、万事达、JCB等卡品牌。
+ (1)接口补充说明
+ * 该接口支持对外卡消费、预授权、预授权完成交易进行撤消
+ * 对消费进行撤消时,只能支持撤消当日交易(注意:北京时间23:00后,视为隔天)。对于非当日交易,可以通过退款接口进行处理。
+ 
+ (2)接口交易流程
+ <div align=center>
+ ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665464582903.jpg)
+ </div>
 
 2.请求报文格式
 
@@ -349,18 +391,18 @@ AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全
 | merID         | String(15) | M    | 商户 ID,由 AllPay 分配                        |
 | acqID         | String(11) | M    | 收单行 ID "99020344"                           |
 | paymentSchema | String(10) | M    | 渠道代码:FC                                   |
-| RespCode      | String(2)  | M    | 应答码 00-成功                                 |
+| RespCode      | String(2)  | M    | 应答码 00-成功,01-失败。详情见本文档第6章应答码 |
 | RespMsg       | String(20) | M    | 应答消息                                       |
 | transTime     | String(14) | M    | 交易时间,格式:"yyyyMMddHHmmss"               |
 | GWTime        | String(14) | M    | YYYYMMDDHHMMSS,为 GW 时间,目前为本地交易时间 |
 | signType      | String(10) | M    | MD5或SHA256                                    |
 | signature     | String(32) | M    | 采用 MD5或SHA256 签名                          |
 
-### 4.9 外卡手工退款接口
+### 4.9 外卡手工退款申请接口
 
 1.接口功能说明 
 
-该接口为接入商家提供人工退款申请。备注:在商户不能做联机退款时(交易时间超过90天),可以调用此接口实现手工退款申请
+对90天之前的交易进行退款,商户无法通过调用联机退款接口处理,需调用该接口发起退款申请,申请成功后我们业务人员会通过人工方式进行处理,处理周期大概在3-5个工作日,退款申请交易经过人工处理后被成功退款,交易才会清算
 
 2.请求报文格式 
 
@@ -456,7 +498,7 @@ AllPay 为客户提供统一的API接入,以帮助客户实 现快速、安全
 | RespMsg    | String | M    | 应答消息                                               |
 | sdk_params | String | O    | 小程序支付所需参数(JSON字符串)。应答码为00返回该字段 |
 
-将上述返回数据放入微信小程序支付接口,即可调起微信小程序支付,具体方法,参考微信小程序api
+将上述返回数据放入微信小程序支付接口,即可调起微信小程序支付,具体方法,参考微信小程序API
 
 #### 5.1.5 APP支付
 
@@ -738,4 +780,5 @@ iOS对接文档:[点击这里](https://git.allpayx.com/OpenAPI/common/src/mast
 
 ## 8.技术支持
 
-如果您在调试时遇到问题,请与我们联系:support@allpayx.com
+如果您在调试时遇到问题,请与我们联系:support@allpayx.com
+

+ 55 - 12
AllPay_Integration_Specification_EN.md

@@ -82,7 +82,7 @@ Parameters as follows:
 | merID         | String(15)   | M    | Merchant ID, assigned by AllPay                                      |
 | acqID         | String(11)   | M    | "99020344"                                 |
 | paymentSchema | String(10)   | M    | Channel code:[Click Here](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
-| RespCode      | String(2)    | M    | 00 stands for success; 01 stands for fail. |
+| RespCode      | String(2)    | M    | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
 | RespMsg       | String(20)   | M    | Response message |
 | transID       | String(32)   | M    | The unique transaction id generated by the gateway.                       |
 | GWTime        | String(14)   | M    | yyyyMMddHHmmss this should be a GWtime, currently is local transaction time. |
@@ -97,6 +97,14 @@ Parameters as follows:
 
  This interface provides the function of inqiury transaction for access merchants.
 
+ (1) Interface supplement
+ * After the merchant initiates the consumer transaction, the status of the consumer transaction can be queried through the interface.
+
+ (2) Interface transaction process
+<div align=center>
+ ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665470156706.jpg)
+</div>
+
 2.Request message format 
 
 | Parameter          | Type       | Required | Description                                        |
@@ -124,7 +132,7 @@ Parameters as follows:
 | merID         | String(15) | M    | Merchant ID, assigned by AllPay |
 | acqID         | String(11) | M    | "99020344" |
 | paymentSchema | String(10) | M    | Channel code:[Click Here](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
-| RespCode      | String(2)  | M    | 00 stands for success; 01 stands for fail. |
+| RespCode      | String(2)  | M    | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
 | RespMsg       | String(20) | M    | Response message |
 | transTime     | String(14) | M    | Transaction time, format :" yyyyMMddHHmmss"                             |
 | GWTime        | String(14) | M    | yyyyMMddHHmmss this should be a GWtime, currently is local transaction time  |
@@ -135,7 +143,17 @@ Parameters as follows:
 
 1.Interface specification 
 
-This interface provides the function of refund transaction for access merchants. Remarks: International credit card transactions cannot be refunded on the same day, can be revoked, and can only be refunded every other day.
+ This interface provides access to merchants with a refund of transactions.
+
+ (1) Interface supplement
+ * The interface is initiated after the consumer transaction is successful, and the original order number is required to be specified.
+ * International credit card transactions cannot be refunded on the same day, can be revoked, and can only be refunded every other day.
+ * Under normal circumstances, the refund amount of the merchant on the day shall not be greater than the successful transaction amount on the day.
+
+ (2) Interface transaction process
+ <div align=center>
+ ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665469966231.jpg)
+ </div>
 
 2.Request message format 
 
@@ -167,7 +185,7 @@ This interface provides the function of refund transaction for access merchants.
 | merID     | String(15) | M    | Merchant ID, assigned by AllPay |
 | acqID     | String(11) | M    | "99020344" |
 | paymentSchema | String(10) | M    | Channel code:[Click Here](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
-| RespCode  | String(2)  | M    | 00 stands for success; 01 stands for fail. |
+| RespCode  | String(2)  | M    | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
 | RespMsg   | String(20) | M    | Response message |
 | transTime | String(14) | M    | Transaction time, format :" yyyyMMddHHmmss" |
 | GWTime    | String(14) | M    | yyyyMMddHHmmss this should be a GWtime, currently is local transaction time |
@@ -180,6 +198,14 @@ This interface provides the function of refund transaction for access merchants.
 
  This interface provides the function of refund inqiury transaction for access merchants.
 
+ (1) Interface supplement
+ * This interface is used by the merchant to check the processing status of the refund transaction after the refund is initiated.
+
+ (2) Interface transaction process
+ <div align=center>
+ ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665470092257.jpg)
+ </div>
+
 2.Request message format 
 
 | Parameter          | Type       | Required | Description                                         |
@@ -207,7 +233,7 @@ This interface provides the function of refund transaction for access merchants.
 | merID         | String(15) | M    | Merchant ID, assigned by AllPay |
 | acqID         | String(11) | M    | "99020344" |
 | paymentSchema | String(10) | M    | Channel code:[Click Here](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
-| RespCode      | String(2)  | M    | 00 stands for success; 01 stands for fail. |
+| RespCode      | String(2)  | M    | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
 | RespMsg       | String(20) | M    | Response message |
 | transTime     | String(14) | M    | Transaction time, format :" yyyyMMddHHmmss"                             |
 | GWTime        | String(14) | M    | yyyyMMddHHmmss this should be a GWtime, currently is local transaction time               |
@@ -218,7 +244,7 @@ This interface provides the function of refund transaction for access merchants.
 
 1.Interface specification
 
- This interface provides pre-authorization for access merchants.
+ The pre-authorization interface is suitable for international credit card transactions, including VISA, MasterCard, JCB and other card brands. Pre-authorized transactions will not participate in liquidation, and the issuing bank will temporarily freeze user funds.
 
 2.Request message format
 
@@ -263,7 +289,7 @@ Parameters as follows:
 | merID         | String(15)   | M    | Merchant ID, assigned by AllPay |
 | acqID         | String(11)   | M    | "99020344" |
 | paymentSchema | String(10)   | M    | Channel code: "FC" |
-| RespCode      | String(2)    | M    | 00 stands for success; 01 stands for fail. |
+| RespCode      | String(2)    | M    | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
 | RespMsg       | String(20)   | M    | Response message |
 | transID       | String(32)   | M    | The unique transaction id generated by the gateway. |
 | GWTime        | String(14)   | M    | yyyyMMddHHmmss this should be a GWtime, currently is local transaction time. |
@@ -276,7 +302,16 @@ Parameters as follows:
 
 1.Interface specification
 
- This interface provides pre-authorization completion for access merchants.
+ The pre-authorization completion interface is applicable to international credit card transactions, including VISA, MasterCard, JCB and other card brands. The pre-authorization completion transaction is similar to the consumer transaction. After the transaction is successful, the merchant will be liquidated. 
+ (1) Interface supplement
+ * The interface is initiated after the pre-authorization transaction is successful, and the original pre-authorization order number is required to be specified, and the time is separated by no more than 30 days.
+ * The pre-authorization completion transaction amount cannot be greater than the pre-authorized transaction amount.
+ * Pre-authorized transactions that only support one successful pre-authorization completion transaction.
+
+ (2) Interface transaction process
+ <div align=center>
+ ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665464464405.jpg)
+ </div>
 
 2.Request message format
 
@@ -308,7 +343,7 @@ Parameters as follows:
 | merID         | String(15) | M    | Merchant ID, assigned by AllPay |
 | acqID         | String(11) | M    | "99020344" |
 | paymentSchema | String(10) | M    | Channel code: "FC" |
-| RespCode      | String(2)  | M    | 00 stands for success; 01 stands for fail. |
+| RespCode      | String(2)  | M    | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
 | RespMsg       | String(20) | M    | Response message |
 | transTime     | String(14) | M    | Transaction time, format :" yyyyMMddHHmmss" |
 | GWTime        | String(14) | M    | yyyyMMddHHmmss this should be a GWtime, currently is local transaction time. |
@@ -319,7 +354,15 @@ Parameters as follows:
 
 1.Interface specification
 
- The interface provides the access merchant with the cancellation of international credit card consumption, pre-authorization, and pre-authorization completion. Remarks: The cancellation of international credit card consumption can only be completed on the day of consumption, and the cancellation cannot be made the next day.
+ The cancellation interface is suitable for international credit card transactions, including VISA, MasterCard, JCB and other card brands.
+ (1) Interface supplement
+ * This interface supports the cancellation of international credit card transactions, including consumption, pre-authorization, and pre-authorization completion.
+ * When withdrawing consumption, you can only support the cancellation of the day's trading (note: after 23:00 Beijing time, it is considered the next day). For non-day trading, it can be processed through the refund interface.
+ 
+ (2) Interface transaction process
+ <div align=center>
+ ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665464582903.jpg)
+ </div>
 
 2.Request message format
 
@@ -349,7 +392,7 @@ Parameters as follows:
 | merID         | String(15) | M    | Merchant ID, assigned by AllPay |
 | acqID         | String(11) | M    | "99020344" |
 | paymentSchema | String(10) | M    | Channel code: "FC" |
-| RespCode      | String(2)  | M    | 00 stands for success; 01 stands for fail. |
+| RespCode      | String(2)  | M    | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
 | RespMsg       | String(20) | M    | Response message |
 | transTime     | String(14) | M    | Transaction time, format :" yyyyMMddHHmmss" |
 | GWTime        | String(14) | M    | yyyyMMddHHmmss this should be a GWtime, currently is local transaction time. |
@@ -360,7 +403,7 @@ Parameters as follows:
 
 1.Interface specification 
 
-This interface provides a manual refund request for the access merchant. Note: When the merchant can't make an online refund (transaction time is more than 90 days), you can call this interface to implement the manual refund request.
+To refund the transaction before 90 days, the merchant can't process the online refund interface, but need to call the interface to initiate the refund application. After the application is successful, our business staff will handle it manually. The processing period is about 3 to 5 working days. The refund application transaction will be successfully refunded after manual processing, and the transaction will be liquidated.
 
 2.Request message format