更新至5.1版本

AllPay_Integration_Specification_CH.md

@@ -26,9 +26,9 @@ signature: 1e0f24d39cdc8236d17a5f6f17672611
 ```
 ## 4. API 说明
 
- 测试主机：https://testapi.allpayx.com<br>
- 生产主机：https://api.allpayx.com<br>
- 请求方式：POST<br>
+ 测试主机：https://testapi.allpayx.com<br><br>
+ 生产主机：https://api.allpayx.com<br><br>
+ 请求方式：POST<br><br>
  数据格式：application/json 或 application/x-www-form-urlencoded
 
 ### 4.1 API 列表 
@@ -120,13 +120,6 @@ signature: 1e0f24d39cdc8236d17a5f6f17672611
 **1. 接口说明**
 
   该接口为接入商家提供订单查询的功能。
-<!-- 
- （1）接口补充说明
-  * 商户发起消费交易后，可通过该接口查询消费交易的状态
-
- （2）接口交易流程
-
-  ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665470156706.jpg) -->
 
 **2. 请求参数** 
 
@@ -299,6 +292,17 @@ signature: 1e0f24d39cdc8236d17a5f6f17672611
 
 | 参数          | 类型         | 属性 | 描述                                                         |
 | ------------- | ------------ | ---- | ------------------------------------------------------------ |
+| RespCode       | String(2)   | M    | 应答码，00表示请求成功 |
+| RespMsg       | String(256)    | M    | 应答信息 |
+| merID     | String(15)    | O    | 商户ID，RespCode为00时返回 |
+| orderNum      | String(60)   | O    | 订单号，RespCode为00时返回 |
+| transID   | String(32)   | O    | GoAllPay流水号，RespCode为00时返回 |
+| parameter | Object    | O    | 支付相关参数，RespCode为00时返回 |
+
+**4. 回调参数**
+
+| 参数          | 类型         | 属性 | 描述                                                         |
+| ------------- | ------------ | ---- | ------------------------------------------------------------ |
 | version       | String(12)   | M    | “VER000000005”                                     |
 | charSet       | String(6)    | M    | “UTF-8”                                            |
 | transType     | String(10)    | M    | “PAUT”                                             |

AllPay_Integration_Specification_EN.md

@@ -26,9 +26,9 @@ signature: 1e0f24d39cdc8236d17a5f6f17672611
 ```
 ## 4.API description
 
- Test environment host: https://testapi.allpayx.com<br>
- Production environment host: https://api.allpayx.com<br>
- Request method: POST<br>
+ Test environment host: https://testapi.allpayx.com<br><br>
+ Production environment host: https://api.allpayx.com<br><br>
+ Request method: POST<br><br>
  Content type: application/json or application/x-www-form-urlencoded
 
 ### 4.1 API list 
@@ -46,13 +46,13 @@ signature: 1e0f24d39cdc8236d17a5f6f17672611
 | Card payment | /api/bindPay |
 | Card unbundling | /api/unBindCard |
 
-### 4.2 Purchase interface
+### 4.2 Purchase
 
-**1.Interface specification**
+**1. Interface specification**
 
 This interface provides the function of purchase transaction for access merchants.
 
-**2.Request parameters**
+**2. Request parameters**
 
 It consists of general fields and channel-specific fields. All upload fields must be signed.
 
@@ -80,7 +80,7 @@ It consists of general fields and channel-specific fields. All upload fields mus
 | signType      | String(10)   | M    | "MD5" or "SHA256" |
 | signature     | String(32)   | M    | MD5 or SHA256 signature |
 
-**3.Response parameters**
+**3. Response parameters**
 
 | parameter          | Type         | Required | Description          |
 | ------------- | ------------ | ---- | ------------------------------------------------------------ |
@@ -91,7 +91,7 @@ It consists of general fields and channel-specific fields. All upload fields mus
 | transID   | String(32)   | O    | GoAllPay serial number. Return it when RespCode is 00. |
 | parameter | Object    | O    | Payment parameters. Return it when RespCode is 00. |
 
-**4.Callback parameters**
+**4. Callback parameters**
 
 | parameter          | Type         | Required | Description          |
 | ------------- | ------------ | ---- | ------------------------------------------------------------ |
@@ -113,28 +113,20 @@ It consists of general fields and channel-specific fields. All upload fields mus
 | signType      | String(10)   | M    | "MD5" or "SHA256" |
 | signature     | String(32)   | M    | MD5 or SHA256 signature |
 
-### 4.3 Inqiury interface 
+### 4.3 Inqiury 
 
-**1.Interface specification**
+**1. Interface specification**
 
  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 parameters** 
+**2. Request parameters** 
 
 | Parameter          | Type       | Required | Description                                        |
 | ------------- | ---------- | ---- | ------------------------------------------------------------ |
 | version       | String(12) | M    | "VER000000005"                                     |
 | charSet       | String(6)  | M    | "UTF-8"                                            |
 | transType     | String(10)  | M    | "INQY"                                             |
-| orderNum      | String(60) | M    | Original payment order number                      |
+| orderNum      | String(60) | M    | Order number                      |
 | merID         | String(15) | M    | Merchant ID, assigned by GoAllPay                                       |
 | acqID         | String(11) | M    | "99020344"                                         |
 | paymentSchema | String(10) | M    | Channel ID：[Click Here](paymentSchema.md) |
@@ -142,14 +134,14 @@ It consists of general fields and channel-specific fields. All upload fields mus
 | signType      | String(10) | M    | "MD5" or "SHA256"                                                          |
 | signature     | String(32) | M    | MD5 or SHA256 signature                                                |
 
-**3.Response parameters**
+**3. Response parameters**
 
 | Parameter          | Type       | Required | Description                                         |
 | ------------- | ---------- | ---- | ------------------------------------------------------------ |
 | version       | String(12) | M    | "VER000000005" |
 | charSet       | String(6)  | M    | "UTF-8" |
-| transType     | String(10)  | M    | "PURC" |
-| orderNum      | String(60) | M    | Original payment order number |
+| transType     | String(10)  | M    | Transaction type |
+| orderNum      | String(60) | M    | Order number |
 | transID       | String(32) | M    | The unique transaction id generated by the gateway. |
 | merID         | String(15) | M    | Merchant ID |
 | acqID         | String(11) | M    | "99020344" |
@@ -161,9 +153,9 @@ It consists of general fields and channel-specific fields. All upload fields mus
 | signType      | String(10)  | M    | "MD5" or "SHA256" |
 | signature     | String(32) | M    | MD5 or SHA256 signature |
 
-### 4.4 Refund interface
+### 4.4 Refund
 
-**1.Interface specification** 
+**1. Interface specification** 
 
  This interface provides access to merchants with a refund of transactions.
 
@@ -177,7 +169,7 @@ It consists of general fields and channel-specific fields. All upload fields mus
  ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665469966231.jpg)
  </div>
 
-**2.Request parameters** 
+**2. Request parameters** 
 
 | Parameter          | Type       | Required | Description |
 | ------------- | ---------- | ---- | ------------------------------------------------------------ |
@@ -195,7 +187,7 @@ It consists of general fields and channel-specific fields. All upload fields mus
 | signType      | String(10)  | M    | "MD5" or "SHA256" |
 | signature     | String(32) | M    | MD5 or SHA256 signature |
 
-**3.Response parameters**
+**3. Response parameters**
 
 | Parameter      | Type       | Required | Description |
 | --------- | ---------- | ---- | ---------------------------------------------- |
@@ -214,7 +206,7 @@ It consists of general fields and channel-specific fields. All upload fields mus
 | signType  | String(10) | M    | "MD5" or "SHA256" |
 | signature | String(32) | M    | MD5 or SHA256 signature |
 
-### 4.5 Refund Inqiury interface
+<!-- ### 4.5 Refund Inqiury interface
 
 **1.Interface specification**
 
@@ -260,15 +252,15 @@ It consists of general fields and channel-specific fields. All upload fields mus
 | transTime     | String(14) | M    | Transaction time, format: "yyyyMMddHHmmss" |
 | GWTime        | String(14) | M    | yyyyMMddHHmmss this should be a GWtime, currently is local transaction time |
 | signType      | String(10) | M    | "MD5" or "SHA256" |
-| signature     | String(32) | M    | MD5 or SHA256 signature |
+| signature     | String(32) | M    | MD5 or SHA256 signature | -->
 
-### 4.6 Pre-authorization interface
+### 4.5 Pre-authorization
 
-**1.Interface specification**
+**1. Interface specification**
 
  The pre-authorization interface is applicable to foreign card (including VISA, MasterCard, JCB and other card brands) and UnionPay card transactions. Pre-authorized transactions will not participate in liquidation, and the issuing bank will temporarily freeze user funds.
 
-**2.Request parameters**
+**2. Request parameters**
 
  It consists of general fields and channel-specific fields. All upload fields must be signed.
 
@@ -285,7 +277,7 @@ It consists of general fields and channel-specific fields. All upload fields mus
 | orderAmount   | String(12)   | M    | Order amount: if 100CNY, it will be 100 or 100.00 |
 | orderCurrency | String(3)    | M    | Currency of the order: ISO standard, such as RMB filling in "CNY", US dollar filling in "USD" |
 | frontURL      | String(400)  | M    | When the payment is complete, jump to the address |
-| backURL       | String(400)  | M    | Payment results are asynchronously notified to this address |
+| backURL       | String(400)  | M    | Payment results are asynchronously notified to this URL. After the payment is successful, the GoAllPay server will call the backURL by POST method, informing the payment result (JSON). When merchant receive the notification, it is required to response String "OK".<br>If we didn't receive "OK" from merchant，GoAllPay will resend the response message to merchant.Time interval is[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400], the unit is second. |
 | merID         | String(15)   | M    | Merchant ID, assigned by GoAllPay |
 | acqID         | String(11)   | M    | "99020344" |
 | paymentSchema | String(10)   | M    | Channel ID: [Click Here](paymentSchema.md) |
@@ -296,13 +288,18 @@ It consists of general fields and channel-specific fields. All upload fields mus
 | signType      | String(10)   | M    | "MD5" or "SHA256" |
 | signature     | String(32)   | M    | MD5 or SHA256 signature |
 
-**3.Response message**
-
-  The merchant needs to provide an HTTP/HTTPS protocol interface that is included in the parameters passed to the SDK, the backURL. After the payment is complete, the GoAllPay server will call the backURL by POST method, informing the payment result (JSON). When merchant receive the notification, the merchant is required to response String "OK".
+**3. Response parameters**
 
-  If we didn't receive "OK" from merchant，GoAllPay will resend the response message to merchant.Time interval is[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400], the unit is second.
+| parameter          | Type         | Required | Description          |
+| ------------- | ------------ | ---- | ------------------------------------------------------------ |
+| RespCode       | String(2)   | M    | Response code. 00 stands for success. |
+| RespMsg       | String(256)    | M    | Response message |
+| merID     | String(15)    | O    | Merchant ID. Return it when RespCode is 00. |
+| orderNum      | String(60)   | O    | Order number. Return it when RespCode is 00. |
+| transID   | String(32)   | O    | GoAllPay serial number. Return it when RespCode is 00. |
+| parameter | Object    | O    | Payment parameters. Return it when RespCode is 00. |
 
-Parameters as follows:
+**4. Callback parameters**
 
 | Parameter          | Type       | Required | Description                                         |
 | ------------- | ------------ | ---- | ------------------------------------------------------------ |
@@ -324,9 +321,9 @@ Parameters as follows:
 | signType      | String(10)   | M    | "MD5" or "SHA256" |
 | signature     | String(32)   | M    | MD5 or SHA256 signature |
 
-### 4.7 Pre-authorization completion interface
+### 4.6 Pre-authorization completion interface
 
-**1.Interface specification**
+**1. Interface specification**
 
  The pre-authorization completion interface is applicable to foreign card (including VISA, MasterCard, JCB and other card brands) and UnionPay card transactions. The pre-authorized transaction is similar to the consumer transaction. After the transaction is successful, the merchant will be cleared of funds. 
 
@@ -340,7 +337,7 @@ Parameters as follows:
  ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665464464405.jpg)
  </div>
 
-**2.Request parameters**
+**2. Request parameters**
 
 | Parameter          | Type       | Required | Description |
 | ------------- | ---------- | ---- | ------------------------------------------------------ |
@@ -358,7 +355,7 @@ Parameters as follows:
 | signType      | String(10) | M    | "MD5" or "SHA256" |
 | signature     | String(32) | M    | MD5 or SHA256 signature |
 
-**3.Response parameters**
+**3. Response parameters**
 
 | Parameter          | Type       | Required | Description |
 | ------------- | ---------- | ---- | ---------------------------------------------- |
@@ -377,9 +374,9 @@ Parameters as follows:
 | signType      | String(10) | M    | "MD5" or "SHA256" |
 | signature     | String(32) | M    | MD5 or SHA256 signature |
 
-### 4.8 Cancellation interface
+### 4.7 Cancellation interface
 
-**1.Interface specification**
+**1. Interface specification**
 
  The revocation interface is applicable to foreign cards (including VISA, MasterCard, JCB and other card brands), UnionPay cards and Alipay Philippines wallet.
 
@@ -392,7 +389,7 @@ Parameters as follows:
  ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665464582903.jpg)
  </div>
 
-**2.Request parameters**
+**2. Request parameters**
 
 | Parameter          | Type       | Required | Description |
 | ------------- | ---------- | ---- | ---------- |
@@ -408,7 +405,7 @@ Parameters as follows:
 | signType      | String(10) | M    | "MD5" or "SHA256" |
 | signature     | String(32) | M    | MD5 or SHA256 signature |
 
-**3.Response parameters**
+**3. Response parameters**
 
 | Parameter          | Type       | Required | Description |
 | ------------- | ---------- | ---- | --------------- |
@@ -427,13 +424,13 @@ Parameters as follows:
 | signType      | String(10) | M    | "MD5" or "SHA256" |
 | signature     | String(32) | M    | MD5 or SHA256 signature |
 
-### 4.9 Manual refund application interface
+### 4.8 Manual refund application interface
 
-**1.Interface specification** 
+**1. Interface specification** 
 
 To refund the payments which are more than 90 days ago, 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 parameters** 
+**2. Request parameters** 
 
 | Parameter          | Type       | Required | Description                                         |
 | ------------- | ---------- | ---- | ------------------------------------------------------------ |
@@ -451,7 +448,7 @@ To refund the payments which are more than 90 days ago, the merchant can't proce
 | signType      | String(10)  | M    | "MD5" or "SHA256" |
 | signature     | String(32) | M    | MD5 or SHA256 signature |
 
-**3.Response parameters**
+**3. Response parameters**
 
 | Parameter      | Type       | Required | Description |
 | --------- | ---------- | ---- | ---------------------------------------------- |
@@ -470,13 +467,13 @@ To refund the payments which are more than 90 days ago, the merchant can't proce
 | signType  | String(10) | M    | "MD5" or "SHA256" |
 | signature | String(32) | M    | MD5 or SHA256 signature |
 
-### 4.10 Card binding interface
+### 4.9 Card binding interface
 
-**1.Interface specification**
+**1. Interface specification**
 
 ​    Provide users with card binding function, suitable for foreign card transactions.
 
-**2.Request parameters** 
+**2. Request parameters** 
 
 | Parameter          | Type       | Required | Description                                         |
 | ------------- | ----------- | ---- | ---------------------------------------------------------- |
@@ -493,7 +490,7 @@ To refund the payments which are more than 90 days ago, the merchant can't proce
 | signType      | String(10)  | M    | "MD5" or "SHA256"                                                |
 | signature     | String(32)  | M    | MD5 or SHA256 signature |
 
-**3.Response parameters**
+**3. Response parameters**
 
 | Parameter      | Type       | Required | Description                                           |
 | ------------- | ---------- | ---- | ---------------------------------------------------------- |
@@ -513,55 +510,13 @@ To refund the payments which are more than 90 days ago, the merchant can't proce
 | signType      | String(10) | M    | "MD5" or "SHA256"                                               |
 | signature     | String(32) | M    | MD5 or SHA256 signature |
 
-### 4.11 Card unbundling interface
-
-**1.Interface specification**
-
-   Unbound card
-
-**2.Request parameters** 
-
-| Parameter          | Type       | Required | Description                                         |
-| ------------- | ---------- | ---- | ---------------------------------------------------------- |
-| version       | String(12) | M    | "VER000000005" |
-| transType     | String(10) | M    | "UNBIND"                                              |
-| orderNum      | String(60) | M    | Order number: it is defined by the merchant itself, and the order number must not be repeated for the same merchant number |
-| orderCurrency | String(3)  | M    | Currency of the order: ISO standard, such as RMB filling in "CNY", us dollar filling in "USD" |
-| customerId    | String(60) | M    | User ID: It is defined by the merchant, and it cannot be repeated under the same merchant number. |
-| token         | String(32) | M    | The token returned after the card is successfully bound |
-| merID         | String(15) | M    | Merchant ID, assigned by GoAllPay |
-| paymentSchema | String(10) | M    | Channel ID: [Click Here](paymentSchema.md) |
-| transTime     | String(14) | M    | Transaction time, format: "yyyyMMddHHmmss" |
-| signType      | String(10) | M    | "MD5" or "SHA256" |
-| signature     | String(32) | M    | MD5 or SHA256 signature |
+### 4.10 Card payment interface
 
-**3.Response parameters**
-
-| Parameter      | Type       | Required | Description                                           |
-| ------------- | ---------- | ---- | ---------------------------------------------------------- |
-| version       | String(12) | M    | "VER000000005" |
-| transType     | String(10) | M    | "UNBIND"                                              |
-| orderNum      | String(60) | M    | Order number |
-| transID       | String(32) | M    | The unique transaction id generated by the gateway. |
-| merID         | String(15) | M    | Merchant ID |
-| paymentSchema | String(10) | M    | Channel ID |
-| 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 |
-| customerId    | String(60) | O    | User ID. |
-| cardNoTail    | String(4)  | O    | The last four digits of the card number, return when the channel is FC |
-| token         | String(32) | O    | token |
-| transTime     | String(14) | M    | Transaction time, format: "yyyyMMddHHmmss" |
-| GWTime        | String(14) | M    | yyyyMMddHHmmss this should be a GWtime, currently is local transaction time |
-| signType      | String(10) | M    | "MD5" or "SHA256" |
-| signature     | String(32) | M    | MD5 or SHA256 signature |
-
-### 4.12 Card payment interface
-
-**1.Interface specification**
+**1. Interface specification**
 
    Card-tied consumer payment, debits the user based on the token returned when the card was tied.
 
-**2.Request parameters** 
+**2. Request parameters** 
 
   It consists of general fields and channel-specific fields. All upload fields must be signed.
 
@@ -577,7 +532,7 @@ To refund the payments which are more than 90 days ago, the merchant can't proce
 | orderNum      | String(60)   | M    | Order number: it is defined by the merchant itself, and the order number must not be repeated for the same merchant number |
 | orderAmount   | String(12)   | M    | Order amount: if 100CNY, it will be 100 or 100.00 |
 | orderCurrency | String(3)    | M    | Currency of the order: ISO standard, such as RMB filling in "CNY", us dollar filling in "USD" |
-| backURL       | String(400)  | M    | Payment results are asynchronously notified to this address |
+| backURL       | String(400)  | M    | Payment results are asynchronously notified to this URL. After the payment is successful, the GoAllPay server will call the backURL by POST method, informing the payment result (JSON). When merchant receive the notification, it is required to response String "OK".<br>If we didn't receive "OK" from merchant，GoAllPay will resend the response message to merchant.Time interval is[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400], the unit is second. |
 | customerId    | String(60)   | M    | User ID: It is defined by the merchant, and it cannot be repeated under the same merchant number. |
 | token         | String(32)   | M    | The token returned after the card is successfully bound |
 | merID         | String(15)   | M    | Merchant ID, assigned by GoAllPay |
@@ -589,13 +544,7 @@ To refund the payments which are more than 90 days ago, the merchant can't proce
 | signType      | String(10)   | M    | "MD5" or "SHA256" |
 | signature     | String(32)   | M    | MD5 or SHA256 signature |
 
-**3.Response parameters**
-
-  The merchant needs to provide an HTTP/HTTPS protocol interface that is included in the parameters passed to the SDK, the backURL. After the payment is complete, the GoAllPay server will call the backURL by POST method, informing the payment result (JSON). When merchant receive the notification, the merchant is required to response String "OK".
-
-  If we didn't receive "OK" from merchant，GoAllPay will resend the response message to merchant.Time interval is[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400], the unit is second.
-
-Parameters as follows:
+**3. Response parameters**
 
 | Parameter      | Type       | Required | Description |
 | ------------- | ------------ | ---- | ---------- |
@@ -617,6 +566,48 @@ Parameters as follows:
 | signType      | String(10)   | M    | "MD5" or "SHA256" |
 | signature     | String(32)   | M    | MD5 or SHA256 signature |
 
+### 4.11 Card unbundling interface
+
+**1. Interface specification**
+
+   Unbound card
+
+**2. Request parameters** 
+
+| Parameter          | Type       | Required | Description                                         |
+| ------------- | ---------- | ---- | ---------------------------------------------------------- |
+| version       | String(12) | M    | "VER000000005" |
+| transType     | String(10) | M    | "UNBIND"                                              |
+| orderNum      | String(60) | M    | Order number: it is defined by the merchant itself, and the order number must not be repeated for the same merchant number |
+| orderCurrency | String(3)  | M    | Currency of the order: ISO standard, such as RMB filling in "CNY", us dollar filling in "USD" |
+| customerId    | String(60) | M    | User ID: It is defined by the merchant, and it cannot be repeated under the same merchant number. |
+| token         | String(32) | M    | The token returned after the card is successfully bound |
+| merID         | String(15) | M    | Merchant ID, assigned by GoAllPay |
+| paymentSchema | String(10) | M    | Channel ID: [Click Here](paymentSchema.md) |
+| transTime     | String(14) | M    | Transaction time, format: "yyyyMMddHHmmss" |
+| signType      | String(10) | M    | "MD5" or "SHA256" |
+| signature     | String(32) | M    | MD5 or SHA256 signature |
+
+**3. Response parameters**
+
+| Parameter      | Type       | Required | Description                                           |
+| ------------- | ---------- | ---- | ---------------------------------------------------------- |
+| version       | String(12) | M    | "VER000000005" |
+| transType     | String(10) | M    | "UNBIND"                                              |
+| orderNum      | String(60) | M    | Order number |
+| transID       | String(32) | M    | The unique transaction id generated by the gateway. |
+| merID         | String(15) | M    | Merchant ID |
+| paymentSchema | String(10) | M    | Channel ID |
+| 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 |
+| customerId    | String(60) | O    | User ID. |
+| cardNoTail    | String(4)  | O    | The last four digits of the card number, return when the channel is FC |
+| token         | String(32) | O    | token |
+| transTime     | String(14) | M    | Transaction time, format: "yyyyMMddHHmmss" |
+| GWTime        | String(14) | M    | yyyyMMddHHmmss this should be a GWtime, currently is local transaction time |
+| signType      | String(10) | M    | "MD5" or "SHA256" |
+| signature     | String(32) | M    | MD5 or SHA256 signature |
+
 ## 5.RespCode 
 
 | RespCode | Description      |