文档中心/API 接口

API REFERENCE

退款查询

POSThttps://mapi.yabandpay.com/Payments
实际接口
API PLAYGROUND · 实际接口

退款查询

POSThttps://mapi.yabandpay.com/Payments
填写凭据后自动签名

请求参数2

先填写必填项

退款查询

可选参数 2
refund_id至少一个stringdata.refund_idYabandPay退款单号选填 (必须包含一个)
m_refund_id至少一个stringdata.m_refund_id商户退款单号选填(必须包含一个)

凭据仅在当前页面使用。secret_key 不保存,也不发送给文档服务器。

参数类型描述是否必填
userString收银员账号的UID必填
signString签名必填
methodStringv3.QueryRefundOrder必填
timeLong时间戳必填
  • 参数
参数类型描述是否必填
refund_idStringYabandPay退款单号选填 (必须包含一个)
m_refund_idString商户退款单号选填(必须包含一个)

签名示例:

拼接为URL方式并排序后的字符串

"method=v3.QueryRefundOrder&time=1728566835&refund_id=3841510a-4d18-4a61-808d-431a45006de2&user=YOUR_CASHIER_UID"

得到的 stringA 使用 secret_key做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.QueryRefundOrder",
    "time": 1728566835,
    "data": {
        "refund_id": "3841510a-4d18-4a61-808d-431a45006de2"
    }
}

返回示例:

{
    "status": true,
    "code": "200",
    "data": {

            "transaction_id": "20240903153820059756",
            "refund_id": "20240903154342497308",
            "m_refund_id": null,
            "refund_time": "1725349422",
            "state": "refunded",
            "refund_amount": "0.01",
            "refund_currency": "EUR",
            "refund_description": "gary",
            "notify_url": "null",
            "demo": "",
            "settlement_refund_amount": "0.01",
            "settlement_refund_currency": "EUR",
            "merchant_cost": "0.1",
            "yb_transaction_id": "c07859aa-3d12-69d4-ef2f-a9556d9c4d33"
        },
    "message": ""
}

更多信息:

返回结果:
  1. 若调用成功,则返回"status": true

  2. 若调用失败,则返回"status": false

退款状态:
CodeStateMessage
20to-be-approval等待管理员批准。
21refund pending当前余额不足,余额充足时自动提交退款。
22refund processing退款请求已经提交,系统正在处理中。
23refunded退款已经成功完成。
24refund failed退款失败,请再次尝试。
25refund error退款失败,请联系我们在线客服。
26refund cancelled退款订单已经被取消。