获取支付链接
访问地址: https://rcsapi.hanwg.com/ability/rcs/payment/api/createPayUrl
提交方式:
支持https
只支持POST
功能:
用于获取支付链接,便于后续通过在5G RCS平台申请制作审核通过模板,下发支付相关的5G消息。
请求头参数:
请求体参数:
参数值说明:以下json内容为提交请求数据格式
{
"params":{"name:":"123","phone":"139xxxxxx"},
"chatbot":"eafb5b3b00964e70b578323475af92a3",
"name":"购买支付",
"payDesc":"三只松鼠",
"productName":"零食",
"totalAmount":1
}
| 序号 | 名称 | 数据类型 | 必填属性 | 描述 |
|---|---|---|---|---|
| 1 | chatbot | string | M | 在5G CSP平台的申请的chatbot的id |
| 2 | name | string | M | 记录名称 |
| 3 | productName | string | M | 支付主题 |
| 4 | payDesc | string | M | 支付描述 |
| 5 | totalAmount | double | M | 价格,单位(元) |
| 6 | params | object | O | 自定义回传参数,如果请求时传递了该参数,则在支付结果推送时会回传该参数。注意:该对象的**json字符串长度不能超过1000** |
返回示例:
{
"code": 0,
"desc": "请求成功",
"result ": "https://xxxxxx"
}
返回参数说明:
| 序号 | 名称 | 数据类型 | 可选属性 | 描述 |
|---|---|---|---|---|
| 1 | code | int | M | 请求状态 |
| 2 | desc | string | M | 请求响应描述 |
| 3 | result | string | C | 支付链接URL,请求成功时存在 |
提交响应错误吗
| 错误码 | 描述 |
|---|---|
| 0 | 请求成功 |
| 1 | 账号为空 |
| 2 | 账号或密码错误 |
| 3 | 密码为空 |
| 4 | ip鉴权失败 |
| 5 | chabot为空 |
| 6 | 缺少请求参数 |
| 7 | 时间逾期 |
| 8 | chatbot错误 |
| 9 | 参数过长 |
| 99 | 系统繁忙 |
| 201 | 能力未添加 |
| 202 | 能力已禁用 |
支付结果回调通知
应用场景
当用户支付完成后,我公司根据在能力使用配置上配置的回调地址,通过POST 请求将相关支付结果以及用户信息通过接口回调的方式发送给客户,客户需要接收处理,并按文档规范返回应答。
注意:
- 同样的回调通知可能会多次发送给客户,客户必须能够正确处理重复的通知
- 后台通知交互时,如果我公司收到客户的应答不符合规范或超时,我公司会判定本次通知失败,会进行重新发送,最多通知3次
通知参数
通知参数说明
| 序号 | 名称 | 数据类型 | 描述 |
|---|---|---|---|
| 1 | paymentType | integer | 支付类型:1-支付宝支付 2-微信支付 |
| 2 | appid | string | 微信/支付宝的appid |
| 3 | tradeNo | string | 交易单号 |
| 4 | buyerId | string | 买家支付账号,支付宝用户号/微信用户openid |
| 5 | sellerId | string | 卖家收款账号,支付宝账号/微信商户号 |
| 6 | tradeStatus | int | 订单交易状态,1-交易成功 2-等待支付 3-交易失败 4-退款成功 5-交易结束 |
| 7 | errorCode | string | 错误返回的响应码 |
| 8 | errorDesc | string | 错误返回的信息描述 |
| 10 | totalAmount | double | 本次交易支付的订单金额,单位为人民币(元)。 |
| 11 | receiptAmount | double | 商家在交易中实际收到的款项,单位为人民币(元)。 |
| 12 | buyerPayAmount | double | 用户在交易中支付的金额。 |
| 13 | pointAmount | double | 使用集分宝支付的金额。或代金券的金额 |
| 14 | subject | string | 商品的主题 |
| 15 | body | string | 该订单的备注、描述、明细等 |
| 16 | gmtCreate | date | 该笔交易创建的时间 |
| 17 | gmtClose | date | 该笔交易结束时间 |
| 18 | phone | string | 用户手机号 |
| 19 | params | object | 自定义回传参数,如果请求时传递了该参数,则返回时会在异步通知时将该参数原样返回。 |
参数示例如下:
{
"appid": "2016083001823675",
"body": "小米11 Ultra 12G 512G",
"buyerId": "2088022756189084",
"buyerPayAmount": 1.0,
"errorCode": "TRADE_SUCCESS",
"errorDesc": "交易支付成功",
"gmtClose": "2021-04-02 19:32:46",
"gmtCreate": "2021-04-02 19:32:45",
"paymentType": 1,
"pointAmount": 0.0,
"receiptAmount": 1.0,
"sellerId": "2088421596729012",
"subject": "小米11 Ultra 12G 512G",
"totalAmount": 1,
"tradeNo": "2021040222001489081431832862",
"tradeStatus": 1,
"phone":"139xxxxxxxx",
"params":{
"name:":"123",
"abs":"123123"
}
}
返回响应
响应参数说明
| 序号 | 名称 | 数据类型 | 可选属性 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 1 | return_code | string | M | SUCCESS | SUCCESS/FAIL SUCCESS表示客户接收通知成功 FAIL 表示失败 |
| 2 | return_msg | string | O | OK | 返回信息,如非空,为错误原因 |
响应示例
{
"return_code": "SUCCESS",
"return_msg": "OK"
}文档更新时间: 2023-12-25 10:24 作者:夏亮