# GoAllPay在线支付接入规范文档V5.2.0
[上海偶可贝网络科技有限公司](https://www.goallpayx.com)
* 版本信息：中文 V5.2.0
* 更新时间：2021 年 10 月
## 目录：
- [1. 概述](#1-概述)
- [2. 交易流程](#2-交易流程)
- [3. 签名规则](#3-签名规则)
- [4. API 说明](#4-api-说明)
- [4.1 API 列表](#41-api-列表)
- [4.2 支付接口](#42-支付接口)
- [4.3 查询接口](#43-查询接口)
- [4.4 退款接口](#44-退款接口)
- [4.5 预授权接口](#45-预授权接口)
- [4.6 预授权完成接口](#46-预授权完成接口)
- [4.7 撤销接口](#47-撤销接口)
- [4.8 手工退款申请接口](#48-手工退款申请接口)
- [4.9 签约接口](#49-签约接口)
- [4.10 订阅扣款接口](#410-订阅扣款接口)
- [4.11 解约接口](#411-解约接口)
- [5. 应答码](#5-应答码)
- [6. APP模式对接文档](#6-app模式对接文档)
- [7. 技术支持](#7-技术支持)
## 1. 概述
GoAllPay 为客户提供统一的API接入，以帮助客户实现快速、安全、集中式的接入支付渠道。
## 2. 交易流程
## 3. 签名规则
```html
1. 将所有传入参数（除 signature 参数外）按照参数名的 ASCII 码从小到大排序后（字典序），使用 URL 键值对的格式（即 key1=value1&key2=value2...）拼接成字符串 String1。
2. 在 String1 最后直接拼接（不需要用“&”连接）双方约定的签名密钥 Key（接入 GoAllPay 时分配），得到 stringSignTemp 字符串，并对 stringSignTemp 进行加密运算（加密算法以参数signType值为准），得到 signature 的值。
3. 签名过程示例：
String1: OsType=WINDOWS&OsVersion=10.0.19043&acqID=99020344&backURL=http://test.com/notify&charSet=UTF-8&detailInfo=W3siZ29vZHNfbmFtZSI6ImlQaG9uZSBYIiwicXVhbnRpdHkiOiIyIn0seyJnb29kc19uYW1lIjoiaVBob25lIDgiLCJxdWFudGl0eSI6IjQifV0=&frontURL=http://test.com/return&goodsInfo=apple&merID=000000000000015&merReserve=yuliu&orderAmount=1&orderCurrency=CNY&orderNum=20211025163735&paymentSchema=UP&signType=MD5&tradeFrom=H5&transTime=20211025163735&transType=PURC&version=VER000000005
stringSignTemp: OsType=WINDOWS&OsVersion=10.0.19043&acqID=99020344&backURL=http://test.com/notify&charSet=UTF-8&detailInfo=W3siZ29vZHNfbmFtZSI6ImlQaG9uZSBYIiwicXVhbnRpdHkiOiIyIn0seyJnb29kc19uYW1lIjoiaVBob25lIDgiLCJxdWFudGl0eSI6IjQifV0=&frontURL=http://test.com/return&goodsInfo=apple&merID=000000000000015&merReserve=yuliu&orderAmount=1&orderCurrency=CNY&orderNum=20211025163735&paymentSchema=UP&signType=MD5&tradeFrom=H5&transTime=20211025163735&transType=PURC&version=VER0000000052f2c77e3718c47cfb47a89a6fbc9d361
signature: 0be23be18fb6148572e15f9fa2f97816
```
## 4. API 说明
**请求方式：**POST<br><br>
**数据格式：**JSON<br><br>
**测试主机：**https://testapi.allpayx.com<br><br>
**生产主机：**https://api.allpayx.com
### 4.1 API 列表
| API名称 | URL路径 |
| ------- | ------------------------------------------- |
| 支付 | /api/createorder |
| 查询 | /api/orderquery |
| 退款 | /api/refund |
| 预授权 | /api/createorder |
| 预授权完成 | /api/pauc |
| 撤销 | /api/canc |
| 手工退款申请 | /api/refdreq |
| 签约 | /api/bindCard |
| 订阅扣款 | /api/bindPay |
| 解约 | /api/unBindCard |
### 4.2 支付接口
**1. 接口说明**
该接口为接入商家提供消费购买的功能。
**2. 请求参数**
由通用参数和渠道专属参数组成，凡是上送参数都需参与签名。
***渠道专属参数：*** [点击查看](payExclusive_CH.md)
***通用参数：***
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ------------ | ---- | ------------------------------------------------------------ |
| paymentSchema | String(10) | 是 | 渠道ID：[点击查看详情](paymentSchema.md) |
| version | String(12) | 是 | 统一填写为“VER000000005” |
| charSet | String(6) | 是 | 统一填写为“UTF-8” |
| transType | String(10) | 是 | 消费交易填写“PURC” |
| 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 通知支付结果（详见回调参数）。商户在接收到通知后，需响应字符串“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) | 是 | 商品信息。注意不要包含特殊符号，如 "#"，"&"，"+" 等 |
| detailInfo | String(400) | 是 | 商品明细。<br>格式：[{"goods_name":"iPhone X","quantity":"2"},{"goods_name":"iPhone 8","quantity":"4"}]，需Base64编码后上送。注意goods_name不要包含特殊符号，如 "#"，"&"，"+" 等 |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| merReserve | String(1024) | 否 | 预留内容，商户自定义。注意不要包含特殊符号，如 "#"，"&"，"+" 等 |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
| OsType | String(20) | 是 | 操作系统类型。<br>"IOS"，"ANDROID"，"HARMONYOS"，"WINDOWS"，"MAC"，"OTHER" 选其中一个上送 |
| OsVersion | String(20) | 否 | 操作系统版本。示例："10.0.19043" |
**3. 响应参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ------------ | ---- | ------------------------------------------------------------ |
| RespCode | String(2) | 是 | 应答码，00表示请求成功 |
| RespMsg | String(256) | 是 | 应答信息 |
| merID | String(15) | 否 | 商户ID |
| orderNum | String(60) | 否 | 订单号 |
| transID | String(32) | 否 | GoAllPay流水号 |
| parameter | Object | 否 | 支付相关参数。RespCode为00且非后台支付模式时返回，返回值详见[渠道专属参数](payExclusive_CH.md) |
**4. 回调参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ------------ | ---- | ------------------------------------------------------------ |
| version | String(12) | 是 | “VER000000005” |
| charSet | String(6) | 是 | “UTF-8” |
| transType | String(10) | 是 | “PURC” |
| orderNum | String(60) | 是 | 订单号 |
| orderAmount | String(12) | 是 | 订单金额 |
| orderCurrency | String(3) | 是 | 订单币种 |
| merID | String(15) | 是 | 商户 ID |
| acqID | String(11) | 是 | 收单行 ID "99020344" |
| paymentSchema | String(10) | 是 | 渠道ID |
| RespCode | String(2) | 是 | 应答码 00-成功，01-失败。详情见本文档第5章应答码 |
| RespMsg | String(20) | 是 | 应答消息 |
| transID | String(32) | 是 | GoAllPay流水号 |
| GWTime | String(14) | 是 | yyyyMMddHHmmss，为 GW 时间 |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| merReserve | String(1024) | 否 | 商户预留内容 |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
### 4.3 查询接口
**1. 接口说明**
该接口为接入商家提供订单查询的功能。
**2. 请求参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
| version | String(12) | 是 | 统一填写为“VER000000005” |
| charSet | String(6) | 是 | 统一填写为“UTF-8” |
| transType | String(10) | 是 | 查询填写“INQY” |
| orderNum | String(60) | 是 | 订单号 |
| merID | String(15) | 是 | 商户 ID，由 GoAllPay 分配 |
| acqID | String(11) | 是 | 收单行 ID "99020344" |
| paymentSchema | String(10) | 是 | 渠道ID：[点击这里](paymentSchema.md) |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
**3. 响应参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
| version | String(12) | 是 | “VER000000005” |
| charSet | String(6) | 是 | “UTF-8” |
| transType | String(10) | 是 | 交易类型 |
| orderNum | String(60) | 是 | 订单号 |
| transID | String(32) | 是 | GoAllPay流水号 |
| merID | String(15) | 是 | 商户 ID |
| acqID | String(11) | 是 | 收单行 ID "99020344" |
| paymentSchema | String(10) | 是 | 渠道ID |
| RespCode | String(2) | 是 | 应答码 00-成功，01-失败。详情见本文档第5章应答码 |
| RespMsg | String(20) | 是 | 应答消息 |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| GWTime | String(14) | 是 | yyyyMMddHHmmss，为 GW 时间，目前为本地交易时间 |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
### 4.4 退款接口
**1. 接口功能说明**
该接口为接入商家提供交易退款的功能。
（1）接口补充说明
* 该接口在消费交易成功后发起，要求指定原订单号
* 外卡交易当日不能做退款，可以做撤销，只能隔日退款
* 正常情况下，商户当日退款金额，不得大于当日成功交易额
（2）接口交易流程
**2. 请求参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
| version | String(12) | 是 | 统一填写为“VER000000005” |
| charSet | String(6) | 是 | 统一填写为“UTF-8” |
| transType | String(10) | 是 | 退款填写“REFD” |
| orderNum | String(60) | 是 | 退款订单号:商户自行定义，需保证同一商户号下退款订单号不能重复 |
| origOrderNum | String(60) | 是 | 原支付订单号 |
| returnAmount | String(12) | 是 | 退款金额：如 100 元，表示为 100 或 100.00 |
| orderCurrency | String(3) | 是 | 订单币种：ISO标准 如：人民币填写“CNY”,美元填写"USD" |
| merID | String(15) | 是 | 商户 ID，由 GoAllPay 分配 |
| paymentSchema | String(10) | 是 | 渠道ID：[点击这里](paymentSchema.md) |
| acqID | String(11) | 是 | 收单行 ID "99020344" |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
**3. 响应参数**
| 参数 | 类型 | 必填 | 描述 |
| --------- | ---------- | ---- | ---------------------------------------------- |
| version | String(12) | 是 | “VER000000005” |
| charSet | String(6) | 是 | “UTF-8” |
| transType | String(10) | 是 | “REFD” |
| orderNum | String(60) | 是 | 退款订单号 |
| transID | String(32) | 是 | GoAllPay流水号 |
| merID | String(15) | 是 | 商户 ID |
| acqID | String(11) | 是 | 收单行 ID "99020344" |
| paymentSchema | String(10) | 是 | 渠道ID |
| RespCode | String(2) | 是 | 应答码 00-成功，01-失败。详情见本文档第5章应答码 |
| RespMsg | String(20) | 是 | 应答消息 |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| GWTime | String(14) | 是 | yyyyMMddHHmmss，为 GW 时间，目前为本地交易时间 |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
<!-- ### 4.5 退款查询接口
**1.接口说明**
该接口为接入商家提供退款查询的功能。
（1）接口补充说明
* 该接口用于商户在退款发起后，查询退款交易的处理状态
（2）接口交易流程
**2.请求参数**
| 参数 | 类型 | 属性 | 描述 |
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
| version | String(12) | M | 统一填写为“VER000000005” |
| charSet | String(6) | M | 统一填写为“UTF-8” |
| transType | String(10) | 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(10) | M | “REFD” |
| orderNum | String(60) | M | 退款订单号 |
| transID | String(32) | M | GoAllPay流水号 |
| merID | String(15) | M | 商户 ID |
| 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. 接口说明**
预授权接口适用于外卡（包括VISA、万事达、JCB等卡品牌）和银联卡交易。预授权交易不会参与清算，发卡银行会暂时冻结用户资金。
**2. 请求参数**
由通用参数和渠道专属参数组成。凡是上送参数都需参与签名。
***渠道专属参数：*** [点击查看](preAuthorizationExclusive_CH.md)
***通用参数：***
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ------------ | ---- | ------------------------------------------------------------ |
| version | String(12) | 是 | 统一填写为“VER000000005” |
| charSet | String(6) | 是 | 统一填写为“UTF-8” |
| transType | String(10) | 是 | 预授权填写“PAUT” |
| 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 通知支付结果（详见回调参数）。商户在接收到通知后，需响应字符串“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) |
| goodsInfo | String(60) | 是 | 商品信息。注意不要包含特殊符号，如 "#"，"&"，"+" 等 |
| detailInfo | String(400) | 是 | 商品明细。<br>格式：[{"goods_name":"iPhone X","quantity":"2"},{"goods_name":"iPhone 8","quantity":"4"}]，需Base64编码后上送。注意goods_name不要包含特殊符号，如 "#"，"&"，"+" 等 |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| merReserve | String(1024) | 否 | 预留内容，商户自定义。注意不要包含特殊符号，如 "#"，"&"，"+" 等 |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
**3. 响应参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ------------ | ---- | ------------------------------------------------------------ |
| RespCode | String(2) | 是 | 应答码，00表示请求成功 |
| RespMsg | String(256) | 是 | 应答信息 |
| merID | String(15) | 否 | 商户ID |
| orderNum | String(60) | 否 | 订单号 |
| transID | String(32) | 否 | GoAllPay流水号 |
| parameter | Object | 否 | 支付相关参数，RespCode为00时返回 |
**4. 回调参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ------------ | ---- | ------------------------------------------------------------ |
| version | String(12) | 是 | “VER000000005” |
| charSet | String(6) | 是 | “UTF-8” |
| transType | String(10) | 是 | “PAUT” |
| orderNum | String(60) | 是 | 订单号 |
| orderAmount | String(12) | 是 | 订单金额 |
| orderCurrency | String(3) | 是 | 订单币种 |
| merID | String(15) | 是 | 商户 ID |
| acqID | String(11) | 是 | 收单行 ID "99020344" |
| paymentSchema | String(10) | 是 | 渠道ID |
| RespCode | String(2) | 是 | 应答码 00-成功，01-失败。详情见本文档第5章应答码 |
| RespMsg | String(20) | 是 | 应答消息 |
| transID | String(32) | 是 | GoAllPay流水号 |
| GWTime | String(14) | 是 | yyyyMMddHHmmss，为 GW 时间 |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| merReserve | String(1024) | 否 | 商户预留内容 |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
### 4.6 预授权完成接口
**1. 接口说明**
预授权完成接口适用于外卡（包括VISA、万事达、JCB等卡品牌）和银联卡交易。预授权完成交易与消费交易相似，交易成功后，会对商户进行资金的清算。
（1）接口补充说明
* 该接口在预授权交易成功后发起，要求指定原预授权订单号，时间相隔最长不超过30天
* 预授权完成交易金额，不能大于预授权交易金额
* 预授权交易，只支持一次成功的预授权完成交易
（2）接口交易流程
**2. 请求参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ---------- | ---- | ------------------------------------------------------ |
| version | String(12) | 是 | 统一填写为“VER000000005” |
| charSet | String(6) | 是 | 统一填写为“UTF-8” |
| transType | String(10) | 是 | 预授权完成填写“PAUC” |
| orderNum | String(60) | 是 | 订单号：商户自行定义，需保证同一商户号下订单号不能重复 |
| origOrderNum | String(60) | 是 | 原预授权订单号 |
| orderAmount | String(12) | 是 | 订单金额：如 100 元，表示为 100 或 100.00 |
| orderCurrency | String(3) | 是 | 订单币种：ISO标准。如：人民币填写“CNY”，美元填写"USD" |
| merID | String(15) | 是 | 商户 ID，由 GoAllPay 分配 |
| acqID | String(11) | 是 | 收单行 ID "99020344" |
| paymentSchema | String(10) | 是 | 渠道ID：[点击这里](paymentSchema.md)|
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
**3. 响应参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ---------- | ---- | ---------------------------------------------- |
| version | String(12) | 是 | “VER000000005” |
| charSet | String(6) | 是 | “UTF-8” |
| transType | String(10) | 是 | “PAUC” |
| orderNum | String(60) | 是 | 预授权完成订单号 |
| transID | String(32) | 是 | GoAllPay流水号 |
| merID | String(15) | 是 | 商户 ID |
| acqID | String(11) | 是 | 收单行 ID "99020344" |
| paymentSchema | String(10) | 是 | 渠道ID |
| RespCode | String(2) | 是 | 应答码 00-成功，01-失败。详情见本文档第5章应答码 |
| RespMsg | String(20) | 是 | 应答消息 |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| GWTime | String(14) | 是 | yyyyMMddHHmmss，为 GW 时间，目前为本地交易时间 |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
### 4.7 撤销接口
**1. 接口说明**
撤销接口适用于外卡（包括VISA、万事达、JCB等卡品牌）、银联卡和支付宝菲律宾钱包。
（1）接口补充说明
* 该接口支持对外卡消费、预授权、预授权完成交易，银联预授权交易以及支付宝菲律宾钱包的消费交易进行撤消。
* 对消费进行撤消时，只能支持撤消当日交易（注意：CIL外卡，北京时间23:00后，视为隔天；RDP外卡，北京时间24:00后，视为隔天）。对于非当日交易，可以通过退款接口进行处理。
（2）接口交易流程
**2. 请求参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
| version | String(12) | 是 | 统一填写为“VER000000005” |
| charSet | String(6) | 是 | 统一填写为“UTF-8” |
| transType | String(10) | 是 | 填写“VOID” |
| orderNum | String(60) | 是 | 订单号：商户自行定义，需保证同一商户号下订单号不能重复 |
| origOrderNum | String(60) | 是 | 原交易订单号：要撤销的订单号，可以为消费、预授权、预授权完成的orderNum |
| merID | String(15) | 是 | 商户 ID，由 GoAllPay 分配 |
| acqID | String(11) | 是 | 收单行 ID "99020344" |
| paymentSchema | String(10) | 是 | 渠道ID：[点击这里](paymentSchema.md) |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
**3. 响应参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ---------- | ---- | ---------------------------------------------- |
| version | String(12) | 是 | “VER000000005” |
| charSet | String(6) | 是 | “UTF-8” |
| transType | String(10) | 是 | “VOID” |
| orderNum | String(60) | 是 | 撤销订单号 |
| transID | String(32) | 是 | GoAllPay流水号 |
| merID | String(15) | 是 | 商户 ID |
| acqID | String(11) | 是 | 收单行 ID "99020344" |
| paymentSchema | String(10) | 是 | 渠道ID |
| RespCode | String(2) | 是 | 应答码 00-成功，01-失败。详情见本文档第5章应答码 |
| RespMsg | String(20) | 是 | 应答消息 |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| GWTime | String(14) | 是 | yyyyMMddHHmmss，为 GW 时间，目前为本地交易时间 |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
### 4.8 手工退款申请接口
**1. 接口说明**
对90天之前的交易进行退款，商户无法通过调用联机退款接口处理，需调用该接口发起退款申请，申请成功后我们业务人员会通过人工方式进行处理，处理周期大概在3-5个工作日，退款申请交易经过人工处理后被成功退款，交易才会清算。
**2. 请求参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
| version | String(12) | 是 | 统一填写为“VER000000005” |
| charSet | String(6) | 是 | 统一填写为“UTF-8” |
| transType | String(10) | 是 | 人工退款填写“REFDREQ” |
| orderNum | String(60) | 是 | 退款申请单号:商户自行定义，需保证同一商户号下退款订单号不能重复 |
| origOrderNum | String(60) | 是 | 原支付订单号 |
| returnAmount | String(12) | 是 | 退款金额：如 100 元，表示为 100 或 100.00 |
| orderCurrency | String(3) | 是 | 订单币种：ISO标准 如：人民币填写“CNY”,美元填写"USD" |
| merID | String(15) | 是 | 商户 ID，由 GoAllPay 分配 |
| paymentSchema | String(10) | 是 | 渠道ID：[点击这里](paymentSchema.md) |
| acqID | String(11) | 是 | 收单行 ID "99020344" |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
**3. 响应参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ---------- | ---- | ---------------------------------------------- |
| version | String(12) | 是 | “VER000000005” |
| charSet | String(6) | 是 | “UTF-8” |
| transType | String(10) | 是 | “REFDREQ” |
| orderNum | String(60) | 是 | 退款订单号 |
| transID | String(32) | 是 | GoAllPay流水号 |
| merID | String(15) | 是 | 商户 ID |
| acqID | String(11) | 是 | 收单行 ID "99020344" |
| paymentSchema | String(10) | 是 | 渠道ID |
| RespCode | String(2) | 是 | 应答码 00 代表申请已受理 |
| RespMsg | String(20) | 是 | 应答消息 |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| GWTime | String(14) | 是 | yyyyMMddHHmmss，为 GW 时间，目前为本地交易时间 |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
### 4.9 签约接口
**1. 接口说明**
为用户提供签约功能，适用于外卡、银联卡、支付宝本地支付。
**2. 请求参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ----------- | ---- | ---------------------------------------------------------- |
| version | String(12) | 是 | 统一填写为“VER000000005” |
| transType | String(10) | 是 | 绑卡 "BIND" |
| orderNum | String(60) | 是 | 绑卡订单号：商户自行定义，需保证同一商户号下订单号不能重复 |
|orderCurrency |String(3) |是 |订单币种：ISO标准。如：人民币填写“CNY”，美元填写"USD"|
| customerId | String(60) | 是 | 用户ID: 商户自行定义，需保证同一商户号下不同用户不能重复 |
| frontURL | String(400) | 是 | 绑定后前端跳转地址 |
| backURL | String(400) | 是 | 绑定结果异步通知到该URL。绑定成功后，GoAllPay 会以 POST 方式调用 backURL 通知支付结果（详见回调参数）。商户在接收到通知后，需响应字符串“OK”。<br>如果没有收到商户响应“OK”，GoAllPay将会过一段时间后重新推送，时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400]，单位为秒。 |
| merID | String(15) | 是 | 商户 ID，由 GoAllPay 分配 |
| paymentSchema | String(10) | 是 | 渠道ID：[点击这里](paymentSchema.md) |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| tradeFrom | String(20) | 是 | 场景，绑卡："PAN-BINGDING" |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
**3. 响应参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ---------- | ---- | ---------------------------------------------------------- |
| version | String(12) | 是 | “VER000000005” |
| transType | String(10) | 是 | "BIND" |
| orderNum | String(60) | 是 | 绑卡订单号 |
| transID | String(32) | 是 | GoAllPay流水号 |
| merID | String(15) | 是 | 商户 ID |
| paymentSchema | String(10) | 是 | 渠道ID|
| RespCode | String(2) | 是 | 应答码 00 代表成功 |
| RespMsg | String(20) | 是 | 应答消息 |
| token | String(32) | 否 | 应答码为 00时返回 |
| customerId | String(60) | 否 | 用户ID |
| cardNoTail | String(4) | 否 | 渠道为FC时返回，卡号后四位 |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| GWTime | String(14) | 是 | yyyyMMddHHmmss，为 GW 时间，目前为本地交易时间 |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
### 4.10 订阅扣款接口
**1. 接口说明**
订阅消费，根据绑卡时返回的token，对用户进行扣款
**2. 请求参数**
由通用参数和渠道专属参数组成。凡是上送参数都需参与签名。
***渠道专属参数：*** [点击查看](bindCardPayExclusive_CH.md)
***通用参数：***
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ------------ | ---- | ------------------------------------------------------------ |
| version | String(12) | 是 | 统一填写为“VER000000005” |
| charSet | String(6) | 是 | 统一填写为“UTF-8” |
| transType | String(10) | 是 | 消费填写“PURC” |
| orderNum | String(60) | 是 | 订单号：商户自行定义，需保证同一商户号下订单号不能重复 |
| orderAmount | String(12) | 是 | 订单金额：如 100 元，表示为 100 或 100.00 |
| orderCurrency | String(3) | 是 | 订单币种：ISO标准。如：人民币填写“CNY”，美元填写"USD" |
| backURL | String(400) | 是 | 支付结果异步通知到该URL。支付成功后，GoAllPay 会以 POST 方式调用 backURL 通知支付结果（详见回调参数）。商户在接收到通知后，需响应字符串“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 分配 |
| acqID | String(11) | 是 | 收单行 ID "99020344" |
| paymentSchema | String(10) | 是 | 渠道ID：[点击这里](paymentSchema.md) |
| goodsInfo | String(60) | 是 | 商品信息。注意不要包含特殊符号，如 "#"，"&"，"+" 等 |
| detailInfo | String(400) | 是 | 商品明细。<br>格式：[{"goods_name":"iPhone X","quantity":"2"},{"goods_name":"iPhone 8","quantity":"4"}]，需Base64编码后上送。注意goods_name不要包含特殊符号，如 "#"，"&"，"+" 等 |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| tradeFrom | String(20) | 是 | 场景，绑卡："PAN-BINGDING" |
| merReserve | String(1024) | 否 | 预留内容，商户自定义。注意不要包含特殊符号，如 "#"，"&"，"+" 等 |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
**3. 响应参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ------------ | ---- | ------------------------------------------------------------ |
| version | String(12) | 是 | “VER000000005” |
| charSet | String(6) | 是 | “UTF-8” |
| transType | String(10) | 是 | “PURC” |
| orderNum | String(60) | 是 | 订单号 |
| orderAmount | String(12) | 是 | 订单金额 |
| orderCurrency | String(3) | 是 | 订单币种 |
| merID | String(15) | 是 | 商户 ID |
| acqID | String(11) | 是 | 收单行 ID "99020344" |
| paymentSchema | String(10) | 是 | 渠道ID |
| RespCode | String(2) | 是 | 应答码 00-成功，01-失败。详情见本文档第5章应答码 |
| RespMsg | String(20) | 是 | 应答消息 |
| transID | String(32) | 是 | GoAllPay流水号 |
| GWTime | String(14) | 是 | yyyyMMddHHmmss，为 GW 时间 |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| merReserve | String(1024) | 否 | 商户预留内容 |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
### 4.11 解约接口
**1. 接口功能说明**
解除绑定的卡片
**2. 请求参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ---------- | ---- | ---------------------------------------------------------- |
| version | String(12) | 是 | 统一填写为“VER000000005” |
| transType | String(10) | 是 | 绑卡 "UNBIND" |
| orderNum | String(60) | 是 | 解绑订单号：商户自行定义，需保证同一商户号下订单号不能重复 |
| customerId | String(60) | 是 | 用户ID: 商户自行定义，需保证同一商户号下不同用户不能重复 |
| token | String(32) | 是 | 绑卡时返回的token |
| merID | String(15) | 是 | 商户 ID，由 GoAllPay 分配 |
| paymentSchema | String(10) | 是 | 渠道ID：[点击这里](paymentSchema.md) |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| tradeFrom | String(20) | 是 | 场景，绑卡："PAN-BINGDING" |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
**3. 响应参数**
| 参数 | 类型 | 必填 | 描述 |
| ------------- | ---------- | ---- | ---------------------------------------------------------- |
| version | String(12) | 是 | “VER000000005” |
| transType | String(10) | 是 | "UNBIND" |
| orderNum | String(60) | 是 | 解绑订单号 |
| transID | String(32) | 是 | GoAllPay流水号 |
| merID | String(15) | 是 | 商户 ID |
| paymentSchema | String(10) | 是 | 渠道ID |
| RespCode | String(2) | 是 | 应答码 00 代表成功 |
| RespMsg | String(20) | 是 | 应答消息 |
| customerId | String(60) | 否 | 用户ID |
| cardNoTail | String(4) | 否 | 卡号后四位，渠道为FC时返回 |
| token | String(32) | 否 | token |
| transTime | String(14) | 是 | 交易时间，格式："yyyyMMddHHmmss" |
| GWTime | String(14) | 是 | yyyyMMddHHmmss，为 GW 时间，目前为本地交易时间 |
| signType | String(10) | 是 | MD5或SHA256 |
| signature | String(32) | 是 | 采用 MD5或SHA256 签名 |
## 5. 应答码
| 应答码 | 描述 |
| ------ | --------- |
| 00 | 成功 |
| 01 | 失败 |
| 04 | 处理中 |
| 61 | 超过限额 |
| U1 | 商户号不存在 |
| U2 | 签名错误 |
| U3 | 请求被篡改 |
| U4 | 缺失参数 |
| U5 | 无效的参数 |
| U6 | 重复的订单号 |
| U7 | 订单不存在 |
| U8 | 参数为空 |
| U9 | 系统错误 |
| P1 | 渠道未配置 |
| P2 | 币种未配置 |
| P3 | 余额不足 |
| P4 | 功能不支持 |
| P5 | 渠道返回错误 |
| A3 | 渠道商户不存在 |
## 6. APP模式对接文档
Android对接文档：[点击这里](/v5/android/Android_Integration_Specification_CH.md)
iOS对接文档：[点击这里](/v5/ios/iOS_Integration_Specification_CH.md)
## 7. 技术支持
如果您在调试时遇到问题，请与我们联系：support@allpayx.com