文档中心/API 接口

API REFERENCE

取消支付

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

取消支付

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

请求参数1

先填写必填项

取消支付

trade_id必填stringdata.trade_idYabandPay订单编号

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

该API用于取消支付订单,包括未支付、已支付或者已完成预授权的任何支付订单

如果没有收到YabandPay的最终支付结果(成功或者失败),或者想关闭支付订单,可以调用本接口将支付订单取消。

  1. 时间限制:支付订单只能在约定时间内进行取消操作,即从交易发起到第二天30分钟内 (T+1日00:30 ),欧洲中部时区。
  2. 金额限制:必须全额取消,不支持部分金额取消。
  3. 退款限制:如果支付订单进行了任何退款操作,那么不能被取消。
  4. 结算以及费用:支付订单被取消以后不会进行清结算,YabandPay也不会收取任何交易费用。
参数类型描述是否必填
userString收银员账号的UID必填
signString签名必填
methodStringv3.CancelPayment必填
timeLong时间戳必填
  • 参数
参数类型描述是否必填
trade_idStringYabandPay订单编号必填

签名示例:

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

"method=v3.CancelPayment&time=1546588959&trade_id=4a49ffb3-a30f-ba92-9422-1969afb6f121&user=YOUR_CASHIER_UID"

得到的 stringA 使用 secret_key做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:

{
    "user": "YOUR_CASHIER_UID",
	"sign": "YOUR_SIGNATURE",
	"method": "v3.CancelPayment",
	"time": 1546588959,
	"data": {
		"trade_id": "4a49ffb3-a30f-ba92-9422-1969afb6f121"
    }
}

返回示例:

{
    "status": true,
    "code": "200",
    "data": {
        "type": "payment",
        "user": "YOUR_CASHIER_UID",
        "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

可以通过调用订单查询查询订单状态,如果订单状态state为cancelled,即取消成功。

返回代码:
StatusCodeMessage
true200
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