文档中心/API 接口

API REFERENCE

快捷支付

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

快捷支付

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

请求参数9

先填写必填项

快捷支付

pay_method必填stringdata.pay_methodoffline
amount必填stringdata.amount金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1
currency必填stringdata.currency货币代码,ISO 4217,例如EUR,CHF
auth_code必填stringdata.auth_code微信支付或者支付宝+钱包的授权码
description必填stringdata.description订单描述
可选参数 4
sub_pay_method可选stringdata.sub_pay_methodWeChat Pay,Alipay,UnionPay QRcode,通过接口获取sub pay method 获取。如果为空(推荐),将由YabandPay来做支付方式判断。
tip_amount可选stringdata.tip_amount总金额中包含的小费,金额数字。例如 1.02
demo可选stringdata.demo自定义字段
notify_url可选stringdata.notify_url支付完成后异步通知地址

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

适用于线下门店支付场景,支持微信支付、支付宝+和银联云闪付 。

字段类型描述是否必填
userString收银员账号的UID必填
signString签名必填
methodStringv3.BarcodePayment必填
timeLong时间戳必填
  • 参数
字段类型描述是否必填
pay_methodStringoffline必填
sub_pay_methodStringWeChat Pay,Alipay,UnionPay QRcode,通过接口获取sub pay method 获取。如果为空(推荐),将由YabandPay来做支付方式判断。选填
order_idString商户订单号必填
amountString金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1必填
tip_amountString总金额中包含的小费,金额数字。例如 1.02选填
currencyString货币代码,ISO 4217,例如EUR,CHF必填
demoString自定义字段选填
auth_codeString微信支付或者支付宝+钱包的授权码必填
descriptionString订单描述必填
notify_urlString支付完成后异步通知地址选填

签名示例:

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

"amount=2.1&auth_code=134443133735495918&currency=EUR&demo=test&description=YabandPay test&method=v3.BarcodePayment&notify_url=https://www.yabandpay.com/notify&order_id=202488465489451317&pay_method=offline&sub_pay_method=WeChat Pay&time=1555499083&tip_amount=0.5&user=YOUR_CASHIER_UID"

得到的 stringA 使用 secret_key做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.BarcodePayment",
    "time": 1555499083,
    "data": {
        "amount": "2.1",
        "tip_amount": "0.5",
        "auth_code": "YOUR_AUTH_CODE",
        "currency": "EUR",
        "demo": "test",
        "description": "YabandPay test",
        "notify_url": "https://www.yabandpay.com/notify",
        "order_id": "YOUR_ORDER_ID",
        "pay_method": "offline",
        "sub_pay_method": "WeChat Pay"
    }
}

返回示例:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "511444d0-2d91-5396-9e34-f2900e80d715",
        "amount": "2.1",
        "tip_amount": "0.5",
		"sub_pay_method": "WeChat Pay",
        "state": "paid"
    },
    "message": ""}

更多信息:

返回结果:

小贴士

  1. 在用户免密码验证情况下,支付结果将同步返回。
  2. 扫码后遇到用户输入密码验证情况下,会出现支付结果state: processing,这时商户需要每隔5秒循环调用订单查询判断实际支付结果。
  3. 如果用户取消支付或累计30秒用户内仍未支付,建议商户退出查询流程后继续调用取消支付以便撤销支付交易。如果用户实际已经支付,系统将自动做退款处理。
返回代码:
StatusCodeMessage
true200Success
false-1000Internal error
false-1007Identity code is invalid
false-4011Not support the payment method
false-4015This order has been closed
false-4028WeChat Pay is not available
false-4029Alipay is not available
false-4086Unknow identity code