【无标题】

支付中心

简介：

支付中心api文档

HOST:10.22.3.73:8140

联系人:

Version:1.0

接口路径：/v2/api-docs

场景图

预结算场景

支付场景

退款场景

通用方法

通用预订单

接口描述:

接口地址:/api/common/book/{payId}

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"data": {
		"branchesId": "网点号",
		"businessType": "默认0:海王",
		"cardNo": "实体卡卡号",
		"expand": "拓展字段(可传JSON)",
		"orderCharacteristics": "支付特征(渠道需要时传入)",
		"payAmount": "支付总金额(明细总价),以分为最小单位",
		"products": [
			{
				"barcode": "商品编码",
				"name": "商品名称",
				"orgPrice": "商品原单价,以分为最小单位",
				"payPrice": "商品支付单价,以分为最小单位",
				"quantity": "商品数量",
				"spec": "规格",
				"unit": "单位",
				"upc": "国际条码",
				"batch": "商品批号"
			}
		],
		"tokens": "支付凭证tokens(线上授权码/实体卡密码),如多个授权码以英文逗号分割(如有实体卡实体卡密码在第一位)"
	},
	"nonce": "请求主键唯一值",
	"sign": "签名",
	"timestamp": "10位秒级时间戳",
	"version": "默认传入V1.0"
}

请求参数：

schema属性说明

请求基类«预支付订单 入参»

预支付订单 入参

预支付订单 商品模型

响应示例:

{
	"code": 0,
	"data": {
		"bookOrderNo": "内部预订单流水号",
		"payAmount": "支付总金额(明细总价),以分为最小单位",
		"schemes": [
			{
				"orgAmount": "方案总金额,以分为最小单位",
				"outerPromoAmount": "外部支付优惠,以分为最小单位",
				"payAmount": "结算金额,以分为最小单位",
				"payDetails": [
					{
						"amount": "支付金额,以分为最小单位",
						"cardNo": "实体卡卡号",
						"line": "行标识",
						"remark": "备注",
						"schemeName": "支付类型名称",
						"schemeType": "支付类型0:门店收款、1:收款方式1、2:收款方式2(类推)"
					}
				],
				"promoAmount": "内部支付优惠,以分为最小单位",
				"schemeCharacteristics": "方案特征",
				"schemeNo": "方案号"
			}
		],
		"status": "预订单状态:0:已发起 10:待回调 20:已回调 30:错误方案 97:超时取消 98:已取消 99:已完成"
	},
	"msg": ""
}

响应参数:

schema属性说明

预订单发起/查询请求方法 出参基类

预订单发起/查询请求方法 出参方案模型

预订单发起/查询请求方法 出参方案明细模型

响应状态:

通用预订单查询

接口描述:

接口地址:/api/common/bookSearch/{payId}

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"data": {
		"bookOrderNo": "内部预订单流水号:BKxxxxxxxxxxxx",
		"branchesId": "网点号",
		"businessType": "默认0:海王"
	},
	"nonce": "请求主键唯一值",
	"sign": "签名",
	"timestamp": "10位秒级时间戳",
	"version": "默认传入V1.0"
}

请求参数：

schema属性说明

请求基类«预订单查询请求方法 入参基类»

预订单查询请求方法 入参基类

响应示例:

{
	"code": 0,
	"data": {
		"bookOrderNo": "内部预订单流水号",
		"payAmount": "支付总金额(明细总价),以分为最小单位",
		"schemes": [
			{
				"orgAmount": "方案总金额,以分为最小单位",
				"outerPromoAmount": "外部支付优惠,以分为最小单位",
				"payAmount": "结算金额,以分为最小单位",
				"payDetails": [
					{
						"amount": "支付金额,以分为最小单位",
						"cardNo": "实体卡卡号",
						"line": "行标识",
						"remark": "备注",
						"schemeName": "支付类型名称",
						"schemeType": "支付类型0:门店收款、1:收款方式1、2:收款方式2(类推)"
					}
				],
				"promoAmount": "内部支付优惠,以分为最小单位",
				"schemeCharacteristics": "方案特征",
				"schemeNo": "方案号"
			}
		],
		"status": "预订单状态:0:已发起 10:待回调 20:已回调 30:错误方案 97:超时取消 98:已取消 99:已完成"
	},
	"msg": ""
}

响应参数:

schema属性说明

预订单发起/查询请求方法 出参基类

预订单发起/查询请求方法 出参方案模型

预订单发起/查询请求方法 出参方案明细模型

响应状态:

通用回调

接口描述:

接口地址:/api/common/callback/{businessType}/{payId}/{callType}

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"data": {
		"cardNo": "1031092650840",
		"pwd": "666666"
	},
	"nonce": "请求主键唯一值",
	"sign": "签名",
	"timestamp": "10位秒级时间戳",
	"version": "默认传入V1.0"
}

请求参数：

schema属性说明

请求基类«查询卡余额请求方法 入参基类»

查询卡余额请求方法 入参基类

响应示例:

{
	"code": 200,
	"data": {
        "cardNo": "1031092650840",
        "balance": 10445,
        "items": [
            {
                "category": "D01",
                "balance": 10445
            },
            {
                "category": "D02",
                "balance": 10445
            }]
	},
	"msg": "操作成功"
}

响应参数:

查询卡余额请求方法 出参基类

查询卡余额明细 出参基类

响应状态:

通用支付

接口描述:

接口地址:/api/common/pay/{payId}

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"data": {
		"authCode": "授权条形码",
		"branchesId": "网点号",
		"businessType": "默认0:海王",
		"orders": [{
			"orderNo": "明细支付订单号",
			"amount": "明细支付金额"
		}],
		"payAmount": "支付总金额(明细总价),以分为最小单位",
		"termNo": "业务终端号"
	},
	"nonce": "请求主键唯一值",
	"sign": "签名",
	"timestamp": "10位秒级时间戳",
	"version": "默认传入V1.0"
}

请求参数：

schema属性说明

请求基类«支付请求方法 入参基类»

支付请求方法 入参基类

请求方法 订单类

响应示例:

{
	"code": 0,
	"data": {
		"payAmount": "支付总金额(明细总价),以分为最小单位",
		"payOrderNo": "内部支付流水号",
        "interaction": "与银行交互流水号",
		"refAmount": "退费总金额(明细总价),以分为最小单位",
		"status": "支付状态 0:已发起 10:待回调 20:发起全部退费 21:待全部退费回调 22:已全部退费 30:发起部分退分 31:待部分退费回调 32:已部分退费 98:已取消 99:已支付",
		"termNo": "业务终端号"
	},
	"msg": ""
}

响应参数:

schema属性说明

支付/退款请求方法 出参基类

响应状态:

通用退款

接口描述:

接口地址:/api/common/refund/{payId}

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"data": {
		"branchesId": "网点号",
		"businessType": "默认0:海王",
		"extendInfo": "扩展信息",
		"orders": [{
			"orderNo": "明细支付订单号",
			"amount": "明细支付金额"
		}],
		"payOrderNo": "内部支付流水号",
        "interaction": "与银行交互流水号",
		"reason": "退款原因",
		"refAmount": "退费总金额(明细总价),以分为最小单位"
	},
	"nonce": "请求主键唯一值",
	"sign": "签名",
	"timestamp": "10位秒级时间戳",
	"version": "默认传入V1.0"
}

请求参数：

schema属性说明

请求基类«退款请求方法 入参基类»

退款请求方法 入参基类

请求方法 订单类

响应示例:

{
	"code": 0,
	"data": {
		"payAmount": "支付总金额(明细总价),以分为最小单位",
		"payOrderNo": "内部支付流水号",
        "interaction": "与银行交互流水号",
		"refAmount": "退费总金额(明细总价),以分为最小单位",
		"status": "支付状态 0:已发起 10:待回调 20:发起全部退费 21:待全部退费回调 22:已全部退费 30:发起部分退分 31:待部分退费回调 32:已部分退费 98:已取消 99:已支付",
		"termNo": "业务终端号"
	},
	"msg": ""
}

响应参数:

schema属性说明

支付/退款请求方法 出参基类

响应状态:

通用查询

接口描述:

接口地址:/api/common/search/{payId}

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
	"data": {
		"branchesId": "网点号",
		"businessType": "默认0:海王",
		"payOrderNo": "内部支付流水号",
        "interaction": "与银行交互流水号",
	},
	"nonce": "请求主键唯一值",
	"sign": "签名",
	"timestamp": "10位秒级时间戳",
	"version": "默认传入V1.0"
}

请求参数：

schema属性说明

请求基类«查询请求方法 入参基类»

查询请求方法 入参基类

响应示例:

{
	"code": 0,
	"data": {
		"accountType": "微信:WECHAT,支付宝:ALIPAY,银联:UQRCODEPAY,翼支付:BESTPAY,苏宁易付宝:SUNING,数字货币:DCPAY",
		"branchesId": "网点号",
		"createTime": "格式:yyyy/MM/dd HH:mm:ss",
		"outerPayOrderNo": "外部支付流水号",
		"outerPromoAmount": "外部支付优惠默认传0,以分为最小单位",
		"payAmount": "支付总金额(明细总价),以分为最小单位",
		"payId": "支付渠道ID",
		"payOrderNo": "内部支付流水号",
        "interaction": "与银行交互流水号",
		"payTime": "格式:yyyy/MM/dd HH:mm:ss",
		"promoAmount": "内部支付优惠默认传0,以分为最小单位",
		"refAmount": "已退费总金额(明细总价),以分为最小单位",
		"refTime": "格式:yyyy/MM/dd HH:mm:ss",
		"remark": "备注",
		"status": "0:已发起 10:待回调 20:发起全部退费 21:待全部退费回调 22:已全部退费 30:发起部分退费 31:待部分退费回调 32:已部分退费 98:已取消 99:已支付",
		"updateTime": "格式:yyyy/MM/dd HH:mm:ss"
	},
	"msg": ""
}

响应参数:

schema属性说明

查询请求方法 出参基类

响应状态:

查询网点支付渠道

接口描述:

接口地址:/api/channel/getChannelByBranches

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
    "data": {
        "branchesId": "网点号",
        "businessType": "默认0:海王",
        "payId": "支付渠道ID"
    },
    "nonce": "请求主键唯一值",
    "sign": "签名",
    "timestamp": "10位秒级时间戳",
    "version": "默认传入V1.0"
}

请求参数：

schema属性说明

请求基类«查询渠道方法 入参基类»

查询渠道方法 入参基类

响应示例:

{
    "code": 0,
    "data": [
        {
            "branchesId": "网点号",
            "businessType": "默认0:海王",
            "payId": "支付渠道ID",
            "payName": "支付渠道名称",
            "subjectId": "支付类目ID",
            "terminalNo": "网点终端号",
            "isBooking": "是否预订单 0:否 1:是"
        }
    ],
    "msg": ""
}

响应参数:

schema属性说明

查询渠道方法 出参基类

响应状态:

查询支付渠道集合

接口描述:

接口地址:/api/channel/getChannelByPayId

请求方式：POST

consumes:["application/json"]

produces:["*/*"]

请求示例：

{
    "data": {
        "businessType": "默认0:海王",
        "payId": "支付渠道ID"
    },
    "nonce": "请求主键唯一值",
    "sign": "签名",
    "timestamp": "10位秒级时间戳",
    "version": "默认传入V1.0"
}

请求参数：

schema属性说明

请求基类«查询渠道集合方法 入参基类»

查询渠道集合方法 入参基类

响应示例:

{
    "code": 0,
    "data": [
        {
            "businessType": "默认0:海王",
            "dataStatus": "0:正常 1:停用 9:作废",
            "payId": "支付渠道ID",
            "payName": "支付渠道名称",
            "subjectId": "支付类目ID",
            "isBooking": "是否预订单 0:否 1:是"
        }
    ],
    "msg": ""
}

响应参数:

schema属性说明

查询渠道集合方法 出参基类

响应状态: