泰山付支付接口文档

与商户通信接口说明

请求方式：POST

请求地址：{{host}}/api/***

Header参数名	类型	必需	描述	示例 e.g.
timeStamp	string	是	当前时间戳	1695480098
sign	string	是	当前时间戳加密后字符串	9BEFFB9A364667C9FA1C47B6A8756E36

详细说明：

规则说明：

1、header中传 timeStamp 和 sign两个参数；timeStamp为当前时间戳，sign为当前时间戳加密后字符串

2、用于md5加密的key请自行联系运营人员获取;

3、sign加密规则: md5(md5Key:timeStamp)

4、双方所有接口通信都采用以上规则

5、使用表单数据格式传递参数 Content-Type: application/json

6、注意：加密后字母大写

支付公共接口

请求方式：POST

请求地址：{{host}}/api/payment/pay/{商户编号}

Body参数名	类型	必需	描述	示例 e.g.
merchantSubject	string	是	订单标题	测试订单
merchantTradeNo	string	是	商户订单号	100004
totalAmount	string	是	订单总金额	100
notifyUrl	string	是	商户异步通知URL	http://www.baidu.com
quitUrl	string	是	用户付款中途退出返回商户网站的地址	http://www.baidu.com
returnUrl	string	是	支付成功同步返回地址	http://www.baidu.com
payType	string	是	支付方式 1、手机网站支付 2. 电脑网站 3.APP支付 4 小程序支付 5 扫码支付 6\ 条码支付	1
timeExpire	string	否	绝对超时时间，格式为yyyy-MM-dd HH:mm:ss。超时时间范围：1m~15d。	2016-12-31 10:05:00
clientIp	string	否	客户端IP, 用户下单 IP，详细请查看用户下单IP获取指引	43.245.219.126
extUserInfoName	string	否	指定买家允许的最小买家年龄	方大花
extUserInfoMobile	string	否	指定买家手机号	13511111111
extUserInfoMinAge	string	否	指定买家允许的最小买家年龄	18

详细说明：

返回示例：

                                {
    "code": 200,
    "type": "success",
    "message": "",
    "result": {
        "url": "http://localhost:5005/gateWay/wap?id=yz231006211629242",
        "linkType": 1
    },
    "extras": null,
    "time": "2023-10-06 21:16:29"
}

参数名	描述	类型
code	消息编码 200 表示成功其他失败	string
type	消息类型 success 成功	string
message	消息	string
result.url	支付url	string
result.linkType	换起支付模式 1普通链接	string
time	时间	string

交易查询

请求方式：POST

请求地址：http://{{host}}/api/payment/query/{商户编号}

Body参数名	类型	必需	描述	示例 e.g.
merchantTradeNo	string	是	商户订单号	12345667
platformOutTradeNo	string	是	平台订单号	12345667
tradeNo	string	是	支付宝订单号	12345667

详细说明：

三个订单号有一个不为空就可以，

如果都不为空，优先级为merchantTradeNo->platformOutTradeNo->tradeNo

返回示例：

                                {
    "code": 200,
    "type": "success",
    "message": "",
    "result": {
        "platformOutTradeNo": "12345566",
        "platformSubject": "测试订单28",
        "merchantTradeNo": "100028",
        "merchantSubject": "测试订单28",
        "totalAmount": 0.01,
        "merchantId": "11234556",
        "realCommission": 0,
        "merchantGoodsType": "平台默认商品类别",
        "platformGoodsType": "平台默认商品类别",
        "buyerInfo": "135******70(123456789)",
        "payTime": "2023-10-15 23:02:19",
        "payType": 1,
        "refundAmount": 0.01,
        "refundOutRequestNo": "",
        "refundTime": "2023-10-15 23:02:20",
        "serviceFee": 0.0001,
        "settleAmount": 0.01,
        "settleTime": "1900-01-01 00:00:00",
        "status": 3,
        "tradeNo": "2231111",
        "createTime": "2023-10-15 23:01:38"
    },
    "extras": null,
    "time": "2023-10-16 00:23:21"
}

参数名	描述	类型
platformOutTradeNo	平台订单编号	string
platformSubject	平台订单标题	string
merchantTradeNo	商户订单编号	string
merchantSubject	商户订单标题	string
totalAmount	订单总金额	string
merchantId	商户ID	string
realCommission	佣金手续费	string
merchantGoodsType	商户商品类型	string
platformGoodsType	平台商品类型	string
buyerInfo	购买人信息	string
payTime	支付时间	string
payType	支付方式 1、手机网站支付 2. 电脑网站 3.APP支付 4\小程序支付 5 扫码支付 6\ 条码支付	string
refundAmount	退款金额	string
refundTime	退款时间	string
settleAmount	结算金额	string
settleTime	结算时间	string
status	状态 0 未支付 1 已支付 2 已结算 3 已退款	string
tradeNo	支付宝交易号	string
createTime	创建时间	string

交易订单结果通知商户

请求方式：POST

请求地址：此地址为支付公共接口中notifyUrl参数值

Header参数名	类型	必需	描述	示例 e.g.
timeStamp	string	是	当前时间戳
sign	string	是	当前时间戳加密结果

Body参数名	类型	必需	描述	示例 e.g.
MerchantTradeNo	string	是	商户订单号	12345667
PlatformOutTradeNo	string	是	平台订单号	12345667
BuyerId	string	是	购买人用户Id	1234567890
BuyerLogonId	string	是	买家支付宝账号	150****0870
Subject	string	是	订单标题	测试订单
NotifyType	string	是	通知类型 trade_status_sync 订单状态改变	trade_status_sync
TradeStatus	string	是	交易状态 WAIT_BUYER_PAY交易待支付TRADE_SUCCESS交易支付成功 TRADE_CLOSED 未付款交易超时关闭，或支付完成后全额退款 TRADE_FINISHED交易结束，不可退款	TRADE_SUCCESS
TotalAmount	number	是	订单金额	100.00
GmtPayment	string	是	支付成功时间 - 仅针对支付	2023-11-27 14:44:42
RefundFee	number	是	退款金额	0
IsBackRefund	integer	是	是否黑名单退款 0 否 1 是	0

详细说明：

商户处理成功返回success

返回示例：

                                success

退款接口

请求方式：POST

请求地址：http://{{host}}/api/payment/refund/{商户编号}

Body参数名	类型	必需	描述	示例 e.g.
merchantTradeNo	string	是	商户订单号	12345667
platformOutTradeNo	string	是	平台订单号	12345667
tradeNo	string	是	支付宝订单号	12345667

详细说明：

三个订单号有一个不为空就可以，

如果都不为空，优先级为merchantTradeNo->platformOutTradeNo->tradeNo

返回示例：

                                {
    "code": 200,
    "type": "success",
    "message": "",
    "result": null,
    "extras": null,
    "time": "2023-10-16 00:31:15"
}

参数名	描述	类型
code	状态编码 200 为成功其他为失败	string
type	状态类型	string
message	错误消息	string
result	返回数据	string
extras	额外内容	string
time	执行时间	string

部分退款接口

请求方式：POST

请求地址：http://{{host}}/api/payment/part-refund/{商户编号}

Body

Body参数名	类型	必需	描述	示例 e.g.
merchantTradeNo	string	是	商户订单号	12345667
platformOutTradeNo	string	是	平台订单号	12345667
tradeNo	string	是	支付宝订单号	12345667
refundAmount	number	是	退款金额	100
TransOut	array	否	退分账	退分账
TransOut.loginName	string	是	支付宝账号	15067920870
TransOut.name	string	是	分账接收方真实姓名	汤晓峰
TransOut.amount	number	是	退分账金额	10
TransOut.remark	string	否	备注	退物流服务费

详细说明：

三个订单号有一个不为空就可以，

如果都不为空，优先级为merchantTradeNo->platformOutTradeNo->tradeNo

分账收款方只支持实名认证的支付宝账号。在分账关系绑定后，如果分账收款方注销，则无法继续作为分账收款方。

返回示例：

                                {
    "code": 200,
    "type": "success",
    "message": "",
    "result": null,
    "extras": null,
    "time": "2023-10-16 00:31:15"
}

参数名	描述	类型
code	状态编码 200 为成功其他为失败	string
type	状态类型	string
message	错误消息	string
result	返回数据	string
extras	额外内容	string
time	执行时间	string

退款查询接口

请求方式：POST

请求地址：http://{{host}}/api/payment/refund-query-v2/{商户编号}

Body

Body参数名	类型	必需	描述	示例 e.g.
merchantTradeNo	string	否	商户订单号	12345667
platformOutTradeNo	string	否	平台订单号	12345667
tradeNo	string	否	支付宝订单号	12345667

详细说明：

三个订单号有一个不为空就可以，

如果都不为空，优先级为merchantTradeNo->platformOutTradeNo->tradeNo

返回示例：

                                {
    "code": 200,
    "type": "success",
    "message": "",
    "result": {
        "platformOutTradeNo": "PR240425001901373",
        "merchantTradeNo": "2024042501",
        "requestNo": "2024042501",
        "refundTime": "2024-04-25 00:19:47",
        "refundAmount": 0.1,
        "refundFee": 0.2,
        "totalAmount": 0.2,
        "refundStatus": "REFUND_SUCCESS"
    },
    "extras": null,
    "time": "2023-10-16 00:31:15"
}

参数名	描述	类型
code	状态编码 200 为成功其他为失败	string
type	状态类型	string
message	错误消息	string
result	返回数据	string
extras	额外内容	string
time	执行时间	string
result.platformOutTradeNo	泰山付订单编号	string
result.merchantTradeNo	商户订单编号	number
result.requestNo	退款请求号	number
result.refundTime	退款时间	string
result.refundFee	退款总金额	number
result.refundAmount	退款金额本次退款请求，对应的退款金额	number
result.totalAmount	订单金额该笔退款所对应的交易的订单金额	number
result.refundStatus	退款状态。枚举值 REFUND_SUCCESS 退款处理成功；未返回该字段表示退款请求未收到或者退款失败注：如果退款查询发起时间早于退款时间，或者间隔退款发起时间太短，可能出现退款查询时还没处理成功，后面又处理成功的情况，建议商户在退款发起后间隔10秒以上再发起退款查询请求。	string

部分退款接口V3

请求方式：POST

请求地址：http://{{host}}/api/payment/part-refund-v3/{商户编号}

Body

Body参数名	类型	必需	描述	示例 e.g.
requestNo	string	是	退款单号
merchantTradeNo	string	是	商户订单号	12345667
platformOutTradeNo	string	是	平台订单号	12345667
tradeNo	string	是	支付宝订单号	12345667
refundAmount	number	是	退款金额	100
TransOut	array	否	退分账	退分账
TransOut.loginName	string	是	支付宝账号	15067920870
TransOut.name	string	是	分账接收方真实姓名	汤晓峰
TransOut.amount	number	是	退分账金额	10
TransOut.remark	string	否	备注	退物流服务费

返回示例：

                                {
    "code": 200,
    "type": "success",
    "message": "",
    "result": null,
    "extras": null,
    "time": "2023-10-16 00:31:15"
}

参数名	描述	类型
code	状态编码 200 为成功其他为失败	string
type	状态类型	string
message	错误消息	string
result	返回数据	string
extras	额外内容	string
time	执行时间	string

退款查询接口V3

请求方式：POST

请求地址：http://{{host}}/api/payment/refund-query-v3/{商户编号}

Body

Body参数名	类型	必需	描述	示例 e.g.
requestNo	string	是	退款单号	BR12345667
merchantTradeNo	string	否	商户订单号	12345667
platformOutTradeNo	string	否	平台订单号	12345667
tradeNo	string	否	支付宝订单号	12345667

详细说明：

三个订单号有一个不为空就可以，

如果都不为空，优先级为merchantTradeNo->platformOutTradeNo->tradeNo

返回示例：

                                {
    "code": 200,
    "type": "success",
    "message": "",
    "result": {
        "platformOutTradeNo": "PR240425001901373",
        "merchantTradeNo": "2024042501",
        "requestNo": "2024042501",
        "refundTime": "2024-04-25 00:19:47",
        "refundAmount": 0.1,
        "refundFee": 0.2,
        "totalAmount": 0.2,
        "refundStatus": "REFUND_SUCCESS"
    },
    "extras": null,
    "time": "2023-10-16 00:31:15"
}

参数名	描述	类型
code	状态编码 200 为成功其他为失败	string
type	状态类型	string
message	错误消息	string
result	返回数据	string
extras	额外内容	string
time	执行时间	string
result.platformOutTradeNo	泰山付订单编号	string
result.merchantTradeNo	商户订单编号	number
result.requestNo	退款请求号	number
result.refundTime	退款时间	string
result.refundFee	退款总金额	number
result.refundAmount	退款金额本次退款请求，对应的退款金额	number
result.totalAmount	订单金额该笔退款所对应的交易的订单金额	number
result.refundStatus	退款状态。枚举值 REFUND_SUCCESS 退款处理成功；未返回该字段表示退款请求未收到或者退款失败注：如果退款查询发起时间早于退款时间，或者间隔退款发起时间太短，可能出现退款查询时还没处理成功，后面又处理成功的情况，建议商户在退款发起后间隔10秒以上再发起退款查询请求。	string

二次分账

请求方式：POST

请求地址：http://{{host}}/api/payment/sencondTransfer/{商户编号}

Body

Body参数名	类型	必需	描述	示例 e.g.
merchantTradeNo	string	是	商户订单号	12345667
platformOutTradeNo	string	是	平台订单号	12345667
tradeNo	string	是	支付宝订单号	12345667
transIn	array	是	分账明细信息	分账数组
transIn.loginName	string	是	支付宝账号	15067920870
transIn.name	string	是	分账接收方真实姓名	汤晓峰
transIn.amount	string	是	分账金额	10
transIn.remark	string	否	备注	物流服务费

详细说明：

三个订单号有一个不为空就可以，

如果都不为空，优先级为merchantTradeNo->platformOutTradeNo->tradeNo

分账收款方只支持实名认证的支付宝账号。在分账关系绑定后，如果分账收款方注销，则无法继续作为分账收款方。

返回示例：

                                {
    "code": 200,
    "type": "success",
    "message": "",
    "result": null,
    "extras": null,
    "time": "2023-10-16 00:31:15"
}

参数名	描述	类型
code	状态编码 200 为成功其他为失败	string
type	状态类型	string
message	错误消息	string
result	返回数据	string
extras	额外内容	string
time	执行时间	string

分账关系绑定

请求方式：POST

请求地址：http://{{host}}/api/payment/bind-royalty-relation/{商户编号}

Body

Body参数名	类型	必需	描述	示例 e.g.
loginName	string	是	支付宝账号	15067920871
name	string	是	分账接收方真实姓名	汤晓峰
memo	string	否	备注	测试备注

返回示例：

                                {
    "code": 200,
    "type": "success",
    "message": "",
    "result": null,
    "extras": null,
    "time": "2023-10-16 00:31:15"
}

参数名	描述	类型
code	状态编码 200 为成功其他为失败	string
type	状态类型	string
message	错误消息	string
result	返回数据	string
extras	额外内容	string
time	执行时间	string

分账关系解绑定

请求方式：POST

请求地址：http://{{host}}/api/payment/unbind-royalty-relation/{商户编号}

Body

Body参数名	类型	必需	描述	示例 e.g.
loginName	string	是	支付宝账号	15067920871
name	string	是	分账接收方真实姓名	汤晓峰
memo	string	否	备注	测试备注

返回示例：

                                {
    "code": 200,
    "type": "success",
    "message": "",
    "result": null,
    "extras": null,
    "time": "2023-10-16 00:31:15"
}

参数名	描述	类型
code	状态编码 200 为成功其他为失败	string
type	状态类型	string
message	错误消息	string
result	返回数据	string
extras	额外内容	string
time	执行时间	string

公共

与商户通信接口说明

交易收款

支付公共接口

交易查询

交易订单结果通知商户

退款

退款接口

部分退款接口

退款查询接口

部分退款接口V3

退款查询接口V3

结算

二次分账

分账关系绑定

分账关系解绑定

附录

环境变量