# GoAllPay在线支付接入规范文档V5.0.0
[上海偶可贝网络科技有限公司](https://www.goallpayx.com)

* 版本信息：中文 V5.0.0
* 更新时间：2020 年6 月

## 1.概述
GoAllPay 为客户提供统一的API接入，以帮助客户实现快速、安全、集中式的接入支付渠道。
## 2.交易流程 
![image](https://git.allpayx.com/OpenAPI/b2c/raw/master/images/pc_flowsheet.png)
## 3.验签说明 
```
1.对于发送到 GoAllPay 系统的请求报文，其中所有传入参数（除 signature 参数外）按照字段名的 ASCII 码从小到大排序后（字典序），使用 URL 键值对的格式（即 key1=value1&key2=value2...）拼接成字符串 String1。

2.在 String1 最后直接拼接（不需要用“&”连接）双方约定的签名密钥 Key（接入 GoAllPay 时分配），得到 stringSignTemp 字符串，并对 stringSignTemp 进行加密运算，得到 signature 的值。

3.示例签名串 acqID=99020344&backURL=https://testapi.allpayx.com/test&charSet=UTF-8&detailInfo=W3siZ29vZHNfbmFtZSI6IuiLueaenCIsInF1YW50aXR5IjoiMyJ9LHsiZ29vZHNfbmFtZSI6IuapmOWtkCIsInF1YW50aXR5IjoiNyJ9XQ==&frontURL=http://114.80.87.249/cashier/estore/j&goodsInfo=pingguo&merID=600039259442068&merReserve=er&orderAmount=1&orderCurrency=CNY&orderNum=20200601140953&paymentSchema=UP&signType=MD5&tradeFrom=H5&transTime=20200601140953&transType=PURC&version=VER000000005fzxego5kgo248dsv9566fo8wz98f8bqk
```
## 4.通用API说明

 商户服务器和 GoAllPay 网关对接的通用接口，每个渠道都具有的功能，包括：消费，消费查询，退款，退款查询。

### 4.1 通用 API 接入地址 

| 交易名称 | 测试地址                                 | 生产地址                             |
| ------- | ------------------------------------------- | --------------------------------------- |
| 消费    | https://testapi.allpayx.com/api/unifiedorder | https://api.allpayx.com/api/unifiedorder |
| 消费查询 | https://testapi.allpayx.com/api/orderquery   | https://api.allpayx.com/api/orderquery   |
| 退款    | https://testapi.allpayx.com/api/refund       | https://api.allpayx.com/api/refund       |
| 退款查询 | https://testapi.allpayx.com/api/refundquery  | https://api.allpayx.com/api/refundquery  |
| 预授权 | https://testapi.allpayx.com/api/unifiedorder | https://api.allpayx.com/api/unifiedorder |
| 预授权完成 | https://testapi.allpayx.com/api/pauc | https://api.allpayx.com/api/pauc |
| 撤销 | https://testapi.allpayx.com/api/canc | https://api.allpayx.com/api/canc |
| 手工退款申请 | https://testapi.allpayx.com/api/refdreq | https://api.allpayx.com/api/refdreq |
| 签约 | https://testapi.allpayx.com/api/bindCard | https://api.allpayx.com/api/bindCard |
| 解约 | https://testapi.allpayx.com/api/unBindCard | https://api.allpayx.com/api/unBindCard |
| 订阅扣款 | https://testapi.allpayx.com/api/bindPay | https://api.allpayx.com/api/bindPay |

### 4.2 消费交易接口

**1.接口说明**

 该接口为接入商家提供消费购买的功能。

**2.请求报文格式**

 由通用字段和渠道专属字段组成。凡是上送字段都需参与签名。消费接口分为跳转型和参数返回型，默认为跳转型，参数返回型会在渠道专属字段中说明。

 *渠道专属字段：* [点击查看](payExclusive_CH.md)

 *通用字段：*

| 参数          | 类型         | 属性 | 描述                                                         |
| ------------- | ------------ | ---- | ------------------------------------------------------------ |
| version       | String(12)   | M    | 统一填写为“VER000000005”                                     |
| 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    | 支付结果异步通知到该地址                                     |
| merID         | String(15)   | M    | 商户 ID，由 GoAllPay 分配                                       |
| acqID         | String(11)   | M    | 收单行 ID "99020344"                                         |
| paymentSchema | String(10)   | M    | 渠道ID：[点击查看详情](paymentSchema.md) |
| goodsInfo     | String(60)   | M    | 商品信息,在支付页面上显示。                                    |
| detailInfo    | String(400)  | M    | 商品明细。格式：[{"goods_name":"iPhone X","quantity":"2"},{"goods_name":"iPhone 8","quantity":"4"}]，需对该字段进行base-64编码后签名上送。 |
| transTime     | String(14)   | M    | 交易时间，格式："yyyyMMddHHmmss" |
| merReserve    | String(1024) | O    | 商户预留内容，可传任意内容，如购买商品信息、员号等，但不要传特殊符号，如逗号等。 |
| signType      | String(10)   | M    | MD5或SHA256                                                   |
| signature     | String(32)   | M    | 采用 MD5或SHA256 签名                                         |

**3.跳转型消费接口响应报文**

  商户需要提供一个 http/https 协议的接口，包含在参数里传递给GoAllPay，即 backURL。GoAllPay 服务器在支付完成后，会以 POST 方式调用 backURL，通知支付结果（JSON）。商户在接收到通知后，需响应字符串“OK”。

  如果没有收到商户返回“OK”，GoAllPay将会过一段时间后重新推送，时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400]，单位为秒。

 推送参数如下表：

| 参数          | 类型         | 属性 | 描述                                                         |
| ------------- | ------------ | ---- | ------------------------------------------------------------ |
| version       | String(12)   | M    | 统一填写为“VER000000005”                                     |
| 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"        |
| merID         | String(15)   | M    | 商户 ID，由 GoAllPay 分配                                      |
| acqID         | String(11)   | M    | 收单行 ID "99020344"                                         |
| paymentSchema | String(10)   | M    | 渠道ID |
| RespCode      | String(2)    | M    | 应答码 00-成功，01-失败。详情见本文档第5章应答码 |
| RespMsg       | String(20)   | M    | 应答消息                                                     |
| transID       | String(32)   | M    | GW 系统生成的交易 ID，每笔交易保持唯一                       |
| GWTime        | String(14)   | M    | yyyyMMddHHmmss，为 GW 时间                                   |
| transTime     | String(14)   | M    | 交易时间，格式："yyyyMMddHHmmss"                             |
| merReserve    | String(1024) | O    | 商户预留内容，可传任意内容，如购买商品信息、员号等，但不要传特殊符号，如逗号。 |
| signType      | String(10)   | M    | MD5或SHA256                                                  |
| signature     | String(32)   | M    | 采用 MD5或SHA256 签名                                        |

### 4.3 消费查询交易接口 

**1.接口说明**

  该接口为接入商家提供消费查询的功能。

 （1）接口补充说明
  * 商户发起消费交易后，可通过该接口查询消费交易的状态

 （2）接口交易流程

  ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665470156706.jpg)

**2.请求报文格式** 

| 参数          | 类型       | 属性 | 描述                                                         |
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
| version       | String(12) | M    | 统一填写为“VER000000005”                                     |
| charSet       | String(6)  | M    | 统一填写为“UTF-8”                                            |
| transType     | String(4)  | M    | 查询填写“INQY”                                               |
| orderNum      | String(60) | M    | 支付订单号                                                       |
| merID         | String(15) | M    | 商户 ID，由 GoAllPay 分配                                       |
| acqID         | String(11) | M    | 收单行 ID "99020344"                                         |
| paymentSchema | String(10) | M    | 渠道ID：[点击这里](paymentSchema.md) |
| transTime     | String(14) | M    | 交易时间，格式："yyyyMMddHHmmss"                               |
| signType      | String(10) | M    | MD5或SHA256                                                          |
| signature     | String(32) | M    | 采用 MD5或SHA256 签名                                                |

**3.响应报文格式**

| 参数          | 类型       | 属性 | 描述                                                         |
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
| version       | String(12) | M    | 统一填写为“VER000000005”                                     |
| 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，由 GoAllPay 分配                                      |
| acqID         | String(11) | M    | 收单行 ID "99020344"                                         |
| paymentSchema | String(10) | M    | 渠道ID |
| RespCode      | String(2)  | M    | 应答码 00-成功，01-失败。详情见本文档第5章应答码 |
| RespMsg       | String(20) | M    | 应答消息                                                     |
| transTime     | String(14) | M    | 交易时间，格式："yyyyMMddHHmmss"                             |
| GWTime        | String(14) | M    | YYYYMMDDHHMMSS，为 GW 时间，目前为本地交易时间               |
| signType      | String(3)  | M    | MD5或SHA256                                                  |
| signature     | String(32) | M    | 采用 MD5或SHA256 签名                                        |

### 4.4 退款交易接口

**1.接口功能说明**
 
  该接口为接入商家提供交易退款的功能。

 （1）接口补充说明
 * 该接口在消费交易成功后发起，要求指定原订单号
 * 外卡交易当日不能做退款，可以做撤销，只能隔日退款
 * 正常情况下，商户当日退款金额，不得大于当日成功交易额

 （2）接口交易流程

  ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665469966231.jpg)

**2.请求报文格式** 

| 参数          | 类型       | 属性 | 描述                                                         |
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
| version       | String(12) | M    | 统一填写为“VER000000005”                                     |
| charSet       | String(6)  | M    | 统一填写为“UTF-8”                                            |
| transType     | String(4)  | M    | 退款填写“REFD”                                               |
| orderNum      | String(60) | M    | 退款订单号:商户自行定义，需保证同一商户号下退款订单号不能重复 |
| origOrderNum  | String(60) | M    | 原支付订单号                                                 |
| returnAmount  | String(12) | M    | 退款金额：如 100 元，表示为 100 或 100.00                    |
| orderCurrency | String(3)  | M    | 订单币种：ISO标准 如：人民币填写“CNY”,美元填写"USD"          |
| merID         | String(15) | M    | 商户 ID，由 GoAllPay 分配                                       |
| paymentSchema | String(10) | M    | 渠道ID：[点击这里](paymentSchema.md) |
| acqID         | String(11) | M    | 收单行 ID "99020344"                                         |
| transTime     | String(14) | M    | 交易时间，格式："yyyyMMddHHmmss"                             |
| signType      | String(3)  | M    | MD5或SHA256                                                  |
| signature     | String(32) | M    | 采用 MD5或SHA256 签名                                        |

**3.响应报文格式**

| 参数      | 类型       | 属性 | 描述                                           |
| --------- | ---------- | ---- | ---------------------------------------------- |
| version   | String(12) | M    | 统一填写为“VER000000005”                       |
| charSet   | String(6)  | M    | 统一填写为“UTF-8”                              |
| transType | String(4)  | M    | 退款填写“REFD”                                 |
| orderNum  | String(60) | M    | 退款订单号                                     |
| transID   | String(32) | M    | GW 系统生成的交易 ID，每笔交易保持唯一         |
| merID     | String(15) | M    | 商户 ID，由 GoAllPay 分配                         |
| acqID     | String(11) | M    | 收单行 ID "99020344"                           |
| paymentSchema | String(10) | M    | 渠道ID |
| RespCode  | String(2)  | M    | 应答码 00-成功，01-失败。详情见本文档第5章应答码 |
| 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.5 退款查询交易接口

**1.接口说明**

  该接口为接入商家提供退款查询的功能。

（1）接口补充说明
 * 该接口用于商户在退款发起后，查询退款交易的处理状态

（2）接口交易流程

 ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665470092257.jpg)

**2.请求报文格式** 

| 参数          | 类型       | 属性 | 描述                                                         |
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
| version       | String(12) | M    | 统一填写为“VER000000005”                                     |
| charSet       | String(6)  | M    | 统一填写为“UTF-8”                                            |
| transType     | String(4)  | M    | 查询填写“RFQY”                                               |
| orderNum      | String(60) | M    | 退款订单号                                                   |
| merID         | String(15) | M    | 商户 ID，由 GoAllPay 分配                                       |
| acqID         | String(11) | M    | 收单行 ID "99020344"                                         |
| paymentSchema | String(10) | M    | 渠道ID：[点击这里](paymentSchema.md) |
| transTime     | String(14) | M    | 交易时间，格式:"yyyyMMddHHmmss" |
| signType      | String(10) | M    | MD5或SHA256 |
| signature     | String(32) | M    | 采用 MD5或SHA256 签名 |

**3.响应报文格式**

| 参数          | 类型       | 属性 | 描述                                                         |
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
| version       | String(12) | M    | 统一填写为“VER000000005”                                     |
| charSet       | String(6)  | M    | 统一填写为“UTF-8”                                            |
| transType     | String(4)  | M    | 查询填写“RFQY”                                               |
| orderNum      | String(60) | M    | 退款订单号                                                   |
| transID       | String(32) | M    | GW 系统生成的交易 ID，每笔交易保持唯一                       |
| merID         | String(15) | M    | 商户 ID，由 GoAllPay 分配                                      |
| acqID         | String(11) | M    | 收单行 ID "99020344"                                         |
| paymentSchema | String(10) | M    | 渠道ID |
| RespCode      | String(2)  | M    | 应答码 00-成功，01-失败。详情见本文档第5章应答码 |
| 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.6 预授权接口

**1.接口说明**

  预授权接口适用于外卡（包括VISA、万事达、JCB等卡品牌）和银联卡交易。预授权交易不会参与清算，发卡银行会暂时冻结用户资金。

**2.请求报文格式**

  由通用字段和渠道专属字段组成。凡是上送字段都需参与签名。

 *渠道专属字段：* [点击查看](preAuthorizationExclusive_CH.md)

 *通用字段：*

| 参数          | 类型         | 属性 | 描述                                                         |
| ------------- | ------------ | ---- | ------------------------------------------------------------ |
| version       | String(12)   | M    | 统一填写为“VER000000005”                                     |
| charSet       | String(6)    | M    | 统一填写为“UTF-8”                                            |
| transType     | String(4)    | M    | 预授权填写“PAUT”                                             |
| 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    | 支付结果异步通知到该地址                                     |
| merID         | String(15)   | M    | 商户 ID，由 GoAllPay 分配                                      |
| acqID         | String(11)   | M    | 收单行 ID "99020344"                                         |
| paymentSchema | String(10)   | M    | 渠道ID：[点击这里](paymentSchema.md) |
| goodsInfo     | String(60)   | M    | 商品信息,在支付页面上显示。                                  |
| detailInfo    | String(400)  | M    | 商品明细。格式：[{"goods_name":"iPhone X","quantity":"2"},{"goods_name":"iPhone 8","quantity":"4"}]，需对该字段进行base-64编码后签名上送。 |
| transTime     | String(14)   | M    | 交易时间，格式："yyyyMMddHHmmss"                             |
| merReserve    | String(1024) | O    | 商户预留内容，可传任意内容，如购买商品信息、员号等，但不要传特殊符号，如逗号等。 |
| signType      | String(10)   | M    | MD5或SHA256                                                  |
| signature     | String(32)   | M    | 采用 MD5或SHA256 签名                                        |

**3.响应报文**

  商户需要提供一个 http/https 协议的接口，包含在参数里传递给GoAllPay，即 backURL。GoAllPay 服务器在支付完成后，会以 POST 方式调用 backURL，通知支付结果（JSON）。商户在接收到通知后，需响应字符串“OK”。

  如果没有收到商户返回“OK”，GoAllPay将会过一段时间后重新推送，时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400]，单位为秒。

 推送参数如下表：

| 参数          | 类型         | 属性 | 描述                                                         |
| ------------- | ------------ | ---- | ------------------------------------------------------------ |
| version       | String(12)   | M    | 统一填写为“VER000000005”                                     |
| charSet       | String(6)    | M    | 统一填写为“UTF-8”                                            |
| transType     | String(4)    | M    | 预授权填写“PAUT”                                             |
| orderNum      | String(60)   | M    | 订单号                                                       |
| orderAmount   | String(12)   | M    | 订单金额：如 100 元，表示为 100 或 100.00                    |
| orderCurrency | String(3)    | M    | 订单币种：ISO标准。如：人民币填写“CNY”，美元填写"USD"        |
| merID         | String(15)   | M    | 商户 ID，由 GoAllPay 分配                                      |
| acqID         | String(11)   | M    | 收单行 ID "99020344"                                         |
| paymentSchema | String(10)   | M    | 渠道ID |
| RespCode      | String(2)    | M    | 应答码 00-成功，01-失败。详情见本文档第5章应答码 |
| RespMsg       | String(20)   | M    | 应答消息                                                     |
| transID       | String(32)   | M    | GW 系统生成的交易 ID，每笔交易保持唯一                       |
| GWTime        | String(14)   | M    | yyyyMMddHHmmss，为 GW 时间                                   |
| transTime     | String(14)   | M    | 交易时间，格式："yyyyMMddHHmmss"                             |
| merReserve    | String(1024) | O    | 商户预留内容，可传任意内容，如购买商品信息、员号等，但不要传特殊符号，如逗号。 |
| signType      | String(10)   | M    | MD5或SHA256                                                  |
| signature     | String(32)   | M    | 采用 MD5或SHA256 签名                                        |

### 4.7 预授权完成接口

**1.接口说明**

  预授权完成接口适用于外卡（包括VISA、万事达、JCB等卡品牌）和银联卡交易。预授权完成交易与消费交易相似，交易成功后，会对商户进行资金的清算。

（1）接口补充说明
 * 该接口在预授权交易成功后发起，要求指定原预授权订单号，时间相隔最长不超过30天
 * 预授权完成交易金额，不能大于预授权交易金额
 * 预授权交易，只支持一次成功的预授权完成交易

（2）接口交易流程

 ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665464464405.jpg)

**2.请求报文格式**

| 参数          | 类型       | 属性 | 描述                                                   |
| ------------- | ---------- | ---- | ------------------------------------------------------ |
| version       | String(12) | M    | 统一填写为“VER000000005”                               |
| charSet       | String(6)  | M    | 统一填写为“UTF-8”                                      |
| transType     | String(4)  | M    | 预授权完成填写“PAUC”                                       |
| orderNum      | String(60) | M    | 订单号：商户自行定义，需保证同一商户号下订单号不能重复 |
| origOrderNum  | String(60) | M    | 原预授权订单号                                   |
| orderAmount   | String(12) | M    | 订单金额：如 100 元，表示为 100 或 100.00              |
| orderCurrency | String(3)  | M    | 订单币种：ISO标准。如：人民币填写“CNY”，美元填写"USD"  |
| merID         | String(15) | M    | 商户 ID，由 GoAllPay 分配                                |
| acqID         | String(11) | M    | 收单行 ID "99020344"                                   |
| paymentSchema | String(10) | M    | 渠道ID：[点击这里](paymentSchema.md)|
| transTime     | String(14) | M    | 交易时间，格式："yyyyMMddHHmmss" |
| signType      | String(10) | M    | MD5或SHA256 |
| signature     | String(32) | M    | 采用 MD5或SHA256 签名 |

**3.响应报文格式**

| 参数          | 类型       | 属性 | 描述                                           |
| ------------- | ---------- | ---- | ---------------------------------------------- |
| version       | String(12) | M    | 统一填写为“VER000000005”                       |
| charSet       | String(6)  | M    | 统一填写为“UTF-8”                              |
| transType     | String(4)  | M    | 预授权完成填写“PAUC”                                 |
| orderNum      | String(60) | M    | 预授权完成订单号                               |
| transID       | String(32) | M    | GW 系统生成的交易 ID，每笔交易保持唯一         |
| merID         | String(15) | M    | 商户 ID，由 GoAllPay 分配                        |
| acqID         | String(11) | M    | 收单行 ID "99020344"                           |
| paymentSchema | String(10) | M    | 渠道ID：FC                                   |
| RespCode      | String(2)  | M    | 应答码 00-成功，01-失败。详情见本文档第5章应答码 |
| 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.8 撤销接口

**1.接口说明**

  撤销接口适用于外卡（包括VISA、万事达、JCB等卡品牌）、银联卡和支付宝菲律宾钱包。

 （1）接口补充说明
 * 该接口支持对外卡消费、预授权、预授权完成交易，银联预授权交易以及支付宝菲律宾钱包的消费交易进行撤消。
 * 对消费进行撤消时，只能支持撤消当日交易（注意：北京时间23:00后，视为隔天）。对于非当日交易，可以通过退款接口进行处理。

 （2）接口交易流程

  ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665464582903.jpg)

**2.请求报文格式**

| 参数          | 类型       | 属性 | 描述                                                         |
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
| version       | String(12) | M    | 统一填写为“VER000000005”                                     |
| charSet       | String(6)  | M    | 统一填写为“UTF-8”                                            |
| transType     | String(4)  | M    | 填写“VOID”                                                   |
| orderNum      | String(60) | M    | 订单号：商户自行定义，需保证同一商户号下订单号不能重复       |
| origOrderNum  | String(60) | M    | 原交易订单号：要撤销的订单号，可以为消费、预授权、预授权完成的orderNum |
| merID         | String(15) | M    | 商户 ID，由 GoAllPay 分配                                      |
| acqID         | String(11) | M    | 收单行 ID "99020344"                                         |
| paymentSchema | String(10) | M    | 渠道ID：[点击这里](paymentSchema.md) |
| transTime     | String(14) | M    | 交易时间，格式："yyyyMMddHHmmss" |
| signType      | String(10) | M    | MD5或SHA256                                                  |
| signature     | String(32) | M    | 采用 MD5或SHA256 签名                                        |

**3.响应报文格式**

| 参数          | 类型       | 属性 | 描述                                           |
| ------------- | ---------- | ---- | ---------------------------------------------- |
| version       | String(12) | M    | 统一填写为“VER000000005”                       |
| charSet       | String(6)  | M    | 统一填写为“UTF-8”                              |
| transType     | String(4)  | M    | 填写“VOID”                                 |
| orderNum      | String(60) | M    | 撤销订单号                                     |
| transID       | String(32) | M    | GW 系统生成的交易 ID，每笔交易保持唯一         |
| merID         | String(15) | M    | 商户 ID，由 GoAllPay 分配                        |
| acqID         | String(11) | M    | 收单行 ID "99020344"                           |
| paymentSchema | String(10) | M    | 渠道ID |
| RespCode      | String(2)  | M    | 应答码 00-成功，01-失败。详情见本文档第5章应答码 |
| 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 手工退款申请接口

**1.接口功能说明**

  对90天之前的交易进行退款，商户无法通过调用联机退款接口处理，需调用该接口发起退款申请，申请成功后我们业务人员会通过人工方式进行处理，处理周期大概在3-5个工作日，退款申请交易经过人工处理后被成功退款，交易才会清算。

**2.请求报文格式** 

| 参数          | 类型       | 属性 | 描述                                                         |
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
| version       | String(12) | M    | 统一填写为“VER000000005”                                     |
| charSet       | String(6)  | M    | 统一填写为“UTF-8”                                            |
| transType     | String(10) | M    | 人工退款填写“REFDREQ”                                        |
| orderNum      | String(60) | M    | 退款申请单号:商户自行定义，需保证同一商户号下退款订单号不能重复 |
| origOrderNum  | String(60) | M    | 原支付订单号                                                 |
| returnAmount  | String(12) | M    | 退款金额：如 100 元，表示为 100 或 100.00                    |
| orderCurrency | String(3)  | M    | 订单币种：ISO标准 如：人民币填写“CNY”,美元填写"USD"          |
| merID         | String(15) | M    | 商户 ID，由 GoAllPay 分配                                       |
| paymentSchema | String(10) | M    | 渠道ID：[点击这里](paymentSchema.md) |
| acqID         | String(11) | M    | 收单行 ID "99020344"                                         |
| transTime     | String(14) | M    | 交易时间，格式："yyyyMMddHHmmss"                             |
| signType      | String(3)  | M    | MD5或SHA256                                                  |
| signature     | String(32) | M    | 采用 MD5或SHA256 签名                                        |

**3.响应报文格式**

| 参数          | 类型       | 属性 | 描述                                           |
| ------------- | ---------- | ---- | ---------------------------------------------- |
| version       | String(12) | M    | 统一填写为“VER000000005”                       |
| charSet       | String(6)  | M    | 统一填写为“UTF-8”                              |
| transType     | String(4)  | M    | 人工退款填写“REFDREQ”                          |
| orderNum      | String(60) | M    | 退款订单号                                     |
| transID       | String(32) | M    | GW 系统生成的交易 ID，每笔交易保持唯一         |
| merID         | String(15) | M    | 商户 ID，由 GoAllPay 分配                        |
| acqID         | String(11) | M    | 收单行 ID "99020344"                           |
| paymentSchema | String(10) | M    | 渠道ID：FC                                   |
| RespCode      | String(2)  | M    | 应答码 00 代表申请已受理                       |
| 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.10 签约接口

**1.接口功能说明** 

​  为用户提供绑卡功能，适用于外卡和银联卡交易。

**2.请求报文格式** 

| 参数          | 类型        | 属性 | 描述                                                       |
| ------------- | ----------- | ---- | ---------------------------------------------------------- |
| version       | String(12)  | M    | 统一填写为“VER000000005”                                   |
| transType     | String(10)  | M    | 绑卡 "BIND"                                                |
| orderNum      | String(60)  | M    | 绑卡订单号：商户自行定义，需保证同一商户号下订单号不能重复 |
| customerId    | String(60)  | M    | 用户ID:  商户自行定义，需保证同一商户号下不同用户不能重复  |
| frontURL      | String(400) | M    | 绑定结果前端跳转地址                                       |
| backURL       | String(400) | M    | 绑定成功后异步通知到该地址                                 |
| merID         | String(15)  | M    | 商户 ID，由 GoAllPay 分配                                  |
| paymentSchema | String(10)  | M    | 渠道ID：[点击这里](paymentSchema.md) |
| transTime     | String(14)  | M    | 交易时间，格式："yyyyMMddHHmmss"                           |
| tradeFrom     | String(20)  | M    | 场景，绑卡："PAN-BINGDING"                           |
| signType      | String(10)  | M    | MD5或SHA256                                                |
| signature     | String(32)  | M    | 采用 MD5或SHA256 签名                                      |

**3.响应报文格式**

| 参数          | 类型       | 属性 | 描述                                                       |
| ------------- | ---------- | ---- | ---------------------------------------------------------- |
| version       | String(12) | M    | 统一填写为“VER000000005”                                   |
| transType     | String(10) | M    | 绑卡 "BIND"                                                |
| orderNum      | String(60) | M    | 绑卡订单号：商户自行定义，需保证同一商户号下订单号不能重复 |
| transID       | String(32) | M    | GW 系统生成的交易 ID，每笔交易保持唯一                     |
| merID         | String(15) | M    | 商户 ID，由 GoAllPay 分配                                  |
| paymentSchema | String(10) | M    | 渠道ID                                                   |
| RespCode      | String(2)  | M    | 应答码 00 代表成功                                         |
| RespMsg       | String(20) | M    | 应答消息                                                   |
| token         | String(32) | O    | 应答码为 00时返回                                          |
| customerId    | String(60) | O    | 用户ID:  商户自行定义，需保证同一商户号下不同用户不能重复  |
| cardNoTail    | String(4)  | O    | 渠道为FC时返回 ,卡号后四位                                 |
| transTime     | String(14) | M    | 交易时间，格式："yyyyMMddHHmmss"                           |
| GWTime        | String(14) | M    | YYYYMMDDHHMMSS，为 GW 时间，目前为本地交易时间             |
| signType      | String(10) | M    | MD5或SHA256                                                |
| signature     | String(32) | M    | 采用 MD5或SHA256 签名                                      |

### 4.11 解约接口

**1.接口功能说明** 

  解除绑定的卡片

**2.请求报文格式** 

| 参数          | 类型       | 属性 | 描述                                                       |
| ------------- | ---------- | ---- | ---------------------------------------------------------- |
| version       | String(12) | M    | 统一填写为“VER000000005”                                   |
| transType     | String(10) | M    | 绑卡 "UNBIND"                                              |
| orderNum      | String(60) | M    | 解绑订单号：商户自行定义，需保证同一商户号下订单号不能重复 |
| customerId    | String(60) | M    | 用户ID:  商户自行定义，需保证同一商户号下不同用户不能重复  |
| token         | String(32) | M    | 绑卡时返回的token                                          |
| merID         | String(15) | M    | 商户 ID，由 GoAllPay 分配                                  |
| paymentSchema | String(10) | M    | 渠道ID：[点击这里](paymentSchema.md) |
| transTime     | String(14) | M    | 交易时间，格式："yyyyMMddHHmmss"                           |
| tradeFrom     | String(20)  | M    | 场景，绑卡："PAN-BINGDING"                           |
| signType      | String(10) | M    | MD5或SHA256                                                |
| signature     | String(32) | M    | 采用 MD5或SHA256 签名                                      |

**3.响应报文格式**

| 参数          | 类型       | 属性 | 描述                                                       |
| ------------- | ---------- | ---- | ---------------------------------------------------------- |
| version       | String(12) | M    | 统一填写为“VER000000005”                                   |
| transType     | String(10) | M    | 绑卡 "UNBIND"                                              |
| orderNum      | String(60) | M    | 解绑订单号：商户自行定义，需保证同一商户号下订单号不能重复 |
| transID       | String(32) | M    | GW 系统生成的交易 ID，每笔交易保持唯一                     |
| merID         | String(15) | M    | 商户 ID，由 GoAllPay 分配                                  |
| paymentSchema | String(10) | M    | 渠道ID                                                   |
| RespCode      | String(2)  | M    | 应答码 00 代表成功                                         |
| RespMsg       | String(20) | M    | 应答消息                                                   |
| customerId    | String(60) | O    | 用户ID:  商户自行定义，需保证同一商户号下不同用户不能重复  |
| cardNoTail    | String(4)  | O    | 卡号后四位,渠道为FC时返回                                  |
| token         | String(32) | O    | token                                                      |
| transTime     | String(14) | M    | 交易时间，格式："yyyyMMddHHmmss"                           |
| GWTime        | String(14) | M    | YYYYMMDDHHMMSS，为 GW 时间，目前为本地交易时间             |
| signType      | String(10) | M    | MD5或SHA256                                                |
| signature     | String(32) | M    | 采用 MD5或SHA256 签名                                      |

### 4.12 订阅扣款接口

**1.接口功能说明** 

  绑卡消费支付，根据绑卡时返回的token，对用户进行扣款

**2.请求报文格式** 

 

  *通用字段：*

| 参数          | 类型         | 属性 | 描述                                                         |
| ------------- | ------------ | ---- | ------------------------------------------------------------ |
| version       | String(12)   | M    | 统一填写为“VER000000005”                                     |
| 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"        |
| backURL       | String(400)  | M    | 支付结果异步通知到该地址                                     |
| customerId    | String(60)   | M    | 用户ID:  商户自行定义，需保证同一商户号下不同用户不能重复    |
| token         | String(32)   | M    | 绑卡时返回的token                                            |
| merID         | String(15)   | M    | 商户 ID，由 GoAllPay 分配                                    |
| acqID         | String(11)   | M    | 收单行 ID "99020344"                                         |
| paymentSchema | String(10)   | M    | 渠道ID：[点击这里](paymentSchema.md) |
| detailInfo    | String(400)  | M    | 商品明细。格式：[{"goods_name":"iPhone X","quantity":"2"},{"goods_name":"iPhone 8","quantity":"4"}]，需对该字段进行base-64编码后签名上送。 |
| transTime     | String(14)   | M    | 交易时间，格式："yyyyMMddHHmmss"                             |
| tradeFrom     | String(20)  | M    | 场景，绑卡："PAN-BINGDING"                           |
| merReserve    | String(1024) | O    | 商户预留内容，可传任意内容，如购买商品信息、员号等，但不要传特殊符号，如逗号等。 |
| signType      | String(10)   | M    | MD5或SHA256                                                  |
| signature     | String(32)   | M    | 采用 MD5或SHA256 签名                                        |

**3.响应报文**

  商户需要提供一个 http/https 协议的接口，包含在参数里传递给GoAllPay，即 backURL。GoAllPay 服务器在支付完成后，会以 POST 方式调用 backURL，通知支付结果（JSON）。商户在接收到通知后，需响应字符串“OK”。

  如果没有收到商户返回“OK”，GoAllPay将会过一段时间后重新推送，时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400]，单位为秒。

 推送参数如下表：

| 参数          | 类型         | 属性 | 描述                                                         |
| ------------- | ------------ | ---- | ------------------------------------------------------------ |
| version       | String(12)   | M    | 统一填写为“VER000000005”                                     |
| 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"        |
| merID         | String(15)   | M    | 商户 ID，由 GoAllPay 分配                                      |
| acqID         | String(11)   | M    | 收单行 ID "99020344"                                         |
| paymentSchema | String(10)   | M    | 渠道ID：FC                                                 |
| RespCode      | String(2)    | M    | 应答码 00-成功，01-失败。详情见本文档第5章应答码             |
| RespMsg       | String(20)   | M    | 应答消息                                                     |
| transID       | String(32)   | M    | GW 系统生成的交易 ID，每笔交易保持唯一                       |
| GWTime        | String(14)   | M    | yyyyMMddHHmmss，为 GW 时间                                   |
| transTime     | String(14)   | M    | 交易时间，格式："yyyyMMddHHmmss"                             |
| merReserve    | String(1024) | O    | 商户预留内容，可传任意内容，如购买商品信息、员号等，但不要传特殊符号，如逗号。 |
| signType      | String(10)   | M    | MD5或SHA256                                                  |
| signature     | String(32)   | M    | 采用 MD5或SHA256 签名                                        |

## 5.应答码 

| 应答码 | 描  述      |
| ------ | --------- |
| 00     | 成功       |
| 01     | 失败       |
| 04     | 处理中     |
| 61     | 超过限额   |
| U1     | 商户号不存在 |
| U2     | 签名错误   |
| U3     | 报文被篡改 |
| U4     | 缺失参数   |
| U5     | 无效的参数 |
| U6     | 重复的订单号 |
| U7     | 订单不存在  |
| U8     | 参数为空   |
| U9     | 系统错误   |
| P1     | 渠道未配置  |
| P2     | 币种未配置  |
| P3     | 余额不足    |
| P4     | 功能不支持  |
| P5     | 渠道返回错误  |

## 6.APP模式对接文档

  Android对接文档：[点击这里](/v5/android/Android_Integration_Specification_CH.md)

  iOS对接文档：[点击这里](/v5/ios/iOS_Integration_Specification_CH.md)

## 7.技术支持

  如果您在调试时遇到问题，请与我们联系：support@allpayx.com