1. 交易(二级)
TiPay
  • 开放文档
    • Ti-Pay 支付通道快速接入
    • Q&A
    • 易宝钱包支付页面交互步骤图解
    • 交易(二级)
      • 交易下单
        POST
      • 查询订单
        GET
      • 分账申请
        POST
      • 分账结果查询
        GET
      • 申请退款
        POST
      • 退款查询
        GET
    • 数藏钱包
      • 钱包注册/登录接口
      • 钱包账户信息查询
  1. 交易(二级)

申请退款

POST
https://api.tipay.tianhecloud.com/api/v1/yb/trade/refund

接口描述#

交易后如需要退款,商户可调用此接口将支付款退还给付款方。

使用说明#

1.
订单状态为“SUCCESS”时才能发起退款。
2.
退款支持单笔交易分多次退款,多次退款需要提交原支付订单的商户订单号和不同的退款单号,总退款金额不能超过用户实际支付金额。
3.
一笔退款失败后重新提交,请不要更换退款单号,请使用相同的商户退款请求号请求退款。
4.
申请退款接口的响应参数code仅代表业务的受理情况,具体退款是否成功,需要通过申请退款结果通知或查询退款接口返回的status获取退款结果。
​ (1)当响应参数code=200时,说明易宝已受理该笔退款,此时需要根据status来判断退款状态;
​ (2)当响应参数code≠200时,说明易宝没有受理该笔退款,可根据返回的msg进行相应处理。
5.
申请退款接口使用在求购,抢购,拍卖等这类需要频繁进行退款的业务场景时,需要向易宝支付报备进行额外配置,这类场景订单支付产生的手续费由平台承担,需确保平台账户余额充足,否则会退款失败
6.
退款场景支持情况,申请退款接口使用在求购,抢购,拍卖等这类场景时,建议等活动结束后在进行申请分账操作
(1)订单不是分账订单,直接调用退款接口退款(支持)
(2)订单是分账订单且没有任何分账记录,直接调用退款接口退款(支持)
(3)订单是分账订单且有一部分分账记录,如果要退分出去的那部分,先调用分账归还接口,再调用退款接口 (暂不支持)
(4)订单是分账订单且有一部分分账记录,如果要退尚未分出去的那部分,先调用分账接口把这部分资金分给平台,再调用退款接口 (暂不支持)
(5)订单是分账订单且全部都已经分完,先调用分账归还接口,再调用退款接口 (暂不支持)

请求参数

Header 参数

Body 参数application/json

示例
{
    "merchantNo": "string",
    "orderId": "string",
    "refundRequestId": "string",
    "refundAmount": "string",
    "description": "string",
    "notifyUrl": "string"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.tipay.tianhecloud.com/api/v1/yb/trade/refund' \
--header 'ti-appid: tichain000000' \
--header 'ti-timestamp: 1647751123703' \
--header 'ti-signature: 644dbdb0137f1f3add30eca4c9e582da5c6e45d77fea51ab76fbd10ef3442f6b' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchantNo": "string",
    "orderId": "string",
    "refundRequestId": "string",
    "refundAmount": "string",
    "description": "string",
    "notifyUrl": "string"
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 200,
    "success": true,
    "data": {
        "code": "OPR00000",
        "message": "成功",
        "merchantNo": "1008xxxxxxx",
        "orderId": "bda4e84ef8ee427b830d869d7a6bfd71",
        "refundRequestId": "1b118148eaf54b09a213adcb332d7a19",
        "uniqueRefundNo": "1002202301300000005245434665",
        "status": "PROCESSING",
        "refundAmount": "0.01",
        "refundRequestDate": "2023-01-30 17:08:14",
        "refundAccountDetail": "[{\"accountType\":\"SETTLE_ACCOUNT\",\"debitAmount\":0.01}]"
    },
    "msg": "操作成功"
}
🟢200退款结果通知
修改于 2023-07-31 09:33:22
上一页
分账结果查询
下一页
退款查询
Built with