文档中心/API 接口

API REFERENCE

交易撤销

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

交易撤销

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

请求参数3

先填写必填项

交易撤销

tid必填stringdata.tid设备的TID
trade_id必填stringdata.trade_idYabandPay订单编号
request_id必填stringdata.request_id请求id需保持唯一,建议24以上位数字+字母

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

适用于线下POS支付场景

该接口用于通过云端发起对已成功交易的撤销操作。

交易撤销仅支持当日交易,且仅可进行全额撤销。

如需处理部分撤销或非当日交易,请使用退款接口。

撤销指令下发后,POS 终端将实时展示撤销处理过程及最终结果,以便商户和用户即时确认撤销状态。如需执行静默撤销(不在 POS 终端展示处理过程),请使用取消支付接口。

在调用本接口前,请务必确认 POS 设备处于在线且可用状态,以确保撤销指令能够成功下发并被正常处理。

API URL(生产环境):https://mapi.yabandpay.com/Payments

API URL(测试环境):https://acc-mapi.yabandpay.com/Payments

参数类型描述是否必填
userString设备的TID必填
signString签名必填
methodStringv3.POSReversal必填
timeLong时间戳必填
  • 参数
ParameterTypeDescription是否必填
tidstring设备的TID必填
trade_idStringYabandPay订单编号必填
request_idString请求id需保持唯一,建议24以上位数字+字母必填

签名示例:

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

 "method=v3.POSReversal&request_id=a7z1lox4l6z6mdx1udgn5gtezasze1x0&tid=T125119061&time=1555498137&trade_id=4a49ffb3-a30f-ba92-9422-1969afb6f121&user=T125119061" 

得到的 stringA 使用 secret_key做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:

 {
  "user": "T125119061",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.POSReversal",
  "time": 1555498137,
  "data": {
   "tid": "T125119061",
		"trade_id": "4a49ffb3-a30f-ba92-9422-1969afb6f121",
    "request_id": "a7z1lox4l6z6mdx1udgn5gtezasze1x0"

  }
} 

返回示例:

{
  "status": true,
  "code": "200",
  "data": {
        "type": "payment",
        "user": "T125119061",
        "amount": "0.10",
        "currency": "EUR",
        "trade_id": "4a49ffb3-a30f-ba92-9422-1969afb6f121",
        "description": "YabandPay test",
        "order_id": "YOUR_ORDER_ID",
        "createDate": "1706771212",
        "demo": "test",
        "transaction_id": "",
        "state": "cancelled"
  },
  "message": ""} 

更多信息:

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

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

我们强烈建议同时使用订单查询和异步通知来同步和更新支付状态,以确保支付信息的实时准确性。

返回代码:
StatusCodeMessage
true200
false-3001Required field is missing
false-3002duplicate request_id
false-4111Exceed cancel window
false-4112The transaction has been cleared cannot be cancelled
false-4114The trade_id does not exist
false-4115The transaction cannot be cancelled
false-4116The transaction has been cancelled
false-4117The transaction has been Expired