文档中心/API 接口

API REFERENCE

二维码支付

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

二维码支付

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

请求参数10

先填写必填项

二维码支付

pay_method必填stringdata.pay_methodoffline
sub_pay_method必填stringdata.sub_pay_methodQRcode
amount必填stringdata.amount金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1
currency必填stringdata.currency货币代码,ISO 4217,例如EUR,CHF
description必填stringdata.description订单描述
timeout必填stringdata.timeout过期时间单位分钟(0-1440)
notify_url必填stringdata.notify_url支付完成后异步通知地址
可选参数 3
tip_amount可选stringdata.tip_amount总金额中包含的小费,金额数字。例如 1.02
demo可选stringdata.demo自定义字段
redirect_url可选stringdata.redirect_url支付完成后跳转地址

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

适用于线下门店支付场景

小贴士

请将返回的url(或将url转换成二维码)以及可用支付方式的icon展示给用户。

参数类型描述是否必填
userString收银员账号的UID必填
signString签名必填
methodStringv3.QRcodePayment必填
timeLong时间戳必填
  • 参数
ParameterTypeDescription是否必填
pay_methodStringoffline必填
sub_pay_methodStringQRcode必填
order_idString商户的订单ID必填
amountString金额数字。例如 € 24.99 应该写成24.99,CNY金额>=1,欧元金额>=0.1必填
tip_amountString总金额中包含的小费,金额数字。例如 1.02选填
currencyString货币代码,ISO 4217,例如EUR,CHF必填
descriptionString订单描述必填
demoString自定义字段选填
timeoutString过期时间单位分钟(0-1440)必填
redirect_urlString支付完成后跳转地址选填
notify_urlString支付完成后异步通知地址必填

签名示例:

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

 "amount=12.1&currency=EUR&demo=test&description=YabandPay test&method=v3.QRcodePayment&notify_url=https://www.yabandpay.com/notify&order_id=202486556498441613&pay_method=offline&redirect_url=https://www.yabandpay.com&sub_pay_method=QRcode&time=1555498137&timeout=0&tip_amount=0.5&user=YOUR_CASHIER_UID" 

得到的 stringA 使用 secret_key做签名

得到的签名如下:

"YOUR_SIGNATURE"

提交示例:

 {
  "user": "YOUR_CASHIER_UID",
  "sign": "YOUR_SIGNATURE",
  "method": "v3.QRcodePayment",
  "time": 1555498137,
  "data": {
    "amount": "12.1",
    "currency": "EUR",
    "tip_amount": "0.5",
    "demo": "test",
    "description": "YabandPay test",
    "notify_url": "https://www.yabandpay.com/notify",
    "order_id": "YOUR_ORDER_ID",
    "pay_method": "offline",
    "redirect_url": "https://www.yabandpay.com",
    "sub_pay_method": "QRcode",
    "timeout": "0"
  }
} 

返回示例:

{
  "status": true,
  "code": "200",
  "data": {
    "order_id": "YOUR_ORDER_ID",
    "trade_id": "4552eeea-1ae8-1e40-3b4b-802dc2f5686a",
    "amount": "12",
    "currency": "EUR",
    "tip_amount": "0.5",
    "url": "https://pay.yabandpay.com/payments/selectpay/order/ODlmYmYyMzQtN2U1Yy00ZDI5LTM5NWMtNGI4NzljYjI4MDlj",
    "available_payment_methods": "Alipay+, Wechat Pay, iDEAL, UnionPay, QuickPass, Bancontact, Visa, Mastercard, ApplePay, GooglePay",
    "state": "processing"
  },
  "message": ""} 

更多信息:

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

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

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

返回代码:
StatusCodeMessage
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method