Browse Source

更新英文版文档

tao.zhou 1 year ago
parent
commit
b64043ccd0
2 changed files with 448 additions and 184 deletions
  1. 28 28
      AllPay_Integration_Specification_CH.md
  2. 420 156
      AllPay_Integration_Specification_EN.md

+ 28 - 28
AllPay_Integration_Specification_CH.md

@@ -95,8 +95,8 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 | orderNum      | String(60)   | 是    | 订单号:商户自行定义,需保证同一商户号下订单号不能重复 |
 | orderAmount   | String(12)   | 是    | 订单金额:如 100 元,表示为 100 或 100.00 |
 | orderCurrency | String(3)    | 是    | 订单币种:ISO标准。如:人民币填写“CNY”,美元填写"USD" |
-| frontURL      | String(400)  | 是    | 支付完成后前端跳转到该URL |
-| backURL       | String(400)  | 是    | 支付结果异步通知到该URL。支付成功后,GoAllPay 会以 POST 方式调用 backURL 通知支付结果(详见[3.3 支付结果通知(回调)](#33-支付结果通知-回调))。商户在接收到通知后,需响应字符串“OK”。<br>如果没有收到商户响应“OK”,GoAllPay将会过一段时间后重新推送,时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400],单位为秒。 |
+| frontURL      | String(400)  | 是    | 支付完成后前端跳转到该URL。GET请求,参数详见[3.3 支付结果通知(回调)](#33-支付结果通知-回调) |
+| backURL       | String(400)  | 是    | 支付结果异步通知到该URL。支付成功后,GoAllPay 会以 POST JSON 方式调用 backURL 通知支付结果(详见[3.3 支付结果通知(回调)](#33-支付结果通知-回调))。商户在接收到通知后,需响应字符串“OK”。<br>如果没有收到商户响应“OK”,GoAllPay将会过一段时间后重新推送,时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400],单位为秒。 |
 | merID         | String(15)   | 是    | 商户 ID,由 GoAllPay 分配 |
 | acqID         | String(11)   | 是    | 收单行 ID,统一填写为"99020344" |
 | goodsInfo     | String(60)   | 是    | 商品信息。注意不要包含特殊符号,如 "#","&","+" 等 |
@@ -143,8 +143,8 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 | orderNum            | String(60)     | 是    | 订单号:商户自行定义,需保证同一商户号下订单号不能重复 |
 | orderAmount         | String(12)     | 是    | 订单金额:如 100 元,表示为 100 或 100.00 |
 | orderCurrency       | String(3)      | 是    | 订单币种:ISO标准。如:人民币填写“CNY”,美元填写"USD" |
-| frontURL            | String(400)    | 是    | 支付完成后前端跳转到该URL|
-| backURL             | String(400)    | 是    | 支付结果异步通知到该URL。支付成功后,GoAllPay 会以 POST 方式调用 backURL 通知支付结果(详见[3.3 支付结果通知(回调)](#33-支付结果通知-回调))。商户在接收到通知后,需响应字符串“OK”。 如果没有收到商户响应“OK”,GoAllPay将会过一段时间后重新推送,时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400],单位为秒。|
+| frontURL            | String(400)    | 是    | 支付完成后前端跳转到该URL。GET请求,参数详见[3.3 支付结果通知(回调)](#33-支付结果通知-回调)|
+| backURL             | String(400)    | 是    | 支付结果异步通知到该URL。支付成功后,GoAllPay 会以 POST JSON 方式调用 backURL 通知支付结果(详见[3.3 支付结果通知(回调)](#33-支付结果通知-回调))。商户在接收到通知后,需响应字符串“OK”。 如果没有收到商户响应“OK”,GoAllPay将会过一段时间后重新推送,时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400],单位为秒。|
 | merID               | String(15)     | 是    | 商户 ID,由 GoAllPay 分配 |
 | acqID               | String(11)     | 是    | 收单行 ID,统一填写为"99020344"|
 | goodsInfo           | String(60)     | 是    | 商品信息。注意不要包含特殊符号,如 "#","&","+" 等 |
@@ -156,8 +156,8 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 | OsType              | String(20)     | 是    | 操作系统类型。"IOS","ANDROID","HARMONYOS","WINDOWS","MAC","OTHER" 选其中一个上送|
 | OsVersion           | String(20)     | 否    | 操作系统版本。示例:"10.0.19043" |
 | tokenFlag           | String(10)     | 否    | 是否同时返回签约支付token的标识,需要返回时,填写:"true",该功能需要单独审批开通。 |
-| tokenBackURL        | String(400)    | 否    | 签约支付token的异步通知URL,当tokenFlag为"True"时,必须填写 |
-| logisticsCountry    | String         | 是    | 物流国家/地区,2位国家码,如:US  |
+| tokenBackURL        | String(400)    | 否    | 签约支付token的异步通知URL,当tokenFlag为"true"时,必须填写 |
+| logisticsCountry    | String(2)      | 是    | 物流国家/地区,2位国家码,如:US  |
 | logisticsState      | String         | 是    | 物流州/省/邦,2位编码,如:CA  |
 | logisticsCity       | String         | 是    | 物流城市 |
 | logisticsStreet     | String         | 是    | 物流地址 |
@@ -182,7 +182,7 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 
 **1. 接口说明**
  
- 商家调用支付接口、收银台支付接口,后台支付结果将通过该接口,返回到支付交易的 backURL 位置。
+ 商家调用支付接口、收银台支付接口、后台支付接口、预授权接口,结果将通过该接口返回到交易的 backURL 位置。
 
 **2. 请求路径**
 
@@ -340,8 +340,8 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 | orderNum      | String(60)   | 是    | 订单号:商户自行定义,需保证同一商户号下订单号不能重复       |
 | orderAmount   | String(12)   | 是    | 订单金额:如 100 元,表示为 100 或 100.00                    |
 | orderCurrency | String(3)    | 是    | 订单币种:ISO标准。如:人民币填写“CNY”,美元填写"USD"        |
-| frontURL      | String(400)  | 是    | 支付完成后跳转到该地址                                       |
-| backURL       | String(400)  | 是    | 支付结果异步通知到该URL。支付成功后,GoAllPay 会以 POST 方式调用 backURL 通知支付结果(详见[3.3 支付结果通知(回调)](#33-支付结果通知-回调))。商户在接收到通知后,需响应字符串“OK”。<br>如果没有收到商户响应“OK”,GoAllPay将会过一段时间后重新推送,时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400],单位为秒。 |
+| frontURL      | String(400)  | 是    | 支付完成后跳转到该地址。GET请求,参数详见[3.3 支付结果通知(回调)](#33-支付结果通知-回调) |
+| backURL       | String(400)  | 是    | 支付结果异步通知到该URL。支付成功后,GoAllPay 会以 POST JSON 方式调用 backURL 通知支付结果(详见[3.3 支付结果通知(回调)](#33-支付结果通知-回调))。商户在接收到通知后,需响应字符串“OK”。<br>如果没有收到商户响应“OK”,GoAllPay将会过一段时间后重新推送,时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400],单位为秒。 |
 | merID         | String(15)   | 是    | 商户 ID,由 GoAllPay 分配                                      |
 | acqID         | String(11)   | 是    | 收单行 ID "99020344"                                         |
 | paymentSchema | String(10)   | 是    | 渠道ID:[点击这里](paymentSchema.md) |
@@ -525,7 +525,7 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 
 **1. 接口说明** 
 
- 为用户提供签约(签约)支付功能,适用于支付宝本地支付。<br><br>接口交易流程:<br>![](images/applyToken.png)
+ 为用户提供签约功能,适用于支付宝本地支付和部分渠道的外卡。<br><br>接口交易流程:<br>![](images/applyToken.png)
 
 **2. 请求路径**
 
@@ -542,18 +542,18 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 | 参数          | 类型        | 必填 | 描述                                                       |
 | ------------- | ----------- | ---- | ---------------------------------------------------------- |
 | version       | String(12)  | 是    | 统一填写为“VER000000005”                                   |
-| userRegion    | String(2)  | 否    | 用户地区,ISO标准两位国家代码,如PH                                                |
+| userRegion    | String(2)  | 否    | 用户地区,ISO标准两位国家代码,如PH       |
 | orderNum      | String(60)  | 是    | 签约订单号:商户自行定义,需保证同一商户号下订单号不能重复 |
 | orderCurrency	|String(3)	|是	|订单币种:ISO标准。如:人民币填写“CNY”,美元填写"USD"|
 | customerId    | String(60)  | 是    | 用户ID:  商户自行定义,需保证同一商户号下不同用户不能重复  |
-| frontURL      | String(400) | 是    | 签约后前端跳转地址                                       |
-| backURL       | String(400)  | 是    | 签约结果异步通知到该URL。签约成功后,GoAllPay 会以 POST 方式调用 backURL 通知支付结果(详见[签约结果通知-回调](#42-签约结果通知-回调))。商户在接收到通知后,需响应字符串“OK”。<br>如果没有收到商户响应“OK”,GoAllPay将会过一段时间后重新推送,时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400],单位为秒。 |
+| frontURL      | String(400) | 是    | 签约后前端跳转地址。GET请求,参数详见[签约结果通知-回调](#42-签约结果通知-回调) |
+| backURL       | String(400)  | 是    | 签约结果异步通知到该URL。签约成功后,GoAllPay 会以 POST JSON 方式调用 backURL 通知支付结果(详见[签约结果通知-回调](#42-签约结果通知-回调))。商户在接收到通知后,需响应字符串“OK”。<br>如果没有收到商户响应“OK”,GoAllPay将会过一段时间后重新推送,时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400],单位为秒。 |
 | merID         | String(15)  | 是    | 商户 ID,由 GoAllPay 分配                                  |
 | paymentSchema | String(20)  | 是    | 渠道ID:"AliPayPlus"或"FC" |
 | transTime     | String(14)  | 是    | 交易时间,格式:"yyyyMMddHHmmss" |
 | terminalType  | String(10)  | 是    | 终端类型。"WEB","WAP","MINI_APP","APP"选其中一个上送 |
-| OsType  | String(10)  | 是    | 操作系统类型。"IOS","ANDROID","OTHER" 选其中一个上送 |
-| OsVersion  | String(10)  | 否   | 操作系统版本,如11.0.2 |
+| OsType  | String(10)  | 是    | 用户操作系统类型。<br>"IOS","ANDROID","HARMONYOS","WINDOWS","MAC","OTHER" 选其中一个上送 |
+| OsVersion  | String(10)  | 否   | 用户操作系统版本,如11.0.2 |
 | signType      | String(10)  | 是    | SHA256 |
 | signature     | String(32)  | 是    | 签名  |
 
@@ -576,7 +576,7 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 
 **2. 请求路径**
 
-签约支付接口中的`backURL`参数,或是收银台支付接口中的`tokenBackURL`参数。
+签约接口中的`backURL`参数,或是收银台支付接口中的`tokenBackURL`参数。
 
 **3. 请求参数**
 
@@ -590,7 +590,7 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 | refreshTokenExpiryTime         | String(25)   | 否    | 更新token有效期,格式:"2019-11-27T12:01:01+08:00" |
 | merID         | String(15)   | 是    | 商户ID |
 | paymentSchema | String(20)   | 是    | 渠道ID |
-| sub_brand_code| String(20)   |     | 子品牌 |
+| sub_brand_code| String(20)   |     | 子品牌 |
 | RespCode      | String(2)    | 是    | 应答码 00-成功,01-失败。详情见本文档第5章应答码 |
 | RespMsg       | String(20)   | 是    | 应答消息 |
 | customerId    | String(60)   | 是    | 用户ID |
@@ -622,8 +622,8 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 | customerId    | String(60)  | 是   | 用户ID |
 | orderNum      | String(60) | 是    | 签约订单号 |
 | merID         | String(15) | 是    | 商户 ID,由 GoAllPay 分配                                       |
-| sub_brand_code| String(20) | 是    | 子品牌 |
-| paymentSchema | String(20) | 是    | 渠道ID:"AliPayPlus" |
+| sub_brand_code| String(20) | 否    | 子品牌。paymentSchema为"AliPayPlus"时必填 |
+| paymentSchema | String(20) | 是    | 渠道ID:"AliPayPlus"或"FC" |
 | transTime     | String(14) | 是    | 交易时间,格式:"yyyyMMddHHmmss"                               |
 | signType      | String(10) | 是    | SHA256                                                          |
 | signature     | String(32) | 是    | 签名                                                |
@@ -640,7 +640,7 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 | refreshTokenExpiryTime         | String(25)   | 否    | 更新token有效期,格式:"2019-11-27T12:01:01+08:00" |
 | merID         | String(15)   | 是    | 商户ID |
 | paymentSchema | String(20)   | 是    | 渠道ID |
-| sub_brand_code| String(20)   |     | 子品牌 |
+| sub_brand_code| String(20)   |     | 子品牌 |
 | RespCode      | String(2)    | 是    | 应答码 00-成功,01-失败。详情见本文档第5章应答码 |
 | RespMsg       | String(20)   | 是    | 应答消息 |
 | customerId    | String(60)   | 是    | 用户ID |
@@ -676,7 +676,7 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 | orderNum      | String(60)   | 是    | 订单号:商户自行定义,需保证同一商户号下订单号不能重复       |
 | orderAmount   | String(12)   | 是    | 订单金额:如 100 元,表示为 100 或 100.00                    |
 | orderCurrency | String(3)    | 是    | 订单币种:ISO标准。如:人民币填写“CNY”,美元填写"USD"        |
-| backURL       | String(400)  | 是    | 支付结果异步通知到该URL。支付成功后,GoAllPay 会以 POST 方式调用 backURL 通知支付结果(详见[3.3 支付结果通知(回调)](#33-支付结果通知-回调))。商户在接收到通知后,需响应字符串“OK”。<br>如果没有收到商户响应“OK”,GoAllPay将会过一段时间后重新推送,时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400],单位为秒。 |
+| backURL       | String(400)  | 是    | 支付结果异步通知到该URL。支付成功后,GoAllPay 会以 POST JSON 方式调用 backURL 通知支付结果(详见[3.3 支付结果通知(回调)](#33-支付结果通知-回调))。商户在接收到通知后,需响应字符串“OK”。<br>如果没有收到商户响应“OK”,GoAllPay将会过一段时间后重新推送,时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400],单位为秒。 |
 | customerId    | String(60)   | 是    | 用户ID:  商户自行定义,需保证同一商户号下不同用户不能重复    |
 | token         | String(32)   | 是    | 签约时返回的token                                            |
 | merID         | String(15)   | 是    | 商户 ID,由 GoAllPay 分配                                    |
@@ -728,12 +728,12 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 | 参数          | 类型       | 必填 | 描述                                                         |
 | ------------- | ---------- | ---- | ------------------------------------------------------------ |
 | version       | String(12) | 是    | 统一填写为“VER000000005”                                     |
-| customerId    | String(60)  | 是   | 用户ID |
+| customerId    | String(60) | 是    | 用户ID |
 | orderNum      | String(60) | 是    | 订单号。商户自行定义,需保证同一商户号下订单号不能重复 |
 | merID         | String(15) | 是    | 商户 ID,由 GoAllPay 分配                                       |
 | refreshToken  | String(32) | 是    | 签约时返回的refreshToken |
-| sub_brand_code| String(20) | 是    | 子品牌       |
-| paymentSchema | String(20) | 是    | 渠道ID:"AliPayPlus" |
+| sub_brand_code| String(20) | 否    | 子品牌。paymentSchema为"AliPayPlus"时必填 |
+| paymentSchema | String(20) | 是    | 渠道ID:"AliPayPlus"或"FC" |
 | transTime     | String(14) | 是    | 交易时间,格式:"yyyyMMddHHmmss"                               |
 | signType      | String(10) | 是    | SHA256                                                          |
 | signature     | String(32) | 是    | 签名                                                |
@@ -750,7 +750,7 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 | refreshTokenExpiryTime         | String(25)   | 否    | 更新token有效期,格式:"2019-11-27T12:01:01+08:00" |
 | merID         | String(15)   | 是    | 商户ID |
 | paymentSchema | String(20)   | 是    | 渠道ID |
-| sub_brand_code| String(20)   |     | 子品牌 |
+| sub_brand_code| String(20)   |     | 子品牌 |
 | RespCode      | String(2)    | 是    | 应答码 00-成功,01-失败。详情见本文档第5章应答码 |
 | RespMsg       | String(20)   | 是    | 应答消息 |
 | reason        | JSON Object  | 否    | 失败原因,JSON格式```{"code":"原因代码", "text":"原因说明"}```,[点击查看详情](refreshToken_reason.md)。 |
@@ -776,12 +776,12 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 | 参数          | 类型       | 必填 | 描述                                                       |
 | ------------- | ---------- | ---- | ---------------------------------------------------------- |
 | version       | String(12) | 是    | 统一填写为“VER000000005”                                   |
-| sub_brand_code| String(20) |     | 子品牌 |
+| sub_brand_code| String(20) |     | 子品牌 |
 | orderNum      | String(60) | 是    | 解约订单号:商户自行定义,需保证同一商户号下订单号不能重复 |
 | customerId    | String(60) | 是    | 用户ID  |
 | token         | String(32) | 是    | 签约时返回的token                                          |
 | merID         | String(15) | 是    | 商户 ID,由 GoAllPay 分配                                  |
-| paymentSchema | String(20) | 是    | 渠道ID:"AliPayPlus" |
+| paymentSchema | String(20) | 是    | 渠道ID:"AliPayPlus"或"FC" |
 | transTime     | String(14) | 是    | 交易时间,格式:"yyyyMMddHHmmss"                           |
 | signType      | String(10) | 是    | SHA256                                                |
 | signature     | String(32) | 是    | 签名                                      |
@@ -795,7 +795,7 @@ signature: 40f1e5adebba58cc7822dac0b3a2bfebb6676e245370be027cdfb952695bee29
 | token         | String(32)   | 否    | 签约扣款交易使用该token |
 | merID         | String(15)   | 是    | 商户ID |
 | paymentSchema | String(20)   | 是    | 渠道ID |
-| sub_brand_code| String(20)   |     | 子品牌 |
+| sub_brand_code| String(20)   |     | 子品牌 |
 | RespCode      | String(2)    | 是    | 应答码 00-成功,01-失败。详情见本文档第5章应答码 |
 | RespMsg       | String(20)   | 是    | 应答消息 |
 | customerId    | String(60)   | 是    | 用户ID |

File diff suppressed because it is too large
+ 420 - 156
AllPay_Integration_Specification_EN.md