# GoAllPay在线支付接入规范文档V5.2.0 [上海偶可贝网络科技有限公司](https://www.goallpayx.com) * 版本信息:中文 V5.2.0 * 更新时间:2022 年 1 月 ## 目录: - [1. 概述](#1-概述) - [2. 交易流程](#2-交易流程) - [3. 签名规则](#3-签名规则) - [4. API 说明](#4-api-说明) - [4.1 通用说明](#41-通用说明) - [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-签约扣款接口) - [4.12 签约更新接口](#412-签约更新接口) - [4.13 商户主动解约接口](#413-商户主动解约接口) - [4.14 用户征询解约接口](#414-用户征询解约接口) - [5. 应答码](#5-应答码) - [6. APP模式对接文档](#6-app模式对接文档) - [7. 技术支持](#7-技术支持) ## 1. 概述 GoAllPay 为客户提供统一的API接入,以帮助客户实现快速、安全、集中式的接入支付渠道。 ## 2. 交易流程 ![image](https://git.allpayx.com/OpenAPI/b2c/raw/master/images/pc_flowsheet.png) ## 3. 签名规则 ```html 1. 将所有传入参数(除 signature 参数外)按照参数名的 ASCII 码从小到大排序后(字典序),使用 URL 键值对的格式(即 key1=value1&key2=value2...)拼接成字符串 string1。 2. 在 string1 最后直接拼接(不需要用“&”连接)双方约定的签名密钥 Key(接入 GoAllPay 时分配),得到 stringSignTemp 字符串,并对 stringSignTemp 进行加密运算(加密算法以参数signType值为准),得到 signature 的值。 3. 签名示例: string1: OsType=WINDOWS&OsVersion=&acqID=99020344&backURL=https://testapi.allpayx.com/test&charSet=UTF-8&detailInfo=W3siZ29vZHNfbmFtZSI6ImlQaG9uZSBYIiwicXVhbnRpdHkiOiIyIn0seyJnb29kc19uYW1lIjoiaVBob25lIDgiLCJxdWFudGl0eSI6IjQifV0=&frontURL=http://114.80.87.249/cashier/estore/j&goodsInfo=apple&merID=000000000000015&merReserve=&orderAmount=1&orderCurrency=CNY&orderNum=20211230114713&paymentSchema=UP&signType=MD5&tradeFrom=H5&transTime=20211230114713&transType=PURC&version=VER000000005 stringSignTemp: OsType=WINDOWS&OsVersion=&acqID=99020344&backURL=https://testapi.allpayx.com/test&charSet=UTF-8&detailInfo=W3siZ29vZHNfbmFtZSI6ImlQaG9uZSBYIiwicXVhbnRpdHkiOiIyIn0seyJnb29kc19uYW1lIjoiaVBob25lIDgiLCJxdWFudGl0eSI6IjQifV0=&frontURL=http://114.80.87.249/cashier/estore/j&goodsInfo=apple&merID=000000000000015&merReserve=&orderAmount=1&orderCurrency=CNY&orderNum=20211230114713&paymentSchema=UP&signType=MD5&tradeFrom=H5&transTime=20211230114713&transType=PURC&version=VER0000000052f2c77e3718c47cfb47a89a6fbc9d361 signature: 25f4eb90cebec86cf0467659f466e345 ``` ## 4. API 说明 ### 4.1 通用说明 **请求方式:**POST

**数据格式:**JSON

**测试主机:**https://testapi.allpayx.com

**生产主机:**https://api.allpayx.com ### 4.2 支付接口 **1. 接口说明** 该接口为接入商家提供消费购买的功能。 **2. 请求路径** /api/createorder **3. 请求参数** 由通用参数和渠道专属参数组成,凡是上送参数都需参与签名。 ***渠道专属参数:*** [点击查看](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”。
如果没有收到商户响应“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) | 是 | 商品明细。
格式:[{"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) | 是 | 操作系统类型。
"IOS","ANDROID","HARMONYOS","WINDOWS","MAC","OTHER" 选其中一个上送 | | OsVersion | String(20) | 否 | 操作系统版本。示例:"10.0.19043" | **4. 响应参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ------------ | ---- | ------------------------------------------------------------ | | 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) | **5. 回调参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ------------ | ---- | ------------------------------------------------------------ | | 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. 请求路径** /api/orderquery **3. 请求参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ------------------------------------------------------------ | | 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 签名 | **4. 响应参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ------------------------------------------------------------ | | 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)接口交易流程 ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665469966231.jpg) **2. 请求路径** /api/refund **3. 请求参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ------------------------------------------------------------ | | 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 签名 | **4. 响应参数** | 参数 | 类型 | 必填 | 描述 | | --------- | ---------- | ---- | ---------------------------------------------- | | 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. 接口说明** 预授权接口适用于外卡(包括VISA、万事达、JCB等卡品牌)和银联卡交易。预授权交易不会参与清算,发卡银行会暂时冻结用户资金。 **2. 请求路径** /api/createorder **3. 请求参数** 由通用参数和渠道专属参数组成。凡是上送参数都需参与签名。 ***渠道专属参数:*** [点击查看](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”。
如果没有收到商户响应“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) | 是 | 商品明细。
格式:[{"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 签名 | **4. 响应参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ------------ | ---- | ------------------------------------------------------------ | | RespCode | String(2) | 是 | 应答码,00表示请求成功 | | RespMsg | String(256) | 是 | 应答信息 | | merID | String(15) | 否 | 商户ID | | orderNum | String(60) | 否 | 订单号 | | transID | String(32) | 否 | GoAllPay流水号 | | parameter | Object | 否 | 支付相关参数,RespCode为00时返回 | **5. 回调参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ------------ | ---- | ------------------------------------------------------------ | | 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)接口交易流程 ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665464464405.jpg) **2. 请求路径** /api/pauc **3. 请求参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ------------------------------------------------------ | | 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 签名 | **4. 响应参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ---------------------------------------------- | | 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)接口交易流程 ![](https://allpayfile-hd2.oss-cn-shanghai.aliyuncs.com/git/b2c/15665464582903.jpg) **2. 请求路径** /api/canc **3. 请求参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ------------------------------------------------------------ | | 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 签名 | **4. 响应参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ---------------------------------------------- | | 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. 请求路径** /api/refdreq **3. 请求参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ------------------------------------------------------------ | | 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 签名 | **4. 响应参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ---------------------------------------------- | | 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. 接口说明** 为用户提供签约功能,适用于支付宝本地支付。

接口交易流程:
![](images/applyToken.png) **2. 请求路径** /api/applyToken **3. 请求参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ----------- | ---- | ---------------------------------------------------------- | | version | String(12) | 是 | 统一填写为“VER000000005” | | 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 通知支付结果(详见回调参数)。商户在接收到通知后,需响应字符串“OK”。
如果没有收到商户响应“OK”,GoAllPay将会过一段时间后重新推送,时间间隔为[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400],单位为秒。 | | merID | String(15) | 是 | 商户 ID,由 GoAllPay 分配 | | paymentSchema | String(20) | 是 | 渠道ID:"AliPayPlus" | | sub_brand_code | String(20) | 是 | 子品牌。"gcash","dana","tng","rabbit_line_pay"选其中一个上送| | transTime | String(14) | 是 | 交易时间,格式:"yyyyMMddHHmmss" | | terminalType | String(10) | 是 | 终端类型。"WEB","WAP","MINI_APP","APP"选其中一个上送 | | OsType | String(10) | 是 | 操作系统类型。"IOS","ANDROID","OTHER" 选其中一个上送 | | OsVersion | String(10) | 否 | 操作系统版本,如11.0.2 | | signType | String(10) | 是 | MD5或SHA256 | | signature | String(32) | 是 | 采用 MD5或SHA256 签名 | **4. 响应参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ---------------------------------------------------------- | | RespCode | String(2) | 是 | 应答码,00表示请求成功 | | RespMsg | String(256) | 是 | 应答信息 | | merID | String(15) | 否 | 商户ID | | orderNum | String(60) | 否 | 订单号 | | transID | String(32) | 否 | GoAllPay流水号 | | parameter | Object | 否 | 签约相关参数。当RespCode为00时,至少会返回schemeUrl,applinkUrl,normalUrl其中一个。

url说明:
  • schemeUrl:通过该地址打开Android或iOS APP
  • applinkUrl:重定向用户打开应用程序的URL,如果没有安装应用程序,则重定向到WAP页面。对于Android,这个字段是原生的App Link,对于iOS,是Universal Link。
  • normalUrl:通过该地址将用户重定向到浏览器或WebView中的WAP/WEB页面 | **5. 回调参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ------------ | ---- | ------------------------------------------------------------ | | version | String(12) | 是 | “VER000000005” | | orderNum | String(60) | 是 | 订单号 | | token | String(32) | 否 | 签约扣款交易使用该token | | tokenExpiryTime | String(25) | 否 | token有效期,格式:"2019-11-27T12:01:01+08:00" | | refreshToken | String(32) | 否 | 更新token时使用 | | refreshTokenExpiryTime | String(25) | 否 | 更新token有效期,格式:"2019-11-27T12:01:01+08:00" | | merID | String(15) | 是 | 商户ID | | paymentSchema | String(20) | 是 | 渠道ID | | sub_brand_code| String(20) | 是 | 子品牌 | | RespCode | String(2) | 是 | 应答码 00-成功,01-失败。详情见本文档第5章应答码 | | RespMsg | String(20) | 是 | 应答消息 | | customerId | String(60) | 是 | 用户ID | | transID | String(32) | 是 | GoAllPay流水号 | | GWTime | String(14) | 是 | yyyyMMddHHmmss,为 GW 时间 | | transTime | String(14) | 是 | 交易时间,格式:"yyyyMMddHHmmss" | | signType | String(10) | 是 | MD5或SHA256 | | signature | String(32) | 是 | 采用 MD5或SHA256 签名 | ### 4.10 签约查询接口 **1. 接口说明** 可查询签约是否成功。 **2. 请求路径** /api/inquiryToken **3. 请求参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ------------------------------------------------------------ | | version | String(12) | 是 | 统一填写为“VER000000005” | | customerId | String(60) | 是 | 用户ID | | orderNum | String(60) | 是 | 签约订单号 | | merID | String(15) | 是 | 商户 ID,由 GoAllPay 分配 | | sub_brand_code| String(20) | 是 | 子品牌 | | paymentSchema | String(20) | 是 | 渠道ID:"AliPayPlus" | | transTime | String(14) | 是 | 交易时间,格式:"yyyyMMddHHmmss" | | signType | String(10) | 是 | MD5或SHA256 | | signature | String(32) | 是 | 采用 MD5或SHA256 签名 | **4. 响应参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ------------ | ---- | ------------------------------------------------------------ | | version | String(12) | 是 | “VER000000005” | | orderNum | String(60) | 是 | 订单号 | | token | String(32) | 否 | 签约扣款交易使用该token | | tokenExpiryTime | String(25) | 否 | token有效期,格式:"2019-11-27T12:01:01+08:00" | | refreshToken | String(32) | 否 | 更新token时使用 | | refreshTokenExpiryTime | String(25) | 否 | 更新token有效期,格式:"2019-11-27T12:01:01+08:00" | | merID | String(15) | 是 | 商户ID | | paymentSchema | String(20) | 是 | 渠道ID | | sub_brand_code| String(20) | 是 | 子品牌 | | RespCode | String(2) | 是 | 应答码 00-成功,01-失败。详情见本文档第5章应答码 | | RespMsg | String(20) | 是 | 应答消息 | | customerId | String(60) | 是 | 用户ID | | transID | String(32) | 是 | GoAllPay流水号 | | GWTime | String(14) | 是 | yyyyMMddHHmmss,为 GW 时间 | | transTime | String(14) | 是 | 交易时间,格式:"yyyyMMddHHmmss" | | signType | String(10) | 是 | MD5或SHA256 | | signature | String(32) | 是 | 采用 MD5或SHA256 签名 | ### 4.11 签约扣款接口 **1. 接口说明** 订阅消费,根据签约时返回的token,对用户进行扣款。

接口交易流程:
![](images/bindPay.png) **2. 请求路径** /api/bindPay **3. 请求参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ------------ | ---- | ------------------------------------------------------------ | | 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”。
如果没有收到商户响应“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(20) | 是 | 渠道ID:"AliPayPlus" | | sub_brand_code| String(20) | 是 | 子品牌 | | goodsInfo | String(60) | 是 | 商品信息。注意不要包含特殊符号,如 "#","&","+" 等 | | detailInfo | String(400) | 是 | 商品明细。
格式:[{"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 签名 | **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.12 签约更新接口 **1. 接口说明** 商户需要在用户token过期前,主动更新token。否则,后续支付时,将需要用户重新进行签约。

接口交易流程:
![](images/refreshToken.png) **2. 请求路径** /api/refreshToken **3. 请求参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ------------------------------------------------------------ | | version | String(12) | 是 | 统一填写为“VER000000005” | | 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" | | transTime | String(14) | 是 | 交易时间,格式:"yyyyMMddHHmmss" | | signType | String(10) | 是 | MD5或SHA256 | | signature | String(32) | 是 | 采用 MD5或SHA256 签名 | **4. 响应参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ------------ | ---- | ------------------------------------------------------------ | | version | String(12) | 是 | “VER000000005” | | orderNum | String(60) | 是 | 订单号 | | token | String(32) | 否 | 签约扣款交易使用该token | | tokenExpiryTime | String(25) | 否 | token有效期,格式:"2019-11-27T12:01:01+08:00" | | refreshToken | String(32) | 否 | 更新token时使用 | | refreshTokenExpiryTime | String(25) | 否 | 更新token有效期,格式:"2019-11-27T12:01:01+08:00" | | merID | String(15) | 是 | 商户ID | | paymentSchema | String(20) | 是 | 渠道ID | | sub_brand_code| String(20) | 是 | 子品牌 | | RespCode | String(2) | 是 | 应答码 00-成功,01-失败。详情见本文档第5章应答码 | | RespMsg | String(20) | 是 | 应答消息 | | customerId | String(60) | 是 | 用户ID | | transID | String(32) | 是 | GoAllPay流水号 | | GWTime | String(14) | 是 | yyyyMMddHHmmss,为 GW 时间 | | transTime | String(14) | 是 | 交易时间,格式:"yyyyMMddHHmmss" | | signType | String(10) | 是 | MD5或SHA256 | | signature | String(32) | 是 | 采用 MD5或SHA256 签名 | ### 4.13 商户主动解约接口 **1. 接口功能说明** 商户主动发起解约。

接口交易流程:
![](images/cancelToken.png) **2. 请求路径** /api/cancelToken **3. 请求参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ---------------------------------------------------------- | | version | String(12) | 是 | 统一填写为“VER000000005” | | 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" | | transTime | String(14) | 是 | 交易时间,格式:"yyyyMMddHHmmss" | | signType | String(10) | 是 | MD5或SHA256 | | signature | String(32) | 是 | 采用 MD5或SHA256 签名 | **4. 响应参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ---------------------------------------------------------- | | version | String(12) | 是 | “VER000000005” | | orderNum | String(60) | 是 | 订单号 | | token | String(32) | 否 | 签约扣款交易使用该token | | merID | String(15) | 是 | 商户ID | | paymentSchema | String(20) | 是 | 渠道ID | | sub_brand_code| String(20) | 是 | 子品牌 | | RespCode | String(2) | 是 | 应答码 00-成功,01-失败。详情见本文档第5章应答码 | | RespMsg | String(20) | 是 | 应答消息 | | customerId | String(60) | 是 | 用户ID | | transID | String(32) | 是 | GoAllPay流水号 | | GWTime | String(14) | 是 | yyyyMMddHHmmss,为 GW 时间 | | transTime | String(14) | 是 | 交易时间,格式:"yyyyMMddHHmmss" | | signType | String(10) | 是 | MD5或SHA256 | | signature | String(32) | 是 | 采用 MD5或SHA256 签名 | ### 4.14 用户征询解约接口 **1. 接口功能说明** 用户在钱包端解约,GoAllPay将结果推送给商户,商户做出回复。

接口交易流程:
![](images/consultUnbinding.png) **2. 请求路径** 商户域名+/api/consultUnbinding **3. 请求参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ---------------------------------------------------------- | | customerId | String(60) | 是 | 用户ID | | token | String(32) | 是 | 签约时返回的token | | merID | String(15) | 是 | 商户 ID,由 GoAllPay 分配 | | transTime | String(14) | 是 | 交易时间,格式:"yyyyMMddHHmmss" | | signType | String(10) | 是 | MD5或SHA256 | | signature | String(32) | 是 | 采用 MD5或SHA256 签名 | **4. 商户响应参数** | 参数 | 类型 | 必填 | 描述 | | ------------- | ---------- | ---- | ---------------------------------------------------------- | | allowUnbinding | String(10) | 是 | true表示同意,false表示拒绝 | | refuseReason | String(60) | 否 | allowUnbinding为false时,填写原因 | ## 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