文档中心/API 接口

API REFERENCE

获取trade_id

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

获取trade_id

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

请求参数1

先填写必填项

获取trade_id

invoice_id必填stringdata.invoice_id单号

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

通过invoice_id获取trade_id。

小贴士

交易成功后,可通过该接口获取对应的 trade_id,用于后续操作(如增加预授权、减少预授权、请款、查询、撤销或退款等)。

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

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

参数类型描述是否必填
userString收银员账号的UID必填
signString签名必填
methodStringv3.GetTradeId必填
timeLong时间戳必填
  • 参数
参数类型描述是否必填
invoice_idString单号必填

签名示例:

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

"invoice_id=1234567&method=v3.GetTradeId&time=1546588959&user=YOUR_CASHIER_UID"

得到的 stringA 使用 secret_key做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:

{
  "user": "YOUR_CASHIER_UID",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.GetTradeId",
  "time": 1546588959,
  "data": {
    "invoice_id": "1234567"
  }
}

返回示例:

{
  "status": true,
  "code": "200",
  "data": {
    "trade_id": "2312e8b0-8ed5-6a66-293e-29efc206c599"
  },
  "message": ""
}

更多信息:

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

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

返回代码:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-4006Order number does not exist

注意事项

trade_id 通常需在交易完成约 1 分钟后方可获取。
若返回错误信息 "Order number does not exist",请间隔约 1 分钟后重试获取。