文档中心/API 接口

API REFERENCE

减少预授权

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

减少预授权

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

请求参数6

先填写必填项

减少预授权

trade_id必填stringdata.trade_id对应减少预授权的trade_id
amount必填stringdata.amount金额数字。例如 € 24.99 应该写成24.99
currency必填stringdata.currency货币代码,ISO 4217,例如EUR,CHF
description必填stringdata.description订单描述
notify_url必填stringdata.notify_url支付完成后异步通知地址
request_id必填stringdata.request_id请求id需保持唯一,建议24以上位数字+字母

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

参数类型描述是否必填
userString收银员账号的UID必填
signString签名必填
methodStringv3.PreauthDecrement必填
timeLong时间戳必填
  • 参数
参数类型描述是否必填
trade_idString对应减少预授权的trade_id必填
amountString金额数字。例如 € 24.99 应该写成24.99必填
currencyString货币代码,ISO 4217,例如EUR,CHF必填
descriptionString订单描述必填
notify_urlString支付完成后异步通知地址必填
request_idString请求id需保持唯一,建议24以上位数字+字母必填

签名示例:

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

"amount=0.1&currency=EUR&description=test&method=v3.PreauthDecrement&notify_url=https://www.yabandpay.com/notify&request_id=skc5vtsovtetqe09us0jdrqm1vjdeaki&time=1774246236&trade_id=9222e0e1-6ef5-639f-3692-90f1e2a33e68&user=YOUR_CASHIER_UID"

得到的 stringA 使用 secret_key做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:


{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.PreauthDecrement",
    "time": 1774246236,
    "data": {
        "description": "test",
        "trade_id": "9222e0e1-6ef5-639f-3692-90f1e2a33e68",
        "amount": "0.1",
        "currency": "EUR",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "skc5vtsovtetqe09us0jdrqm1vjdeaki"
    }
}

返回示例:

{
  "status": true,
  "code": "200",
  "data": {
    "order_id": "YOUR_ORDER_ID",
    "trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
    "amount": "1",
    "currency": "EUR",
    "state": "authorized"
  },
  "message": "",
  "response_id": "202407111550570060848432"
}

更多信息:

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

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

此接口用于减少预授权金额。同步就可获得调用结果,减少金额不可大于预授权金额。

返回代码:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-2001The user not exist
false-3001Required field is missing
false-4118Incorrect request ID
false-4024The original trade ID is incorrect