AllPay_Other_Integration_Specification_CH.md 8.9 KB

GoAllPay其他接口文档V1.0.0

上海偶可贝网络科技有限公司

  • 版本信息:中文 V1.0.0
  • 更新时间:2021 年 8 月

1. 概述

GoAllPay 为客户提供统一的 API 接入,以帮助客户实现快速、安全、集中式的接入服务。

2. 签名规则

1. 对于发送到 GoAllPay 系统的请求报文,其中所有传入参数(除 signature 参数外)按照字段名的 ASCII 码从小到大排序后(字典序),使用 URL 键值对的格式(即 key1=value1&key2=value2...)拼接成字符串 String1。

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

3. 签名过程示例:
String1: merID=000000000000015&signType=MD5&transID=MQkmUGAh3Gw2HEEi
stringSignTemp: merID=000000000000015&signType=MD5&transID=MQkmUGAh3Gw2HEEi2f2c77e3718c47cfb47a89a6fbc9d361
signature: 16d93a9ac6ca89bfdefb018924f11965

3. API 说明

3.1 获取渠道流水信息接口

该接口可通过支付响应中的transID查询渠道流水相关信息。支持 GET / POST 请求

测试环境地址 生产环境地址
https://testapi.allpayx.com/api/schemaTransId https://api.allpayx.com/api/schemaTransId

1.请求参数

参数 类型 属性 描述
merID String(15) M 商户 ID,由 GoAllPay 分配
transID String(64) M GW 系统生成的交易 ID,由 GoAllPay 系统返回
signType String(10) M MD5或SHA256
signature String(60) M 采用 MD5或SHA256 签名

2.响应参数

参数 类型 属性 描述
merID String(12) M 商户 ID,由 GoAllPay 分配
orderNum String(64) M 商户订单号
allpayOrderNum String(4) M GoAllPay系统的转换商户订单号
schemaTransId String(60) O 支付渠道的交易ID
billCurrency String(3) O 扣账币种:“CNY”。目前只有支付宝和微信有值,其他渠道为空。
billAmount String(12) O 扣账金额:人民币金额。目前只有支付宝和微信有值,其他渠道为空。
truncatePan String(32) O 截断卡号。目前只支持外卡
paymentTime String(14) O 支付完成时间,格式:"yyyyMMddHHmmss"
originalRequest Object O 原始支付请求,数据格式:JSON
originalResponse Object O 原始支付响应,数据格式:JSON
transID String(32) M GW 系统生成的交易 ID,每笔交易保持唯一
paymentSchema String(10) M 渠道代码:点击这里
RespCode String(2) M 应答码 00-成功
RespMsg String(20) M 应答消息

3.2 汇率查询接口

该接口提供银联、微信、支付宝渠道汇率查询的功能。仅支持 GET 请求

测试环境地址 生产环境地址
https://test-sapi.allpayx.com/sapi/v1/get_exchange_rate https://sapi.allpayx.com/sapi/v1/get_exchange_rate

1.请求参数

参数 类型 属性 描述
pid String(12) M 商户 ID,由 GoAllPay 分配
issuer String(3) M 汇率的提供机构,取值:UPI银联国际,ALP支付宝,WXP微信支付
original_currency String(3) M 源币种,取值:USD,HKD,……
conversion_currency String(3) M 转换币种,取值:微信、支付宝当前仅支持CNY;银联支持CNY,USD
sign_type String(6) M sha256
sign String(60) M 签名

2.响应参数

参数 类型 属性 描述
status String(30) M 响应状态
message String(30) M 响应信息
data Object O 汇率数据详情:
rate_date:汇率日期,8位日期格式YYYYMMDD
issuer:汇率的提供机构
original_currency:源币种
conversion_currency:转换币种
exchange_rate:参考汇率值

3.3 物流信息上传接口

该接口提供物流信息上传功能。

测试环境地址 生产环境地址
https://testapi.allpayx.com/api/logistics https://api.allpayx.com/api/logistics

1.请求参数

参数 类型 属性 描述
version String(12) M "VER000000005"
merID String(15) M 商户 ID,由 GoAllPay 分配
orderNum String(64) M 支付订单号
paymentSchema String(10) M 渠道代码:点击这里
logisticsNo String(64) M 物流单号
logisticsCompany String(64) M 物流公司
signType String(10) M MD5或SHA256
signature String(60) M 采用 MD5或SHA256 签名

2.响应参数

参数 类型 属性 描述
RespCode String(2) M 应答码 00-成功
RespMsg String(20) M 应答消息

3.4 consultPayment接口

1.请求参数

参数 类型 必填 描述
paymentSchema String 渠道ID:AliPayPlus
version String 统一填写为“VER000000005”
orderNum String 订单号:商户自行定义,需保证同一商户号下订单号不能重复
orderAmount String 订单金额:如 100 元,表示为 100 或 100.00
orderCurrency String 订单币种:ISO标准。如:人民币填写“CNY”,美元填写"USD"
merID String 商户 ID,由 GoAllPay 分配
transTime String 交易时间,格式:"yyyyMMddHHmmss"
signType String MD5或SHA256
signature String 采用 MD5或SHA256 签名
OsType String 操作系统类型。
"IOS","ANDROID","HARMONYOS","WINDOWS","MAC","OTHER" 选其中一个上送
terminalType String APP/WAP
presentmentMode String UNIFIED/TILE

2.响应参数

参数 类型 属性 描述
RespCode String(2) M 应答码 00-成功
RespMsg String(20) M 应答消息
data Object O 应答码为 00时返回

4. 应答码

应答码 描 述
00 成功
01 失败
U1 商户号不存在
U2 签名错误
U3 报文被篡改
U4 缺失参数
U5 无效的参数
U7 订单不存在
U8 参数为空
U9 系统错误
P4 功能不支持

5. 技术支持

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